Provisioning API

The Vonage Business Communications Provisioning API enables you to retrieve information about accounts, users and extensions.

Your application must subscribe to the Provisioning API suite to use this API.

Descargar la especificación OpenAPI

Operaciones disponibles

Get account data by ID

gethttps://api.vonage.com/t/vbc.prod/provisioning/api/accounts/:account_id

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Tu token OAuth. Más información sobre los tokens OAuth	Headers	`Bearer <access_token>`

Ruta Parámetros

account_id

string

Requerido

The Vonage Business Communications account ID

Respuestas
Tipo de contenido
application/json

Success

page_size

number

ejemplo100

Number of records per page

page

number

ejemplo1

Current page number

total_pages

number

ejemplo10

Total number of pages

total_items

number

ejemplo100

Total number of records

_links

object

first

object

URL to the first page of records

href

string

object

URL to the previous page of records

href

string

self

object

URL to the current page of records

href

string

object

URL to the next page of records

href

string

last

object

URL to the last page of records

href

string

_embedded

object

Account object

data

object

number

ejemplo571700

Unique identifier of the account

name

string

ejemploVonage

Name of the account

status

string

ejemploACTIVE

Status of the account

address

object

address_1

string

ejemplo123 Example Street

Street portion of the address

address_2

string

ejemploApt. 456

Additional address information

country

string

ejemploUS

Country code

state

string

ejemploNJ

State/Province code

city

string

ejemploHolmdel

City name

postal_code

string

ejemplo07733

Postal code

Ejemplo Respuesta

{
   "page_size": 100,
   "page": 1,
   "total_pages": 10,
   "total_items": 100,
   "_links": {
      "first": {
         "href": "string"
      },
      "prev": {
         "href": "string"
      },
      "self": {
         "href": "string"
      },
      "next": {
         "href": "string"
      },
      "last": {
         "href": "string"
      }
   },
   "_embedded": {
      "data": {
         "id": 571700,
         "name": "Vonage",
         "status": "ACTIVE",
         "address": {
            "address_1": "123 Example Street",
            "address_2": "Apt. 456",
            "country": "US",
            "state": "NJ",
            "city": "Holmdel",
            "postal_code": "07733"
         }
      }
   }
}

Get account locations data by account ID

gethttps://api.vonage.com/t/vbc.prod/provisioning/api/accounts/:account_id/locations

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Tu token OAuth. Más información sobre los tokens OAuth	Headers	`Bearer <access_token>`

Ruta Parámetros

account_id

string

Requerido

The Vonage Business Communications account ID

Respuestas
Tipo de contenido
application/json

Success

page_size

number

ejemplo100

page

number

ejemplo1

total_pages

number

ejemplo10

total_items

number

ejemplo100

_links

object

first

object

URL to the first page of records

href

string

object

URL to the previous page of records

href

string

self

object

URL to the current page of records

href

string

object

URL to the next page of records

href

string

last

object

URL to the last page of records

href

string

_embedded

object

Collection of location objects

data

array

number

ejemplo327910

Unique identifier of the location

name

string

ejemploHeadquarters

Name of the location

address

object

address_1

string

ejemplo123 Example Street

Street portion of the address

address_2

string

ejemploApt. 456

Additional address information

country

string

ejemploUS

Country code

state

string

ejemploNJ

State/Province code

city

string

ejemploHolmdel

City name

postal_code

string

ejemplo07733

Postal code

time_zone

string

ejemploAmerica/New York

Time zone

Ejemplo Respuesta

{
   "page_size": 100,
   "page": 1,
   "total_pages": 10,
   "total_items": 100,
   "_links": {
      "first": {
         "href": "string"
      },
      "prev": {
         "href": "string"
      },
      "self": {
         "href": "string"
      },
      "next": {
         "href": "string"
      },
      "last": {
         "href": "string"
      }
   },
   "_embedded": {
      "data": [
         {
            "id": 327910,
            "name": "Headquarters",
            "address": {
               "address_1": "123 Example Street",
               "address_2": "Apt. 456",
               "country": "US",
               "state": "NJ",
               "city": "Holmdel",
               "postal_code": "07733",
               "time_zone": "America/New York"
            }
         }
      ]
   }
}

Get location data by account ID and location ID

gethttps://api.vonage.com/t/vbc.prod/provisioning/api/accounts/:account_id/locations/:location_id

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Tu token OAuth. Más información sobre los tokens OAuth	Headers	`Bearer <access_token>`

Ruta Parámetros

account_id

string

Requerido

The Vonage Business Communications account ID

location_id

number

Requerido

The Vonage Business Communications location ID

Respuestas
Tipo de contenido
application/json

Success

page_size

number

ejemplo100

Number of records per page

page

number

ejemplo1

Current page number

total_pages

number

ejemplo10

Total number of pages

total_items

number

ejemplo100

Total number of records

_links

object

first

object

URL to the first page of records

href

string

object

URL to the previous page of records

href

string

self

object

URL to the current page of records

href

string

object

URL to the next page of records

href

string

last

object

URL to the last page of records

href

string

_embedded

object

Location object

data

object

number

ejemplo327910

Unique identifier of the location

name

string

ejemploHeadquarters

Name of the location

address

object

address_1

string

ejemplo123 Example Street

Street portion of the address

address_2

string

ejemploApt. 456

Additional address information

country

string

ejemploUS

Country code

state

string

ejemploNJ

State/Province code

city

string

ejemploHolmdel

City name

postal_code

string

ejemplo07733

Postal code

time_zone

string

ejemploAmerica/New York

Time zone

Ejemplo Respuesta

{
   "page_size": 100,
   "page": 1,
   "total_pages": 10,
   "total_items": 100,
   "_links": {
      "first": {
         "href": "string"
      },
      "prev": {
         "href": "string"
      },
      "self": {
         "href": "string"
      },
      "next": {
         "href": "string"
      },
      "last": {
         "href": "string"
      }
   },
   "_embedded": {
      "data": {
         "id": 327910,
         "name": "Headquarters",
         "address": {
            "address_1": "123 Example Street",
            "address_2": "Apt. 456",
            "country": "US",
            "state": "NJ",
            "city": "Holmdel",
            "postal_code": "07733",
            "time_zone": "America/New York"
         }
      }
   }
}

Get account extensions data by account ID

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

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Tu token OAuth. Más información sobre los tokens OAuth	Headers	`Bearer <access_token>`

Ruta Parámetros

account_id

string

Requerido

The Vonage Business Communications account ID

Consulta Parámetros

page_size

number

Number of records per page

page

number

Current page number

location_id

number

Filter by location id

phone_number

string

Filter by phone number

login_name

string

Filter by login name

string

Filter by email address

Respuestas
Tipo de contenido
application/json

Success

page_size

number

ejemplo10

Number of records per page

page

number

ejemplo1

Current page number

total_pages

number

ejemplo10

Total number of pages

total_items

number

ejemplo100

Total number of records

_links

object

first

object

URL to the first page of records

href

string

object

URL to the previous page of records

href

string

self

object

URL to the current page of records

href

string

object

URL to the next page of records

href

string

last

object

URL to the last page of records

href

string

_embedded

object

data

object

extension_number

string

ejemplo789

Extension number

user

object

number

ejemplo2111111

Unique ID of the user

string

ejemplojohn.smith@example.com

Email address of the user

login_name

string

ejemplojsmith

first_name

string

ejemploJohn

First name of the user

last_name

string

ejemploSmith

Last name of the user

location_id

number

ejemplo145214

Unique identifier of the assigned location

vtt_enabled

boolean

ejemplotrue

Voicemail transcription status of the location

dnd_enabled

boolean

Do Not Disturb status of the extension

caller_id

string

ejemploJohn Smith

Caller ID of the extension

external_id

string

ejemploabc11111111111

The unique identifier of the extension

block_caller_id

boolean

Block Caller ID status of the extension

dids

array

Collection of phone numbers assigned to the extension

phone_number

string

ejemplo14155550100

Phone number

custom_tag

string

ejemploMy Tag

Custom tag associated with the phone number

extension_handsets

array

Collection of handsets assigned to the extension

handset_name

string

ejemploline1-VH6370927

Name of the handset

sip_id

string

ejemploVH16370927

SIP identifier of the handset

Ejemplo Respuesta

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

Get extension data by account ID and extension ID

gethttps://api.vonage.com/t/vbc.prod/provisioning/api/accounts/:account_id/extensions/:external_id

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Tu token OAuth. Más información sobre los tokens OAuth	Headers	`Bearer <access_token>`

