AgentChat API

This document describes how you can use the ChannelMobile AgentChat API

PreviousAPI Reference NextChannel360 V1.1 API

Last updated 10 months ago

Was this helpful?

AgentLogon

The API call to logon the agent and return a session token

post

/AgentLogon

Query parameters

Versionstringrequired

The current version number

Example: {{BUILD_VERSION}}

Body

EmailAddressstringrequired

The unique email address and the username the agent will use to login

Passwordstringrequired

The password corresponding to the unique email address

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://agentchat.abcsoftware.dnsalias.com/api/AgentLogon?Version=%7B%7BBUILD_VERSION%7D%7D' \
  --header 'Content-Type: application/json' \
  --data '{
    "EmailAddress": "joe@agentchat.co.za",
    "Password": "123smith$$"
  }'

200

No body

SetPassword

The API call to update the password for an agent

post

/SetPassword

Query parameters

Versionstringrequired

The current version number

Example: {{BUILD_VERSION}}

Body

ResetCodestringrequired

The ResetCode in the reset password request URL

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://agentchat.abcsoftware.dnsalias.com/api/SetPassword?Version=%7B%7BBUILD_VERSION%7D%7D' \
  --header 'Content-Type: application/json' \
  --data '{
    "ResetCode": "76897132458762458761243"
  }'

200

No body

RequestPasswordReset

The API call to initiate a password change for an agent

get

/RequestPasswordReset

Query parameters

EmailAddressstringrequired

The unique email address and the username of the agent

Example: {{EmailAddress}}

Versionstringrequired

The current version number

Example: {{BUILD_VERSION}}

SessionTokenstringrequired

The session token returned by the AgentLogon call

Example: 3a4783a081028a59e7b35529a3f9ef22

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://agentchat.abcsoftware.dnsalias.com/api/RequestPasswordReset?EmailAddress=%7B%7BEmailAddress%7D%7D&Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22'

200

No body

AgentLogoff

The API call to log-off the agent and invalidate the session token

get

/AgentLogoff

Query parameters

Versionstringrequired

The current version number

Example: {{BUILD_VERSION}}

SessionTokenstringrequired

The session token returned by the AgentLogon call

Example: 3a4783a081028a59e7b35529a3f9ef22

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://agentchat.abcsoftware.dnsalias.com/api/AgentLogoff?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22'

200

No body

SendMessage

The API call to send a message to a chat

post

/SendMessage

Authorizations

Query parameters

Versionstringrequired

The current version number

Example: {{BUILD_VERSION}}

SessionTokenstringrequired

The session token returned by the AgentLogon call

Example: 3a4783a081028a59e7b35529a3f9ef22

Body

ChatIDstringrequired

The ID number of the Chat from which the message is to be sent

MessageTextstringrequired

The text of the message

AttachmentTypestring

Type of file being attached to the message

AttachmentNamestring

The name of the file to be attached to the message

AttachmentDatastring

The base 64 encoded file content

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://agentchat.abcsoftware.dnsalias.com/api/SendMessage?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22' \
  --header 'apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "ChatID": "408",
    "MessageText": "Hallo there",
    "AttachmentType": "image/jpeg",
    "AttachmentName": "image.jpg",
    "AttachmentData": "/9j/4AAQSkZJRgABAQEBLAEsAAD//gATQ3JlYXRlZCB3...............M0xIZA4JnL+v/2Q=="
  }'

200

No body

AddComment

The API call to add a comment to a customer

post

/AddComment

Query parameters

Versionstringrequired

The current version number

Example: {{BUILD_VERSION}}

SessionTokenstringrequired

The session token returned by the AgentLogon call

Example: 3a4783a081028a59e7b35529a3f9ef22

Body

CustomerIDintegerrequired

The customer ID of the customer that the chat belongs to. The customer must be linked to an active chat

Commentstringrequired

The Comment being added.

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://agentchat.abcsoftware.dnsalias.com/api/AddComment?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22' \
  --header 'Content-Type: application/json' \
  --data '{
    "CustomerID": "1",
    "Comment": "This is a new comment"
  }'

