(→Sample) |
|||
Line 54: | Line 54: | ||
For details on the <tt>statusCode</tt> value, please refer to the [[Documentation:HTCC:API:ReturnValues:8.5.2#All_Methods|All Methods]] sub-section of the [[Documentation:HTCC:API:ReturnValues:8.5.2|Return Values]] page. | For details on the <tt>statusCode</tt> value, please refer to the [[Documentation:HTCC:API:ReturnValues:8.5.2#All_Methods|All Methods]] sub-section of the [[Documentation:HTCC:API:ReturnValues:8.5.2|Return Values]] page. | ||
+ | |||
+ | ===Notification=== | ||
+ | Here are the list of notifications received after send new message | ||
+ | ====Notification with new message==== | ||
+ | <pre> | ||
+ | { | ||
+ | "messages": [ | ||
+ | { | ||
+ | "index": 3, | ||
+ | "from": { | ||
+ | "nickname": "TestName", | ||
+ | "type": "Agent", | ||
+ | "participantId": "007352CE72D50290" | ||
+ | }, | ||
+ | "text": "How may I help you?", | ||
+ | "visibility": "All", | ||
+ | "timestamp": "2014-01-09 11:58:12.035+0200", | ||
+ | "type": "Text", | ||
+ | "timestampSeconds": 1389261492035L | ||
+ | } | ||
+ | ], | ||
+ | "notificationType": "NewMessages", | ||
+ | "messageType": "MessageLogUpdated", | ||
+ | "chatUri": "http://localhost:8080/api/v2/chats/0000Wa9CAM6W00FN" | ||
+ | } | ||
+ | </pre> | ||
+ | |||
[[Category:V:HTCC:8.5.2]] | [[Category:V:HTCC:8.5.2]] |
Revision as of 19:50, April 14, 2014
SendMessage
This operation is performed when an agent sends a message to other chat participants.
Overview
Request URL | /api/v2/me/chats/{id} |
---|---|
HTTP Method | POST |
Required Features | api-multimedia |
Parameters
Parameter | Value |
---|---|
operationName | SendMessage |
text | text to send to customer |
Sample
HTTP Request
POST on /me/chats/{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 page.
Notification
Here are the list of notifications received after send new message
Notification with new message
{ "messages": [ { "index": 3, "from": { "nickname": "TestName", "type": "Agent", "participantId": "007352CE72D50290" }, "text": "How may I help you?", "visibility": "All", "timestamp": "2014-01-09 11:58:12.035+0200", "type": "Text", "timestampSeconds": 1389261492035L } ], "notificationType": "NewMessages", "messageType": "MessageLogUpdated", "chatUri": "http://localhost:8080/api/v2/chats/0000Wa9CAM6W00FN" }
Comments or questions about this documentation? Contact us for support!