(Update with the copy of version: 8.5.2DRAFT) |
(Update with the copy of version: 8.5.2DRAFT) |
||
| Line 6: | Line 6: | ||
{| | {| | ||
! Request URL | ! Request URL | ||
| − | | /api/v2/me/devices/{id}/calls | + | | /api/v2/me/devices/''{id}''/calls |
|- | |- | ||
| − | ! HTTP | + | ! HTTP method |
| POST | | POST | ||
|- | |- | ||
| − | ! Required | + | ! 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. |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|- | |- | ||
| location | | location | ||
| − | | An optional parameter that is used by Web Services to set the | + | | 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. |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|- | |- | ||
|} | |} | ||
| − | ==Sample | + | ==Sample 1== |
| − | |||
===Request=== | ===Request=== | ||
<source lang="text"> | <source lang="text"> | ||
| Line 60: | Line 48: | ||
</source> | </source> | ||
| − | === | + | ===HTTP response=== |
<source lang="text"> | <source lang="text"> | ||
{ | { | ||
| Line 67: | Line 55: | ||
</source> | </source> | ||
| − | === | + | ===CometD notification=== |
<source lang="text"> | <source lang="text"> | ||
{ | { | ||
| Line 114: | Line 102: | ||
</source> | </source> | ||
| − | ==Sample | + | ==Sample 2== |
| − | This sample includes a key/value pair with the | + | This sample includes a key/value pair with the Dial request: |
===Request=== | ===Request=== | ||
| Line 131: | Line 119: | ||
</source> | </source> | ||
| − | === | + | ===HTTP response=== |
<source lang="text"> | <source lang="text"> | ||
{ | { | ||
| Line 138: | Line 126: | ||
</source> | </source> | ||
| − | + | ===CometD notification=== | |
| − | === | ||
<source lang="text"> | <source lang="text"> | ||
{ | { | ||
Revision as of 18:22, March 25, 2016
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. |
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"
}
Comments or questions about this documentation? Contact us for support!