HomeSign InSign Up

AgentChat API

This document describes how you can use the ChannelMobile AgentChat API

All endpoints are available below, containing information necessary to run each.

Here is a link to our SwaggerHub documentation, you can use our testing credentials to make API calls and try everything out for yourself right now.

EmailAddress: [email protected]

Password: Something23!

LogoBuild, Collaborate & Integrate APIs | SwaggerHub
SwaggerHub Documentation Link

Authentication

AgentLogon

post

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

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
200Success
post
POST /api/AgentLogon HTTP/1.1
Host: agentchat.abcsoftware.dnsalias.com
Content-Type: application/json
Accept: */*
Content-Length: 62

{
  "EmailAddress": "[email protected]",
  "Password": "123smith$$"
}
200Success
No content

SetPassword

post

The API call to update the password for an agent

Query parameters
VersionstringRequired

The current version number

Example: {{BUILD_VERSION}}
Body
ResetCodestringRequired

The ResetCode in the reset password request URL

Responses
200Success
post
POST /api/SetPassword HTTP/1.1
Host: agentchat.abcsoftware.dnsalias.com
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "ResetCode": "76897132458762458761243"
}
200Success
No content

RequestPasswordReset

get

The API call to initiate a password change for an agent

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
200Success
get
GET /api/RequestPasswordReset HTTP/1.1
Host: agentchat.abcsoftware.dnsalias.com
Accept: */*
200Success
No content

AgentLogoff

get

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

Query parameters
VersionstringRequired

The current version number

Example: {{BUILD_VERSION}}
SessionTokenstringRequired

The session token returned by the AgentLogon call

Example: 3a4783a081028a59e7b35529a3f9ef22
Responses
200Success
get
GET /api/AgentLogoff HTTP/1.1
Host: agentchat.abcsoftware.dnsalias.com
Accept: */*
200Success
No content

Chats

SendMessage

post

The API call to send a message to a chat

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

AttachmentTypestringOptional

Type of file being attached to the message

AttachmentNamestringOptional

The name of the file to be attached to the message

AttachmentDatastringOptional

The base 64 encoded file content

Responses
200Success
post
POST /api/SendMessage HTTP/1.1
Host: agentchat.abcsoftware.dnsalias.com
apikey: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 199

{
  "ChatID": "408",
  "MessageText": "Hallo there",
  "AttachmentType": "image/jpeg",
  "AttachmentName": "image.jpg",
  "AttachmentData": "/9j/4AAQSkZJRgABAQEBLAEsAAD//gATQ3JlYXRlZCB3...............M0xIZA4JnL+v/2Q=="
}
200Success
No content

AddComment

post

The API call to add a comment to a customer

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
200Success
post
POST /api/AddComment HTTP/1.1
Host: agentchat.abcsoftware.dnsalias.com
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "CustomerID": "1",
  "Comment": "This is a new comment"
}
200Success
No content

TransferChat

get

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

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
200Success
get
GET /api/TransferChat HTTP/1.1
Host: agentchat.abcsoftware.dnsalias.com
Accept: */*
200Success
No content

ReAssignChat

get

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

Query parameters
VersionstringRequired

The current version number

Example: {{BUILD_VERSION}}
SessionTokenstringRequired

The session token returned by the AgentLogon call

Example: 3a4783a081028a59e7b35529a3f9ef22
AgentIDintegerRequired
ChatIDintegerOptional
Responses
200Success
get
GET /api/ReAssignChat HTTP/1.1
Host: agentchat.abcsoftware.dnsalias.com
Accept: */*
200Success
No content

GrabChat

get

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

Query parameters
VersionstringRequired

The current version number

Example: {{BUILD_VERSION}}
SessionTokenstringRequired

The session token returned by the AgentLogon call

Example: 3a4783a081028a59e7b35529a3f9ef22
Responses
200Success
get
GET /api/GrabChat HTTP/1.1
Host: agentchat.abcsoftware.dnsalias.com
Accept: */*
200Success
No content

GetChatList

get

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

Query parameters
ChatTypestringOptional

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
200Success
get
GET /api/GetChatList HTTP/1.1
Host: agentchat.abcsoftware.dnsalias.com
Accept: */*
200Success
No content

ExportChat

get

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

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
200Success
get
GET /api/ExportChat HTTP/1.1
Host: agentchat.abcsoftware.dnsalias.com
Accept: */*
200Success
No content

CloseChat

