Loading
Cart Total
$0.00
-
Your shopping cart is empty
Loading
Hello! Log in Your Account
New customer? Start here
Phone Calls & CDR Data
Storefronts
Customer Management
VoIP Bundle (Subscriptions)
SIP Account Management
Audio Management
Phone Numbers & Call Routing
Phone Calls & CDR Data
VoIP Phone Short Code
eFax Management
Voicemails & Mailboxes
Caller ID
SIP Trunks
Wallboard Statistics
VoIP Phone Provisioning
Call Queueing
Phone Books
VoIP Phone Speed Dial
Text (SMS) Messaging
Create outbound calls, there are two ways to use this command, the first is to specify a SIP User or Hunt Group UUID, this method will cause the target users phone to ring. When the user answers the call, the system will then place an outbound call to the destination number. The second method is to provide a call route UUID or JSON data, this will trigger an outbound call to the destination number, on answering the call the number will be placed into the provided call route
Become a ResellerFilter:
* You will be charged every time this command is run.
Creates a new outbound call, either by ringing the target users or using a call route
Back to top
Request Details
Response Details
This command has no URL/Query String parameters
POST body
Name
Type
Required
destination
String
True
The destination phone number to call, the number should be in E164 format for outbound calls, you may also provide extension numbers of your hunt groups, users and call routes
display_name
String
True
What display name should be sent to the user, this will show as the name on their phone (where supported)
targets
Array of OutboundCallTarget
False
The list of SIP user or Hunt Group UUID's who will receive the outbound call request, valid types are `sipuser` or `huntgroup`
user_uuid
String
False
The UUID of the SIP user to make the outbound call for
JSON all-fields example:
{
"destination" : "+443301226000",
"display_name" : "CRM Initiated Call",
"targets" : [
{
"type" : "sipuser",
"uuid" : "4096560c-6cb1-4eb7-bf2a-fb2069bcd947"
},
{
"type" : "huntgroup",
"uuid" : "be3f325e-4522-4452-a286-84334cd2b7de"
}
],
"user_uuid" : "684132b0-6a20-4680-8c1e-adf2d5e5a4aa"
}
201 Response
{
"result" : {},
"status_code" : 201,
"status_message" : "Created"
}
404 Response
{
"result" : {},
"status_code" : 404,
"status_message" : "Not Found"
}