v1

latestOpenAPI 3.0.02026-07-2449050.9 KB

default

Phone Manual Dial (Token Authentication)

Dial a customer number from a registered phone device using manual mode.

post/ca_apis/PhoneManualDial

Headers

Content-Typestring required

Request body

userNamestring required

CloudAgent account username

custNumberstring required

Customer phone number to be dialed

phoneNamestring required

Registered phone name/ID used to make the call

campaignNamestring required

Campaign name under which the call is initiated

didstring required

DID (Direct Inward Dialing) number from which call is made

uuistring

Optional application data passed for reporting or IVR handling

checkStatusboolean required

Flag to check current dial status before dialing

Example request

{
  "userName": "xxxxx",
  "custNumber": "xxxxx",
  "phoneName": "xxxxx",
  "campaignName": "xxxxxx",
  "did": "xxxxx",
  "uui": "xxxxxx",
  "checkStatus": true
}

Response

Successful response