Jump to: navigation, search
(→‎Samples)
(Update with the copy of version: 8.5.2DRAFT)
 
(14 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
=Dial=
 
=Dial=
−
__TOC__
+
__NOTOC__
−
 
+
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.
−
This request 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
 +
|-
 
|}
 
|}
  
 
==Parameters==
 
==Parameters==
−
 
 
{|
 
{|
 
! Parameter
 
! Parameter
Line 27: 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>
+
|-
−
{
+
| location
−
  "phoneNumber": "5551212"
+
| An optional parameter that is used by Web Services to set the <tt>location</tt> attribute for the corresponding T-Server requests.
−
}
 
−
</pre>
 
 
|-
 
|-
 
| 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>
+
|-
−
{
+
| outboundCallerId
−
  "Product": "Guitars"
+
| An optional parameter that is used by Web Services to set the <tt>outbound caller Id</tt> attribute for the corresponding T-Server requests.
−
}
 
−
</pre>
 
 
|}
 
|}
  
−
==Sample #1==
+
==Sample 1==
−
 
 
 
===Request===
 
===Request===
−
<pre>
+
<source lang="text">
−
POST api/v2/me/devices/efe1ab32-53f9-43ce-b65e-5768c61f7d4a/calls
+
POST api/v2/me/devices/631608b3-ceb1-472b-ba05-2ae39555b0d1/calls
 
   
 
   
 
{
 
{
 
   "operationName": "Dial",
 
   "operationName": "Dial",
 
   "destination": {
 
   "destination": {
−
     "phoneNumber": "5001"
+
     "phoneNumber": "15002"
 
   }
 
   }
 
}
 
}
−
</pre>
+
</source>
  
−
===Response===
+
===HTTP response===
−
<pre>
+
<source lang="text">
 
{
 
{
 
   "statusCode": 0
 
   "statusCode": 0
 
}
 
}
−
</pre>
+
</source>
  
−
===Notification===
+
===CometD notification===
−
<pre>
+
<source lang="text">
 +
{ 
 +
  "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"
 +
}
 +
</source>
 +
 
 +
==Sample 2==
 +
This sample includes a key/value pair with the Dial request:
 +
 
 +
===Request===
 +
<source lang="text">
 +
POST api/v2/me/devices/631608b3-ceb1-472b-ba05-2ae39555b0d1/calls
 
{
 
{
−
   "data": {
+
   "operationName": "Dial",
−
    "messageType": "CallStateChangeMessage",
+
  "destination": {
−
    "notificationType": "StatusChange",
+
     "phoneNumber": "15002"
−
    "call": {
 
−
      "id": "0071023821aec010",
 
−
      "state": "Dialing",
 
−
      "callUuid": "013V08JRL498H1OI04000VTAES00000G",
 
−
      "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/0071023821aec010",
 
−
      "participants": [
 
−
        "5001"
 
−
      ],
 
−
      "participantsInfo": [
 
−
        {
 
−
          "digits": "5001",
 
−
          "e164Number": "5001",
 
−
          "formattedPhoneNumber": "5001"
 
−
        }
 
−
      ],
 
−
      "dnis": "5001",
 
−
      "callType": "Internal",
 
−
      "capabilities": [
 
−
        "DeleteUserDataPair",
 
−
        "AttachUserData",
 
−
        "Hangup",
 
−
        "DeleteUserData",
 
−
        "SendDtmf",
 
−
        "UpdateUserData"
 
−
      ],
 
−
      "duration": "0",
 
−
      "mute": "Off",
 
−
      "supervisorListeningIn": false,
 
−
      "monitoredUserMuted": false
 
−
    },
 
−
     "phoneNumber": "5005"
 
 
   },
 
   },
−
   "channel": "/v2/me/calls"
+
   "userData": {
 +
    "CustomerSegment": "Gold"
 +
  }
 
}
 
}
−
</pre>
+
</source>
  
 +
===HTTP response===
 +
<source lang="text">
 +
{
 +
  "statusCode": 0
 +
}
 +
</source>
 +
 +
===CometD notification===
 +
<source lang="text">
 +
{ 
 +
  "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"
 +
}
 +
</source>
  
  
 
[[Category:V:HTCC:8.5.2]]
 
[[Category:V:HTCC:8.5.2]]

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!