Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The GET /callbackNumbers endpoint gets a list of all callback numbers within the VCC account.

...

Type

Required

Example

integerFalse25

The required number of items per page. Minimum of 1. Maximum of 5000. Default is 25.

page

Type

Required

Example

integerFalse1

The required page. Minimum of 1, maximum of 1000000000. Default is 1.

Requests

Request all callback numbers

...

Code Block
languagepowershell
themeMidnight
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

Code Block
languagejs
themeMidnight
{
  "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.

Insert excerpt
_ExcerptRunInPostman
_ExcerptRunInPostman
nopaneltrue