Jump to: navigation, search
(Update with the copy of version: 8.5.2DRAFT)
 
(11 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
=Send=
+
=SendMessage=
−
This operation can be performed whenever an agent wants to send a message to other chat participants.
+
__NOTOC__
−
===HTTP Request===
+
This operation is part of the [[Chat|Chat API]] section of the [[Welcome|Web Services API]].
 +
 
 +
==Overview==
 +
This operation is performed when an agent sends a message to other chat participants.
 +
{|
 +
! 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
 +
|-
 +
| messageType
 +
| Defines the message type. This parameter is optional and the value is only included in the CometD notification if you set the [[Documentation:HTCC:Dep:HTCCConfigurationOptionsReference#includeMessageType|includeMessageType]] option to <tt>true</tt>.
 +
|-
 +
| treatAs
 +
| Specifies how the message should be treated: Normal or System
  
−
POST on '''/me/interactions/{id}'''
+
|}
  
 +
==Sample==
 +
===HTTP Request===
 +
POST on '''/me/chats/{id}'''
 
<pre>
 
<pre>
 
{
 
{
 
   "operationName":"SendMessage",
 
   "operationName":"SendMessage",
−
   "text":string-representation-of-text
+
   "text":string-representation-of-text,
 +
  "messageType":"Greeting"
 
}
 
}
 
</pre>
 
</pre>
  
 
===HTTP Response===
 
===HTTP Response===
−
 
−
''Success''
 
 
<pre>
 
<pre>
 
{
 
{
Line 21: Line 53:
 
</pre>
 
</pre>
  
−
''Failure''
+
For details on the <tt>statusCode</tt> value, refer to the [[ReturnValues#All_Methods|All Methods]] sub-section of the [[ReturnValues|Return Values]] page.
 +
 
 +
===CometD notification===
 
<pre>
 
<pre>
 
{
 
{
−
  "statusCode": an integer value above 0,
+
  "messages": [
−
  "statusMessage":details
+
      {
 +
          "index": 3,
 +
          "from": {
 +
              "nickname": "TestName",
 +
              "type": "Agent",
 +
              "participantId": "007352CE72D50290"
 +
          },
 +
          "messageType": "Greeting",
 +
          "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>
 
</pre>
  
−
For details on the <tt>statusCode</tt> value, please refer to the [[ReturnValues#All_Methods|All Methods]] sub-section of the Return Values section.
 
  
 
[[Category:V:HTCC:8.5.2]]
 
[[Category:V:HTCC:8.5.2]]

Latest revision as of 13:20, October 20, 2021

SendMessage

This operation is part of the Chat API section of the Web Services API.

Overview

This operation is performed when an agent sends a message to other chat participants.

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
messageType Defines the message type. This parameter is optional and the value is only included in the CometD notification if you set the includeMessageType option to true.
treatAs Specifies how the message should be treated: Normal or System

Sample

HTTP Request

POST on /me/chats/{id} 

{
  "operationName":"SendMessage",
  "text":string-representation-of-text,
  "messageType":"Greeting"
}

HTTP Response

{
  "statusCode": 0
}

For details on the statusCode value, refer to the All Methods sub-section of the Return Values page.

CometD notification

{
   "messages": [
       {
           "index": 3,
           "from": {
               "nickname": "TestName",
               "type": "Agent",
               "participantId": "007352CE72D50290"
           },
           "messageType": "Greeting",
           "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"
}
This page was last edited on October 20, 2021, at 13:20.
Comments or questions about this documentation? Contact us for support!