Get all callback numbers
The GET /callbackNumbers endpoint gets a list of all callback numbers within the VCC account.
In this page
Most URLs in the example code use the following values:
- ***. To access the API for your region, replace *** with the correct subdomain for your region:
Region URL subdomain Base URL EMEA emea https://emea.api.newvoicemedia.com USA nam https://nam.api.newvoicemedia.com APAC apac https://apac.api.newvoicemedia.com - <ACCESS_TOKEN>. The value represents a bearer access token which you must use to validate every request. Replace <ACCESS_TOKEN> where used with your bearer access token. For information about getting a bearer access token, see How to authenticate with a Vonage Contact Center (VCC) API.
Headers
Header parameters in Requests (User Admin API) apply to this endpoint.
Authorization scopes supported:
| Scope | Access granted |
|---|---|
users:read | Entire endpoint |
users:write | Entire endpoint |
Parameters
The endpoint accepts the following query parameters:
limit
Type | Required | Example |
|---|---|---|
| integer | False | 25 |
The required number of items per page. Minimum of 1. Maximum of 5000. Default is 25.
page
Type | Required | Example |
|---|---|---|
| integer | False | 1 |
The required page. Minimum of 1, maximum of 1000000000. Default is 1.
Requests
Request all callback numbers
curl -L -X GET "https://***.api.newvoicemedia.com/useradmin/callbackNumbers" \ -H "Accept: application/vnd.newvoicemedia.v4+json" \ -H "Authorization: Bearer <ACCESS_TOKEN>"
Request second page of callback numbers
curl -L -X GET "https://***.api.newvoicemedia.com/useradmin/callbackNumbers?page=2" \ -H "Accept: application/vnd.newvoicemedia.v4+json" \ -H "Authorization: Bearer <ACCESS_TOKEN>"
Responses
Responses contain a list of all callback numbers within the VCC account.
Successful response
Successful requests return a 200 Success code and a collection of callback numbers.
Example response
{
"meta": {
"page": 1,
"count": 3,
"pageCount": 1,
"totalCount": 3
},
"callbackNumbers": [
{
"callbackNumberId": "4e29556d-6f8c-934a-abbf-2539ac72b9aa",
"callbackNumberName": "CallbackNumber1",
"callbackNumberClid": "+441111"
},
{
"callbackNumberId": "118135e7-5a08-b79d-d4c7-ae65bbb7181c",
"callbackNumberName": "CallbackNumber2",
"callbackNumberClid": "+481112"
},
{
"callbackNumberId": "75c5a231-d609-3e1d-21a6-a3e88ac0ffe6",
"callbackNumberName": "CallbackNumber3",
"callbackNumberClid": "+481113"
}
]
}
where:
callbackNumbers. A collection of callback numbers.callbackNumberId. The unique ID of the callback number.callbackNumberName. The user-friendly name of the callback number.callbackNumberClid. The callback number that is presented externally when making an outbound call using this callback number.
Try it out
For information, see Trying out Vonage Contact Center APIs.