Documentation:HTCC:API:ChatSendStartTypingToAgentsNotification:8.5.2DRAFT

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
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.

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"
}