Jump to: navigation, search
(added text, messageType, and treatAs parameters)
m (Reverted edits by Xavier (talk) to last revision by Jumunn)
 
(2 intermediate revisions by the same user not shown)
Line 16: Line 16:
  
 
==Parameters==
 
==Parameters==
{{Chgbar_open}}
 
 
{|
 
{|
 
! Parameter
 
! Parameter
Line 23: Line 22:
 
| operationName
 
| operationName
 
| SendStartTypingToAgentsNotification
 
| SendStartTypingToAgentsNotification
|-
 
 
| text
 
| (Optional) The text to send to the customer.
 
|-
 
| messageType
 
|(Optional) Defines the message type. Note that this parameter must be provided together with the '''text''' parameter.
 
|-
 
| treatAs
 
| (Optional) Specifies how the message should be treated: Normal or System. Note that this parameter must be provided together with the '''text''' parameter.
 
 
|}
 
|}
{{Chgbar_close}}
 
 
  
 
==Sample==
 
==Sample==

Latest revision as of 11:33, June 15, 2017

SendStartTypingToAgentsNotification

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

Overview

This request sends a notification to agents who are in a conference or consultation. Customers do not see this notification.

Request URL /api/v2/me/chats/{id}
HTTP Method POST
Required Features api-multimedia

Parameters

Parameter Value
operationName SendStartTypingToAgentsNotification

Sample

Request

POST api/v2/me/chats/0071023821aec011
{
  "operationName": "SendStartTypingToAgentsNotification"
}

Response

{
  "statusCode": 0
}

Notification

{
   "messages": [
       {
           "index": 4,
           "from": {
               "nickname": "TestName",
               "type": "Agent",
               "participantId": "007352CE764002A3"
           },
           "timestamp": "2014-01-09 12:13:15.009+0200",
           "visibility": "Agents",
           "type": "TypingStarted",
           "timestampSeconds": 1389262395009L
       }
   ],
   "notificationType": "NewMessages",
   "messageType": "MessageLogUpdated",
   "chatUri": "http://localhost:8080/api/v2/chats/0000Wa9CAM6W00FY"
}
This page was last edited on June 15, 2017, at 11:33.
Comments or questions about this documentation? Contact us for support!