Hybrid Chat APIs

1

Delivery Notification

/msg-client/delivery-notification

REST - POST

WebHook for Twilio to post the delivery notifications.

no

2

Twilio Message Receive 

/msg-client/receive

REST - POST

To receive Message from Twilio 

NO

3

Message Send 

/msg-client/send

REST - POST

To send outbound sms 

NO

4

Viber Message Receive 

/viber-message/receive

REST - POST

To receive Message from Viber 

NO

5

Facebook Message Receive 

/webhook

REST - POST

To receive Message from Facebook

NO

6

Facebook Webhook

/webhook

REST - GET

To verify Facebook Webhook

NO

7

Health Check

/api/SystemInfo

REST - GET

This API can be polled to monitor Customer Channel Manager health

NO

8

SMPP Message Send

/sms/send

REST - POST

To Receive Message from SMPP

NO

1

Initiate a Chat Request

/api/customer/init

REST - POST

This API is used to initiate a new conversation session for the web channel

no

2

Get Transcript

/api/customer/transcript/

REST - GET

Returns transcript for a conversation

no

3

Get history

/api/customer/history/

REST - GET

Return history for a conversation based upon a reference id (phone number)

no

4

Send a Message

/api/message/send

REST - POST

Used to send a message for a conversation. This API is used for all channels except the web

no

5

/api/external/message

REST - POST

no

6

Receive a Customer Message

/api/external/message/receive

REST - POST

Used for receiving an inbound message from a customer

no

7

Register a Connector

/api/external/register/connector

REST - POST

This API is used to register a connector with Chat Server e.g. Bot Connector, Customer Channel Manager

no

8

Get Agents List

/api/external/agents/list 

deprecated

REST - GET

Get list of agents with the state

no

9

Health Check

/api/SystemInfo

REST - GET

This API can be polled to monitor Chat Server health

no

10

Get Sockets Count

/api/getSocketCount

REST - GET

Returns count of currently connected sockets

no

11

End an ongoing Chat

/api/external/endChat

REST - POST

End an ongoing conversation

no

12

Get History

/history.html

REST - GET

View a conversation history by reference id (phone number)

yes  (Authentication only)

13

Suggest Action API

/api/message/suggest-action

REST - POST

Used to suggest an action for ongoing chat e.g handoff, end chat, etc

no

1

Health Check

/api/status

REST - GET

This API can be polled to monitor Communication Server health

NO

2

List Logged-in Agents

/api/agents

REST - GET

Returns a list of logged-in agents

NO

1

Health Check

/api/status

REST - GET

This API can be polled to monitor MRE health

NO

2

Get Estimated Wait Time

/api/EWT

REST - GET

Returns estimated wait time for a routable task that is in the queue.

no

3

Get Agent Information

/api/Agent

REST - GET

Returns information of an agent

no

4

Get Queue Statistics & Associated Agents

/api/AgentStats

REST - GET

Returns queue statistics and count of agents in every possible state for that queue

no

5

Check if agents are available to serve chats

/api/AvailableAgents

REST - GET

Returns a boolean value, indicating that agents are available to serve a chat or not

no

1

Health Check

/mre/api

REST - GET

This API can be polled to monitor MRE Microservice health

no

2

Get Attributes

/mre/api/attribute

REST - GET

Get a list of attributes

no

3

Create a new Attribute

/mre/api/attribute

REST - POST

Create a new attribute

no

4

Get an Attribute

/mre/api/attribute?attributeName

REST - GET

Get an attribute by name

no

5

Update an Attribute

/mre/api/attribute?attributeName

REST - PUT

Update an attribute

no

6

Delete an Attribute

/mre/api/attribute?attributeName

REST - DELETE

Delete an attribute

no

7

Get Agents

/mre/api/agent

REST - GET

Get a list of agents

no

8

Add a new Agent

/mre/api/agent

REST - POST

Add a new agent

no

9

Fetch Agent Details

/mre/api/agent/details

REST - POST

Get agents details whose agent_id and stats are provided in the body

no

10

Get an Agent

/mre/api/agent?agentId

REST - GET

Get an agent by id

no

11

Update an Agent

/mre/api/agent?agentId

REST - PUT

Update an agent by id

no

12

Delete an Agent

/mre/api/agent?agentId

REST - DELETE

Delete an agent by id

no

13

Get MRDs

/mre/api/mrd

REST - GET

Get a list of all MRDs

no

14

Create a new MRD

/mre/api/mrd

