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.

OpenAPI-Spezifikation herunterladen

Get account users data by account ID

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

Authentifizierung

SchlüsselBeschreibungWoBeispiel
Authorization

Ihr OAuth-Token.
Lesen Sie mehr über OAuth-Tokens

Headers

Bearer <access_token>

Pfad Parameter

account_id
string
Erforderlich

The Vonage Business Cloud account ID

Abfrage Parameter

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

Antworten
Inhalt Typ
application/json

Success

page_size
number
Beispiel10

Number of records per page

page
number
Beispiel1

Current page number

total_pages
number
Beispiel10

Total number of pages

total_items
number
Beispiel100

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

Email address of the user

login_name
string
Beispieljsmith

Login name of the user

first_name
string
BeispielJohn

First name of the user

last_name
string
BeispielSmith

Last name of the user

id
number
Beispiel869048

Unique identifier of the user

contact_numbers
array

Collection of contact objects

type
string
BeispielHome

Contact type

value
string
Beispiel14155550100

Contact value

extensions
array

Collection of extension objects

dids
array

Collection of phone numbers assigned to the extension

phone_number
string
Beispiel14155550100

Phone number

custom_tag
string
BeispielMy Tag

Custom tag associated with the phone number

extension_number
string
Beispiel789

Extension number

Beispiel Antwort

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

Authentifizierung

SchlüsselBeschreibungWoBeispiel
Authorization

Ihr OAuth-Token.
Lesen Sie mehr über OAuth-Tokens

Headers

Bearer <access_token>

Pfad Parameter

account_id
string
Erforderlich

The Vonage Business Cloud account ID

user_id
number
Erforderlich

The Vonage Business Cloud user ID

Antworten
Inhalt Typ
application/json

Success

page_size
number
Beispiel10

Number of records per page

page
number
Beispiel1

Current page number

total_pages
number
Beispiel10

Total number of pages

total_items
number
Beispiel100

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

Email address of the user

login_name
string
Beispieljsmith

Login name of the user

first_name
string
BeispielJohn

First name of the user

last_name
string
BeispielSmith

Last name of the user

id
number
Beispiel869048

Unique identifier of the user

contact_numbers
array

Collection of contact objects

type
string
BeispielHome

Contact type

value
string
Beispiel14155550100

Contact value

extensions
array

Collection of extension objects

dids
array

Collection of phone numbers assigned to the extension

phone_number
string
Beispiel14155550100

Phone number

custom_tag
string
BeispielMy Tag

Custom tag associated with the phone number

extension_number
string
Beispiel789

Extension number

Beispiel Antwort

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