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.

Télécharger la spécification OpenAPI
Opérations disponibles

Get account users data by account ID

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

Authentification

CléDescriptionOùExemple
Authorization

Votre jeton OAuth.
En savoir plus sur les jetons OAuth

Headers

Bearer <access_token>

Trajectoire Paramètres

account_id
string
Exigée

The Vonage Business Cloud account ID

Demande de renseignements Paramètres

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

Réponses
Type de contenu
application/json

Success

page_size
number
exemple10

Number of records per page

page
number
exemple1

Current page number

total_pages
number
exemple10

Total number of pages

total_items
number
exemple100

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
exemplejohn.smith@example.com

Email address of the user

login_name
string
exemplejsmith

Login name of the user

first_name
string
exempleJohn

First name of the user

last_name
string
exempleSmith

Last name of the user

id
number
exemple869048

Unique identifier of the user

contact_numbers
array

Collection of contact objects

type
string
exempleHome

Contact type

value
string
exemple14155550100

Contact value

extensions
array

Collection of extension objects

dids
array

Collection of phone numbers assigned to the extension

phone_number
string
exemple14155550100

Phone number

custom_tag
string
exempleMy Tag

Custom tag associated with the phone number

extension_number
string
exemple789

Extension number

Exemple Réponse

{
   "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

Authentification

CléDescriptionOùExemple
Authorization

Votre jeton OAuth.
En savoir plus sur les jetons OAuth

Headers

Bearer <access_token>

Trajectoire Paramètres

account_id
string
Exigée

The Vonage Business Cloud account ID

user_id
number
Exigée

The Vonage Business Cloud user ID

Réponses
Type de contenu
application/json

Success

page_size
number
exemple10

Number of records per page

page
number
exemple1

Current page number

total_pages
number
exemple10

Total number of pages

total_items
number
exemple100

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
exemplejohn.smith@example.com

Email address of the user

login_name
string
exemplejsmith

Login name of the user

first_name
string
exempleJohn

First name of the user

last_name
string
exempleSmith

Last name of the user

id
number
exemple869048

Unique identifier of the user

contact_numbers
array

Collection of contact objects

type
string
exempleHome

Contact type

value
string
exemple14155550100

Contact value

extensions
array

Collection of extension objects

dids
array

Collection of phone numbers assigned to the extension

phone_number
string
exemple14155550100

Phone number

custom_tag
string
exempleMy Tag

Custom tag associated with the phone number

extension_number
string
exemple789

Extension number

Exemple Réponse

{
   "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"
            }
         ]
      }
   }
}