Jump to: navigation, search
Line 4: Line 4:
  
 
<h2> Overview </h2>
 
<h2> Overview </h2>
−
This request accepts an incoming facebook private message.
+
This request accepts an incoming Facebook private message.
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
Line 27: Line 27:
 
|-
 
|-
 
|nickname
 
|nickname
−
|agent nickname  
+
|The agent's nickname.
 
|}
 
|}
  
Line 52: Line 52:
 
<h3>Notification</h3>
 
<h3>Notification</h3>
  
−
Here are the list of notifications received after accepting a facebooksession:
+
Here is the list of notifications received after accepting a [[FacebookSessionResource|FacebookSession]]:
  
−
<h4>Status changed to Chatting</h4>
+
<h4>Status changed to '''Chatting'''</h4>
 
<source lang="text">
 
<source lang="text">
 
{
 
{
Line 111: Line 111:
 
</source>
 
</source>
  
−
<h4>Facebooksession history up to the point of joining</h4>
+
<h4>FacebookSession history up to the point of joining</h4>
  
 
<source lang="text">
 
<source lang="text">
Line 189: Line 189:
 
}
 
}
 
</source>
 
</source>
−
 
−
 
−
 
−
[[Category:V:HTCC:8.5.2DRAFT]]
 
  
 
[[Category:V:HTCC:8.5.2DRAFT]]
 
[[Category:V:HTCC:8.5.2DRAFT]]

Revision as of 18:22, September 29, 2015

Accept

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

Overview

This request accepts an incoming Facebook private message.

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

Parameters

Parameter Value
operationName Accept
nickname The agent's nickname.

Sample

Request

POST api/v2/me/facebooksession/0071023821aec011
{
  "operationName": "Accept",
  "nickname": "John Doe"
}

Response

{
  "statusCode": 0
}

Notification

Here is the list of notifications received after accepting a FacebookSession:

Status changed to Chatting

{
    "messageType": "FacebooksessionStateChangeMessage",
    "referenceId": 17,
    "notificationType": "StatusChange",
    "facebooksession": {
        "state": "Chatting",
        "capabilities": [
            "Transfer",
            "Complete",
            "Leave",
            "InFocus",
            "SendMessage",
            "SendStartTypingNotification",
            "SendStopTypingNotification"
        ],
        "id": "0000Na9B26EF002X",
        "uri": "http://localhost:8080/api/v2/facebooksession/0000Na9B26EF002X",
        "participants": []
    }
}

Updated participant list

{
    "messageType": "FacebooksessionStateChangeMessage",
    "notificationType": "ParticipantsUpdated",
    "facebooksession": {
        "state": "Chatting",
        "capabilities": [
            "Transfer",
            "Complete",
            "Leave",
            "InFocus",
            "SendMessage",
            "SendStartTypingNotification",
            "SendStopTypingNotification"
        ],
        "id": "0000Na9B26EF002X",
        "uri": "http://localhost:8080/api/v2/facebooksession/0000Na9B26EF002X",
        "participants": [
            {
                "type": "Agent",
                "nickname": "Marat",
                "participantId": "009052C5E743004C"
            },
            {
                "type": "Customer",
                "nickname": "PersonP",
                "participantId": "009052C5E6D6004A"
            }
        ]
    }
}

FacebookSession history up to the point of joining

{
    "messageType": "MessageLogUpdated",
    "notificationType": "NewMessages",
    "messages": [
        {
            "index": 1,
            "type": "ParticipantJoined",
            "from": {
                "type": "Customer",
                "nickname": "PersonP",
                "participantId": "009052C5E6D6004A"
            },
            "visibility": "All",
            "timestamp": "2014-01-02T14:23:18.000-0800"
        },
        {
            "index": 2,
            "type": "ParticipantJoined",
            "from": {
                "type": "Agent",
                "nickname": "Marat",
                "participantId": "009052C5E743004C"
            },
            "visibility": "All",
            "timestamp": "2014-01-02T14:23:18.109-0800"
        },
        {
            "index": 3,
            "type": "ParticipantLeft",
            "from": {
                "type": "Agent",
                "nickname": "Marat",
                "participantId": "009052C5E743004C"
            },
            "visibility": "All",
            "timestamp": "2014-01-02T14:23:19.909-0800"
        },
        {
            "index": 4,
            "type": "TypingStarted",
            "from": {
                "type": "Customer",
                "nickname": "PersonP",
                "participantId": "009052C5E6D6004A"
            },
            "visibility": "All",
            "timestamp": "2014-01-02T14:23:20.121-0800"
        },
        {
            "index": 5,
            "type": "Text",
            "from": {
                "type": "Customer",
                "nickname": "PersonP",
                "participantId": "009052C5E6D6004A"
            },
            "text": "Hello World",
            "visibility": "All",
            "timestamp": "2014-01-02T14:23:20.126-0800"
        },
        {
            "index": 6,
            "type": "ParticipantJoined",
            "from": {
                "type": "Agent",
                "nickname": "Marat",
                "participantId": "009052C5EF51004D"
            },
            "visibility": "All",
            "timestamp": "2014-01-02T14:23:20.171-0800"
        }
    ],
    "facebooksessionUri": "http://localhost:8080/api/v2/facebooksession/0000Na9B26EF002X"
}
Comments or questions about this documentation? Contact us for support!