Jump to: navigation, search
(Update with the copy of version: 8.5.2DRAFT)
(Undo revision 329509 by Jumunn (talk))
Line 42: Line 42:
 
==Sample==
 
==Sample==
 
===Request===
 
===Request===
<source lang="text">
+
<pre>
POST api/v2/me/devices/631608b3-ceb1-472b-ba05-2ae39555b0d1
+
POST api/v2/me/devices/efe1ab32-53f9-43ce-b65e-5768c61f7d4a
 
{
 
{
 
   "operationName": "SetCallDisposition",
 
   "operationName": "SetCallDisposition",
   "callUri": "http://127.0.0.1:8080/api/v2/calls/01RCC3N118B1V0SL8O7GK2LAES000006",
+
   "callUri": "http://localhost:8080/api/v2/calls/011DJV5JI898NB2L04000VTAES00000I",
   "callUuid": "01RCC3N118B1V0SL8O7GK2LAES000006",
+
   "callUuid": "011DJV5JI898NB2L04000VTAES00000I",
   "disposition": "Referred",
+
   "disposition": "IssueResolved",
 
   "dispositionKey": "DispositionCode"
 
   "dispositionKey": "DispositionCode"
 
}
 
}
</source>
+
</pre>
  
 
===Response===
 
===Response===
<source lang="text">
+
<pre>
 
{
 
{
 
   "statusCode": 0
 
   "statusCode": 0
 
}
 
}
</source>
+
</pre>
  
 
===Notification===
 
===Notification===
If this request is sent while the call is still active, GWS delivers a <tt>CallStateChangeMessage</tt>. If the call has been released, there is no notification.
+
If this request is sent while the call is still active, a <tt>CallStateChangeMessage</tt> will be delivered. If the call has been released there will not be a notification.
  
<source lang="text">
+
<pre>
{
+
{
  "data":{
+
  "data": {
      "notificationType":"AttachedDataChanged",
+
    "messageType": "CallStateChangeMessage",
       "call":{
+
    "notificationType": "AttachedDataChanged",
        "id":"01RCC3N118B1V0SL8O7GK2LAES000006",
+
    "extensions": {
        "state":"Established",
+
      "WrapUpTime": 0,
        "callUuid":"01RCC3N118B1V0SL8O7GK2LAES000006",
+
       "BusinessCall": 0
        "connId":"0071027198180006",
+
    },
        "deviceUri":"http://127.0.0.1:8080/api/v2/devices/631608b3-ceb1-472b-ba05-2ae39555b0d1",
+
    "call": {
        "participants":[
+
      "id": "011DJV5JI898NB2L04000VTAES00000I",
            {
+
      "connId": "007102385535e00e",
              "e164Number":"",
+
      "state": "Established",
              "formattedPhoneNumber":"15001",
+
      "callUuid": "011DJV5JI898NB2L04000VTAES00000I",
              "phoneNumber":"15001",
+
      "deviceUri": "http://127.0.0.1:8080/api/v2/devices/efe1ab32-53f9-43ce-b65e-5768c61f7d4a",
              "digits":"15001"
+
      "uri": "http://127.0.0.1:8080/api/v2/me/calls/011DJV5JI898NB2L04000VTAES00000I",
            }
+
      "participants": [
        ],
+
        "5000",
        "dnis":"15000",
+
        "5001"
        "callType":"Internal",
+
      ],
        "capabilities":[
+
      "participantsInfo": [
            "UpdateUserData",
+
        {
            "SendDtmf",
+
          "digits": "5000",
            "InitiateConference",
+
          "e164Number": "5000",
            "Hold",
+
          "formattedPhoneNumber": "5000"
            "SingleStepTransfer",
+
        },
            "InitiateTransfer",
+
        {
            "AttachUserData",
+
          "digits": "5001",
            "DeleteUserDataPair",
+
          "e164Number": "5001",
            "SingleStepConference",
+
          "formattedPhoneNumber": "5001"
            "DeleteUserData",
+
        }
            "Hangup"
+
      ],
        ],
+
      "dnis": "5001",
        "userData":{ 
+
      "callType": "Internal",
            "DispositionCode":"Referred"
+
      "capabilities": [
        },
+
        "AttachUserData",
        "duration":"262",
+
        "InitiateConference",
        "mute":"Off",
+
        "UpdateUserData",
        "supervisorListeningIn":false,
+
        "Hold",
        "monitoredUserMuted":false,
+
        "SingleStepTransfer",
        "monitoring":false,
+
        "DeleteUserData",
        "uri":"http://127.0.0.1:8080/api/v2/me/calls/01RCC3N118B1V0SL8O7GK2LAES000006",
+
        "SingleStepConference",
        "path":"/calls/01RCC3N118B1V0SL8O7GK2LAES000006"
+
        "Hangup",
 +
        "DeleteUserDataPair",
 +
        "SendDtmf",
 +
        "InitiateTransfer",
 +
        "SwitchToListenIn",
 +
        "RemoveParticipantFromConference"
 +
      ],
 +
      "userData": {
 +
        "DispositionCode": "IssueResolved"
 
       },
 
       },
       "phoneNumber":"15000",
+
       "duration": "1173",
       "messageType":"CallStateChangeMessage"
+
      "mute": "Off",
  },
+
       "supervisorListeningIn": false,
  "channel":"/v2/me/calls"
+
      "monitoredUserMuted": false
 +
    },
 +
    "phoneNumber": "5005"
 +
  },
 +
  "channel": "/v2/me/calls"
 
}
 
}
</source>
+
</pre>
  
 
[[Category:V:HTCC:8.5.2]]
 
[[Category:V:HTCC:8.5.2]]

Revision as of 20:12, October 23, 2015

SetCallDisposition

This operation is part of the Voice API section of the Genesys Web Services REST API.

Overview

Sets the disposition for the specified call using the provided parameters.

If the call is active at the time of the request, it will be processed by updating the key in the user data.

If the call has already been released, then EventUserEvent will be sent to propagate the disposition to the reporting solution.

Request URL /api/v2/me/calls/{id}
HTTP Method POST
Required Features api-voice

Parameters

Parameter Value
operationName SetCallDisposition
callUri The URI of the call to disposition.
callUuid The UUID of the call to disposition. This can be obtained from the call resource.
disposition A string value to be used for the call disposition.
dispositionKey An optional string value to be used for the as the userdata key for the call disposition. If not specified, the disposition key configured for the server will be used.

Sample

Request

POST api/v2/me/devices/efe1ab32-53f9-43ce-b65e-5768c61f7d4a
{
  "operationName": "SetCallDisposition",
  "callUri": "http://localhost:8080/api/v2/calls/011DJV5JI898NB2L04000VTAES00000I",
  "callUuid": "011DJV5JI898NB2L04000VTAES00000I",
  "disposition": "IssueResolved",
  "dispositionKey": "DispositionCode"
}

Response

{
  "statusCode": 0
}

Notification

If this request is sent while the call is still active, a CallStateChangeMessage will be delivered. If the call has been released there will not be a notification.

{
  "data": {
    "messageType": "CallStateChangeMessage",
    "notificationType": "AttachedDataChanged",
    "extensions": {
      "WrapUpTime": 0,
      "BusinessCall": 0
    },
    "call": {
      "id": "011DJV5JI898NB2L04000VTAES00000I",
      "connId": "007102385535e00e",
      "state": "Established",
      "callUuid": "011DJV5JI898NB2L04000VTAES00000I",
      "deviceUri": "http://127.0.0.1:8080/api/v2/devices/efe1ab32-53f9-43ce-b65e-5768c61f7d4a",
      "uri": "http://127.0.0.1:8080/api/v2/me/calls/011DJV5JI898NB2L04000VTAES00000I",
      "participants": [
        "5000",
        "5001"
      ],
      "participantsInfo": [
        {
          "digits": "5000",
          "e164Number": "5000",
          "formattedPhoneNumber": "5000"
        },
        {
          "digits": "5001",
          "e164Number": "5001",
          "formattedPhoneNumber": "5001"
        }
      ],
      "dnis": "5001",
      "callType": "Internal",
      "capabilities": [
        "AttachUserData",
        "InitiateConference",
        "UpdateUserData",
        "Hold",
        "SingleStepTransfer",
        "DeleteUserData",
        "SingleStepConference",
        "Hangup",
        "DeleteUserDataPair",
        "SendDtmf",
        "InitiateTransfer",
        "SwitchToListenIn",
        "RemoveParticipantFromConference"
      ],
      "userData": {
        "DispositionCode": "IssueResolved"
      },
      "duration": "1173",
      "mute": "Off",
      "supervisorListeningIn": false,
      "monitoredUserMuted": false
    },
    "phoneNumber": "5005"
  },
  "channel": "/v2/me/calls"
}
Comments or questions about this documentation? Contact us for support!