200

No body

TransferChat

The API call to transfer a chat to a new department.

get

/TransferChat

Query parameters

ChatIDintegerrequired

The ID of the chat to be assigned

DepartmentIDintegerrequired

The ID of the department that the chat must be transferred to

Versionstringrequired

The current version number

Example: {{BUILD_VERSION}}

SessionTokenstringrequired

The session token returned by the AgentLogon call

Example: 3a4783a081028a59e7b35529a3f9ef22

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://agentchat.abcsoftware.dnsalias.com/api/TransferChat?ChatID=1&DepartmentID=1&Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22'

200

No body

ReAssignChat

The API call to transfer a chat to a new agent. Business Rules: 1. Chat must be assigned. 2 Agent must be online.

get

/ReAssignChat

Query parameters

Versionstringrequired

The current version number

Example: {{BUILD_VERSION}}

SessionTokenstringrequired

The session token returned by the AgentLogon call

Example: 3a4783a081028a59e7b35529a3f9ef22

AgentIDintegerrequired

ChatIDinteger

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://agentchat.abcsoftware.dnsalias.com/api/ReAssignChat?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22&AgentID=1'

200

No body

GrabChat

The API call to assign a new chat to the calling agent (Agent making the GrabChat call)

get

/GrabChat

Query parameters

Versionstringrequired

The current version number

Example: {{BUILD_VERSION}}

SessionTokenstringrequired

The session token returned by the AgentLogon call

Example: 3a4783a081028a59e7b35529a3f9ef22

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://agentchat.abcsoftware.dnsalias.com/api/GrabChat?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22'

200

No body

GetChatList

The API call to return a list and details of unassigned, open and closed chats

get

/GetChatList

Query parameters

ChatTypestring

The type of Chat which has to be one of the three Valid Values: open, unassigned, closed

Example: closed

Versionstringrequired

The current version number

Example: {{BUILD_VERSION}}

SessionTokenstringrequired

The session token returned by the AgentLogon call

Example: 3a4783a081028a59e7b35529a3f9ef22

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://agentchat.abcsoftware.dnsalias.com/api/GetChatList?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22'

200

No body

ExportChat

The API call to return the details of a chat to be exported, this data will be in a csv format

get

/ExportChat

Query parameters

ChatIDinteger · int32required

The unique ID number of each chat

Example: 406

Versionstringrequired

The current version number

Example: {{BUILD_VERSION}}

SessionTokenstringrequired

The session token returned by the AgentLogon call

Example: 3a4783a081028a59e7b35529a3f9ef22

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://agentchat.abcsoftware.dnsalias.com/api/ExportChat?ChatID=406&Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22'

200

No body

CloseChat

The API call to update the status of a chat to closed

get

/CloseChat

Query parameters

ChatIDinteger · int32required

The unique ID number of each chat

Example: 406

Versionstringrequired

The current version number

Example: {{BUILD_VERSION}}

SessionTokenstringrequired

The session token returned by the AgentLogon call

Example: 3a4783a081028a59e7b35529a3f9ef22

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://agentchat.abcsoftware.dnsalias.com/api/CloseChat?ChatID=406&Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22'

200

No body

AssignChat

The API call to update the status of a Chat to assigned, when assigned to an Agent

get

/AssignChat

Query parameters

ChatIDinteger · int32required

The ID of the chat to be assigned

Example: 406

AgentIDinteger · int32

the id of the agent the chat must be assigned to, if not specified, the chat will be assigned to the agent that is performing the call

Example: 3

Versionstringrequired

The current version number

Example: {{BUILD_VERSION}}

SessionTokenstringrequired

The session token returned by the AgentLogon call

Example: 3a4783a081028a59e7b35529a3f9ef22

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://agentchat.abcsoftware.dnsalias.com/api/AssignChat?ChatID=406&Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22'

200

No body

CreateAgent

The API call to create a new Agent

post

/CreateAgent

