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: [e-mail]

Password: Something23!

Build, Collaborate & Integrate APIs | SwaggerHub

SwaggerHub Documentation Link

Authentication

AgentLogon

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

POSThttps://agentchat.abcsoftware.dnsalias.com/api/AgentLogon

Query parameters

Body

application/json

EmailAddress*string

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

Password*string

The password corresponding to the unique email address

Response

200

Request

JavaScriptCurlPython

const response = await fetch('https://agentchat.abcsoftware.dnsalias.com/api/AgentLogon?Version=%7B%7BBUILD_VERSION%7D%7D', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "EmailAddress": "[e-mail]",
      "Password": "123smith$$"
    }),
});
const data = await response.json();

SetPassword

The API call to update the password for an agent

POSThttps://agentchat.abcsoftware.dnsalias.com/api/SetPassword

Query parameters

Body

application/json

ResetCode*string

The ResetCode in the reset password request URL

Response

200

Request

JavaScriptCurlPython

const response = await fetch('https://agentchat.abcsoftware.dnsalias.com/api/SetPassword?Version=%7B%7BBUILD_VERSION%7D%7D', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "ResetCode": "76897132458762458761243"
    }),
});
const data = await response.json();

RequestPasswordReset

The API call to initiate a password change for an agent

GEThttps://agentchat.abcsoftware.dnsalias.com/api/RequestPasswordReset

Query parameters

Response

200

Request

JavaScriptCurlPython

const response = await fetch('https://agentchat.abcsoftware.dnsalias.com/api/RequestPasswordReset?EmailAddress=%7B%7BEmailAddress%7D%7D&Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

AgentLogoff

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

GEThttps://agentchat.abcsoftware.dnsalias.com/api/AgentLogoff

Query parameters

Response

200

Request

JavaScriptCurlPython

const response = await fetch('https://agentchat.abcsoftware.dnsalias.com/api/AgentLogoff?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Chats

SendMessage

The API call to send a message to a chat

POSThttps://agentchat.abcsoftware.dnsalias.com/api/SendMessage

Authorization

apiKey

Query parameters

Body

application/json

ChatID*string

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

MessageText*string

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

Response

200

Request

JavaScriptCurlPython

const response = await fetch('https://agentchat.abcsoftware.dnsalias.com/api/SendMessage?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "ChatID": "408",
      "MessageText": "Hallo there",
      "AttachmentType": "image/jpeg",
      "AttachmentName": "image.jpg",
      "AttachmentData": "/9j/4AAQSkZJRgABAQEBLAEsAAD//gATQ3JlYXRlZCB3...............M0xIZA4JnL+v/2Q=="
    }),
});
const data = await response.json();

AddComment

The API call to add a comment to a customer

POSThttps://agentchat.abcsoftware.dnsalias.com/api/AddComment

Query parameters

Body

application/json

CustomerID*integer

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

Comment*string

The Comment being added.

Response

200

Request

JavaScriptCurlPython

const response = await fetch('https://agentchat.abcsoftware.dnsalias.com/api/AddComment?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "CustomerID": "1",
      "Comment": "This is a new comment"
    }),
});
const data = await response.json();

TransferChat

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

GEThttps://agentchat.abcsoftware.dnsalias.com/api/TransferChat

Query parameters

Response

200

Request

JavaScriptCurlPython

