Extension API

Retrieve information about extensions.

Get account extensions data by account ID

GET https://api.vonage.com/t/vbc.prod/provisioning/api/accounts/:account_id/extensions

Authentication

Key Description Example Default
Authorization Your OAuth token.
Read more about OAuth tokens
Bearer <access_token> None

Path Parameters

Key Description Example Default
account_id
Required | string

The account ID

None None

Query Parameter

Key Description Example Default
page_size
number

Number of records per page

10 None
page
number

Current page number

10 None
location_id
number

Filter by location id

123456 None
phone_number
string

Filter by phone number

14155550100 None
login_name
string

Filter by login name

jsmith None
email
string

Filter by email address

john.smith@example.com None

Hide response field descriptions

Response Fields

Field Description
page_size
number

Number of records per page

page
number

Current page number

total_pages
number

Total number of pages

total_items
number

Total number of records

_embedded
object
Field Description
data
object
Field Description
extension_number
string

Extension number

user
object
Field Description
email
string

Email address of the user

login_name
string

Login name of the user

first_name
string

First name of the user

last_name
string

Last name of the user

location_id
number

Unique identifier of the assigned location

vtt_enabled
boolean

Voicemail transcription status of the location

dnd_enabled
boolean

Do Not Disturb status of the extension

caller_id
string

Caller ID of the extension

block_caller_id
boolean

Block Caller ID status of the extension

dids
array of objects

Collection of phone numbers assigned to the extension

Field Description
phone_number
string

Phone number

custom_tag
string

Custom tag associated with the phone number

extension_handsets
array of objects

Collection of handsets assigned to the extension

Field Description
handset_name
string

Name of the handset

sip_id
string

SIP identifier of the handset

{
  "page_size": 10,
  "page": 1,
  "total_pages": 10,
  "total_items": 100,
  "_links": {
    "first": {
      "href": "abc123"
    },
    "prev": {
      "href": "abc123"
    },
    "self": {
      "href": "abc123"
    },
    "next": {
      "href": "abc123"
    }
  },
  "_embedded": {
    "data": {
      "extension_number": "789",
      "user": {
        "email": "john.smith@example.com",
        "login_name": "jsmith",
        "first_name": "John",
        "last_name": "Smith"
      },
      "location_id": 123456,
      "vtt_enabled": true,
      "dnd_enabled": false,
      "caller_id": "John Smith",
      "block_caller_id": false,
      "dids": [
        {
          "phone_number": "14155550100",
          "custom_tag": "My Tag"
        }
      ],
      "extension_handsets": [
        {
          "handset_name": "line1-VH1234567",
          "sip_id": "VH1234567"
        }
      ]
    }
  }
}
{
  "status": 1,
  "title": "abc123",
  "instance": "abc123",
  "invalid_parameters": [
    {
      "name": "abc123",
      "reason": "abc123"
    }
  ]
}

Get extension data by account ID and extension number

GET https://api.vonage.com/t/vbc.prod/provisioning/api/accounts/:account_id/extensions/:extension_number

Authentication

Key Description Example Default
Authorization Your OAuth token.
Read more about OAuth tokens
Bearer <access_token> None

Path Parameters

Key Description Example Default
account_id
Required | string

The account ID

None None
extension_number
Required | number

The extension number

789 None

Hide response field descriptions

Response Fields

Field Description
page_size
number

Number of records per page

page
number

Current page number

total_pages
number

Total number of pages

total_items
number

Total number of records

_embedded
object
Field Description
data
object
Field Description
extension_number
string

Extension number

user
object
Field Description
email
string

Email address of the user

login_name
string

Login name of the user

first_name
string

First name of the user

last_name
string

Last name of the user

location_id
number

Unique identifier of the assigned location

vtt_enabled
boolean

Voicemail transcription status of the location

dnd_enabled
boolean

Do Not Disturb status of the extension

caller_id
string

Caller ID of the extension

block_caller_id
boolean

Block Caller ID status of the extension

dids
array of objects

Collection of phone numbers assigned to the extension

Field Description
phone_number
string

Phone number

custom_tag
string

Custom tag associated with the phone number

extension_handsets
array of objects

Collection of handsets assigned to the extension

Field Description
handset_name
string

Name of the handset

sip_id
string

SIP identifier of the handset

{
  "page_size": 10,
  "page": 1,
  "total_pages": 10,
  "total_items": 100,
  "_links": {
    "first": {
      "href": "abc123"
    },
    "prev": {
      "href": "abc123"
    },
    "self": {
      "href": "abc123"
    },
    "next": {
      "href": "abc123"
    }
  },
  "_embedded": {
    "data": {
      "extension_number": "789",
      "user": {
        "email": "john.smith@example.com",
        "login_name": "jsmith",
        "first_name": "John",
        "last_name": "Smith"
      },
      "location_id": 123456,
      "vtt_enabled": true,
      "dnd_enabled": false,
      "caller_id": "John Smith",
      "block_caller_id": false,
      "dids": [
        {
          "phone_number": "14155550100",
          "custom_tag": "My Tag"
        }
      ],
      "extension_handsets": [
        {
          "handset_name": "line1-VH1234567",
          "sip_id": "VH1234567"
        }
      ]
    }
  }
}
{
  "msg": "abc123",
  "status": 1
}