Send a message
post
/engagement/api/consumer/{fqSiteName}/v1/postMessage
This operation is used by the end user to send messages to the agent. The collection of these messages comprises a chat engagement.
The user can start sending messages as soon as the chat engagement is created and does not have to wait until the chat engagement is accepted by the agent.
The user can start sending messages as soon as the chat engagement is created and does not have to wait until the chat engagement is accepted by the agent.
Request
Supported Media Types
- application/json; charset=utf-8
Path Parameters
-
fqSiteName: string
The name of the site returned by the call to establish a session.
Query Parameters
-
pool: string
The pool ID specified in the Establish Sessions response or provided in an RNEngagementConfigurationChangedMessage system message.
Header Parameters
-
SessionId: string
The unique identifier of the consumer session.
The object containing the request information.
Root Schema : com.rightnow.chat.rest.consumer_api.model.requests.v1.PostEngagementMessageRequest
Type:
Show Source
object
-
body:
string
The text message from the end user to the agent.
-
clientRequestTime(optional):
string
The local time of the requesting client in yyyy-MM-dd'T'HH:mm:ssXXX format.
-
clientTransactionId(optional):
integer(int64)
The unique identifier of the client transaction. The value specified in this field is echoed back in the response object. It is used to link requests to responses.
-
messageDataMap(optional):
object messageDataMap
An optional map of client supplied key/value String pairs associated with this message.
-
messageId(optional):
string
The unique identifier of the message.
-
offTheRecord(optional):
boolean
Indicates whether the text message should be considered 'off the record' and not logged. If true, then the message is not logged. The default value is false.
-
richText(optional):
boolean
Indicates whether the text message is rich text. If true, then the message is rich text. The default value is false.
Nested Schema : messageDataMap
Type:
object
An optional map of client supplied key/value String pairs associated with this message.
Response
Supported Media Types
- application/json; charset=utf-8
200 Response
The request completed successfully.
Root Schema : com.rightnow.chat.rest.consumer_api.model.responses.v1.PostEngagementMessageResponse
Type:
Show Source
object
-
clientId(optional):
integer(int64)
The unique identifier of the client.
-
clientIdString(optional):
string
The unique identifier of the client as a String.
-
clientRequestTime(optional):
string
The local time of the requesting client in yyyy-MM-dd'T'HH:mm:ssXXX format.
-
clientTransactionId(optional):
integer(int64)
The unique identifier of the client transaction. The value specified in this field is echoed back in the response object. It is used to link requests to responses.
-
clientTransactionIdString(optional):
string
The unique identifier of the client transaction as a String.
-
serviceFinishTime(optional):
string
The time when the request processing completed in yyyy-MM-dd'T'HH:mm:ssXXX format.
-
serviceStartTime(optional):
string
The time when the request processing started in yyyy-MM-dd'T'HH:mm:ssXXX format.
400 Response
The validation of the request object failed.
Root Schema : schema
Type:
object
403 Response
The consumer session identifier is unknown.
Root Schema : schema
Type:
object
404 Response
The resource was not found.
Root Schema : schema
Type:
object
409 Response
The lead agent participant has left the engagement.
Root Schema : schema
Type:
object
500 Response
An error occurred in the chat server while processing the request.
Root Schema : schema
Type:
object
Examples
The following example shows how to a send message to an agent by submitting a POST request using cURL:
cURL Command Example
curl -X POST https://chat_rest_server_domain.com/engagement/api/consumer/day119_181100_sql_238h/v1/postMessage?pool=297:1 -H 'Content-Type: application/json; charset=UTF-8' -H 'SessionId: 192hyto5qomm8r8rpzzmuzsa6' -d '{"body":"Hello I need help with my refund, it has been very long time."}'
Request Body Example
The following shows an example of the request body in JSON format.
{ "body":"Hello I need help with my refund, it has been very long time." }
Response Header Example
The following shows an example of the response header.
Status: 200 OK Content-Type: application/json;charset=utf-8
Response Body Example
The following shows an example of the response body in JSON format.
{ "clientRequestTime": null, "serviceStartTime": "2018-10-23T14:00:38.205Z", "serviceFinishTime": "2018-10-23T14:00:38.218Z", "clientId": 34, "clientIdString": "34", "clientTransactionId": 0, "clientTransactionIdString": "0" }