REST API for Chat in B2C Service

All REST Endpoints

Agent Interactions

The list of operations that can be used to manage a chat engagement as an agent.

Accept an engagement assignment: Method: post
Path: /engagement/api/agent/{fqSiteName}/v1/assignmentAcknowledgement
Conclude an engagement: Method: post
Path: /engagement/api/agent/{fqSiteName}/v1/concludeChat
Create an automated agent session: Method: post
Path: /engagement/api/agent/{fqSiteName}/v1/createAutomatedAgentSession
Get agents and queues: Method: post
Path: /engagement/api/agent/{fqSiteName}/v1/retrieveAgentsAndQueues
Get reroute availability: Method: get
Path: /engagement/api/agent/{fqSiteName}/v1/rerouteAvailability
Get system messages: Method: post
Path: /engagement/api/agent/{fqSiteName}/v1/getMessages
Log off an agent session: Method: post
Path: /engagement/api/agent/{fqSiteName}/v1/logoff
Release an engagement: Method: post
Path: /engagement/api/agent/{fqSiteName}/v1/releaseChat
Request an engagement assignment: Method: post
Path: /engagement/api/agent/{fqSiteName}/v1/requestAssignment
Reroute an engagement: Method: post
Path: /engagement/api/agent/{fqSiteName}/v1/rerouteEngagement
Send a message: Method: post
Path: /engagement/api/agent/{fqSiteName}/v1/postMessage
Set activity status: Method: post
Path: /engagement/api/agent/{fqSiteName}/v1/setActivityStatus
Set engagement property: Method: post
Path: /engagement/api/agent/{fqSiteName}/v1/setEngagementProperty
Set interaction status: Method: post
Path: /engagement/api/agent/{fqSiteName}/v1/setInteractionStatus
Update the properties of an engagement: Method: post
Path: /engagement/api/agent/{fqSiteName}/v1/modifyProperties

Consumer Interactions

The list of operations that can be used to create and manage a chat engagement.

Change activity status: Method: post
Path: /engagement/api/consumer/{fqSiteName}/v1/activity
Conclude an engagement: Method: post
Path: /engagement/api/consumer/{fqSiteName}/v1/concludeEngagement
Create an engagement: Method: post
Path: /engagement/api/consumer/{fqSiteName}/v1/requestEngagement
Get engagement queue: Method: get
Path: /engagement/api/consumer/{fqSiteName}/v1/getEngagementQueue
Get queue statistics: Method: get
Path: /engagement/api/consumer/{fqSiteName}/v1/getQueueStats
Get system messages: Method: post
Path: /engagement/api/consumer/{fqSiteName}/v1/getMessages
Send a message: Method: post
Path: /engagement/api/consumer/{fqSiteName}/v1/postMessage