User API

The Vonage Business Cloud User API enables you to retrieve information about users.

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

Descargar la especificación OpenAPI
Operaciones disponibles

Get account users data by account ID

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

Autenticación

ClaveDescripciónDóndeEjemplo
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 Cloud 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

email
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
prev
object

URL to the previous page of records

href
string
self
object

URL to the current page of records

href
string
next
object

URL to the next page of records

href
string
_embedded
object
data
array
email
string
ejemplojohn.smith@example.com

Email address of the user

login_name
string
ejemplojsmith

Login name of the user

first_name
string
ejemploJohn

First name of the user

last_name
string
ejemploSmith

Last name of the user

id
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"
      }
   },
   "_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

ClaveDescripciónDóndeEjemplo
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 Cloud account ID

user_id
number
Requerido

The Vonage Business Cloud 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
prev
object

URL to the previous page of records

href
string
self
object

URL to the current page of records

href
string
next
object

URL to the next page of records

href
string
_embedded
object
data
object
email
string
ejemplojohn.smith@example.com

Email address of the user

login_name
string
ejemplojsmith

Login name of the user

first_name
string
ejemploJohn

First name of the user

last_name
string
ejemploSmith

Last name of the user

id
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"
      }
   },
   "_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"
            }
         ]
      }
   }
}