Use this request to make a public call using a
If successful, the request returns the Id of the newly created PhoneCall as well as other properties.
The request is made by an App that is registered to a User account.
To create Callback PhoneCalls, issue a HTTP POST request:
This section describes how to format the request to the service.
The following parameters must be sent in the URI fragment.
Id of the User which owns the
All requests to list phone calls support the Standard-Request-Parameters and the custom fields parameter. All parameters are optional.
The maximum number of seconds to wait until one of the phone numbers used picks up.
Total duration of the call, in seconds.
Callback phone calls, the following restrictions apply to the PhoneCall resource sent in the Request Payload.
|extension||UAPI-Extension-Number||Must refer to a |
Must be owned by the user identified by the
Cannot be set to @self and must be specified.
|source||Array<String>||A public phone number.|
|destination||Array<String>||A public phone number.|
The caller name and number.
|nonce||String||A unique string which allows to identify the call created based on the request.|
Short extension numbers can be given as source, extension, and destination, but only when the request is made using an App registered to a User or an Organization.
The Service returns the Id of the newly created PhoneCall and the following HTTP statuses:
|200||The Id of the phone call is returned.|
|204||There is no Id to be returned.|
When it fails, the request returns the following error codes:
|400||extension_invalid||Value supplied in extension parameter is missing or invalid. The parameter must be set to the number of a |
|400||pc_duration_invalid||Value supplied in |
|400||pc_source_invalid||Value supplied in source parameter is missing or invalid. The parameter must be set to a list of extended or short extension numbers or public phone numbers.|
|400||pc_destination_invalid||Value supplied in destination parameter is missing or invalid. The parameter must be set to a list of extended or short extension numbers or public phone numbers.|
|400||pc_timeout_invalid||Value supplied in |
|400||pc_callerid_invalid||Value supplied in |
Below you can find two examples that will help you understand the request and the response.
This example connects two public phone numbers using the
Callback Extension 212. The request is made by an App on behalf of a User.
Assuming that the request has been successful, the Service sends the following answer:
STEP 1: The Service identifies the Extension given in the
STEP 2: Then checks if the Extension corresponds to a
STEP 3: If the Extension is valid, the User of the Extension in question is charged for the phone call.
STEP 4: The Service creates a PhoneCall resource that is owned by the same User.
STEP 5: Then the Service connects with the source numbers given in the
STEP 6: If a
callerId is given in the
Request-Payload, it is displayed to the phone number associated with the source.
callerId must suit the data type. If not sent in the request, the Service will use the one set on the extension given in the
STEP 7: Once the Service connects to the source, it calls the destination phone number given in the
This example makes a call between two phone numbers using a
Callback Extension. The request is made by an App on behalf of a User.
Assuming that the request has been successful, the Service returns the following answer:
The same process as the one for the App registered to the User account occurs.
Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 4.0 International.