Excerpt |
---|
This method allows making PhoneCalls using a Callback Extension. |
Table of Contents maxLevel 3 exclude Apps Using This, Quick Examples, Need Help?
Request/Response model
Overview
Use this request to make a public call using a Callback
Extension.
If successful, the request returns the Id of the newly created PhoneCall as well as other properties.
The Id can be used later to query the status of the phone call, hang it up or update it using the available actions.
The request is made by an App that is registered to a User account.
To create Callback PhoneCalls, issue a HTTP POST request:
Panel | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
HTTP-Method = "POST" URI-Fragment = "/uapi/phoneCalls/" User-Id "/callback" Query-Parameters = multiple Request-Payload = PhoneCall Return-Object = Array<PhoneCall> |
Panel | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
POST /uapi/phoneCalls/@me/callback HTTP/1.1 HOST |
Request
This section describes how to format the request to the service.
Anchor | ||||
---|---|---|---|---|
|
URI fragment
The following parameters must be sent in the URI fragment.
Name | Type | Required | Description |
---|---|---|---|
userId | User-Id | Yes | Id of the User which owns the |
Anchor | ||||
---|---|---|---|---|
|
Query Parameters Parameters
All requests to list phone calls support the the Standard-Request-Parameters and and the custom fields parameter. All parameters are optional.
Name | Type | Required | Description |
---|---|---|---|
waitForPickup | Number | No | The maximum number of seconds to wait until one of the phone numbers used picks upThe maximum number of seconds to wait until one of the phone numbers used picks up. |
callDuration | Number | No | Total duration of the call, in seconds. |
Anchor | ||||
---|---|---|---|---|
|
Request Payload Payload
When making Callback
phone calls, the following restrictions apply to the PhoneCall resource sent in the Request Payload.
Name | Type | Description |
---|---|---|
extension | UAPI-Extension-Number | Must refer to a a Callback Extension.Must be owned by the user identified by the userId sent in the URI-Fragment.Cannot be set to @self and must be specified. |
source | Array<String> | A public phone number. |
destination | Array<String> | A public phone number. |
callerId | UAPI-Caller-Id | The caller name and number. |
nonce | String | A unique string which allows to identify the call created based on the request. |
Tip |
---|
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. |
Response
Success
The Service returns the Id of the newly created PhoneCall and and the following HTTP statuses:
HTTP Code | Description |
200 | The Id of the phone call is returned. |
204 | There is no Id to be returned. |
Failure
When it fails, the request returns the following error codes:
HTTP Code | Code | Description |
---|---|---|
400 | extension_invalid | Value supplied in extension parameter is missing or invalid. The parameter must be set to the number of a Callback extension that must be owned by the user. |
400 | pc_duration_invalid | Value supplied in callDuration parameter is missing or invalid. The parameter must be set to a numeric value and represents the mandatory duration of a phone call in seconds. |
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 waitForPickup parameter is missing or invalid. The parameter must be numeric and higher than 0. |
400 | pc_callerid_invalid | Value supplied in callerId parameter is missing or invalid. The parameter must be set to a value with the format: John Doe <+3334444>. |
Examples
Below you can find two examples that will help you understand the request and the response.
Localtab Group | ||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 4.0 International.