const response = await fetch('https://agentchat.abcsoftware.dnsalias.com/api/TransferChat?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

ReAssignChat

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

GEThttps://agentchat.abcsoftware.dnsalias.com/api/ReAssignChat

Query parameters

Response

200

Request

JavaScriptCurlPython

const response = await fetch('https://agentchat.abcsoftware.dnsalias.com/api/ReAssignChat?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

GrabChat

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

GEThttps://agentchat.abcsoftware.dnsalias.com/api/GrabChat

Query parameters

Response

200

Request

JavaScriptCurlPython

const response = await fetch('https://agentchat.abcsoftware.dnsalias.com/api/GrabChat?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

GetChatList

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

GEThttps://agentchat.abcsoftware.dnsalias.com/api/GetChatList

Query parameters

Response

200

Request

JavaScriptCurlPython

const response = await fetch('https://agentchat.abcsoftware.dnsalias.com/api/GetChatList?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

ExportChat

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

GEThttps://agentchat.abcsoftware.dnsalias.com/api/ExportChat

Query parameters

Response

200

Request

JavaScriptCurlPython

const response = await fetch('https://agentchat.abcsoftware.dnsalias.com/api/ExportChat?ChatID=406&Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

CloseChat

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

GEThttps://agentchat.abcsoftware.dnsalias.com/api/CloseChat

Query parameters

Response

200

Request

JavaScriptCurlPython

const response = await fetch('https://agentchat.abcsoftware.dnsalias.com/api/CloseChat?ChatID=406&Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

AssignChat

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

GEThttps://agentchat.abcsoftware.dnsalias.com/api/AssignChat

Query parameters

Response

200

Request

JavaScriptCurlPython

const response = await fetch('https://agentchat.abcsoftware.dnsalias.com/api/AssignChat?ChatID=406&Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Agent/User

CreateAgent

The API call to create a new Agent

POSThttps://agentchat.abcsoftware.dnsalias.com/api/CreateAgent

Query parameters

Body

application/json

Name*string

The full name of the Agent

EmailAddress*string

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

MobileNumberstring

RoleID*string

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

DepartmentID*array of integer

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

Response

200

Request

JavaScriptCurlPython

const response = await fetch('https://agentchat.abcsoftware.dnsalias.com/api/CreateAgent?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "Name": "Testing",
      "EmailAddress": "[e-mail]",
      "MobileNumber": "0821231234",
      "RoleID": "2",
      "DepartmentID": [
        "1",
        "2"
      ]
    }),
});
const data = await response.json();

KeepAlive

The API call to keep the session active

GEThttps://agentchat.abcsoftware.dnsalias.com/api/KeepAlive

Query parameters

Response

200

Request

JavaScriptCurlPython

const response = await fetch('https://agentchat.abcsoftware.dnsalias.com/api/KeepAlive?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

UpdateAgent

The API call to update an existing Agent’s details

POSThttps://agentchat.abcsoftware.dnsalias.com/api/UpdateAgent

Query parameters

Body

application/json

AgentID*integer

The ID number of the Agent to be updated

Name*string

The name of the Agent to be updated

MobileNumberstring

The mobile number of the Agent to be updated

EmailAddress*string

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

Notificationsarray of string

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

RoleID*integer

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

StatusID*integer

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

DepartmentIDarray of integer

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

Enabledboolean

Response

200

Request

JavaScriptCurlPython

const response = await fetch('https://agentchat.abcsoftware.dnsalias.com/api/UpdateAgent?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "AgentID": "3",
      "Name": "Jack Rabbit",
      "MobileNumber": "[phone]",
      "EmailAddress": "[e-mail]",
      "Notifications": [
        "UnassignedChatsWaiting"
      ],
      "RoleID": "2",
      "StatusID": "4",
      "DepartmentID": [
        "1",
        "4"
      ],
      "Enabled": true
    }),
});
const data = await response.json();

Department

CreateDepartment

The API call to create a new Department

POSThttps://agentchat.abcsoftware.dnsalias.com/api/CreateDepartment

Query parameters

Body

application/json

Name*string

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)

AutoTagIDarray of integer

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

Response

200

Request

JavaScriptCurlPython

const response = await fetch('https://agentchat.abcsoftware.dnsalias.com/api/CreateDepartment?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "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"
      ]
    }),
});
const data = await response.json();

UpdateDepartment

The API call to update an existing Department

POSThttps://agentchat.abcsoftware.dnsalias.com/api/UpdateDepartment

Query parameters

Body

application/json

DepartmentID*integer

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)

AutoTagIDarray of integer

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

Response

200

Request

JavaScriptCurlPython

const response = await fetch('https://agentchat.abcsoftware.dnsalias.com/api/UpdateDepartment?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "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
    }),
});
const data = await response.json();

GetDepartmentList

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

GEThttps://agentchat.abcsoftware.dnsalias.com/api/GetDepartmentList

Query parameters

Response

200

Request

JavaScriptCurlPython

const response = await fetch('https://agentchat.abcsoftware.dnsalias.com/api/GetDepartmentList?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Customer/Client

UpdateCustomer

The API call to update a Customer’s details

POSThttps://agentchat.abcsoftware.dnsalias.com/api/UpdateCustomer

Query parameters

Body

application/json

CustomerID*integer

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

TagIDarray of integer

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

Response

200

Request

JavaScriptCurlPython

const response = await fetch('https://agentchat.abcsoftware.dnsalias.com/api/UpdateCustomer?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "CustomerID": "1",
      "FullName": "Joe the Jester",
      "EmailAddress": "[e-mail]",
      "Comment": "Another Comment",
      "TagID": [
        "1",
        "2"
      ]
    }),
});
const data = await response.json();

FindCustomer

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

GEThttps://agentchat.abcsoftware.dnsalias.com/api/FindCustomer

Query parameters

Response

200

Request

JavaScriptCurlPython

