Place a new call to a telephone number

post https://api-us.webexconnect.io/v1/voice/calls

📘
Note:
Once call is anwered by the end user ,Webex Connect will send "answered event" to the URL configured in the API request.The client's application should send one of the following actions as response to the event.

Actions

Action Name	Description
Answered	Answered action is sent from developer application to Webex Connect, to inform Webex Connect to answer the call
Hangup	Hangup action is sent from developer application to Webex Connect, to inform Webex Connect to hangup or reject the call
Play	Play action is sent from developer application to Webex Connect, to play the provided content file or to use TTS to play the audio corresponding to the TTS text which was specified.
Patch	Patch action is sent from developer application to Webex Connect, to inform Webex Connect to perform call patch operation.
Record	Record action is sent from developer application to Webex Connect, to inform Webex Connectt to perform record operation.

All these actions have to include 200 OK as the response header.

Body Params

callerId

string

required

The calling party number to use when placing the call to the dialed number

dialedNumber

string

required

Number to dial and start call sessions with.

callbackUrl

string

required

URL for event callbacks that will provide the next actions for the call

recordCallSeconds

integer

If present and a positive value, record the call for this many seconds. A value of 0 means to record until the end of the call.

detectVoiceMail

boolean

Defaults to false

Not supported currently.

correlationId

string

A user-provided arbitrary string value that will be stored with the call status and sent in all callback events.

Headers

Idempotency-Key

string

required

length ≤ 64

An optional user provided value that is used to prevent duplicate requests. API requests with an Idempotency-Key value that has been used in the previous 1 hours will be rejected as a duplicate request.

Responses

Callback

Language

Credentials

Bearer


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api-us.webexconnect.io/v1/voice/calls \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "detectVoiceMail": false
8
}
9
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

📘Note:

Actions

202accepted

400bad input parameter.

401unauthorized i.e. customer doestn't exist or customer account over quota

404resource not found

405method not allowed

409conflict

429too many requests (for rate limiting)

5XXInternal server error

📘
Note: