Jump to: navigation, search

SendStartTypingNotification

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

Overview

This operation is performed to send notifications to other chat participants that the agent has started typing (for example: 'agent typing').

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

Parameters

Parameter Value
operationName SendStartTypingNotification

Sample

HTTP Request

POST on /me/chats/{id}

{
  "operationName":"SendStartTypingNotification"
}

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": 4,
           "from": {
               "nickname": "TestName",
               "type": "Agent",
               "participantId": "007352CE764002A3"
           },
           "timestamp": "2014-01-09 12:13:15.009+0200",
           "visibility": "All",
           "type": "TypingStarted",
           "timestampSeconds": 1389262395009L
       }
   ],
   "notificationType": "NewMessages",
   "messageType": "MessageLogUpdated",
   "chatUri": "http://localhost:8080/api/v2/chats/0000Wa9CAM6W00FY"
}

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on March 25, 2016, at 10:22.