const response = await fetch('https://agentchat.abcsoftware.dnsalias.com/api/FindCustomer?MobileNumber=112798647&IncludeChats=true&Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Tags

AddTag

The API call to add a tag to a chat.

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

POSThttps://agentchat.abcsoftware.dnsalias.com/api/AddTag

Query parameters

Body

application/json

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

Response

200

Request

JavaScriptCurlPython

const response = await fetch('https://agentchat.abcsoftware.dnsalias.com/api/AddTag?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "ChatID": "407",
      "TagID": "1"
    }),
});
const data = await response.json();

CreateTag

The API call to create a new Tag

POSThttps://agentchat.abcsoftware.dnsalias.com/api/CreateTag

Query parameters

Body

application/json

TagGroupID*integer

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

Name*string

The name of the tag to be created

Enabled*boolean

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

Response

200

Request

JavaScriptCurlPython

const response = await fetch('https://agentchat.abcsoftware.dnsalias.com/api/CreateTag?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "TagGroupID": "1",
      "Name": "Warranty Enquiries",
      "Enabled": true
    }),
});
const data = await response.json();

RemoveTag

The API call to remove a tag from a chat

POSThttps://agentchat.abcsoftware.dnsalias.com/api/RemoveTag

Query parameters

Body

application/json

ChatID*integer

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

TagID*integer

The ID number of the Tag to be removed

Response

200

Request

JavaScriptCurlPython

const response = await fetch('https://agentchat.abcsoftware.dnsalias.com/api/RemoveTag?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "ChatID": "407",
      "TagID": "1"
    }),
});
const data = await response.json();

UpdateTag

POSThttps://agentchat.abcsoftware.dnsalias.com/api/UpdateTag

Query parameters

Body

application/json

TagID*integer

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

Response

200

Request

JavaScriptCurlPython

const response = await fetch('https://agentchat.abcsoftware.dnsalias.com/api/UpdateTag?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "TagID": "22",
      "Name": "Updated Name",
      "Enabled": true
    }),
});
const data = await response.json();

DeleteTag

The API call to delete a Tag

DELETEhttps://agentchat.abcsoftware.dnsalias.com/api/DeleteTag

Query parameters

Response

200

Request

JavaScriptCurlPython

const response = await fetch('https://agentchat.abcsoftware.dnsalias.com/api/DeleteTag?TagID=2&Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Tag Groups

CreateTagGroup

The API call to create a new Group of Tags

POSThttps://agentchat.abcsoftware.dnsalias.com/api/CreateTagGroup

Query parameters

Body

application/json

Name*string

The name of the Tag Group to be created

Enabled*boolean

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

Response

200

Request

JavaScriptCurlPython

const response = await fetch('https://agentchat.abcsoftware.dnsalias.com/api/CreateTagGroup?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "Name": "Product Enquiries",
      "Enabled": true
    }),
});
const data = await response.json();

UpdateTagGroup

The API call to update an existing Group of Tags

POSThttps://agentchat.abcsoftware.dnsalias.com/api/UpdateTagGroup

Query parameters

Body

application/json

TagGroupID*integer

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

Response

200

Request

JavaScriptCurlPython

const response = await fetch('https://agentchat.abcsoftware.dnsalias.com/api/UpdateTagGroup?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "TagGroupID": "5",
      "Name": "Updated Group",
      "Enabled": true
    }),
});
const data = await response.json();

Canned Response

CreateCannedResponse

The API call to create a new Canned Response

POSThttps://agentchat.abcsoftware.dnsalias.com/api/CreateCannedResponse

Query parameters

Body

application/json

Name*string

The name of the canned response to be created

MessageText*string

The text of the canned response being created

Response

200

Request

JavaScriptCurlPython

const response = await fetch('https://agentchat.abcsoftware.dnsalias.com/api/CreateCannedResponse?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "Name": "opening hours",
      "MessageText": "We are open from 9am to 5pm, Monday to Friday"
    }),
});
const data = await response.json();

UpdateCannedResponse

The API call to update an existing Canned Response

POSThttps://agentchat.abcsoftware.dnsalias.com/api/UpdateCannedResponse

Query parameters

Body

application/json

CannedResponseID*integer

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

Response

200

Request

JavaScriptCurlPython

const response = await fetch('https://agentchat.abcsoftware.dnsalias.com/api/UpdateCannedResponse?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "CannedResponseID": "1",
      "Name": "Test canned response",
      "MessageText": "This is a test response"
    }),
});
const data = await response.json();

DeleteCannedResponse

The API call to delete a Canned Response

DELETEhttps://agentchat.abcsoftware.dnsalias.com/api/DeleteCannedResponse

Query parameters

Response

200

Request

JavaScriptCurlPython