REST - POST

Create a new MRD

no

15

Get an MRD

/mre/api/mrd?mrdId

REST - GET

Get an mrd by id

no

16

Update an MRD

/mre/api/mrd?mrdId

REST - PUT

Update an MRD by id

no

17

Delete an MRD

/mre/api/mrd?mrdId

REST - DELETE

Delete an MRD by id

no

18

Get Labels

/mre/api/lbl

REST - GET

Get a list of labels

no

19

Add a new Label

/mre/api/lbl

REST - POST

Add a new label

no

20

Get a Label

/mre/api/lbl?lblId

REST - GET

Get a label by id

NO

21

Update a Label

/mre/api/lbl?lblId

REST - PUT

Update a label by id

no

22

Delete a Label

/mre/api/lbl?lblId

REST - DELETE

Delete a label by id

no

23

Get Precision Queues

/mre/api/pqueue

REST - GET

Get a list of all precision queues

no

24

Add a new Precision Queue

/mre/api/pqueue

REST - POST

Create a new precision queue

no

25

Get a Precision Queue

/mre/api/pqueue?pqueueId

REST - GET

Get a specific precision queue by id

no

26

Update a Precision Queue

/mre/api/pqueue?pqueueId

REST - PUT

Update a precision queue by id

no

27

Delete a Precision Queue

/mre/api/pqueue?pqueueId

REST - DELETE

Delete a precision queue by id

no

1

Upload File

/api/uploadFileStream

REST - POST

This API is used to upload a file

no

2

Download File

/api/downloadFileStream

REST - GET

This API is used to download a file, it streams file.

no

3

Get File Statistics

/api/getFileStat

REST - GET

Returns file statistics for provided filename

no

4

Upload File from a Media URL

/api/uploadFileFromUrl

REST - POST

This API is called when Twilio / Facebook / Viber sends a file media URL. The file engine downloads the file and saves it in the Minio bucket.

NO

5

Health Check

/api/SystemInfo

REST - GET

This API can be polled to monitor File Engine health.

no

1

Health Check

/status

REST - GET

This API can be polled to monitor Database Connector health

no

2

Save Conversation

/conversations/saveConversation

REST - POST

Save a new conversation

no

3

Update Conversation

/conversations/updateConversation

REST - PUT

Update an existing conversation

no

4

Update Session Type

/conversations/updateSessionType

REST - PUT

Update session type of an existing conversation

no

5

Update Task Id

/conversations/updateTaskId

REST - PUT

Update task-id/session-id of an existing conversation

no

6

Add Participant in a Conversation

/conversations/addParticipant

REST - PUT

Add a participant in an existing conversation

no

7

Get Conversation By Id

/conversations/getConversationById

REST - GET

Get a conversation by conversation id

no

8

Get Conversation by Reference Id (Phone number)

/conversations/getConversationByRefId

REST - GET

Get a conversation by phone number

no

9

Get History by Reference Id (Phone number)

/conversations/getHistoryByRefId

REST - GET

Get history by phone number

no

10

Save Message

/messages/saveMessage

REST - POST

Save a message

no

11

Update a Message

/messages/updateMessage

REST - PUT

Update a message

no

12

Get a Message by Conversation Id

/messages/getMessagesByConversationId

REST - GET

Get a message by conversation id

no

13

Get a Message by Message-Id

/messages/getMessageByMessageId

REST - GET

Get a message by Message-id

no

14

Delete a Queue by Name

/queues/deteleQueueByName

REST - DELETE

Delete a queue by providing queue name

no

15

Get Active Tasks

/getTasks

REST - GET

Get all active tasks in the realtime database

no

16

Get Active Agents

/getAgents

REST - GET

Get all active agents in the realtime database

no

17

Get Active Queues

/getQueues

REST - GET

Get all active queues and task-IDs in queues in the realtime database

no

18

Get Active Conversations

/getConversations

REST - GET

Get all the active conversations in the realtime database

no

19

Get Messages

/getMessages

REST - GET

Get all messages

no

20

Get Active Announcements

/announcements/getActiveAnnouncements

REST - GET

Get all active announcements

no

21

Get Announcements by Team

/announcements/getAnnouncementsByTeam

REST - GET

Get all active announcements of a specified team

no

22

Get List of Accouncements by Teams 

/announcements/getAnnouncementsByTeams

REST - GET

Gel all active announcements of all teams

no

23

Create an Announcement

/announcements/createAnnouncement

REST - POST

Create an announcement

