Versions Compared

Key

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

The GET /telephonyRegions endpoint gets a list of all telephony regions within the VCC account.

Panel
borderColor#eeeeee
bgColorwhite
titleColorwhite
borderWidth1
titleBGColor#7ec9f4
borderStylesolid
titleIn this page

Table of Contents

...

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 telephony regions

...

Code Block
languagepowershell
themeMidnight
curl -L -X GET "https://***.api.newvoicemedia.com/useradmin/telephonyRegions?page=2" \
-H "Accept: application/vnd.newvoicemedia.v4+json" \
-H "Authorization: Bearer <ACCESS_TOKEN>"

Responses

Responses contain a list of all telephony regions within the VCC account.

Successful response

Successful requests return a 200 Success code and a collection of telephony regions.

Example response

Code Block
languagejs
themeMidnight
{
  "meta": {
    "page": 1,
    "count": 2,
    "pageCount": 1,
    "totalCount": 2
  },
  "telephonyRegions": [
    {
      "telephonyRegionId": "0a034465-6a26-4e06-bd99-ccfd49bbf8f7",
      "telephonyRegionName": "Sydney",
      "default": false
    },
    {
      "telephonyRegionId": "a90451bc-f902-4f9c-a2f5-2426c53467cc",
      "telephonyRegionName": "Singapore",
      "default": true
    }
  ]
}

where:

  • telephonyRegions. A collection of telephony regions.
    • telephonyRegionId. The unique ID of the telephony region.
    • telephonyRegionName. The user-friendly name of the telephony region.
    • default. Indicates if the telephony region is the default for your account.