Query parameters

Versionstringrequired

The current version number

Example: {{BUILD_VERSION}}

SessionTokenstringrequired

The session token returned by the AgentLogon call

Example: 3a4783a081028a59e7b35529a3f9ef22

Body

Namestringrequired

The full name of the Agent

EmailAddressstringrequired

The unique email address and the username the agent will use to login

MobileNumberstring

RoleIDstringrequired

The role ID of the user being created, 1 = Agent, 2 = Manager

DepartmentIDinteger[]required

Array of Department ID numbers that the agents will be assigned to

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://agentchat.abcsoftware.dnsalias.com/api/CreateAgent?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22' \
  --header 'Content-Type: application/json' \
  --data '{
    "Name": "Testing",
    "EmailAddress": "test@agentchat.co.za",
    "MobileNumber": "0821231234",
    "RoleID": "2",
    "DepartmentID": [
      "1",
      "2"
    ]
  }'

200

No body

KeepAlive

The API call to keep the session active

get

/KeepAlive

Query parameters

Versionstringrequired

The current version number

Example: {{BUILD_VERSION}}

SessionTokenstringrequired

The session token returned by the AgentLogon call

Example: 3a4783a081028a59e7b35529a3f9ef22

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://agentchat.abcsoftware.dnsalias.com/api/KeepAlive?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22'

200

No body

UpdateAgent

The API call to update an existing Agent’s details

post

/UpdateAgent

Query parameters

Versionstringrequired

The current version number

Example: {{BUILD_VERSION}}

SessionTokenstringrequired

The session token returned by the AgentLogon call

Example: 3a4783a081028a59e7b35529a3f9ef22

Body

AgentIDintegerrequired

The ID number of the Agent to be updated

Namestringrequired

The name of the Agent to be updated

MobileNumberstring

The mobile number of the Agent to be updated

EmailAddressstringrequired

The unique email address, which is also used as the username, of the Agent to be updated

Notificationsstring[]

The array of notifications to enable. (Note the current version only has UnassignedChatsWaiting )

RoleIDintegerrequired

The role ID of the user being updated 1 = Agent, 2 = Manager

StatusIDintegerrequired

The status ID of the Agent being updated 1 = Offline, 2 = Busy, 3 = Onbreak, 4 = Online

DepartmentIDinteger[]

Array of Department ID numbers that the agents will be assigned to

Enabledboolean

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://agentchat.abcsoftware.dnsalias.com/api/UpdateAgent?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22' \
  --header 'Content-Type: application/json' \
  --data '{
    "AgentID": "3",
    "Name": "Jack Rabbit",
    "MobileNumber": "+27800000000",
    "EmailAddress": "jack@abcsoftware.co.za",
    "Notifications": [
      "UnassignedChatsWaiting"
    ],
    "RoleID": "2",
    "StatusID": "4",
    "DepartmentID": [
      "1",
      "4"
    ],
    "Enabled": true
  }'

200

No body

CreateDepartment

The API call to create a new Department

post

/CreateDepartment

Query parameters

Versionstringrequired

The current version number

Example: {{BUILD_VERSION}}

SessionTokenstringrequired

The session token returned by the AgentLogon call

Example: 3a4783a081028a59e7b35529a3f9ef22

Body

Namestringrequired

The name of the department to be created

IncludeInWelcomeMenuboolean

Must the Department Name be included in the welcome menu

NameInMenustring

The name of the Department as it will be included in the welcome menu options

WelcomeReturningstring

Welcome message for returning customers

WelcomeNewstring

Welcome message for new customers (typically includes POPIA information)

MenuIndexinteger · int32

Option number in the welcome menu

Enabledboolean

To Enabled the Department (true/false)

AutoTagIDinteger[]