get

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

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
200Success
get
GET /api/CloseChat HTTP/1.1
Host: agentchat.abcsoftware.dnsalias.com
Accept: */*
200Success
No content

AssignChat

get

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

Query parameters
ChatIDinteger · int32Required

The ID of the chat to be assigned

Example: 406
AgentIDinteger · int32Optional

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
200Success
get
GET /api/AssignChat HTTP/1.1
Host: agentchat.abcsoftware.dnsalias.com
Accept: */*
200Success
No content

Agent/User

CreateAgent

post

The API call to create a new Agent

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

MobileNumberstringOptional
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
200Success
post
POST /api/CreateAgent HTTP/1.1
Host: agentchat.abcsoftware.dnsalias.com
Content-Type: application/json
Accept: */*
Content-Length: 122

{
  "Name": "Testing",
  "EmailAddress": "[email protected]",
  "MobileNumber": "0821231234",
  "RoleID": "2",
  "DepartmentID": [
    "1",
    "2"
  ]
}
200Success
No content

KeepAlive

get

The API call to keep the session active

Query parameters
VersionstringRequired

The current version number

Example: {{BUILD_VERSION}}
SessionTokenstringRequired

The session token returned by the AgentLogon call

Example: 3a4783a081028a59e7b35529a3f9ef22
Responses
200Success
get
GET /api/KeepAlive HTTP/1.1
Host: agentchat.abcsoftware.dnsalias.com
Accept: */*
200Success
No content

UpdateAgent

post

The API call to update an existing Agent’s details

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

MobileNumberstringOptional

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[]Optional

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[]Optional

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

EnabledbooleanOptional
Responses
200Success
post
POST /api/UpdateAgent HTTP/1.1
Host: agentchat.abcsoftware.dnsalias.com
Content-Type: application/json
Accept: */*
Content-Length: 217

{
  "AgentID": "3",
  "Name": "Jack Rabbit",
  "MobileNumber": "+27800000000",
  "EmailAddress": "[email protected]",
  "Notifications": [
    "UnassignedChatsWaiting"
  ],
  "RoleID": "2",
  "StatusID": "4",
  "DepartmentID": [
    "1",
    "4"
  ],
  "Enabled": true
}
200Success
No content

Department

CreateDepartment

post

The API call to create a new Department

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

IncludeInWelcomeMenubooleanOptional

Must the Department Name be included in the welcome menu

NameInMenustringOptional

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

WelcomeReturningstringOptional

Welcome message for returning customers

WelcomeNewstringOptional

Welcome message for new customers (typically includes POPIA information)

MenuIndexinteger · int32Optional

Option number in the welcome menu

EnabledbooleanOptional

To Enabled the Department (true/false)

AutoTagIDinteger[]Optional

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

Responses
200Success
post
POST /api/CreateDepartment HTTP/1.1
Host: agentchat.abcsoftware.dnsalias.com
Content-Type: application/json
Accept: */*
Content-Length: 331

{
  "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"
  ]
}
200Success
No content

UpdateDepartment

post

The API call to update an existing Department

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

NamestringOptional

The name of the department to be updated

IncludeInWelcomeMenubooleanOptional

Must the Department Name be included in the welcome menu

NameInMenustringOptional

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

WelcomeReturningstringOptional

Welcome message for returning customers

WelcomeNewstringOptional

Welcome message for new customers (typically includes POPIA information)

MenuIndexinteger · int32Optional

Option number in the welcome menu

EnabledbooleanOptional

To Enabled the Department (true/false)

AutoTagIDinteger[]Optional

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

Responses
200Success
post
POST /api/UpdateDepartment HTTP/1.1
Host: agentchat.abcsoftware.dnsalias.com
Content-Type: application/json
Accept: */*
Content-Length: 334

{
  "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
}
200Success
No content

GetDepartmentList

get

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

Query parameters
VersionstringRequired

The current version number

Example: {{BUILD_VERSION}}
SessionTokenstringRequired

The session token returned by the AgentLogon call

Example: 3a4783a081028a59e7b35529a3f9ef22
Responses
200Success
get
GET /api/GetDepartmentList HTTP/1.1
Host: agentchat.abcsoftware.dnsalias.com
Accept: */*
200Success
No content

Customer/Client

UpdateCustomer

post

The API call to update a Customer’s details

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

FullNamestringOptional

The full name of the customer

EmailAddressstringOptional

The customer’s email address

CommentstringOptional

Text field to allow comments