Ruta Parámetros

account_id

string

Requerido

The Vonage Business Communications account ID

external_id

number

Requerido

The unique id of the extension

Respuestas
Tipo de contenido
application/json

Success

_links

object

self

object

URL to the current page of records

href

string

_embedded

object

extension

object

extension_number

string

ejemplo789

Extension number

user

object

number

ejemplo2111111

Unique ID of the user

string

ejemplojohn.smith@example.com

Email address of the user

login_name

string

ejemplojsmith

first_name

string

ejemploJohn

First name of the user

last_name

string

ejemploSmith

Last name of the user

location_id

number

ejemplo145214

Unique identifier of the assigned location

vtt_enabled

boolean

ejemplotrue

Voicemail transcription status of the location

dnd_enabled

boolean

Do Not Disturb status of the extension

caller_id

string

ejemploJohn Smith

Caller ID of the extension

external_id

string

ejemploabc11111111111

The unique identifier of the extension

service_type_name

string

ejemploUX

Service type name of the extension

block_caller_id

boolean

Block Caller ID status of the extension

dids

array

Collection of phone numbers assigned to the extension

phone_number

string

ejemplo14155550100

Phone number

custom_tag

string

ejemploMy Tag

Custom tag associated with the phone number

extension_handsets

array

Collection of handsets assigned to the extension

handset_name

string

ejemploline1-VH6370927

Name of the handset

sip_id

string

ejemploVH16370927

SIP identifier of the handset

Ejemplo Respuesta

{
   "_links": {
      "self": {
         "href": "string"
      }
   },
   "_embedded": {
      "extension": {
         "extension_number": "789",
         "user": {
            "id": 2111111,
            "email": "john.smith@example.com",
            "login_name": "jsmith",
            "first_name": "John",
            "last_name": "Smith"
         },
         "location_id": 145214,
         "vtt_enabled": true,
         "dnd_enabled": false,
         "caller_id": "John Smith",
         "external_id": "abc11111111111",
         "service_type_name": "UX",
         "block_caller_id": false,
         "dids": [
            {
               "phone_number": "14155550100",
               "custom_tag": "My Tag"
            }
         ],
         "extension_handsets": [
            {
               "handset_name": "line1-VH6370927",
               "sip_id": "VH16370927"
            }
         ]
      }
   }
}

Get account users data by account ID

gethttps://api.vonage.com/t/vbc.prod/provisioning/api/accounts/:account_id/users

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Tu token OAuth. Más información sobre los tokens OAuth	Headers	`Bearer <access_token>`

Ruta Parámetros

account_id

string

Requerido

The Vonage Business Communications account ID

Consulta Parámetros

page_size

number

Number of records per page

page

number

Current page number

first_name

string

Filter by first name

last_name

string

Filter by last name

login_name

string

Filter by login name

string

Filter by email address

Respuestas
Tipo de contenido
application/json

Success

page_size

number

ejemplo10

Number of records per page

page

number

ejemplo1

Current page number

total_pages

number

ejemplo10

Total number of pages

total_items

number

ejemplo100

Total number of records

_links

object

first

object

URL to the first page of records

href

string

object

URL to the previous page of records

href

string

self

object

URL to the current page of records

href

string

object

URL to the next page of records

href

string

last

object

URL to the last page of records

href

string

_embedded

object

data

array

string

ejemplojohn.smith@example.com

Email address of the user

login_name

string

ejemplojsmith

first_name

string

ejemploJohn

First name of the user

last_name

string

ejemploSmith

Last name of the user

number

ejemplo869048

Unique identifier of the user

contact_numbers

array

Collection of contact objects

type

string

ejemploHome

Contact type

value

string

ejemplo14155550100

Contact value

extensions

array

Collection of extension objects

dids

array

Collection of phone numbers assigned to the extension

phone_number

string

ejemplo14155550100

Phone number

custom_tag

string

ejemploMy Tag

Custom tag associated with the phone number

extension_number

string

ejemplo789

Extension number

Ejemplo Respuesta

