Jump to: navigation, search

SetDisposition

This operation is part of the SMS Session API section of the Web Services API.

Overview

This sets the disposition for a specified SMS session using the provided parameters. It will be processed by updating the key in the user data.

Request URL /api/v2/me/smsessions/{id}
HTTP Method POST
Required Features api-multimedia

Parameters

Parameter Value
operationName SetDisposition
disposition A string value to be used for the SMS session disposition.
dispositionKey An optional string value to be used for the userdata key for the SMS session disposition. If not specified, the disposition key configured for the server will be used.

Sample

Request

POST api/v2/me/smsessions/0000Na9B26EF003M 
 
{
 'operationName': 'SetDisposition', 
 'dispositionKey': 'DispositionCode', 
 'disposition': 'IssueResolved'
}

Response

{
  "statusCode": 0
}

Notification

{
    u'referenceId': 34,
    u'smsession': {
        u'participants': [
            {
                u'nickname': u'TestName',
                u'type': u'Agent',
                u'participantId': u'009052C73228006D'
            },
            {
                u'nickname': u'FirstL',
                u'type': u'Customer',
                u'participantId': u'009052C73223006B'
            }
        ],
        u'state': u'Chatting',
        u'id': u'0000Na9B26EF003M',
        u'capabilities': [
            u'Transfer',
            u'Complete',
            u'Leave',
            u'InFocus',
            u'SendMessage',
            u'SendStartTypingNotification',
            u'SendStopTypingNotification'
        ],
        "userData": {
            "DispositionCode": "IssueResolved"
        },
        u'uri': u'http: //localhost:8080/api/v2/smsessions/0000Na9B26EF003M'
    },
    u'notificationType': u'PropertiesUpdated',
    u'messageType': u'SMSsessionStateChangeMessage'
}

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on November 4, 2016, at 09:54.