The list of tag ID numbers that will automatically be tagged to the Department being created

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://agentchat.abcsoftware.dnsalias.com/api/CreateDepartment?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22' \
  --header 'Content-Type: application/json' \
  --data '{
    "Name": "Reception",
    "IncludeInWelcomeMenu": true,
    "NameInMenu": "Reception",
    "WelcomeReturning": "Welcome back #CUSTOMERNAME#. You are number #POSITIONINQUEUE# in the #DEPARTMENTNAME# queue",
    "WelcomeNew": "Welcome to #DEPARTMENTNAME#. You are number #POSITIONINQUEUE# in the queue",
    "MenuIndex": 1,
    "Enabled": true,
    "AutoTagID": [
      "1",
      "2",
      "3"
    ]
  }'

200

No body

UpdateDepartment

The API call to update an existing Department

post

/UpdateDepartment

Query parameters

Versionstringrequired

The current version number

Example: {{BUILD_VERSION}}

SessionTokenstringrequired

The session token returned by the AgentLogon call

Example: 3a4783a081028a59e7b35529a3f9ef22

Body

DepartmentIDintegerrequired

The ID number of the Department to be updated

Namestring

The name of the department to be updated

IncludeInWelcomeMenuboolean

Must the Department Name be included in the welcome menu

NameInMenustring

The name of the Department as it will be included in the welcome menu options

WelcomeReturningstring

Welcome message for returning customers

WelcomeNewstring

Welcome message for new customers (typically includes POPIA information)

MenuIndexinteger · int32

Option number in the welcome menu

Enabledboolean

To Enabled the Department (true/false)

AutoTagIDinteger[]

The list of tag ID numbers that will automatically be tagged to the Department being created

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://agentchat.abcsoftware.dnsalias.com/api/UpdateDepartment?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22' \
  --header 'Content-Type: application/json' \
  --data '{
    "DepartmentID": "8",
    "Name": "New department",
    "IncludeInWelcomeMenu": true,
    "NameInMenu": "New department",
    "WelcomeReturning": "Welcome back #CUSTOMERNAME#. You are number #POSITIONINQUEUE# in the #DEPARTMENTNAME# queue",
    "WelcomeNew": "Welcome to #DEPARTMENTNAME#. You are number #POSITIONINQUEUE# in the queue",
    "MenuIndex": 8,
    "Enabled": true
  }'

200

No body

GetDepartmentList

The API call to return a list of Departments and corresponding setting and message details

get

/GetDepartmentList

Query parameters

Versionstringrequired

The current version number

Example: {{BUILD_VERSION}}

SessionTokenstringrequired

The session token returned by the AgentLogon call

Example: 3a4783a081028a59e7b35529a3f9ef22

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://agentchat.abcsoftware.dnsalias.com/api/GetDepartmentList?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22'

200

No body

UpdateCustomer

The API call to update a Customer’s details

post

/UpdateCustomer

Query parameters

Versionstringrequired

The current version number

Example: {{BUILD_VERSION}}

SessionTokenstringrequired

The session token returned by the AgentLogon call

Example: 3a4783a081028a59e7b35529a3f9ef22

Body

CustomerIDintegerrequired

The ID number of the customer to be updated

FullNamestring

The full name of the customer

EmailAddressstring

The customer’s email address

Commentstring

Text field to allow comments

TagIDinteger[]

The ID of tag assigned to the chat. Note that the chat must be active as the tags are linked to the chat not the customer

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://agentchat.abcsoftware.dnsalias.com/api/UpdateCustomer?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22' \
  --header 'Content-Type: application/json' \
  --data '{
    "CustomerID": "1",
    "FullName": "Joe the Jester",
    "EmailAddress": "Joe@lSoap.com",
    "Comment": "Another Comment",
    "TagID": [
      "1",
      "2"
    ]
  }'

200

No body

FindCustomer

The API call to return the results of a search for a customer

get

/FindCustomer

Query parameters

MobileNumberstringrequired

The mobile number to search for, in international format

Example: 112798647

IncludeChatsbooleanrequired

Flag to include the chats for the mobile number

Example: true

Versionstringrequired

The current version number

Example: {{BUILD_VERSION}}

SessionTokenstringrequired

The session token returned by the AgentLogon call

