Jump to: navigation, search
(Created Fix blank page For Version: HTCC:8.5.2)
 
(Update with the copy of version: 8.5.2DRAFT)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
−
<!-- Creation of the fix page -->
+
=SetDisposition=
 +
__NOTOC__
 +
This operation is part of the [[FacebookPM|Facebook Private Messaging API]] section of the [[Welcome|Web Services API]].
 +
 
 +
<h2> Overview </h2>
 +
 
 +
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"
 +
|-
 +
! scope="row"| Request URL
 +
| /api/v2/me/facebooksessions/{id}
 +
|-
 +
! scope="row"| HTTP Method
 +
| POST
 +
|-
 +
! scope="row" | Required Features
 +
| api-multimedia
 +
|}
 +
<h2>Parameters</h2>
 +
 
 +
{| class="wikitable"
 +
|-
 +
! 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.
 +
|}
 +
 
 +
<h2>Sample</h2>
 +
 
 +
<h3>Request</h3>
 +
<source lang="text">
 +
POST api/v2/me/facebooksessions/0000Na9B26EF003M
 +
 
 +
{
 +
'operationName': 'SetDisposition',
 +
'dispositionKey': 'DispositionCode',
 +
'disposition': 'IssueResolved'
 +
}
 +
</source>
 +
<h3>Response</h3>
 +
 
 +
<source lang="text">
 +
{
 +
  "statusCode": 0
 +
}
 +
</source>
 +
 
 +
<h3>Notification</h3>
 +
 
 +
<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": {
 +
            "DispositionCode": "IssueResolved"
 +
        },
 +
        'uri': 'http: //localhost:8080/api/v2/facebooksessions/0000Na9B26EF003M'
 +
    },
 +
    'notificationType': 'PropertiesUpdated',
 +
    'messageType': 'FacebooksessionStateChangeMessage'
 +
}
 +
</source>
 +
 
 +
[[Category:V:HTCC:8.5.2]]

Latest revision as of 03:11, January 24, 2019

SetDisposition

This operation is part of the Facebook Private Messaging API section of the Web Services 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/facebooksessions/{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/facebooksessions/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/facebooksessions/0000Na9B26EF003M'
    },
    'notificationType': 'PropertiesUpdated',
    'messageType': 'FacebooksessionStateChangeMessage'
}
This page was last edited on January 24, 2019, at 03:11.
Comments or questions about this documentation? Contact us for support!