TagIDinteger[]Optional

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
200Success
post
POST /api/UpdateCustomer HTTP/1.1
Host: agentchat.abcsoftware.dnsalias.com
Content-Type: application/json
Accept: */*
Content-Length: 123

{
  "CustomerID": "1",
  "FullName": "Joe the Jester",
  "EmailAddress": "[email protected]",
  "Comment": "Another Comment",
  "TagID": [
    "1",
    "2"
  ]
}
200Success
No content

FindCustomer

get

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

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
200Success
get
GET /api/FindCustomer HTTP/1.1
Host: agentchat.abcsoftware.dnsalias.com
Accept: */*
200Success
No content

Tags

AddTag

post

The API call to add a tag to a chat.

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

Query parameters
VersionstringRequired

The current version number

Example: {{BUILD_VERSION}}
SessionTokenstringRequired

The session token returned by the AgentLogon call

Example: 3a4783a081028a59e7b35529a3f9ef22
Body
ChatIDintegerOptional

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

TagIDintegerOptional
CustomrIDintegerOptional

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

Responses
200Success
post
POST /api/AddTag HTTP/1.1
Host: agentchat.abcsoftware.dnsalias.com
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "ChatID": "407",
  "TagID": "1"
}
200Success
No content

CreateTag

post

The API call to create a new Tag

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
200Success
post
POST /api/CreateTag HTTP/1.1
Host: agentchat.abcsoftware.dnsalias.com
Content-Type: application/json
Accept: */*
Content-Length: 61

{
  "TagGroupID": "1",
  "Name": "Warranty Enquiries",
  "Enabled": true
}
200Success
No content

RemoveTag

post

The API call to remove a tag from a chat

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
200Success
post
POST /api/RemoveTag HTTP/1.1
Host: agentchat.abcsoftware.dnsalias.com
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "ChatID": "407",
  "TagID": "1"
}
200Success
No content

UpdateTag

post
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

NamestringOptional

The name of the tag group to be updated

EnabledbooleanOptional

Flag true to enable and false to disable the tag

Responses
200Success
post
POST /api/UpdateTag HTTP/1.1
Host: agentchat.abcsoftware.dnsalias.com
Content-Type: application/json
Accept: */*
Content-Length: 51

{
  "TagID": "22",
  "Name": "Updated Name",
  "Enabled": true
}
200Success
No content

DeleteTag

delete

The API call to delete a Tag

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
200Success
delete
DELETE /api/DeleteTag HTTP/1.1
Host: agentchat.abcsoftware.dnsalias.com
Accept: */*
200Success
No content

Tag Groups

CreateTagGroup

post

The API call to create a new Group of Tags

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
200Success
post
POST /api/CreateTagGroup HTTP/1.1
Host: agentchat.abcsoftware.dnsalias.com
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "Name": "Product Enquiries",
  "Enabled": true
}
200Success
No content

UpdateTagGroup

post

The API call to update an existing Group of Tags

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

NamestringOptional

The name of the tag group to be updated

EnabledbooleanOptional

Flag true to enable and false to disable the TagGroup

Responses
200Success
post
POST /api/UpdateTagGroup HTTP/1.1
Host: agentchat.abcsoftware.dnsalias.com
Content-Type: application/json
Accept: */*
Content-Length: 56

{
  "TagGroupID": "5",
  "Name": "Updated Group",
  "Enabled": true
}
200Success
No content

Canned Response

CreateCannedResponse

post

The API call to create a new Canned Response

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
200Success
post
POST /api/CreateCannedResponse HTTP/1.1
Host: agentchat.abcsoftware.dnsalias.com
Content-Type: application/json
Accept: */*
Content-Length: 86

{
  "Name": "opening hours",
  "MessageText": "We are open from 9am to 5pm, Monday to Friday"
}
200Success
No content

UpdateCannedResponse

post

The API call to update an existing Canned Response

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

NamestringOptional

The name of the canned Response to be updated

MessageTextstringOptional

The text of the message of the response

Responses
200Success
post
POST /api/UpdateCannedResponse HTTP/1.1
Host: agentchat.abcsoftware.dnsalias.com
Content-Type: application/json
Accept: */*
Content-Length: 94

{
  "CannedResponseID": "1",
  "Name": "Test canned response",
  "MessageText": "This is a test response"
}
200Success
No content

DeleteCannedResponse

delete

The API call to delete a Canned Response

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
200Success
delete
DELETE /api/DeleteCannedResponse HTTP/1.1
Host: agentchat.abcsoftware.dnsalias.com
Accept: */*
200Success
No content

Working Hours

UpdateWorkingHours

post

The API call to update Working Hours

Query parameters
VersionstringRequired

The current version number

Example: {{BUILD_VERSION}}
SessionTokenstringRequired

The session token returned by the AgentLogon call

Example: 3a4783a081028a59e7b35529a3f9ef22
Body
Responses
200Success
post
POST /api/UpdateWorkingHours HTTP/1.1
Host: agentchat.abcsoftware.dnsalias.com
Content-Type: application/json
Accept: */*
Content-Length: 453