const response = await fetch('https://agentchat.abcsoftware.dnsalias.com/api/DeleteCannedResponse?CannedResponseID=2&Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Working Hours

UpdateWorkingHours

The API call to update Working Hours

POSThttps://agentchat.abcsoftware.dnsalias.com/api/UpdateWorkingHours

Query parameters

Body

application/json

Days*array of Day

Response

200

Request

JavaScriptCurlPython

const response = await fetch('https://agentchat.abcsoftware.dnsalias.com/api/UpdateWorkingHours?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "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"
        }
      ]
    }),
});
const data = await response.json();

Reports

CreateReportSchedule

The API call to create a new schedule of Reports

POSThttps://agentchat.abcsoftware.dnsalias.com/api/CreateReportSchedule

Query parameters

Body

application/json

RecipientID*integer

The ID number of the recipient to receive the report

ReportID*integer

The ID number of the report the recipient will receive

Format*string

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

Grouping*array of string

The time over which the reports will be sent

Delivery*string

The method of delivery of the report

ScheduledDay*array of integer

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

ScheduledTime*string

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

Response

200

Request

JavaScriptCurlPython

const response = await fetch('https://agentchat.abcsoftware.dnsalias.com/api/CreateReportSchedule?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "RecipientID": "1",
      "ReportID": "1",
      "Format": "CSV",
      "Grouping": [
        "WEEK",
        "MONTH"
      ],
      "Delivery": "EMAIL",
      "ScheduledDay": [
        "1",
        "2",
        "3",
        "4",
        "5"
      ],
      "ScheduledTime": "16:30"
    }),
});
const data = await response.json();

LiveMetrics

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

GEThttps://agentchat.abcsoftware.dnsalias.com/api/LiveMetrics

Query parameters

Response

200

Request

JavaScriptCurlPython

const response = await fetch('https://agentchat.abcsoftware.dnsalias.com/api/LiveMetrics?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

GetReports

The API call to return details for all available reports

GEThttps://agentchat.abcsoftware.dnsalias.com/api/GetReports

Query parameters

Response

200

Request

JavaScriptCurlPython

const response = await fetch('https://agentchat.abcsoftware.dnsalias.com/api/GetReports?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

DataInsight

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

GEThttps://agentchat.abcsoftware.dnsalias.com/api/DataInsight

Query parameters

Response

200

Request

JavaScriptCurlPython

const response = await fetch('https://agentchat.abcsoftware.dnsalias.com/api/DataInsight?Period=week&Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

DeleteReportSchedule

The API call to delete a Scheduled report

DELETEhttps://agentchat.abcsoftware.dnsalias.com/api/DeleteReportSchedule

Query parameters

Response

200

Request

JavaScriptCurlPython

const response = await fetch('https://agentchat.abcsoftware.dnsalias.com/api/DeleteReportSchedule?ScheduleID=2&Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Recipients

CreateRecipient

The API call to create a new Recipient of emailed reports

POSThttps://agentchat.abcsoftware.dnsalias.com/api/CreateRecipient

Query parameters

Body

application/json

FullName*string

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

EmailAddress*string

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

Response

200

Request

JavaScriptCurlPython

const response = await fetch('https://agentchat.abcsoftware.dnsalias.com/api/CreateRecipient?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "FullName": "Zakes Mthini",
      "EmailAddress": "[e-mail]"
    }),
});
const data = await response.json();

GetRecipients

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

GEThttps://agentchat.abcsoftware.dnsalias.com/api/GetRecipients

Query parameters

Response

200

Request

JavaScriptCurlPython

const response = await fetch('https://agentchat.abcsoftware.dnsalias.com/api/GetRecipients?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

DeleteRecipient

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

DELETEhttps://agentchat.abcsoftware.dnsalias.com/api/DeleteRecipient

Query parameters

Response

200

Request

JavaScriptCurlPython

const response = await fetch('https://agentchat.abcsoftware.dnsalias.com/api/DeleteRecipient?RecipientID=2&Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Settings

UpdateSettings

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

POSThttps://agentchat.abcsoftware.dnsalias.com/api/UpdateSettings

Query parameters

Body

application/json

Settings*array of Setting

any

Response

200

Request

JavaScriptCurlPython

const response = await fetch('https://agentchat.abcsoftware.dnsalias.com/api/UpdateSettings?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "Settings": [
        {
          "CompanyName": "Channel"
        }
      ]
    }),
});
const data = await response.json();

GetSettings

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

GEThttps://agentchat.abcsoftware.dnsalias.com/api/GetSettings

Query parameters

Response

200

Request

JavaScriptCurlPython

const response = await fetch('https://agentchat.abcsoftware.dnsalias.com/api/GetSettings?Version=%7B%7BBUILD_VERSION%7D%7D&SessionToken=3a4783a081028a59e7b35529a3f9ef22', {
    method: 'GET',
    headers: {},
});
const data = await response.json();