Example: 3a4783a081028a59e7b35529a3f9ef22

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://agentchat.abcsoftware.dnsalias.com/api/FindCustomer?MobileNumber=112798647&IncludeChats=true&Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22'

200

No body

AddTag

The API call to add a tag to a chat.

NB The CustomerID or ChatID must be specified in the request.

post

/AddTag

Query parameters

Versionstringrequired

The current version number

Example: {{BUILD_VERSION}}

SessionTokenstringrequired

The session token returned by the AgentLogon call

Example: 3a4783a081028a59e7b35529a3f9ef22

Body

ChatIDinteger

The ChatID of the chat the Tag must be assigned to.

TagIDinteger

CustomrIDinteger

The customer ID of the customer that the chat belongs to. The customer must be linked to an active chat

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://agentchat.abcsoftware.dnsalias.com/api/AddTag?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22' \
  --header 'Content-Type: application/json' \
  --data '{
    "ChatID": "407",
    "TagID": "1"
  }'

200

No body

CreateTag

The API call to create a new Tag

post

/CreateTag

Query parameters

Versionstringrequired

The current version number

Example: {{BUILD_VERSION}}

SessionTokenstringrequired

The session token returned by the AgentLogon call

Example: 3a4783a081028a59e7b35529a3f9ef22

Body

TagGroupIDintegerrequired

The ID number of the group to which the tag will be allocated

Namestringrequired

The name of the tag to be created

Enabledbooleanrequired

Flag true to enable and false to disable the ability to create a tag

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://agentchat.abcsoftware.dnsalias.com/api/CreateTag?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22' \
  --header 'Content-Type: application/json' \
  --data '{
    "TagGroupID": "1",
    "Name": "Warranty Enquiries",
    "Enabled": true
  }'

200

No body

RemoveTag

The API call to remove a tag from a chat

post

/RemoveTag

Query parameters

Versionstringrequired

The current version number

Example: {{BUILD_VERSION}}

SessionTokenstringrequired

The session token returned by the AgentLogon call

Example: 3a4783a081028a59e7b35529a3f9ef22

Body

ChatIDintegerrequired

The ID number of the Chat from which the Tag is to be removed

TagIDintegerrequired

The ID number of the Tag to be removed

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://agentchat.abcsoftware.dnsalias.com/api/RemoveTag?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22' \
  --header 'Content-Type: application/json' \
  --data '{
    "ChatID": "407",
    "TagID": "1"
  }'

200

No body

UpdateTag

post

/UpdateTag

Query parameters

Versionstringrequired

The current version number

Example: {{BUILD_VERSION}}

SessionTokenstringrequired

The session token returned by the AgentLogon call

Example: 3a4783a081028a59e7b35529a3f9ef22

Body

TagIDintegerrequired

The ID number of the tag to be updated

Namestring

The name of the tag group to be updated

Enabledboolean

Flag true to enable and false to disable the tag

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://agentchat.abcsoftware.dnsalias.com/api/UpdateTag?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22' \
  --header 'Content-Type: application/json' \
  --data '{
    "TagID": "22",
    "Name": "Updated Name",
    "Enabled": true
  }'

200

No body

DeleteTag

The API call to delete a Tag

delete

/DeleteTag

Query parameters

TagIDintegerrequired

The ID of the tag to be deleted

Example: 2

Versionstringrequired

The current version number

Example: {{BUILD_VERSION}}

SessionTokenstringrequired

The session token returned by the AgentLogon call

Example: 3a4783a081028a59e7b35529a3f9ef22

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://agentchat.abcsoftware.dnsalias.com/api/DeleteTag?TagID=2&Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22'

200

No body

CreateTagGroup

The API call to create a new Group of Tags

post

/CreateTagGroup

Query parameters

Versionstringrequired

The current version number

Example: {{BUILD_VERSION}}

SessionTokenstringrequired

The session token returned by the AgentLogon call

Example: 3a4783a081028a59e7b35529a3f9ef22

Body

Namestringrequired

