Jump to: navigation, search
(Created Fix blank page For Version: HTCC:8.5.2)
 
(Update with the copy of version: 8.5.2DRAFT)
Line 1: Line 1:
−
<!-- Creation of the fix page -->
+
=SendMessage=
 +
__NOTOC__
 +
This operation is part of the [[FacebookPM|Facebook Private Messaging API]] section of the [[Welcome|Genesys Web Services REST API]].
 +
 
 +
<h2> Overview </h2>
 +
This request sends a text message to all Facebook session participants.
 +
{| class="wikitable"
 +
|-
 +
! scope="row"| Request URL
 +
| /api/v2/me/facebooksession/''{id}''
 +
|-
 +
! scope="row"| HTTP Method
 +
| POST
 +
|-
 +
! scope="row" | Required Features
 +
| api-multimedia
 +
|}
 +
<h2>Parameters</h2>
 +
 
 +
{|
 +
|-
 +
! Parameter
 +
! Value
 +
|-
 +
|operationName
 +
|SendMessage
 +
|-
 +
|text
 +
|The text to send to the customer.
 +
|}
 +
 
 +
<h2>Sample</h2>
 +
 
 +
<h3>Request</h3>
 +
 
 +
<source lang="text">
 +
POST api/v2/me/facebooksession/0071023821aec011
 +
{
 +
  "operationName": "SendMessage",
 +
  "text": "How may I help you?"
 +
}
 +
</source>
 +
 
 +
<h3>Response</h3>
 +
 
 +
<source lang="text">
 +
{
 +
  "statusCode": 0
 +
}
 +
</source>
 +
 
 +
<h3>Notification</h3>
 +
Here is the list of notifications received after sending a new message:
 +
 
 +
<h4>Notification with new message</h4>
 +
 
 +
{
 +
    "messages": [
 +
        {
 +
            "index": 3,
 +
            "from": {
 +
                "nickname": "TestName",
 +
                "type": "Agent",
 +
                "participantId": "007352CE72D50290"
 +
            },
 +
            "text": "How may I help you?",
 +
            "visibility": "All",
 +
            "timestamp": "2014-01-09 11:58:12.035+0200",
 +
            "type": "Text",
 +
            "timestampSeconds": 1389261492035L
 +
        }
 +
    ],
 +
    "notificationType": "NewMessages",
 +
    "messageType": "MessageLogUpdated",
 +
    "facebooksessionUri": "http://localhost:8080/api/v2/facebooksession/0000Wa9CAM6W00FN"
 +
}
 +
 
 +
[[Category:V:HTCC:8.5.2]]

Revision as of 19:44, October 23, 2015

SendMessage

This operation is part of the Facebook Private Messaging API section of the Genesys Web Services REST API.

Overview

This request sends a text message to all Facebook session participants.

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

Parameters

Parameter Value
operationName SendMessage
text The text to send to the customer.

Sample

Request

POST api/v2/me/facebooksession/0071023821aec011
{
  "operationName": "SendMessage",
  "text": "How may I help you?"
}

Response

{
  "statusCode": 0
}

Notification

Here is the list of notifications received after sending a new message:

Notification with new message

{
   "messages": [
       {
           "index": 3,
           "from": {
               "nickname": "TestName",
               "type": "Agent",
               "participantId": "007352CE72D50290"
           },
           "text": "How may I help you?",
           "visibility": "All",
           "timestamp": "2014-01-09 11:58:12.035+0200",
           "type": "Text",
           "timestampSeconds": 1389261492035L
       }
   ],
   "notificationType": "NewMessages",
   "messageType": "MessageLogUpdated",
   "facebooksessionUri": "http://localhost:8080/api/v2/facebooksession/0000Wa9CAM6W00FN"
}
Comments or questions about this documentation? Contact us for support!