| Line 8: | Line 8: | ||
|- | |- | ||
! scope="row"| Request URL | ! scope="row"| Request URL | ||
| − | | /api/v2/me/ | + | | /api/v2/me/facebooksessions/''{id}'' |
|- | |- | ||
! scope="row"| HTTP Method | ! scope="row"| HTTP Method | ||
| Line 35: | Line 35: | ||
<source lang="text"> | <source lang="text"> | ||
| − | POST api/v2/me/ | + | POST api/v2/me/facebooksessions/0071023821aec011 |
{ | { | ||
"operationName": "Accept", | "operationName": "Accept", | ||
| Line 52: | Line 52: | ||
<h3>Notification</h3> | <h3>Notification</h3> | ||
| − | Here is the list of notifications received after accepting a [[ | + | Here is the list of notifications received after accepting a [[facebooksessionResource|facebooksessions]]: |
<h4>Status changed to '''Chatting'''</h4> | <h4>Status changed to '''Chatting'''</h4> | ||
<source lang="text"> | <source lang="text"> | ||
{ | { | ||
| − | "messageType": " | + | "messageType": "facebooksessionStateChangeMessage", |
"referenceId": 17, | "referenceId": 17, | ||
"notificationType": "StatusChange", | "notificationType": "StatusChange", | ||
| − | " | + | "facebooksessions": { |
"state": "Chatting", | "state": "Chatting", | ||
"capabilities": [ | "capabilities": [ | ||
| Line 72: | Line 72: | ||
], | ], | ||
"id": "0000Na9B26EF002X", | "id": "0000Na9B26EF002X", | ||
| − | "uri": "http://localhost:8080/api/v2/ | + | "uri": "http://localhost:8080/api/v2/facebooksessions/0000Na9B26EF002X", |
"participants": [] | "participants": [] | ||
} | } | ||
| Line 80: | Line 80: | ||
<source lang="text"> | <source lang="text"> | ||
{ | { | ||
| − | "messageType": " | + | "messageType": "facebooksessionStateChangeMessage", |
"notificationType": "ParticipantsUpdated", | "notificationType": "ParticipantsUpdated", | ||
| − | " | + | "facebooksessions": { |
"state": "Chatting", | "state": "Chatting", | ||
"capabilities": [ | "capabilities": [ | ||
| Line 94: | Line 94: | ||
], | ], | ||
"id": "0000Na9B26EF002X", | "id": "0000Na9B26EF002X", | ||
| − | "uri": "http://localhost:8080/api/v2/ | + | "uri": "http://localhost:8080/api/v2/facebooksessions/0000Na9B26EF002X", |
"participants": [ | "participants": [ | ||
{ | { | ||
| Line 111: | Line 111: | ||
</source> | </source> | ||
| − | <h4> | + | <h4>facebooksession history up to the point of joining</h4> |
<source lang="text"> | <source lang="text"> | ||
| Line 186: | Line 186: | ||
} | } | ||
], | ], | ||
| − | "facebooksessionUri": "http://localhost:8080/api/v2/ | + | "facebooksessionUri": "http://localhost:8080/api/v2/facebooksessions/0000Na9B26EF002X" |
} | } | ||
</source> | </source> | ||
[[Category:V:HTCC:8.5.2DRAFT]] | [[Category:V:HTCC:8.5.2DRAFT]] | ||
Latest revision as of 05:06, January 14, 2019
Accept
This operation is part of the Facebook Private Messaging API section of the Web Services API.
Overview
This request accepts an incoming Facebook private message.
| Request URL | /api/v2/me/facebooksessions/{id} |
|---|---|
| HTTP Method | POST |
| Required Features | api-multimedia |
Parameters
| Parameter | Value |
|---|---|
| operationName | Accept |
| nickname | The agent's nickname. |
Sample
Request
POST api/v2/me/facebooksessions/0071023821aec011
{
"operationName": "Accept",
"nickname": "John Doe"
}Response
{
"statusCode": 0
}Notification
Here is the list of notifications received after accepting a facebooksessions:
Status changed to Chatting
{
"messageType": "facebooksessionStateChangeMessage",
"referenceId": 17,
"notificationType": "StatusChange",
"facebooksessions": {
"state": "Chatting",
"capabilities": [
"Transfer",
"Complete",
"Leave",
"InFocus",
"SendMessage",
"SendStartTypingNotification",
"SendStopTypingNotification"
],
"id": "0000Na9B26EF002X",
"uri": "http://localhost:8080/api/v2/facebooksessions/0000Na9B26EF002X",
"participants": []
}
}Updated participant list
{
"messageType": "facebooksessionStateChangeMessage",
"notificationType": "ParticipantsUpdated",
"facebooksessions": {
"state": "Chatting",
"capabilities": [
"Transfer",
"Complete",
"Leave",
"InFocus",
"SendMessage",
"SendStartTypingNotification",
"SendStopTypingNotification"
],
"id": "0000Na9B26EF002X",
"uri": "http://localhost:8080/api/v2/facebooksessions/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/facebooksessions/0000Na9B26EF002X"
} This page was last edited on January 14, 2019, at 05:06.
Comments or questions about this documentation? Contact us for support!