(Created Fix blank page For Version: HTCC:8.5.2DRAFT) |
(Update with the copy of version: 8.5.2) |
||
Line 1: | Line 1: | ||
− | < | + | =Accept= |
+ | This operation can be performed after a new chat notification arrives. | ||
+ | |||
+ | Accepting allows the agent to start working on a chat. | ||
+ | |||
+ | After successfully executing this operation, a [[Documentation:HTCC:API:CometDNotifications:8.5.2|CometD notification]] will arrive with complete chat history. | ||
+ | __NOTOC__ | ||
+ | ==Overview== | ||
+ | This request accepts an incoming chat. | ||
+ | {| | ||
+ | ! Request URL | ||
+ | | /api/v2/me/chats/{id} | ||
+ | |- | ||
+ | ! HTTP Method | ||
+ | | POST | ||
+ | |- | ||
+ | ! Required Features | ||
+ | | api-multimedia | ||
+ | |} | ||
+ | |||
+ | ==Parameters== | ||
+ | {| | ||
+ | ! Parameter | ||
+ | ! Value | ||
+ | |- | ||
+ | | operationName | ||
+ | | Accept | ||
+ | |- | ||
+ | | nickname | ||
+ | | agent nickname as will be seen by customer | ||
+ | |} | ||
+ | |||
+ | ==Sample== | ||
+ | ===HTTP Request=== | ||
+ | |||
+ | POST on '''/me/chats/{id}''' | ||
+ | |||
+ | <nowiki> | ||
+ | { | ||
+ | "operationName":"Accept", | ||
+ | "nickname":agent-nickname-to-be-displayed-in-chat | ||
+ | } | ||
+ | </nowiki> | ||
+ | |||
+ | ===HTTP Response=== | ||
+ | <pre> | ||
+ | { | ||
+ | "statusCode": 0 | ||
+ | } | ||
+ | </pre> | ||
+ | |||
+ | For details on the <tt>statusCode</tt> value, please refer to the [[ReturnValues#All_Methods|All Methods]] sub-section of the [[ReturnValues|Return Values]] page. | ||
+ | |||
+ | ===Notification=== | ||
+ | Here are the list of notifications received after accepting a chat: | ||
+ | ====Status changed to Chatting==== | ||
+ | <pre> | ||
+ | { | ||
+ | "messageType": "ChatStateChangeMessage", | ||
+ | "referenceId": 17, | ||
+ | "notificationType": "StatusChange", | ||
+ | "chat": { | ||
+ | "state": "Chatting", | ||
+ | "capabilities": [ | ||
+ | "Transfer", | ||
+ | "Complete", | ||
+ | "Leave", | ||
+ | "InFocus", | ||
+ | "SendMessage", | ||
+ | "SendStartTypingNotification", | ||
+ | "SendStopTypingNotification" | ||
+ | ], | ||
+ | "id": "0000Na9B26EF002X", | ||
+ | "uri": "http://localhost:8080/api/v2/chats/0000Na9B26EF002X", | ||
+ | "participants": [] | ||
+ | } | ||
+ | } | ||
+ | </pre> | ||
+ | ====Updated participant list==== | ||
+ | <pre> | ||
+ | { | ||
+ | "messageType": "ChatStateChangeMessage", | ||
+ | "notificationType": "ParticipantsUpdated", | ||
+ | "chat": { | ||
+ | "state": "Chatting", | ||
+ | "capabilities": [ | ||
+ | "Transfer", | ||
+ | "Complete", | ||
+ | "Leave", | ||
+ | "InFocus", | ||
+ | "SendMessage", | ||
+ | "SendStartTypingNotification", | ||
+ | "SendStopTypingNotification" | ||
+ | ], | ||
+ | "id": "0000Na9B26EF002X", | ||
+ | "uri": "http://localhost:8080/api/v2/chats/0000Na9B26EF002X", | ||
+ | "participants": [ | ||
+ | { | ||
+ | "type": "Agent", | ||
+ | "nickname": "Marat", | ||
+ | "participantId": "009052C5E743004C" | ||
+ | }, | ||
+ | { | ||
+ | "type": "Customer", | ||
+ | "nickname": "PersonP", | ||
+ | "participantId": "009052C5E6D6004A" | ||
+ | } | ||
+ | ] | ||
+ | } | ||
+ | } | ||
+ | </pre> | ||
+ | |||
+ | ====Chat history up to the point of joining==== | ||
+ | <pre> | ||
+ | { | ||
+ | "messageType": "MessageLogUpdated", | ||
+ | "notificationType": "NewMessages", | ||
+ | "messages": [ | ||
+ | { | ||
+ | "index": 1, | ||
+ | "type": "ParticipantJoined", | ||
+ | "from": { | ||
+ | "type": "Customer", | ||
+ | "nickname": "PersonP", | ||
+ | "participantId": "009052C5E6D6004A" | ||
+ | }, | ||
+ | "visibility": "All", | ||
+ | "timestamp": "2014-01-02T14:23:18.000-0800" | ||
+ | }, | ||
+ | { | ||
+ | "index": 2, | ||
+ | "type": "ParticipantJoined", | ||
+ | "from": { | ||
+ | "type": "Agent", | ||
+ | "nickname": "Marat", | ||
+ | "participantId": "009052C5E743004C" | ||
+ | }, | ||
+ | "visibility": "All", | ||
+ | "timestamp": "2014-01-02T14:23:18.109-0800" | ||
+ | }, | ||
+ | { | ||
+ | "index": 3, | ||
+ | "type": "ParticipantLeft", | ||
+ | "from": { | ||
+ | "type": "Agent", | ||
+ | "nickname": "Marat", | ||
+ | "participantId": "009052C5E743004C" | ||
+ | }, | ||
+ | "visibility": "All", | ||
+ | "timestamp": "2014-01-02T14:23:19.909-0800" | ||
+ | }, | ||
+ | { | ||
+ | "index": 4, | ||
+ | "type": "TypingStarted", | ||
+ | "from": { | ||
+ | "type": "Customer", | ||
+ | "nickname": "PersonP", | ||
+ | "participantId": "009052C5E6D6004A" | ||
+ | }, | ||
+ | "visibility": "All", | ||
+ | "timestamp": "2014-01-02T14:23:20.121-0800" | ||
+ | }, | ||
+ | { | ||
+ | "index": 5, | ||
+ | "type": "Text", | ||
+ | "from": { | ||
+ | "type": "Customer", | ||
+ | "nickname": "PersonP", | ||
+ | "participantId": "009052C5E6D6004A" | ||
+ | }, | ||
+ | "text": "Hello World", | ||
+ | "visibility": "All", | ||
+ | "timestamp": "2014-01-02T14:23:20.126-0800" | ||
+ | }, | ||
+ | { | ||
+ | "index": 6, | ||
+ | "type": "ParticipantJoined", | ||
+ | "from": { | ||
+ | "type": "Agent", | ||
+ | "nickname": "Marat", | ||
+ | "participantId": "009052C5EF51004D" | ||
+ | }, | ||
+ | "visibility": "All", | ||
+ | "timestamp": "2014-01-02T14:23:20.171-0800" | ||
+ | } | ||
+ | ], | ||
+ | "chatUri": "http://localhost:8080/api/v2/chats/0000Na9B26EF002X" | ||
+ | } | ||
+ | </pre> | ||
+ | |||
+ | [[Category:V:HTCC:8.5.2DRAFT]] |
Revision as of 18:42, April 22, 2014
Accept
This operation can be performed after a new chat notification arrives.
Accepting allows the agent to start working on a chat.
After successfully executing this operation, a CometD notification will arrive with complete chat history.
Overview
This request accepts an incoming chat.
Request URL | /api/v2/me/chats/{id} |
---|---|
HTTP Method | POST |
Required Features | api-multimedia |
Parameters
Parameter | Value |
---|---|
operationName | Accept |
nickname | agent nickname as will be seen by customer |
Sample
HTTP Request
POST on /me/chats/{id}
{ "operationName":"Accept", "nickname":agent-nickname-to-be-displayed-in-chat }
HTTP Response
{ "statusCode": 0 }
For details on the statusCode value, please refer to the All Methods sub-section of the Return Values page.
Notification
Here are the list of notifications received after accepting a chat:
Status changed to Chatting
{ "messageType": "ChatStateChangeMessage", "referenceId": 17, "notificationType": "StatusChange", "chat": { "state": "Chatting", "capabilities": [ "Transfer", "Complete", "Leave", "InFocus", "SendMessage", "SendStartTypingNotification", "SendStopTypingNotification" ], "id": "0000Na9B26EF002X", "uri": "http://localhost:8080/api/v2/chats/0000Na9B26EF002X", "participants": [] } }
Updated participant list
{ "messageType": "ChatStateChangeMessage", "notificationType": "ParticipantsUpdated", "chat": { "state": "Chatting", "capabilities": [ "Transfer", "Complete", "Leave", "InFocus", "SendMessage", "SendStartTypingNotification", "SendStopTypingNotification" ], "id": "0000Na9B26EF002X", "uri": "http://localhost:8080/api/v2/chats/0000Na9B26EF002X", "participants": [ { "type": "Agent", "nickname": "Marat", "participantId": "009052C5E743004C" }, { "type": "Customer", "nickname": "PersonP", "participantId": "009052C5E6D6004A" } ] } }
Chat history up to the point of joining
{ "messageType": "MessageLogUpdated", "notificationType": "NewMessages", "messages": [ { "index": 1, "type": "ParticipantJoined", "from": { "type": "Customer", "nickname": "PersonP", "participantId": "009052C5E6D6004A" }, "visibility": "All", "timestamp": "2014-01-02T14:23:18.000-0800" }, { "index": 2, "type": "ParticipantJoined", "from": { "type": "Agent", "nickname": "Marat", "participantId": "009052C5E743004C" }, "visibility": "All", "timestamp": "2014-01-02T14:23:18.109-0800" }, { "index": 3, "type": "ParticipantLeft", "from": { "type": "Agent", "nickname": "Marat", "participantId": "009052C5E743004C" }, "visibility": "All", "timestamp": "2014-01-02T14:23:19.909-0800" }, { "index": 4, "type": "TypingStarted", "from": { "type": "Customer", "nickname": "PersonP", "participantId": "009052C5E6D6004A" }, "visibility": "All", "timestamp": "2014-01-02T14:23:20.121-0800" }, { "index": 5, "type": "Text", "from": { "type": "Customer", "nickname": "PersonP", "participantId": "009052C5E6D6004A" }, "text": "Hello World", "visibility": "All", "timestamp": "2014-01-02T14:23:20.126-0800" }, { "index": 6, "type": "ParticipantJoined", "from": { "type": "Agent", "nickname": "Marat", "participantId": "009052C5EF51004D" }, "visibility": "All", "timestamp": "2014-01-02T14:23:20.171-0800" } ], "chatUri": "http://localhost:8080/api/v2/chats/0000Na9B26EF002X" }
Comments or questions about this documentation? Contact us for support!