Jump to: navigation, search
(→‎Sample #2)
 
(8 intermediate revisions by one other user not shown)
Line 1: Line 1:
 
=Dial=
 
=Dial=
 
__NOTOC__
 
__NOTOC__
−
This operation is part of the [[VoiceAPI|Voice API]] section of the [[Welcome|Genesys Web Services REST API]].
+
This operation is part of the [[VoiceAPI|Voice API]] section of the [[Welcome|Web Services API]].
 
==Overview==
 
==Overview==
 
Initiates a new outbound call to the specified destination.
 
Initiates a new outbound call to the specified destination.
 
{|
 
{|
 
! Request URL
 
! Request URL
−
| /api/v2/me/devices/{id}/calls
+
| /api/v2/me/devices/''{id}''/calls
 
|-
 
|-
−
! HTTP Method
+
! HTTP method
 
| POST
 
| POST
 
|-
 
|-
−
! Required Features
+
! Required features
 
| api-voice
 
| api-voice
 
|-
 
|-
Line 17: Line 17:
  
 
==Parameters==
 
==Parameters==
−
 
 
{|
 
{|
 
! Parameter
 
! Parameter
Line 26: Line 25:
 
|-
 
|-
 
| destination
 
| destination
−
| A JSON object that includes the number to be dialed:
+
| A JSON object that includes the number to be dialed.
−
<pre>
 
−
{
 
−
  "phoneNumber": "5551212"
 
−
}
 
−
</pre>
 
 
|-
 
|-
 
| location
 
| location
−
| An optional parameter that is used by GWS to set the "location" attribute for the corresponding TServer requests.  
+
| An optional parameter that is used by Web Services to set the <tt>location</tt> attribute for the corresponding T-Server requests.  
 
|-
 
|-
 
| userData
 
| userData
−
| An optional JSON object that includes key/value data to be included with the call:
+
| An optional JSON object that includes key/value data to be included with the call.
−
<pre>
 
−
{
 
−
  "Product": "Guitars"
 
−
}
 
−
</pre>
 
 
|-
 
|-
 +
| outboundCallerId
 +
| An optional parameter that is used by Web Services to set the <tt>outbound caller Id</tt> attribute for the corresponding T-Server requests.
 
|}
 
|}
  
−
==Sample #1==
+
==Sample 1==
−
 
 
 
===Request===
 
===Request===
 
<source lang="text">
 
<source lang="text">
Line 60: Line 50:
 
</source>
 
</source>
  
−
===Response===
+
===HTTP response===
 
<source lang="text">
 
<source lang="text">
 
{
 
{
Line 67: Line 57:
 
</source>
 
</source>
  
−
===Notification===
+
===CometD notification===
 
<source lang="text">
 
<source lang="text">
−
{
+
{
−
   "data": {
+
   "data":{
−
"notificationType": "StatusChange",
+
      "notificationType":"StatusChange",
−
"call": {
+
      "call":{
−
"id": "012PUFMMS0ASNAK48O7GK2LAES000004",
+
        "id":"012PUFMMS0ASNAK48O7GK2LAES000004",
−
"state": "Dialing",
+
        "state":"Dialing",
−
"callUuid": "012PUFMMS0ASNAK48O7GK2LAES000004",
+
        "callUuid":"012PUFMMS0ASNAK48O7GK2LAES000004",
−
"connId": "007102719260b004",
+
        "connId":"007102719260b004",
−
"deviceUri": "http://hpe-voicevm-70.genesyslab.com:8090/api/v2/devices/631608b3-ceb1-472b-ba05-2ae39555b0d1",
+
        "deviceUri":"http://127.0.0.1:8080/api/v2/devices/631608b3-ceb1-472b-ba05-2ae39555b0d1",
−
"participants": [
+
        "participants":[
−
{
+
            {
−
"e164Number": "",
+
              "e164Number":"",
−
"formattedPhoneNumber": "15002",
+
              "formattedPhoneNumber":"15002",
−
"phoneNumber": "15002",
+
              "phoneNumber":"15002",
−
"digits": "15002"
+
              "digits":"15002"
−
}
+
            }
−
],
+
        ],
−
"dnis": "15002",
+
        "dnis":"15002",
−
"callType": "Internal",
+
        "callType":"Internal",
−
"capabilities": [
+
        "capabilities":[
−
"SendDtmf",
+
            "SendDtmf",
−
"DeleteUserData",
+
            "DeleteUserData",
−
"AttachUserData",
+
            "AttachUserData",
−
"DeleteUserDataPair",
+
            "DeleteUserDataPair",
−
"Hangup",
+
            "Hangup",
−
"UpdateUserData"
+
            "UpdateUserData"
−
],
+
        ],
−
"duration": "0",
+
        "duration":"0",
−
"mute": "Off",
+
        "mute":"Off",
−
"supervisorListeningIn": false,
+
        "supervisorListeningIn":false,
−
"monitoredUserMuted": false,
+
        "monitoredUserMuted":false,
−
"monitoring": false,
+
        "monitoring":false,
−
"uri": "http://hpe-voicevm-70.genesyslab.com:8090/api/v2/me/calls/012PUFMMS0ASNAK48O7GK2LAES000004",
+
        "uri":"http://127.0.0.1:8080/api/v2/me/calls/012PUFMMS0ASNAK48O7GK2LAES000004",
−
"path": "/calls/012PUFMMS0ASNAK48O7GK2LAES000004"
+
        "path":"/calls/012PUFMMS0ASNAK48O7GK2LAES000004"
−
},
+
      },
−
"phoneNumber": "15000",
+
      "phoneNumber":"15000",
−
"extensions": {
+
      "extensions":{
−
"BusinessCall": 0
+
        "BusinessCall":0
−
},
+
      },
−
"messageType": "CallStateChangeMessage",
+
      "messageType":"CallStateChangeMessage"
−
"metrics": {
+
  },
−
"eventProcessing": {
+
   "channel":"/v2/me/calls"
−
"nodeProcessingTimeNanos": 4911602,
 
−
"serverGenerationTimestamp": 1444920326391,
 
−
"serverProcessingTimeTotalMs": 5
 
−
}
 
−
},
 
−
   "channel": "/v2/me/calls",
 
−
  }
 
 
}
 
}
 
</source>
 
</source>
  
−
==Sample #2==
+
==Sample 2==
−
This sample includes a key/value pair with the <tt>Dial</tt> request:
+
This sample includes a key/value pair with the Dial request:
  
 
===Request===
 
===Request===
Line 138: Line 121:
 
</source>
 
</source>
  
−
===Response===
+
===HTTP response===
 
<source lang="text">
 
<source lang="text">
 
{
 
{
Line 145: Line 128:
 
</source>
 
</source>
  
−
 
+
===CometD notification===
−
===Notification===
 
 
<source lang="text">
 
<source lang="text">
 
{   
 
{   
Line 156: Line 138:
 
         "callUuid":"012PUFMMS0ASNAK48O7GK2LAES000004",
 
         "callUuid":"012PUFMMS0ASNAK48O7GK2LAES000004",
 
         "connId":"007102719260b004",
 
         "connId":"007102719260b004",
−
         "deviceUri":"http://hpe-voicevm-70.genesyslab.com:8090/api/v2/devices/631608b3-ceb1-472b-ba05-2ae39555b0d1",
+
         "deviceUri":"http://127.0.0.1:8080/api/v2/devices/631608b3-ceb1-472b-ba05-2ae39555b0d1",
 
         "participants":[   
 
         "participants":[   
 
             {   
 
             {   
Line 183: Line 165:
 
         "monitoredUserMuted":false,
 
         "monitoredUserMuted":false,
 
         "monitoring":false,
 
         "monitoring":false,
−
         "uri":"http://hpe-voicevm-70.genesyslab.com:8090/api/v2/me/calls/012PUFMMS0ASNAK48O7GK2LAES000004",
+
         "uri":"http://127.0.0.1:8080/api/v2/me/calls/012PUFMMS0ASNAK48O7GK2LAES000004",
 
         "path":"/calls/012PUFMMS0ASNAK48O7GK2LAES000004"
 
         "path":"/calls/012PUFMMS0ASNAK48O7GK2LAES000004"
 
       },
 
       },

Latest revision as of 17:41, July 7, 2021

Dial

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

Overview

Initiates a new outbound call to the specified destination.

Request URL /api/v2/me/devices/{id}/calls
HTTP method POST
Required features api-voice

Parameters

Parameter Value
operationName Dial
destination A JSON object that includes the number to be dialed.
location An optional parameter that is used by Web Services to set the location attribute for the corresponding T-Server requests.
userData An optional JSON object that includes key/value data to be included with the call.
outboundCallerId An optional parameter that is used by Web Services to set the outbound caller Id attribute for the corresponding T-Server requests.

Sample 1

Request

POST api/v2/me/devices/631608b3-ceb1-472b-ba05-2ae39555b0d1/calls
 
{
  "operationName": "Dial",
  "destination": {
    "phoneNumber": "15002"
  }
}

HTTP response

{
  "statusCode": 0
}

CometD notification

{  
   "data":{  
      "notificationType":"StatusChange",
      "call":{  
         "id":"012PUFMMS0ASNAK48O7GK2LAES000004",
         "state":"Dialing",
         "callUuid":"012PUFMMS0ASNAK48O7GK2LAES000004",
         "connId":"007102719260b004",
         "deviceUri":"http://127.0.0.1:8080/api/v2/devices/631608b3-ceb1-472b-ba05-2ae39555b0d1",
         "participants":[  
            {  
               "e164Number":"",
               "formattedPhoneNumber":"15002",
               "phoneNumber":"15002",
               "digits":"15002"
            }
         ],
         "dnis":"15002",
         "callType":"Internal",
         "capabilities":[  
            "SendDtmf",
            "DeleteUserData",
            "AttachUserData",
            "DeleteUserDataPair",
            "Hangup",
            "UpdateUserData"
         ],
         "duration":"0",
         "mute":"Off",
         "supervisorListeningIn":false,
         "monitoredUserMuted":false,
         "monitoring":false,
         "uri":"http://127.0.0.1:8080/api/v2/me/calls/012PUFMMS0ASNAK48O7GK2LAES000004",
         "path":"/calls/012PUFMMS0ASNAK48O7GK2LAES000004"
      },
      "phoneNumber":"15000",
      "extensions":{  
         "BusinessCall":0
      },
      "messageType":"CallStateChangeMessage"
   },
   "channel":"/v2/me/calls"
}

Sample 2

This sample includes a key/value pair with the Dial request:

Request

POST api/v2/me/devices/631608b3-ceb1-472b-ba05-2ae39555b0d1/calls
{
  "operationName": "Dial",
  "destination": {
    "phoneNumber": "15002"
  },
  "userData": {
    "CustomerSegment": "Gold"
  }
}

HTTP response

{
  "statusCode": 0
}

CometD notification

{  
   "data":{  
      "notificationType":"StatusChange",
      "call":{  
         "id":"012PUFMMS0ASNAK48O7GK2LAES000004",
         "state":"Dialing",
         "callUuid":"012PUFMMS0ASNAK48O7GK2LAES000004",
         "connId":"007102719260b004",
         "deviceUri":"http://127.0.0.1:8080/api/v2/devices/631608b3-ceb1-472b-ba05-2ae39555b0d1",
         "participants":[  
            {  
               "e164Number":"",
               "formattedPhoneNumber":"15002",
               "phoneNumber":"15002",
               "digits":"15002"
            }
         ],
         "dnis":"15002",
         "callType":"Internal",
         "capabilities":[  
            "SendDtmf",
            "DeleteUserData",
            "AttachUserData",
            "DeleteUserDataPair",
            "Hangup",
            "UpdateUserData"
         ],
         "userData":{  
            "CustomerSegment":"Gold"
         },
         "duration":"0",
         "mute":"Off",
         "supervisorListeningIn":false,
         "monitoredUserMuted":false,
         "monitoring":false,
         "uri":"http://127.0.0.1:8080/api/v2/me/calls/012PUFMMS0ASNAK48O7GK2LAES000004",
         "path":"/calls/012PUFMMS0ASNAK48O7GK2LAES000004"
      },
      "phoneNumber":"15000",
      "extensions":{  
         "BusinessCall":0
      },
      "messageType":"CallStateChangeMessage"
   },
   "channel":"/v2/me/calls"
}
This page was last edited on July 7, 2021, at 17:41.
Comments or questions about this documentation? Contact us for support!