From ce2b866900f61545a20597d1d2c7a0bfe4ff7a4b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Hendrik=20K=C3=B6lbel?= <31684940+HendrikKoelbel@users.noreply.github.com> Date: Mon, 17 Feb 2020 20:45:50 +0100 Subject: [PATCH] Update README.md --- README.md | 324 +++++++++++++++++++++++++++--------------------------- 1 file changed, 162 insertions(+), 162 deletions(-) diff --git a/README.md b/README.md index effae0a..2357fec 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ Installation Usage ------------ -~~~ +```csharp public class ApiExample { LiveChatApi.Api Api; @@ -48,7 +48,7 @@ public class ApiExample Console.WriteLine(result); } } -~~~ +``` Available methods ------------ @@ -58,206 +58,206 @@ Available methods [Agents REST API documentation](https://docs.livechatinc.com/rest-api/#!agents). **List all agents** -~~~ +```csharp string result = await Api.Agents.List(); -~~~ -~~~ +``` +```csharp string status = "accepting chats"; string result = await Api.Agents.List(status); -~~~ +``` **Get a single agent details** -~~~ +```csharp string login = "robert@mycompany.com"; string result = await Api.Agents.Get(login); -~~~ +``` **Create an agent** -~~~ +```csharp Dictionary props = new Dictionary(); props.Add("login", "john@mycompany.com"); props.Add("name", "John"); string result = await Api.Agents.Add(props); -~~~ +``` **Update an agent** -~~~ +```csharp string login = "john@mycompany.com"; Dictionary props = new Dictionary(); props.Add("login_status", "not accepting chats"); props.Add("max_chats_count", "2"); string result = await Api.Agents.Update(login, props); -~~~ +``` **Reset an API key** -~~~ +```csharp string login = "username@mycompany.com"; string result = await Api.Agents.ResetApiKey(login); -~~~ +``` *The agent can only change his own api key.* **Remove an agent** -~~~ +```csharp string login = "john@mycompany.com"; string result = await Api.Agents.Remove(login); -~~~ +``` ### Archives [Archives REST API documentation](https://docs.livechatinc.com/rest-api/#!archives). **Get list of chats** -~~~ +```csharp Dictionary parameters = new Dictionary(); parameters.Add("date_from", "2015-10-01"); parameters.Add("query", "test"); string result = await Api.Archives.Get(parameters); -~~~ +``` **Get single chat** -~~~ +```csharp string chatID = "NXBE94NZ10"; string result = await Api.Archives.Get(chatID); -~~~ +``` **Send chat transcript to e-mail** -~~~ +```csharp string chatID = "NXBE94NZ10"; string email = "username@mycompany.com"; string result = await Api.Archives.SendTranscript(chatID, email); -~~~ +``` **Update chat tags** -~~~ +```csharp string chatID = "NXBE94NZ10"; string[] tags = { "sales", "complaint" }; string result = await Api.Archives.Tags(chatID, tags); -~~~ +``` ### Canned responses [Canned responses REST API documentation](https://docs.livechatinc.com/rest-api/#!canned-responses). **List all canned responses** -~~~ +```csharp string result = await Api.CannedResponses.List(); -~~~ -~~~ +``` +```csharp string groupID = "0"; string result = await Api.CannedResponses.List(groupID); -~~~ +``` **Get single canned response** -~~~ +```csharp string responseID = "3151"; string result = await Api.CannedResponses.Get(responseID); -~~~ +``` **Create a new canned response** -~~~ +```csharp string text = "text"; string[] tags = {"tag1", "tag2"}; string result = await Api.CannedResponses.Add(text, tags); -~~~ -~~~ +``` +```csharp string text = "text"; string[] tags = {"tag1", "tag2"}; string groupID = "0"; string result = await Api.CannedResponses.Add(text, tags, groupID); -~~~ +``` **Update a canned response** -~~~ +```csharp string responseID = "3151"; string[] tags = { "tag3", "tag4" }; string result = await Api.CannedResponses.Update(responseID, tags); -~~~ -~~~ +``` +```csharp string responseID = "3151"; string[] tags = { "tag3", "tag4" }; string text = "text"; string result = await Api.CannedResponses.Update(responseID, tags, text); -~~~ +``` **Remove a canned response** -~~~ +```csharp string responseID = "3151"; string result = await Api.CannedResponses.Remove(responseID); -~~~ +``` ### Goals [Goals REST API documentation](https://docs.livechatinc.com/rest-api/#!goals). **List all goals** -~~~ +```csharp string result = await Api.Goals.List(); -~~~ +``` **Get a single goal details** -~~~ +```csharp string goalID = "7601"; string result = await Api.Goals.Get(goalID); -~~~ +``` **Mark goal as successful** -~~~ +```csharp string goalID = "7601"; string visitorID = "S1415110640.63935a25f1"; string result = await Api.Goals.MarkAsSuccessful(goalID, visitorID); -~~~ +``` **Add a new goal** -~~~ +```csharp string name = "new_goal"; string type = "api"; string result = await Api.Goals.Add(name, type); -~~~ -~~~ +``` +```csharp string name = "new_goal"; string type = "url"; Dictionary parameters = new Dictionary(); parameters.Add("url", "http://www.mystore.com/checkout/thank_you"); parameters.Add("match_type","exact"); string result = await Api.Goals.Add(name, type, parameters); -~~~ +``` **Update a goal** -~~~ +```csharp string goalID = "7601"; Dictionary parameters = new Dictionary(); parameters.Add("name", "new_goal_paused"); parameters.Add("active", "0"); string result = await Api.Goals.Update(goalID, parameters); -~~~ +``` **Remove a goal** -~~~ +```csharp string goalID = "7601"; string result = await Api.Goals.Remove(goalID); -~~~ +``` ### Greetings [Greetings REST API documentation](https://docs.livechatinc.com/rest-api/#!greetings). **List all greetings** -~~~ +```csharp string result = await Api.Greetings.List(); -~~~ -~~~ +``` +```csharp string groupID = "0"; string result = await Api.Greetings.List(groupID); -~~~ +``` **Get a single greeting** -~~~ +```csharp string greetingID = "7661"; string result = await Api.Greetings.Get(greetingID); -~~~ +``` **Create a new greeting** -~~~ +```csharp string name = "my_invitation"; Dictionary[] rules = { new Dictionary(), new Dictionary() }; rules[0].Add("type", "visit_time_page"); @@ -271,8 +271,8 @@ Dictionary[] funnelRules = { new Dictionary() }; funnelRules[0].Add("mystore.com/shoes", "equals"); funnelRules[0].Add("cart", "contains"); string result = await Api.Greetings.Add(name, rules, funnelRules); -~~~ -~~~ +``` +```csharp string name = "my_invitation"; Dictionary[] rules = { new Dictionary(), new Dictionary() }; rules[0].Add("type", "visit_time_page"); @@ -287,75 +287,75 @@ funnelRules[0].Add("mystore.com/shoes", "equals"); funnelRules[0].Add("cart", "contains"); string groupID = "0"; string result = await Api.Greetings.Add(name, rules, funnelRules, groupID); -~~~ +``` **Update a greeting** -~~~ +```csharp string greetingID = "7661"; Dictionary parameters = new Dictionary(); parameters.Add("active","1"); string result = await Api.Greetings.Update(greetingID, parameters); -~~~ +``` **Remove a greeting** -~~~ +```csharp string greetingID = "7661"; string result = await Api.Greetings.Remove(greetingID); -~~~ +``` ### Groups [Groups REST API documentation](https://docs.livechatinc.com/rest-api/#!groups). **List all groups** -~~~ +```csharp string result = await Api.Groups.List(); -~~~ +``` **Get a single group details** -~~~ +```csharp string groupID = "0"; string result = await Api.Groups.Get(groupID); -~~~ +``` **Create a new group** -~~~ +```csharp string name = "new_group"; string[] agents = { "robert@mycompany.com", "john@mycompany.com" }; string result = await Api.Groups.Add(name, agents); -~~~ -~~~ +``` +```csharp string name = "new_group"; string[] agents = { "robert@mycompany.com", "john@mycompany.com" }; string language = "es"; string result = await Api.Groups.Add(name, agents, language); -~~~ +``` **Update a group** -~~~ +```csharp string groupID = "1"; string[] agents = { "robert@mycompany.com" }; result = await Api.Groups.Update(groupID, agents); -~~~ -~~~ +``` +```csharp string groupID = "1"; string[] agents = { "robert@mycompany.com" }; string name = "other_name"; result = await Api.Groups.Update(groupID, agents, name); -~~~ -~~~ +``` +```csharp string groupID = "1"; string[] agents = { "robert@mycompany.com" }; string name = "other_name"; string language = "de" result = await Api.Groups.Update(groupID, agents, name, language); -~~~ +``` **Remove a group** -~~~ +```csharp string groupID = "1"; string result = await Api.Groups.Remove(groupID); -~~~ +``` ### Reports @@ -363,17 +363,17 @@ string result = await Api.Groups.Remove(groupID); [Reports REST API documentation](https://docs.livechatinc.com/rest-api/#!reports). **Total chats** -~~~ +```csharp Dictionary parameters = new Dictionary(); parameters.Add("date_from", "2015-10-01"); parameters.Add("date_to", "2015-10-31"); parameters.Add("agent", "john@mycompany.com"); parameters.Add("group_by", "hour"); string result = await Api.Reports.TotalChats(parameters); -~~~ +``` **Chat sources** -~~~ +```csharp Dictionary parameters = new Dictionary(); parameters.Add("date_from", "2015-10-01"); parameters.Add("date_to", "2015-10-31"); @@ -381,264 +381,264 @@ parameters.Add("agent", "john@mycompany.com"); parameters.Add("group_by", "hour"); parameters.Add("tag[]", "sales"); string result = await Api.Reports.ChatSources(parameters); -~~~ +``` **Chat ratings** -~~~ +```csharp Dictionary parameters = new Dictionary(); parameters.Add("group", "2"); parameters.Add("date_from", "2015-01-01"); parameters.Add("date_to", "2015-10-31"); parameters.Add("group_by", "month"); string result = await Api.Reports.ChatRatings(parameters); -~~~ +``` **Chat ranking** -~~~ +```csharp Dictionary parameters = new Dictionary(); parameters.Add("date_from", "2015-10-01"); parameters.Add("date_to", "2015-10-31"); string result = await Api.Reports.ChatRanking(parameters); -~~~ +``` **Queued visitors** -~~~ +```csharp Dictionary parameters = new Dictionary(); parameters.Add("date_from", "2015-10-01"); parameters.Add("date_to", "2015-10-31"); parameters.Add("group", "2"); string result = await Api.Reports.QueuedVisitors(parameters); -~~~ +``` **Queue waiting times** -~~~ +```csharp Dictionary parameters = new Dictionary(); parameters.Add("date_from", "2015-10-01"); parameters.Add("date_to", "2015-10-31"); parameters.Add("group", "2"); string result = await Api.Reports.QueueWaitingTimes(parameters); -~~~ +``` **Availability** -~~~ +```csharp Dictionary parameters = new Dictionary(); parameters.Add("date_from", "2015-10-01"); parameters.Add("date_to", "2015-10-31"); parameters.Add("agent", "john@mycompany.com"); string result = await Api.Reports.Availability(parameters); -~~~ +``` **Chatting time** -~~~ +```csharp Dictionary parameters = new Dictionary(); parameters.Add("date_from", "2015-10-01"); parameters.Add("date_to", "2015-10-31"); parameters.Add("group", "2"); string result = await Api.Reports.ChattingTime(parameters); -~~~ +``` **Chats first response time** -~~~ +```csharp Dictionary parameters = new Dictionary(); parameters.Add("date_from", "2015-10-01"); parameters.Add("date_to", "2015-10-31"); parameters.Add("agent", "john@mycompany.com"); string result = await Api.Reports.ChatsFirstResponseTime(parameters); -~~~ +``` **Chats response time** -~~~ +```csharp Dictionary parameters = new Dictionary(); parameters.Add("date_from", "2015-10-01"); parameters.Add("date_to", "2015-10-31"); parameters.Add("agent", "john@mycompany.com"); string result = await Api.Reports.ChatsResponseTime(parameters); -~~~ +``` **Goals** -~~~ +```csharp Dictionary parameters = new Dictionary(); parameters.Add("date_from", "2015-01-01"); parameters.Add("date_to", "2015-10-31"); parameters.Add("goal", "71"); parameters.Add("group_by", "month"); string result = await Api.Reports.Goals(parameters); -~~~ +``` **New tickets** -~~~ +```csharp Dictionary parameters = new Dictionary(); parameters.Add("date_from", "2015-10-01"); parameters.Add("date_to", "2015-10-01"); parameters.Add("group_by", "hour"); string result = await Api.Reports.NewTickets(parameters); -~~~ +``` **Tickets first response time** -~~~ +```csharp Dictionary parameters = new Dictionary(); parameters.Add("date_from", "2015-10-01"); parameters.Add("date_to", "2015-10-31"); parameters.Add("agent", "john@mycompany.com"); string result = await Api.Reports.TicketsFirstResponseTime(parameters); -~~~ +``` **Solved tickets** -~~~ +```csharp Dictionary parameters = new Dictionary(); parameters.Add("date_from", "2015-10-01"); parameters.Add("date_to", "2015-10-31"); string result = await Api.Reports.SolvedTickets(parameters); -~~~ +``` **Tickets resolution time** -~~~ +```csharp Dictionary parameters = new Dictionary(); parameters.Add("date_from", "2015-10-01"); parameters.Add("date_to", "2015-10-31"); string result = await Api.Reports.TicketsResolutionTime(parameters); -~~~ +``` **Ticket sources** -~~~ +```csharp Dictionary parameters = new Dictionary(); parameters.Add("date_from", "2015-10-01"); parameters.Add("date_to", "2015-10-31"); string result = await Api.Reports.TicketSources(parameters); -~~~ +``` **Ticket ratings report** -~~~ +```csharp Dictionary parameters = new Dictionary(); parameters.Add("date_from", "2015-01-01"); parameters.Add("date_to", "2015-10-31"); parameters.Add("group_by", "month"); string result = await Api.Reports.TicketRatings(parameters); -~~~ +``` **Ticket Ranking** -~~~ +```csharp Dictionary parameters = new Dictionary(); parameters.Add("date_from", "2015-10-01"); parameters.Add("date_to", "2015-10-31"); string result = await Api.Reports.TicketRanking(parameters); -~~~ +``` **Greetings conversions** -~~~ +```csharp Dictionary parameters = new Dictionary(); parameters.Add("date_from", "2015-01-01"); parameters.Add("date_to", "2015-10-31"); parameters.Add("group_by", "month"); string result = await Api.Reports.GreetingsConversions(parameters); -~~~ +``` **Number of simultaneous chats** -~~~ +```csharp string weekday = "mon"; string result = await Api.Reports.SimultaneousChats(weekday); -~~~ +``` ### Status [Status REST API documentation](https://docs.livechatinc.com/rest-api/#!status). **Get status** -~~~ +```csharp string result = await Api.Status.Get(); -~~~ -~~~ +``` +```csharp string groupID = "1"; string result = await Api.Status.Get(groupID); -~~~ +``` ### Tags [Tags REST API documentation](https://docs.livechatinc.com/rest-api/#!tags). **List all tags** -~~~ +```csharp string result = await Api.Tags.List(); -~~~ -~~~ +``` +```csharp string groupID = "1"; string result = await Api.Tags.Get(groupID); -~~~ +``` **Add a tag** -~~~ +```csharp string author = "john@mycompany.com"; string tag = "support"; string groupID = "1"; string result = await Api.Tags.Add(author, tag, groupID); -~~~ +``` **Delete a tag** -~~~ +```csharp string tag = "support"; string groupID = "1"; string result = await Api.Tags.Remove(tag, groupID); -~~~ +``` ### Tickets [Tickets REST API documentation](https://docs.livechatinc.com/rest-api/#!tickets). **Get list of tickets** -~~~ +```csharp string result = await Api.Tickets.List(); -~~~ -~~~ +``` +```csharp Dictionary parameters = new Dictionary(); parameters.Add("date_from", "2015-10-01"); parameters.Add("date_to", "2015-12-31"); string result = await Api.Tickets.List(parameters); -~~~ +``` **Get single ticket** -~~~ +```csharp string ticketID = "ZR8U4"; string result = await Api.Tickets.Get(ticketID); -~~~ +``` **Create a ticket** -~~~ +```csharp string message = "ticket message"; string requester = "requester@othercompany.com"; string result = await Api.Tickets.Add(message, requester); -~~~ -~~~ +``` +```csharp string message = "ticket message"; string requester = "requester@othercompany.com"; Dictionary parameters = new Dictionary(); parameters.Add("requester[name]", "Bill"); string result = await Api.Tickets.Add(message, requester, parameters); -~~~ +``` **Update ticket tags** -~~~ +```csharp string ticketID = "ZR8U4"; string[] tags = { "sales", "complaint" }; string result = await Api.Tickets.UpdateTags(ticketID, tags); -~~~ +``` ### Visitors [Visitors REST API documentation](https://docs.livechatinc.com/rest-api/#!visitors). **List all visitors** -~~~ +```csharp string result = await Api.Visitors.List(); -~~~ -~~~ +``` +```csharp Dictionary parameters = new Dictionary(); parameters.Add("state", "chatting"); parameters.Add("group[]", "0"); string result = await Api.Visitors.List(parameters); -~~~ +``` **Add custom visitor details** -~~~ +```csharp string visitorID = "S1415110640.63935a25f1"; string licenseID = "123456"; string token = "26132406c42c96ba61ed42689b70f711"; @@ -646,8 +646,8 @@ string id = "my-app"; Dictionary fields = new Dictionary(); fields.Add("name1", "value1"); string result = await Api.Visitors.AddCustomDetails(visitorID, licenseID, token, id, fields); -~~~ -~~~ +``` +```csharp string visitorID = "S1415110640.63935a25f1"; string licenseID = "123456"; string token = "26132406c42c96ba61ed42689b70f711"; @@ -656,27 +656,27 @@ Dictionary fields = new Dictionary(); fields.Add("name1", "value1"); string icon = "http://www.mycompany.com/icon.png"; string result = await Api.Visitors.AddCustomDetails(visitorID, licenseID, token, id, fields, icon); -~~~ +``` ### Webhooks [Webhooks REST API documentation](https://docs.livechatinc.com/rest-api/#!webhooks). **Display configured webhooks** -~~~ +```csharp string result = await Api.Webhooks.List(); -~~~ +``` **Create a new webhook** -~~~ +```csharp string eventType = "chat_started"; string[] dataTypes = { "chat", "visitor" }; string url = "http://www.mycompany.com/parse_webhook.php"; string result = await Api.Webhooks.Add(eventType, dataTypes, url); -~~~ +``` **Delete a webhook** -~~~ +```csharp string webhookID = "39612eee5f1b431217aafb9de19c1e31"; string result = await Api.Webhooks.Remove(webhookID); -~~~ +```