{
  "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"
    }
  ]
}
200Success
No content

Reports

CreateReportSchedule

post

The API call to create a new schedule of Reports

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
200Success
post
POST /api/CreateReportSchedule HTTP/1.1
Host: agentchat.abcsoftware.dnsalias.com
Content-Type: application/json
Accept: */*
Content-Length: 157

{
  "RecipientID": "1",
  "ReportID": "1",
  "Format": "CSV",
  "Grouping": [
    "WEEK",
    "MONTH"
  ],
  "Delivery": "EMAIL",
  "ScheduledDay": [
    "1",
    "2",
    "3",
    "4",
    "5"
  ],
  "ScheduledTime": "16:30"
}
200Success
No content

LiveMetrics

get

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

Query parameters
VersionstringRequired

The current version number

Example: {{BUILD_VERSION}}
SessionTokenstringRequired

The session token returned by the AgentLogon call

Example: 3a4783a081028a59e7b35529a3f9ef22
Responses
200Success
get
GET /api/LiveMetrics HTTP/1.1
Host: agentchat.abcsoftware.dnsalias.com
Accept: */*
200Success
No content

GetReports

get

The API call to return details for all available reports

Query parameters
VersionstringRequired

The current version number

Example: {{BUILD_VERSION}}
SessionTokenstringRequired

The session token returned by the AgentLogon call

Example: 3a4783a081028a59e7b35529a3f9ef22
Responses
200Success
get
GET /api/GetReports HTTP/1.1
Host: agentchat.abcsoftware.dnsalias.com
Accept: */*
200Success
No content

DataInsight

get

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

Query parameters
Periodstring · enumRequired

The period the report data must be grouped by

Example: weekPossible values:
VersionstringRequired

The current version number

Example: {{BUILD_VERSION}}
SessionTokenstringRequired

The session token returned by the AgentLogon call

Example: 3a4783a081028a59e7b35529a3f9ef22
Responses
200Success
get
GET /api/DataInsight HTTP/1.1
Host: agentchat.abcsoftware.dnsalias.com
Accept: */*
200Success
No content

DeleteReportSchedule

delete

The API call to delete a Scheduled report

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
200Success
delete
DELETE /api/DeleteReportSchedule HTTP/1.1
Host: agentchat.abcsoftware.dnsalias.com
Accept: */*
200Success
No content

Recipients

CreateRecipient

post

The API call to create a new Recipient of emailed reports

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
200Success
post
POST /api/CreateRecipient HTTP/1.1
Host: agentchat.abcsoftware.dnsalias.com
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "FullName": "Zakes Mthini",
  "EmailAddress": "[email protected]"
}
200Success
No content

GetRecipients

get

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

Query parameters
VersionstringRequired

The current version number

Example: {{BUILD_VERSION}}
SessionTokenstringRequired

The session token returned by the AgentLogon call

Example: 3a4783a081028a59e7b35529a3f9ef22
Responses
200Success
get
GET /api/GetRecipients HTTP/1.1
Host: agentchat.abcsoftware.dnsalias.com
Accept: */*
200Success
No content

DeleteRecipient

delete

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

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
200Success
delete
DELETE /api/DeleteRecipient HTTP/1.1
Host: agentchat.abcsoftware.dnsalias.com
Accept: */*
200Success
No content

Settings

UpdateSettings

post

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

Query parameters
VersionstringRequired

The current version number

Example: {{BUILD_VERSION}}
SessionTokenstringRequired

The session token returned by the AgentLogon call

Example: 3a4783a081028a59e7b35529a3f9ef22
Body
all ofOptional
and
anyOptionalExample: {"Settings":[{"CompanyName":"Channel"}]}
Responses
200Success
post
POST /api/UpdateSettings HTTP/1.1
Host: agentchat.abcsoftware.dnsalias.com
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "Settings": [
    {
      "CompanyName": "Channel"
    }
  ]
}
200Success
No content

GetSettings

get

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

Query parameters
VersionstringRequired

The current version number

Example: {{BUILD_VERSION}}
SessionTokenstringRequired

The session token returned by the AgentLogon call

Example: 3a4783a081028a59e7b35529a3f9ef22
Responses
200Success
get
GET /api/GetSettings HTTP/1.1
Host: agentchat.abcsoftware.dnsalias.com
Accept: */*
200Success
No content
PreviousAPI ReferenceNextChannel360 V1.1 API

Last updated

Was this helpful?