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 -->
+
= Accept=
 +
__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 accepts an incoming Facebook private message.
 +
{| 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
 +
|Accept
 +
|-
 +
|nickname
 +
|The agent's nickname.
 +
|}
 +
 
 +
<h2>Sample</h2>
 +
 
 +
<h3>Request</h3>
 +
 
 +
<source lang="text">
 +
POST api/v2/me/facebooksession/0071023821aec011
 +
{
 +
  "operationName": "Accept",
 +
  "nickname": "John Doe"
 +
}
 +
</source>
 +
 
 +
<h3>Response</h3>
 +
 
 +
<source lang="text">
 +
{
 +
  "statusCode": 0
 +
}
 +
</source>
 +
 
 +
<h3>Notification</h3>
 +
 
 +
Here is the list of notifications received after accepting a [[FacebookSessionResource|FacebookSession]]:
 +
 
 +
<h4>Status changed to '''Chatting'''</h4>
 +
<source lang="text">
 +
{
 +
    "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": []
 +
    }
 +
}
 +
</source>
 +
<h4>Updated participant list</h4>
 +
<source lang="text">
 +
{
 +
    "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"
 +
            }
 +
        ]
 +
    }
 +
}
 +
</source>
 +
 
 +
<h4>FacebookSession history up to the point of joining</h4>
 +
 
 +
<source lang="text">
 +
{
 +
    "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"
 +
}
 +
</source>
 +
 
 +
[[Category:V:HTCC:8.5.2]]

Revision as of 19:44, October 23, 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!