(Created page with "=SetDisposition= __NOTOC__ This operation is part of the Facebook Private Messaging API section of the Genesys Web Services REST API. <h2> Overview...") |
|||
| Line 5: | Line 5: | ||
<h2> Overview </h2> | <h2> Overview </h2> | ||
| − | This request sets the disposition for the specified | + | This request sets the disposition for the specified Facebook session using the provided parameters. It is processed by updating the key in the UserData. |
{| class="wikitable" | {| class="wikitable" | ||
| Line 29: | Line 29: | ||
|- | |- | ||
|disposition | |disposition | ||
| − | |A string value to be used for the | + | |A string value to be used for the FacebookSession disposition. |
|- | |- | ||
|dispositionKey | |dispositionKey | ||
| − | |An optional string value to be used for the | + | |An optional string value to be used for the UserData key to denote the FacebookSession disposition. If not specified, the disposition key configured for the server is used. |
|} | |} | ||
| Line 59: | Line 59: | ||
<source lang="text"> | <source lang="text"> | ||
{ | { | ||
| − | + | 'referenceId': 34, | |
| − | + | 'facebooksession': { | |
| − | + | 'participants': [ | |
{ | { | ||
| − | + | 'nickname': 'TestName', | |
| − | + | 'type': 'Agent', | |
| − | + | 'participantId': '009052C73228006D' | |
}, | }, | ||
{ | { | ||
| − | + | 'nickname': 'FirstL', | |
| − | + | 'type': 'Customer', | |
| − | + | 'participantId': '009052C73223006B' | |
} | } | ||
], | ], | ||
| − | + | 'state': 'Chatting', | |
| − | + | 'id': '0000Na9B26EF003M', | |
| − | + | 'capabilities': [ | |
| − | + | 'Transfer', | |
| − | + | 'Complete', | |
| − | + | 'Leave', | |
| − | + | 'InFocus', | |
| − | + | 'SendMessage', | |
| − | + | 'SendStartTypingNotification', | |
| − | + | 'SendStopTypingNotification' | |
], | ], | ||
"userData": { | "userData": { | ||
"DispositionCode": "IssueResolved" | "DispositionCode": "IssueResolved" | ||
}, | }, | ||
| − | + | 'uri': 'http: //localhost:8080/api/v2/facebooksession/0000Na9B26EF003M' | |
}, | }, | ||
| − | + | 'notificationType': 'PropertiesUpdated', | |
| − | + | 'messageType': 'FacebooksessionStateChangeMessage' | |
} | } | ||
</source> | </source> | ||
[[Category:V:HTCC:8.5.2DRAFT]] | [[Category:V:HTCC:8.5.2DRAFT]] | ||
Revision as of 19:39, September 29, 2015
SetDisposition
This operation is part of the Facebook Private Messaging API section of the Genesys Web Services REST API.
Overview
This request sets the disposition for the specified Facebook session using the provided parameters. It is processed by updating the key in the UserData.
| Request URL | /api/v2/me/facebooksession/{id} |
|---|---|
| HTTP Method | POST |
| Required Features | api-multimedia |
Parameters
| Parameter | Value |
|---|---|
| operationName | SetDisposition |
| disposition | A string value to be used for the FacebookSession disposition. |
| dispositionKey | An optional string value to be used for the UserData key to denote the FacebookSession disposition. If not specified, the disposition key configured for the server is used. |
Sample
Request
POST api/v2/me/facebooksession/0000Na9B26EF003M
{
'operationName': 'SetDisposition',
'dispositionKey': 'DispositionCode',
'disposition': 'IssueResolved'
}Response
{
"statusCode": 0
}Notification
{
'referenceId': 34,
'facebooksession': {
'participants': [
{
'nickname': 'TestName',
'type': 'Agent',
'participantId': '009052C73228006D'
},
{
'nickname': 'FirstL',
'type': 'Customer',
'participantId': '009052C73223006B'
}
],
'state': 'Chatting',
'id': '0000Na9B26EF003M',
'capabilities': [
'Transfer',
'Complete',
'Leave',
'InFocus',
'SendMessage',
'SendStartTypingNotification',
'SendStopTypingNotification'
],
"userData": {
"DispositionCode": "IssueResolved"
},
'uri': 'http: //localhost:8080/api/v2/facebooksession/0000Na9B26EF003M'
},
'notificationType': 'PropertiesUpdated',
'messageType': 'FacebooksessionStateChangeMessage'
}
Comments or questions about this documentation? Contact us for support!