{
   "page_size": 10,
   "page": 1,
   "total_pages": 10,
   "total_items": 100,
   "_links": {
      "first": {
         "href": "string"
      },
      "prev": {
         "href": "string"
      },
      "self": {
         "href": "string"
      },
      "next": {
         "href": "string"
      },
      "last": {
         "href": "string"
      }
   },
   "_embedded": {
      "data": [
         {
            "email": "john.smith@example.com",
            "login_name": "jsmith",
            "first_name": "John",
            "last_name": "Smith",
            "id": 869048,
            "contact_numbers": [
               {
                  "type": "Home",
                  "value": "14155550100"
               }
            ],
            "extensions": [
               {
                  "dids": [
                     {
                        "phone_number": "14155550100",
                        "custom_tag": "My Tag"
                     }
                  ],
                  "extension_number": "789"
               }
            ]
         }
      ]
   }
}

Get user data by account ID and user ID

gethttps://api.vonage.com/t/vbc.prod/provisioning/api/accounts/:account_id/users/:user_id

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Tu token OAuth. Más información sobre los tokens OAuth	Headers	`Bearer <access_token>`

Ruta Parámetros

account_id

string

Requerido

The Vonage Business Communications account ID

user_id

number

Requerido

The Vonage Business Communications user ID

Respuestas
Tipo de contenido
application/json

Success

page_size

number

ejemplo10

Number of records per page

page

number

ejemplo1

Current page number

total_pages

number

ejemplo10

Total number of pages

total_items

number

ejemplo100

Total number of records

_links

object

first

object

URL to the first page of records

href

string

object

URL to the previous page of records

href

string

self

object

URL to the current page of records

href

string

object

URL to the next page of records

href

string

last

object

URL to the last page of records

href

string

_embedded

object

data

object

string

ejemplojohn.smith@example.com

Email address of the user

login_name

string

ejemplojsmith

first_name

string

ejemploJohn

First name of the user

last_name

string

ejemploSmith

Last name of the user

number

ejemplo869048

Unique identifier of the user

contact_numbers

array

Collection of contact objects

type

string

ejemploHome

Contact type

value

string

ejemplo14155550100

Contact value

extensions

array

Collection of extension objects

dids

array

Collection of phone numbers assigned to the extension

phone_number

string

ejemplo14155550100

Phone number

custom_tag

string

ejemploMy Tag

Custom tag associated with the phone number

extension_number

string

ejemplo789

Extension number

Ejemplo Respuesta

{
   "page_size": 10,
   "page": 1,
   "total_pages": 10,
   "total_items": 100,
   "_links": {
      "first": {
         "href": "string"
      },
      "prev": {
         "href": "string"
      },
      "self": {
         "href": "string"
      },
      "next": {
         "href": "string"
      },
      "last": {
         "href": "string"
      }
   },
   "_embedded": {
      "data": {
         "email": "john.smith@example.com",
         "login_name": "jsmith",
         "first_name": "John",
         "last_name": "Smith",
         "id": 869048,
         "contact_numbers": [
            {
               "type": "Home",
               "value": "14155550100"
            }
         ],
         "extensions": [
            {
               "dids": [
                  {
                     "phone_number": "14155550100",
                     "custom_tag": "My Tag"
                  }
               ],
               "extension_number": "789"
            }
         ]
      }
   }
}

Provisioning API

Operaciones disponibles

Get account data by ID

Autenticación

Ruta Parámetros

Respuestas Tipo de contenidoapplication/json

Ejemplo Respuesta

Get account locations data by account ID

Autenticación

Ruta Parámetros

Respuestas Tipo de contenidoapplication/json

Ejemplo Respuesta

Get location data by account ID and location ID

Autenticación

Ruta Parámetros

Respuestas Tipo de contenidoapplication/json

Ejemplo Respuesta

Get account extensions data by account ID

Autenticación

Ruta Parámetros

Consulta Parámetros

Respuestas Tipo de contenidoapplication/json

Ejemplo Respuesta

Get extension data by account ID and extension ID

Autenticación

Ruta Parámetros

Respuestas Tipo de contenidoapplication/json

Ejemplo Respuesta

Get account users data by account ID

Autenticación

Ruta Parámetros

Consulta Parámetros

Respuestas Tipo de contenidoapplication/json

Ejemplo Respuesta

Get user data by account ID and user ID

Autenticación

Ruta Parámetros

Respuestas Tipo de contenidoapplication/json

Ejemplo Respuesta

Respuestas
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json