v1

latestOpenAPI 3.1.02026-07-24317911.4 MB
Calls (live/active calls)

Make a new Call

post/domains/{domain}/users/{user}/calls

Path parameters

domainstring required

This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. Then using in path for GET you can set to "~" to use the domain name linked to your token/key instead of the domain name itself when reading for your own domain.

Example:example.com
userstring required

This is the main user extension for the user account. ~ can be used to mean "my account" which will extract the user from the token/key used for authentication.

Example:1000

Request body

synchronous'yes' | 'no' required

When synchronous is requested with "yes" the response will be a 200 on success and will contain a valid JSON representiation of the new resource. If no or left off request a 202 "Accepted" will be given in a success case and this can be considered a success. Synchronous responses will be a little slower as the API will process the geo replication request and wait till the local copy has been written and can be read back berfore sending a response.

call-idstring required

This will be the callid for the requested call. This should be a random string generated by your application and stored if you want to read back the call later or end it.

dial-rule-applicationstring

The application can be used to help with next destination selection.

call-term-userstring required

This will be the destination or termination number for the call request. This will be used once the call is connected to the orgination number.

call-orig-userstring

This field will allow you to select the device, user or number the first leg of the call request will connect to. If left blank the origination will be the user@domain of the user making the request.

auto-answer-enabled'yes' | 'no'

If enabled it will request auto answer headers for the first leg (origination) of the call.

caller-id-numberstring

This setting will allow for the callerid of the termination leg to be set, by default it will be the preconfigured callerid of the user making the request.

callback-caller-id-numberstring

This is the callerid that will be used when calling the first leg(callback) of the call request. If left empty it will default to the user's caller id.

Example request

{
  "call-orig-user": "1000@example.com"
}

Response

object required