The name of the Tag Group to be created

Enabledbooleanrequired

Flag true to enable and false to disable the ability to create a Tag Group

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://agentchat.abcsoftware.dnsalias.com/api/CreateTagGroup?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22' \
  --header 'Content-Type: application/json' \
  --data '{
    "Name": "Product Enquiries",
    "Enabled": true
  }'

200

No body

UpdateTagGroup

The API call to update an existing Group of Tags

post

/UpdateTagGroup

Query parameters

Versionstringrequired

The current version number

Example: {{BUILD_VERSION}}

SessionTokenstringrequired

The session token returned by the AgentLogon call

Example: 3a4783a081028a59e7b35529a3f9ef22

Body

TagGroupIDintegerrequired

The ID number of the tag group to be updated

Namestring

The name of the tag group to be updated

Enabledboolean

Flag true to enable and false to disable the TagGroup

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://agentchat.abcsoftware.dnsalias.com/api/UpdateTagGroup?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22' \
  --header 'Content-Type: application/json' \
  --data '{
    "TagGroupID": "5",
    "Name": "Updated Group",
    "Enabled": true
  }'

200

No body

CreateCannedResponse

The API call to create a new Canned Response

post

/CreateCannedResponse

Query parameters

Versionstringrequired

The current version number

Example: {{BUILD_VERSION}}

SessionTokenstringrequired

The session token returned by the AgentLogon call

Example: 3a4783a081028a59e7b35529a3f9ef22

Body

Namestringrequired

The name of the canned response to be created

MessageTextstringrequired

The text of the canned response being created

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://agentchat.abcsoftware.dnsalias.com/api/CreateCannedResponse?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22' \
  --header 'Content-Type: application/json' \
  --data '{
    "Name": "opening hours",
    "MessageText": "We are open from 9am to 5pm, Monday to Friday"
  }'

200

No body

UpdateCannedResponse

The API call to update an existing Canned Response

post

/UpdateCannedResponse

Query parameters

Versionstringrequired

The current version number

Example: {{BUILD_VERSION}}

SessionTokenstringrequired

The session token returned by the AgentLogon call

Example: 3a4783a081028a59e7b35529a3f9ef22

Body

CannedResponseIDintegerrequired

The ID number of the canned Response to be updated

Namestring

The name of the canned Response to be updated

MessageTextstring

The text of the message of the response

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://agentchat.abcsoftware.dnsalias.com/api/UpdateCannedResponse?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22' \
  --header 'Content-Type: application/json' \
  --data '{
    "CannedResponseID": "1",
    "Name": "Test canned response",
    "MessageText": "This is a test response"
  }'

200

No body

DeleteCannedResponse

The API call to delete a Canned Response

delete

/DeleteCannedResponse

Query parameters

CannedResponseIDintegerrequired

The ID of the canned response to be deleted

Example: 2

Versionstringrequired

The current version number

Example: {{BUILD_VERSION}}

SessionTokenstringrequired

The session token returned by the AgentLogon call

Example: 3a4783a081028a59e7b35529a3f9ef22

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://agentchat.abcsoftware.dnsalias.com/api/DeleteCannedResponse?CannedResponseID=2&Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22'

200

No body

UpdateWorkingHours

The API call to update Working Hours

post

/UpdateWorkingHours

Query parameters

Versionstringrequired

The current version number

Example: {{BUILD_VERSION}}

SessionTokenstringrequired

The session token returned by the AgentLogon call

Example: 3a4783a081028a59e7b35529a3f9ef22

Body

Daysobject[]required

Example: {"Day":1,"Enabled":true,"StartTime":"08:00","EndTime":"17:30"}

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://agentchat.abcsoftware.dnsalias.com/api/UpdateWorkingHours?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22' \
  --header 'Content-Type: application/json' \
  --data '{
    "Days": [
      {
        "Day": 1,
        "Enabled": true,
        "StartTime": "08:00",
        "EndTime": "17:30"
      },
      {
        "Day": 2,
        "Enabled": true,
        "StartTime": "08:00",
        "EndTime": "17:30"
      },
      {
        "Day": 3,
        "Enabled": true,
        "StartTime": "08:00",
        "EndTime": "17:30"
      },
      {
        "Day": 4,
        "Enabled": true,
        "StartTime": "08:00",
        "EndTime": "17:30"
      },
      {
        "Day": 5,
        "Enabled": true,
        "StartTime": "08:00",
        "EndTime": "17:30"
      },
      {
        "Day": 6,
        "Enabled": false,
        "StartTime": "00:00",
        "EndTime": "00:00"
      },
      {
        "Day": 7,
        "Enabled": false,
        "StartTime": "00:00",
        "EndTime": "00:00"
      }
    ]
  }'

200

No body

CreateReportSchedule

The API call to create a new schedule of Reports

post

/CreateReportSchedule

Query parameters

Versionstringrequired

The current version number

Example: {{BUILD_VERSION}}

SessionTokenstringrequired

The session token returned by the AgentLogon call

Example: 3a4783a081028a59e7b35529a3f9ef22

Body

RecipientIDintegerrequired

The ID number of the recipient to receive the report

ReportIDintegerrequired

The ID number of the report the recipient will receive

Formatstringrequired

The format of the file containing the report the recipient will receive

Groupingstring[]required

The time over which the reports will be sent

Deliverystringrequired

The method of delivery of the report

ScheduledDayinteger[]required

The day or days of the week the reports will be sent to the recipients. Monday is 1, Tuesday 2, etc

ScheduledTimestringrequired

The time of the day each report will be sent on SheduledDay. Format: HH:MM

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://agentchat.abcsoftware.dnsalias.com/api/CreateReportSchedule?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22' \
  --header 'Content-Type: application/json' \
  --data '{
    "RecipientID": "1",
    "ReportID": "1",
    "Format": "CSV",
    "Grouping": [
      "WEEK",
      "MONTH"
    ],
    "Delivery": "EMAIL",
    "ScheduledDay": [
      "1",
      "2",
      "3",
      "4",
      "5"
    ],
    "ScheduledTime": "16:30"
  }'

200

No body

LiveMetrics

The API call to return the values of the Live Metrics of the Dashboard

get

/LiveMetrics

Query parameters

Versionstringrequired

The current version number

Example: {{BUILD_VERSION}}

SessionTokenstringrequired

The session token returned by the AgentLogon call

Example: 3a4783a081028a59e7b35529a3f9ef22

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://agentchat.abcsoftware.dnsalias.com/api/LiveMetrics?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22'

200

No body

GetReports

The API call to return details for all available reports

get

/GetReports

Query parameters

Versionstringrequired

The current version number

Example: {{BUILD_VERSION}}

SessionTokenstringrequired

The session token returned by the AgentLogon call

Example: 3a4783a081028a59e7b35529a3f9ef22

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://agentchat.abcsoftware.dnsalias.com/api/GetReports?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22'

200

No body

DataInsight

The API call to return the reporting data shown on the dashboard

get

/DataInsight

Query parameters

Periodstring · enumrequired

The period the report data must be grouped by

Example: week

Options: week, month, quarter, year, all

Versionstringrequired

The current version number

Example: {{BUILD_VERSION}}

SessionTokenstringrequired

The session token returned by the AgentLogon call

Example: 3a4783a081028a59e7b35529a3f9ef22

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://agentchat.abcsoftware.dnsalias.com/api/DataInsight?Period=week&Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22'

200

No body

DeleteReportSchedule

The API call to delete a Scheduled report

delete

/DeleteReportSchedule

Query parameters

ScheduleIDintegerrequired

The ID of the schedule to be deleted

Example: 2

Versionstringrequired

The current version number

Example: {{BUILD_VERSION}}

SessionTokenstringrequired

The session token returned by the AgentLogon call

Example: 3a4783a081028a59e7b35529a3f9ef22

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://agentchat.abcsoftware.dnsalias.com/api/DeleteReportSchedule?ScheduleID=2&Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22'

