Jump to: navigation, search
(Created Fix blank page For Version: HTCC:8.5.2DRAFT)
 
(Update with the copy of version: 8.5.2)
Line 1: Line 1:
−
<!-- Creation of the fix page -->
+
=SendStartTypingNotification=
 +
This operation is performed to send notifications to other chat participants that the agent has started typing (for example: 'agent typing').
 +
__NOTOC__
 +
==Overview==
 +
{|
 +
! 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}'''
 +
<pre>
 +
{
 +
  "operationName":"SendStartTypingNotification"
 +
}
 +
</pre>
 +
 
 +
===HTTP Response===
 +
 
 +
''Success''
 +
<pre>
 +
{
 +
  "statusCode": 0
 +
}
 +
</pre>
 +
 
 +
''Failure''
 +
<pre>
 +
{
 +
  "statusCode": an integer value above 0,
 +
  "statusMessage":details
 +
}
 +
</pre>
 +
 
 +
For details on the <tt>statusCode</tt> value, please refer to the [[Documentation:HTCC:API:ReturnValues:8.5.2#All_Methods|All Methods]] sub-section of the [[Documentation:HTCC:API:ReturnValues:8.5.2|Return Values]] page.
 +
 
 +
===Notification===
 +
<pre>
 +
{
 +
  "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"
 +
}
 +
</pre>
 +
 
 +
[[Category:V:HTCC:8.5.2DRAFT]]

Revision as of 18:42, April 22, 2014

SendStartTypingNotification

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

Overview

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"
}
Comments or questions about this documentation? Contact us for support!