Jump to: navigation, search
(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...")
 
(Replaced string /facebooksession/ with /facebooksessions/)
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
=SetDisposition=
 
=SetDisposition=
 
__NOTOC__
 
__NOTOC__
−
This operation is part of the [[FacebookPM|Facebook Private Messaging API]] section of the [[Welcome|Genesys Web Services REST API]].
+
This operation is part of the [[FacebookPM|Facebook Private Messaging API]] section of the [[Welcome|Web Services API]].
  
 
<h2> Overview </h2>
 
<h2> Overview </h2>
  
−
This request sets the disposition for the specified facebook session using the provided parameters, it will be processed by updating the key in the user data.  
+
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"
 
|-
 
|-
 
! scope="row"| Request URL
 
! scope="row"| Request URL
−
| /api/v2/me/facebooksession/{id}
+
| /api/v2/me/facebooksessions/{id}
 
|-
 
|-
 
! scope="row"| HTTP Method
 
! scope="row"| HTTP Method
Line 29: Line 29:
 
|-
 
|-
 
|disposition
 
|disposition
−
|A string value to be used for the facebooksession disposition.  
+
|A string value to be used for the FacebookSession disposition.  
 
|-
 
|-
 
|dispositionKey
 
|dispositionKey
−
|An optional string value to be used for the as the userdata key for the facebooksession disposition. If not specified, the disposition key configured for the server will be used.
+
|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 39: Line 39:
 
<h3>Request</h3>
 
<h3>Request</h3>
 
<source lang="text">
 
<source lang="text">
−
POST api/v2/me/facebooksession/0000Na9B26EF003M  
+
POST api/v2/me/facebooksessions/0000Na9B26EF003M  
  
 
{
 
{
Line 59: Line 59:
 
<source lang="text">
 
<source lang="text">
 
{
 
{
−
     u'referenceId': 34,
+
     'referenceId': 34,
−
     u'facebooksession': {
+
     'facebooksession': {
−
         u'participants': [
+
         'participants': [
 
             {
 
             {
−
                 u'nickname': u'TestName',
+
                 'nickname': 'TestName',
−
                 u'type': u'Agent',
+
                 'type': 'Agent',
−
                 u'participantId': u'009052C73228006D'
+
                 'participantId': '009052C73228006D'
 
             },
 
             },
 
             {
 
             {
−
                 u'nickname': u'FirstL',
+
                 'nickname': 'FirstL',
−
                 u'type': u'Customer',
+
                 'type': 'Customer',
−
                 u'participantId': u'009052C73223006B'
+
                 'participantId': '009052C73223006B'
 
             }
 
             }
 
         ],
 
         ],
−
         u'state': u'Chatting',
+
         'state': 'Chatting',
−
         u'id': u'0000Na9B26EF003M',
+
         'id': '0000Na9B26EF003M',
−
         u'capabilities': [
+
         'capabilities': [
−
             u'Transfer',
+
             'Transfer',
−
             u'Complete',
+
             'Complete',
−
             u'Leave',
+
             'Leave',
−
             u'InFocus',
+
             'InFocus',
−
             u'SendMessage',
+
             'SendMessage',
−
             u'SendStartTypingNotification',
+
             'SendStartTypingNotification',
−
             u'SendStopTypingNotification'
+
             'SendStopTypingNotification'
 
         ],
 
         ],
 
         "userData": {
 
         "userData": {
 
             "DispositionCode": "IssueResolved"
 
             "DispositionCode": "IssueResolved"
 
         },
 
         },
−
         u'uri': u'http: //localhost:8080/api/v2/facebooksession/0000Na9B26EF003M'
+
         'uri': 'http: //localhost:8080/api/v2/facebooksessions/0000Na9B26EF003M'
 
     },
 
     },
−
     u'notificationType': u'PropertiesUpdated',
+
     'notificationType': 'PropertiesUpdated',
−
     u'messageType': u'FacebooksessionStateChangeMessage'
+
     'messageType': 'FacebooksessionStateChangeMessage'
 
}
 
}
 
</source>
 
</source>
  
 
[[Category:V:HTCC:8.5.2DRAFT]]
 
[[Category:V:HTCC:8.5.2DRAFT]]

Latest revision as of 06:00, January 17, 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 17, 2019, at 06:00.
Comments or questions about this documentation? Contact us for support!