LiveChat is an online customer service software with live support, help desk software and web analytics capabilities.
Status: Preview |
Tier: Premium |
Version: 1.0.0 |
Name |
Summary |
Delete hook |
|
List agents |
|
Create a new agent |
|
Remove an agent |
|
List tickets |
|
Create a new ticket |
|
Update ticket |
|
Get ticket |
|
|
Name |
Summary |
When a ticket is created |
|
WebhookChatStarted ([internal]string event_type, WebhookRequest body) |
When a chat starts |
WebhookChatEnded ([internal]string event_type, WebhookRequest body) |
When a chat ends |
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Delete hook
Description: Delete a hook.
Syntax:
LiveChat.DeleteHook (string hookId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
hookId |
string
|
|
True |
Returns:
Summary: List agents
Description: This operation returns a list of all the agents in your LiveChat account.
Syntax:
LiveChat.ListAgents ()
Returns:
Type:array of (ListAgentsResponseItem)
Summary: Agents Array
Description: List of all agents with their details.
Summary: Create a new agent
Description: This operation is used to add a new agent to your LiveChat account.
Syntax:
LiveChat.CreateAgent (CreateAgent_Request body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
|
True |
Returns:
Type:CreateAgent_Response
Summary: Remove an agent
Description: This operation is used to delete an agent from your LiveChat account.
Syntax:
LiveChat.DeleteAgent (string login)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
login |
string (Email) |
The email of the agent. |
True |
Returns:
Type:DeleteAgent_Response
Summary: List tickets
Description: This operation returns a list of tickets in your LiveChat account.
Syntax:
LiveChat.ListTickets ()
Returns:
Type:array of (ListTicketsResponseItem)
Summary: Create a new ticket
Description: This operation is used to add a new ticket to your LiveChat account.
Syntax:
LiveChat.CreateTicket (Createticket_Request body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
|
True |
Returns:
Type:TicketResponse
Summary: Update ticket
Description: This operation is used to update the details of an existing ticket in your LiveChat account.
Syntax:
LiveChat.UpdateTicket (string ticketId, Updateticket_Request body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
ticketId |
string (Ticket Id) |
The id of the ticket |
True |
|
body |
|
|
True |
Returns:
Type:TicketResponse
Summary: Get ticket
Description: This operation is used to fetch the details of a specific ticket in your LiveChat account.
Syntax:
LiveChat.GetTicket (string ticketId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
ticketId |
string (Ticket Id) |
The id of the ticket |
True |
Returns:
Type:TicketResponse
Summary:
Description:
Syntax:
LiveChat.WebhookResponse ([Optional]string logicAppsUri)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
logicAppsUri |
string
|
|
False |
Returns:
Summary: When a ticket is created
Description: This operation triggers when a new ticket is added.
Syntax:
LiveChat.WebhookTicketCreated ([internal]string event_type, [internal]string data_types[], WebhookRequest body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
event_type |
string
|
|
True |
|
data_types[] |
string
|
|
True |
|
body |
|
|
True |
Returns:
Type:WebhookTicketCreatedResponse
Summary: When a chat starts
Description: This operation triggers when new a chat starts.
Syntax:
LiveChat.WebhookChatStarted ([internal]string event_type, WebhookRequest body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
event_type |
string
|
|
True |
|
body |
|
|
True |
Returns:
Type:WebhookChatStartedResponse
Summary: When a chat ends
Description: This operation triggers when a chat ends.
Syntax:
LiveChat.WebhookChatEnded ([internal]string event_type, WebhookRequest body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
event_type |
string
|
|
True |
|
body |
|
|
True |
Returns:
Summary:
Description:
Properties:
Name |
Type |
Summary |
login |
string |
|
name |
string Name |
|
login_status |
string Login status |
Values: [accepting chats, not accepting chats] |
job_title |
string Title |
Defaults to: Support Agent. |
permission |
string Permission |
Values: [administrator, normal] |
password |
string Password |
Minimum length 5. |
max_chats_count |
string Max chat counts |
Limit of the concurrent chats. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
avatar |
string Avatar |
Path to the image on Amazon s3. |
groups |
array of (GroupsItem) Groups Array |
List of all groups the agent is a part of. |
job_title |
string Job Title |
Support agent by default. |
license_id |
License Id |
license_id |
login |
string |
The agent's email address. |
login_status |
string Login Status |
Accepting chats or not accepting chats. |
max_chats_count |
integer(int32) Max Chat Counts |
Limit of the concurrent chats. |
name |
string Name |
Agent's name. |
permission |
string Permission |
Owner, administrator or normal |
status |
string Status |
Accepting chats, not accepting chats or offline. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
integer(int32) Group Id |
Unique id of the group. |
name |
string Group Name |
Name of the group. |
Summary: License Id
Description: license_id
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
message |
string Message |
|
requester |
|
|
subject |
string Subject |
|
assignee |
|
|
source |
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
|
string Requester's Email |
|
name |
string Requester's Name |
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
string Assignee Id |
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
type |
string Source Type |
Pick a source Values: [chat-window, mail, lc2] |
url |
string Source URL |
If source type is chat-window. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
result |
string Result |
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
avatar |
string Avatar |
Path to the image on Amazon s3. |
login |
string Login Email |
The agent's email address. |
name |
string Name |
Agent's name. |
permission |
string Permission |
Owner, administrator or normal. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
date |
string(date-time) Created Date-Time |
yyyy-MM-ddTHH:mm:ss.fffZ |
id |
string Ticket Id |
Unique identifier of the ticket. |
modified |
string(date-time) Modified Date-Time |
yyyy-MM-ddTHH:mm:ss.fffZ |
requester |
Requester |
requester |
source |
Source |
Details of the ticket source. |
status |
string Status |
Open, pending, solved or spam. |
subject |
string Subject |
Description of the ticket source. |
Summary: Requester
Description: requester
Properties:
Name |
Type |
Summary |
ip |
string IP |
IP address of the requester. |
|
string |
Email address of the requester. |
name |
string Name |
Full name of the requester. |
Summary: Source
Description: Details of the ticket source.
Properties:
Name |
Type |
Summary |
id |
string Id |
Unique identifier of the source. |
type |
string Type |
From chat, mail or lc2. |
url |
string URL |
Webpage where the ticket was created. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
currentGroup |
Group |
currentGroup |
date |
string(date-time) Created Date-Time |
yyyy-MM-ddTHH:mm:ss.fffZ |
events |
array of (EventsItem)
|
|
groups |
array of (GroupsItem) Group |
Details of the associated group. |
id |
string Ticket Id |
Unique id of the ticket. |
requester |
Requester |
Details of the requester. |
source |
Source |
|
status |
string Status |
Open, pending, solved or spam. |
subject |
string Subject |
Short description of the ticket. |
tags |
array of (string)
|
|
Summary: Group
Description: currentGroup
Properties:
Name |
Type |
Summary |
id |
integer(int32) Id |
Unique id of the group. |
name |
string Name |
Name of the group. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
author |
Author |
|
date |
string(date-time) Event Date-Time |
yyyy-MM-ddTHH:mm:ss.fffZ |
is_private |
boolean Is Private |
True if event is private. |
message |
string Message |
Description of the event. |
source |
Source |
Ticket source description. |
type |
string Event Type |
Type of event that generated the ticket. |
Summary: Author
Description:
Properties:
Name |
Type |
Summary |
id |
string Id |
Unique id of the user. |
name |
string Name |
Name of the author. |
type |
string Type |
Agent or client. |
Summary: Source
Description: Ticket source description.
Properties:
Name |
Type |
Summary |
type |
string Type |
Chat-window, mail or lc2. |
url |
string URL |
Url of the website that the ticket was sent from. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
integer(int32) Id |
Unique id of the group. |
name |
string Name |
Name of the group. |
Summary: Requester
Description: Details of the requester.
Properties:
Name |
Type |
Summary |
ip |
string IP |
IP address of the requester. |
|
string |
Email address of the requester. |
name |
string Name |
Name of the requester. |
Summary: Source
Description:
Properties:
Name |
Type |
Summary |
id |
string Id |
Unique id of the source. |
type |
string Type |
Lc2, mail, facebook, agent-app-manual or chat-window. |
url |
string URL |
Url of the website where ticket was created. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
message |
string Message |
|
requester |
|
|
subject |
string Subject |
|
assignee |
|
|
source |
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
|
string Requester's Email |
|
name |
string Requester's Name |
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
string Assignee Id |
Pick an assignee. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
type |
string Source Type |
Pick a source. Values: [chat-window, mail, lc2] |
url |
string Source URL |
If source type is chat-window. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
url |
string url |
url |
Summary:
Description:
Properties:
Name |
Type |
Summary |