no

24

Update an Announcement

/announcements/updateAnnouncement

REST - PUT

Update an announcement

no

25

Remove an Announcement

/announcements/removeAnnouncement

REST - PUT

Remove an announcement

no

26

Update Agent Read time of an Announcement

/announcements/updateAgentReadTime

REST - PUT

Update agent read-time on an announcement

no

27

Get Agent Announcement Read Time

/announcements/getAgentReadTime

REST - GET

Get agent read-time of an announcement

no

28

Get All Announcements (Active & Expired)

/announcements/getActiveExpireAnnouncements

REST - GET

Get all active and expired announcements

no

29

Get Agent who handled a Conversation Last Time

/getLastAgent

REST - GET

Get the agents who handled chat last time, this agent could be the agent who sent the last outbound message or the one who handled chat last time.

no

1

Get Average Talk Time

/api/AvgTalkTime

REST - GET

Returns average talk time for a specified period of time

no

2

Health Check

/api/SystemInfo

REST - GET

This API can be polled to monitor Reporting Connector health

no

1

Login

/api/login

REST - POST

Login API

yes

2

Create a User

/user/create

REST - POST

Create a User

yes

3

Fetch a User

/user/show

REST - GET

Get a user details

yes

4

Delete User

/user/delete

REST - DELETE

Delete a user

yes

5

List All Users

/user/list

REST - GET

List all users

no

6

Reset Password

/user/resetPassword

REST - PUT

Reset password of a user

yes

7

Change Password

/user/updatePassword

REST - PUT

Change a user's password

yes

8

Update User Info

/user/update

REST - PUT

Update a user information

yes

9

Add or Revoke a User's Authorization

/user/addRevokeMicroserviceRoles

REST - PUT

Add or revoke a user's permission for a microservice access

yes

10

Delete Bulk Users

/user/deleteMulti

REST - DELETE 

Delete bulk users

yes

11

Update a Microservice

/microservice/update

REST - PUT

Updates the attributes of a microservice. name, IP address and/or the description

yes

12

Get a Microservice

/microservice/show

REST - GET

Get a microservice details

yes

13

List All Microservices

/microservice/list

REST - GET

Get a list of all microservices

yes

14

Create a Microservice

/microservice/create

REST - POST

Create a new microservice

yes

15

Delete a Microservice

/microservice/delete

REST - DELETE

Delete a microservice

yes

16

Add / Removed Roles of a Microservice

/microservice/addRemoveRoles

REST - PUT

Add or remove roles of a microservice

yes

17

Get all Roles

/role/list

REST - GET

Get list of all roles

yes

18

Get a Role

/role/show

REST - GET

Get a specific role details

yes

19

Update a Role

/role/update

REST - PUT

Update a role details

yes

20

Delete a Role

/role/delete

REST - DELETE

Delete a role

yes

21

Bulk Delete Roles

/role/deleteMulti

REST - DELETE

Delete multiple roles

yes

22

Create a Role

/role/create

REST - POST

Create a role

yes

23

Add / Revoke Permissions of a Role

/role/addRevokePermissions

REST - PUT

Add or revoke permissions of a role

yes

24

Users list for a Role

/role/roleUser

REST - GET

Get the list of users for a particular role

yes

25

List all Permissions

/permission/list

REST - GET

List of all the permissions

yes

26

Get a Permission Details

/permission/show

REST - GET

Get specific permission details

yes

27

Create a New Permission

/permission/create

REST - POST

Create a permission record

yes

28

Update an existing Permission

/permission/update

REST - PUT

Update an existing permission

yes

29

Delete an existing Permission

/permission/delete

REST - DELETE

Delete an existing permission

yes

30

List Application settings

/application-settings

REST - GET

Get applications settings list

NO

31

Save Application settings

/application-settings

REST - POST

Save applications settings

NO

32

Update Application Settings

/application-settings

REST - PUT

Updates the existing application settings

NO

33

Start sync job

/users/sync

REST - POST

Starts sync on demand

NO

34

Get Sync job report

/users/sync

REST - GET

Get the report of last sync job

NO

35

Get users list

/users

REST - GET

Get the list of users

NO

1

Fetch Service Status

REST - GET

To check the status of a calendar.

NO

2

Fetch Easy Announcements

REST - GET

To get the easy announcements

NO

3

Fetch General Announcements

REST - GET

To get the announcements of type general.

NO

4

Fetch Service Status

REST - GET

To get the status of a CC service.

NO