Contents
Interactions on Chat Channel Inbound Operations
The following operations can be performed on /me/interactions/{id}.
Accept
After successfully executing this operation, a cometD notification will come with complete chat history up until this point.
HTTP Request
POST on /me/interactions/{id}
{
"operationName":"Accept",
"nickname":agent-nickname-to-be-displayed-in-chat
}
HTTP Response
Success
{
"statusCode": 0
}
Failure
{
"statusCode": an integer value above 0,
"statusMessage":details
}
For details on the statusCode value, please refer to the All Methods sub-section of the Return Values section.
SendMessage
HTTP Request
POST on /me/interactions/{id}
{
"operationName":"SendMessage",
"text":string-representation-of-text
}
HTTP Response
Success
{
"statusCode": 0
}
Failure
{
"statusCode": an integer value above 0,
"statusMessage":details
}
For details on the statusCode value, please refer to the All Methods sub-section of the Return Values section.
SendNotification
HTTP Request
POST on /me/interactions/{id}
{
"operationName":"SendNotification",
"notifcation":TypingStarted, TypingStopped
}
HTTP Response
Success
{
"statusCode": 0
}
Failure
{
"statusCode": an integer value above 0,
"statusMessage":details
}
For details on the statusCode value, please refer to the All Methods sub-section of the Return Values section.
RequestChatHistory
After this request is received, the chat history will be sent via cometD notification.
HTTP Request
POST on /me/interactions/{id}
{
"operationName":"RequestChatHistory",
"eventId", event-id-from-which-to-start-chat-history (optional)
}
HTTP Response
Success
{
"statusCode": 0
}
InitiateConsultation
After this request is received, a chat consultation with an agent will be started. This operation should also used for Two-Step Transfer and Two-Step Conference
HTTP Request
POST on /me/interactions/{id}
{
"operationName":"StartChatConsultation",
"agentId": unique alpha-numeric identifier for user
}
HTTP Response
{
"status":0
}
CompleteTransfer
After this request is received, a chat interaction will be transferred to the agent with whom consultation was initiated using InitiateConsultation. This will complete the Two-Step Transfer.
HTTP Request
POST on /me/interactions/{id}
{
"operationName":"CompleteTransfer"
}
HTTP Response
{
"status":0
}
CompleteConference
After this request is received, a chat interaction will be conferenced with the agent with whom consultation was initiated using InitiateConsultation. This will complete the Two-Step Conference.
HTTP Request
POST on /me/interactions/{id}
{
"operationName":"LeaveChatConsultation"
}
HTTP Response
{
"status":0
}
See also: