Jump to: navigation, search
(Update with the copy of version: 8.5.2DRAFT)
(Undo revision 329499 by Jumunn (talk))
Line 8: Line 8:
 
==Sample Data==
 
==Sample Data==
 
<source lang="text">
 
<source lang="text">
{
+
{
  "id":"01RCC3N118B1V0SL8O7GK2LAES000010",
+
      "id": "011DJV5JI898NB2L04000VTAES00000I",
  "state":"Established",
+
      "connId": "0072026cb98d140f",
  "callUuid":"01RCC3N118B1V0SL8O7GK2LAES000010",
+
      "state": "Established",
  "connId":"0071027198180020",
+
      "callUuid": "011DJV5JI898NB2L04000VTAES00000I",
  "deviceUri":"http://127.0.0.1:8080/api/v2/devices/631608b3-ceb1-472b-ba05-2ae39555b0d1",
+
      "deviceUri": "http://127.0.0.1:8080/api/v2/devices/9c14cad7-17c4-48d0-8492-7cf0ff92c224",
  "participants":[
+
      "uri": "http://127.0.0.1:8080/api/v2/me/calls/011DJV5JI898NB2L04000VTAES00000I",
      
+
      "participants": [
        "e164Number":"",
+
        "5000"
        "formattedPhoneNumber":"15001",
+
       ],
        "phoneNumber":"15001",
+
      "participantsInfo": [
        "digits":"15001"
+
        {
      }
+
          "digits": "5000",
  ],
+
          "e164Number": "5000",
  "dnis":"15001",
+
          "formattedPhoneNumber": "5000"
  "callType":"Internal",
+
        }
  "capabilities":[
+
      ],
      "UpdateUserData",
+
      "dnis": "5001",
      "SendDtmf",
+
      "callType": "Internal",
      "InitiateConference",
+
      "capabilities": [
      "Hold",
+
        "AttachUserData",
      "SingleStepTransfer",
+
        "InitiateConference",
      "InitiateTransfer",
+
        "UpdateUserData",
      "AttachUserData",
+
        "Hold",
      "DeleteUserDataPair",
+
        "SingleStepTransfer",
      "SingleStepConference",
+
        "DeleteUserData",
      "DeleteUserData",
+
        "SingleStepConference",
      "Hangup",
+
        "Hangup",
       "StartCallRecording"
+
        "DeleteUserDataPair",
  ],
+
        "SendDtmf",
  "userData":{
+
        "InitiateTransfer"
      "AccountNumber":"12345678"
+
       ],
  },
+
      "userData": {
  "duration":"7",
+
        "DispositionCode": "IssueResolved"
  "mute":"Off",
+
      },
  "recordingState":"Stopped",
+
      "duration": "1174",
  "supervisorListeningIn":false,
+
      "mute": "Off",
  "monitoredUserMuted":false,
+
      "supervisorListeningIn": true,
  "monitoring":false,
+
      "monitoredUserMuted": false
  "uri":"http://127.0.0.1:8080/api/v2/me/calls/01RCC3N118B1V0SL8O7GK2LAES000010",
+
    },
  "path":"/calls/01RCC3N118B1V0SL8O7GK2LAES000010"
+
    "phoneNumber": "5001"
}
+
  }
 
</source>
 
</source>
  
Line 59: Line 59:
 
| id
 
| id
 
| The ID of the call.
 
| The ID of the call.
 +
|-
 +
| connId
 +
| The connection ID for the call. This value comes from the Tlib event.
 
|-
 
|-
 
| state
 
| state
Line 65: Line 68:
 
| callUuid
 
| callUuid
 
| The universally unique identifier associated with the call.
 
| The universally unique identifier associated with the call.
|-
 
| connId
 
| The connection ID for the call. This value comes from the Tlib event.
 
 
|-
 
|-
 
| deviceUri
 
| deviceUri
 
| Link to the device for which this state is applicable.
 
| Link to the device for which this state is applicable.
 +
|-
 +
| uri
 +
| The call's resource identifier.
 
|-  
 
|-  
 
| participants
 
| participants
| A collection of participants and their information. If the participant number contains <tt>+country_code</tt>, then the participant contains the following list of structures:
+
| A collection of participants.
 +
|-
 +
| participantsInfo
 +
| If the participant number contains <tt>+country_code</tt>, then participantsInfo contains a list of structures:
 
*"country" &mdash; country infromation of the phone number in the JSON format: <tt>"country":{"name":"United States","code":"US","callingCode":"1"}</tt>
 
*"country" &mdash; country infromation of the phone number in the JSON format: <tt>"country":{"name":"United States","code":"US","callingCode":"1"}</tt>
 
*"location" &mdash; region of the phone number
 
*"location" &mdash; region of the phone number
Line 96: Line 102:
 
| mute
 
| mute
 
| Shows whether the call is muted.
 
| Shows whether the call is muted.
|-
 
| recordingState
 
| Shows the recording state of the call. Possible values are Recording, Paused, Stopped.
 
 
|-
 
|-
 
| supervisorListeningIn
 
| supervisorListeningIn
Line 105: Line 108:
 
| monitoredUserMuted
 
| monitoredUserMuted
 
| This attribute indicates the mute state of the user monitored by the supervisor.
 
| This attribute indicates the mute state of the user monitored by the supervisor.
|-
 
| monitoring
 
| Specifies whether the user is monitoring the call.
 
|-
 
| uri
 
| The call's resource identifier.
 
|-
 
| path
 
| The path to the call resource.
 
 
|}
 
|}
  
 
[[Category:V:HTCC:8.5.2]]
 
[[Category:V:HTCC:8.5.2]]

Revision as of 20:13, October 23, 2015

Call Resource

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

Overview

The call resource includes properties that describe the current state of the call and the available operations given the current state. A full description of the properties included on the call resource and their possible values can be found here.

Sample Data

{
      "id": "011DJV5JI898NB2L04000VTAES00000I",
      "connId": "0072026cb98d140f",
      "state": "Established",
      "callUuid": "011DJV5JI898NB2L04000VTAES00000I",
      "deviceUri": "http://127.0.0.1:8080/api/v2/devices/9c14cad7-17c4-48d0-8492-7cf0ff92c224",
      "uri": "http://127.0.0.1:8080/api/v2/me/calls/011DJV5JI898NB2L04000VTAES00000I",
      "participants": [
        "5000"
      ],
      "participantsInfo": [
        {
          "digits": "5000",
          "e164Number": "5000",
          "formattedPhoneNumber": "5000"
        }
      ],
      "dnis": "5001",
      "callType": "Internal",
      "capabilities": [
        "AttachUserData",
        "InitiateConference",
        "UpdateUserData",
        "Hold",
        "SingleStepTransfer",
        "DeleteUserData",
        "SingleStepConference",
        "Hangup",
        "DeleteUserDataPair",
        "SendDtmf",
        "InitiateTransfer"
      ],
      "userData": {
        "DispositionCode": "IssueResolved"
      },
      "duration": "1174",
      "mute": "Off",
      "supervisorListeningIn": true,
      "monitoredUserMuted": false
    },
    "phoneNumber": "5001"
  }

Resource Details

Field Description
id The ID of the call.
connId The connection ID for the call. This value comes from the Tlib event.
state The current call state (Dialing, Held, Established, and so on).
callUuid The universally unique identifier associated with the call.
deviceUri Link to the device for which this state is applicable.
uri The call's resource identifier.
participants A collection of participants.
participantsInfo If the participant number contains +country_code, then participantsInfo contains a list of structures:
  • "country" — country infromation of the phone number in the JSON format: "country":{"name":"United States","code":"US","callingCode":"1"}
  • "location" — region of the phone number
  • "localPhoneNumber" — phone number in domestic format.
  • "E164digits" — phone number in e.164 format
dnis The "DNIS" attribute of the call, as sent by T-Server.
callType The type of call, such as Internal, Inbound, Outbound, Consult.
capabilities A list of capabilities for the current state. For example, if the current state is "Dialing", the list might be ["HangUp", "Hold"].
userData A map of custom values attached to the call.
duration The duration of the call, in seconds.
mute Shows whether the call is muted.
supervisorListeningIn Specificies whether a supervisor is listening to the call.
monitoredUserMuted This attribute indicates the mute state of the user monitored by the supervisor.
Comments or questions about this documentation? Contact us for support!