200

No body

CreateRecipient

The API call to create a new Recipient of emailed reports

post

/CreateRecipient

Query parameters

Versionstringrequired

The current version number

Example: {{BUILD_VERSION}}

SessionTokenstringrequired

The session token returned by the AgentLogon call

Example: 3a4783a081028a59e7b35529a3f9ef22

Body

FullNamestringrequired

The full name (first name and surname) of the recipient

EmailAddressstringrequired

The email address of the recipient to which data, report or other information will be sent

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://agentchat.abcsoftware.dnsalias.com/api/CreateRecipient?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22' \
  --header 'Content-Type: application/json' \
  --data '{
    "FullName": "Zakes Mthini",
    "EmailAddress": "zakes@agentchat.co.za"
  }'

200

No body

GetRecipients

The API call to return recipient details and corresponding report and schedule sending details

get

/GetRecipients

Query parameters

Versionstringrequired

The current version number

Example: {{BUILD_VERSION}}

SessionTokenstringrequired

The session token returned by the AgentLogon call

Example: 3a4783a081028a59e7b35529a3f9ef22

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://agentchat.abcsoftware.dnsalias.com/api/GetRecipients?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22'

200

No body

DeleteRecipient

The API call to delete a Recipient of an email report(s)

delete

/DeleteRecipient

Query parameters

RecipientIDintegerrequired

The ID of the recipient to be deleted

Example: 2

Versionstringrequired

The current version number

Example: {{BUILD_VERSION}}

SessionTokenstringrequired

The session token returned by the AgentLogon call

Example: 3a4783a081028a59e7b35529a3f9ef22

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://agentchat.abcsoftware.dnsalias.com/api/DeleteRecipient?RecipientID=2&Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22'

200

No body

UpdateSettings

The API call to update the company’s Agent Chat setting

post

/UpdateSettings

Query parameters

Versionstringrequired

The current version number

Example: {{BUILD_VERSION}}

SessionTokenstringrequired

The session token returned by the AgentLogon call

Example: 3a4783a081028a59e7b35529a3f9ef22

Body

all of

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://agentchat.abcsoftware.dnsalias.com/api/UpdateSettings?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22' \
  --header 'Content-Type: application/json' \
  --data '{
    "Settings": [
      {
        "CompanyName": "Channel"
      }
    ]
  }'

200

No body

GetSettings

The API call to return the company’s Agent Chat settings and messages

get

/GetSettings

Query parameters

Versionstringrequired

The current version number

Example: {{BUILD_VERSION}}

SessionTokenstringrequired

The session token returned by the AgentLogon call

Example: 3a4783a081028a59e7b35529a3f9ef22

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://agentchat.abcsoftware.dnsalias.com/api/GetSettings?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22'

200

No body

Authentication

Chats

Agent/User

Department

Customer/Client

Tags

Tag Groups

Canned Response

Working Hours

Reports

Recipients

Settings

Authentication

Chats

Agent/User

Department

Customer/Client

Tags

Tag Groups

Canned Response

Working Hours

Reports

Recipients

Settings

AgentLogon

SetPassword

RequestPasswordReset

AgentLogoff

SendMessage

AddComment

TransferChat

ReAssignChat

GrabChat

GetChatList

ExportChat

CloseChat

AssignChat

CreateAgent

KeepAlive

UpdateAgent

CreateDepartment

UpdateDepartment

GetDepartmentList

UpdateCustomer

FindCustomer

AddTag

CreateTag

RemoveTag

UpdateTag

DeleteTag

CreateTagGroup

UpdateTagGroup

CreateCannedResponse

UpdateCannedResponse

DeleteCannedResponse

UpdateWorkingHours

Show child attributes

CreateReportSchedule

LiveMetrics

GetReports

DataInsight

DeleteReportSchedule

CreateRecipient

GetRecipients

DeleteRecipient

UpdateSettings

Show UpdateSettingsRequest

Show child attributes

GetSettings