Documentation:HTCC:API:ChatSendStopTypingNotification:8.5.2DRAFT

SendStopTypingNotification

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

Overview

This operation sends notifications to other chat participants that the agent has stopped typing.

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

Parameters

Parameter	Value
operationName	SendStopTypingNotification
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

HTTP Request

POST on /me/chats/{id}

{
  "operationName":"SendStopTypingNotification"
}

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

{
   "messages": [
       {
           "index": 5,
           "from": {
               "nickname": "TestName",
               "type": "Agent",
               "participantId": "007352CE764002A3"
           },
           "timestamp": "2014-01-09 12:13:15.031+0200",
           "visibility": "All",
           "type": "TypingStopped",
           "timestampSeconds": 1389262395031L
       }
   ],
   "notificationType": "NewMessages",
   "messageType": "MessageLogUpdated",
   "chatUri": "http://localhost:8080/api/v2/chats/0000Wa9CAM6W00FY"
}