Vip numbers

List VIP numbers

Get a collection of VIP numbers.

get

/vip_numbers

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://HOSTNAME:8887/api/vip_numbers' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

200

{
  "count": 100,
  "items": [
    {
      "number": "text",
      "longitude": "text",
      "latitude": "text",
      "address": "text",
      "enabled": true,
      "description": "text",
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "created_at": "2017-07-21T17:32:28Z",
      "updated_at": "2017-07-21T17:32:28Z",
      "expire_at": "2017-07-21T17:32:28Z"
    }
  ]
}

OK

Add VIP number

Create a new VIP number.

post

/vip_numbers

Authorizations

Body

numberstring · min: 1 · max: 64

The VIP number, a string value contains a valid telephone number.

Pattern: [0-9+]{1,64}

longitudestring

VIP number's longitude.

latitudestring

VIP number's latitude.

addressstring · max: 128

The address.

enabledboolean

Enable the VIP number or not.

descriptionstring · max: 1024

VIP number's description.

expire_atall of

VIP number's expire time.

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/vip_numbers' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "number": "text",
    "longitude": "text",
    "latitude": "text",
    "address": "text",
    "enabled": true,
    "description": "text",
    "expire_at": "2017-07-21T17:32:28Z"
  }'

200

4XX

200

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

OK

Retrieve VIP number

Get details of the VIP number.

get

/vip_numbers/{id}

Authorizations

Path parameters

idall ofrequired

The unique ID of VIP number.

The unique ID of the resource.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://HOSTNAME:8887/api/vip_numbers/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

200

{
  "number": "text",
  "longitude": "text",
  "latitude": "text",
  "address": "text",
  "enabled": true,
  "description": "text",
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "created_at": "2017-07-21T17:32:28Z",
  "updated_at": "2017-07-21T17:32:28Z",
  "expire_at": "2017-07-21T17:32:28Z"
}

OK

Update VIP number

Update a VIP number.

post

/vip_numbers/{id}

Authorizations

Path parameters

idall ofrequired

The unique ID of VIP number.

The unique ID of the resource.

Body

numberstring · min: 1 · max: 64

The VIP number, a string value contains a valid telephone number.

Pattern: [0-9+]{1,64}

longitudestring

VIP number's longitude.

latitudestring

VIP number's latitude.

addressstring · max: 128

The address.

enabledboolean

Enable the VIP number or not.

descriptionstring · max: 1024

VIP number's description.

expire_atall of

VIP number's expire time.

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/vip_numbers/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "number": "text",
    "longitude": "text",
    "latitude": "text",
    "address": "text",
    "enabled": true,
    "description": "text",
    "expire_at": "2017-07-21T17:32:28Z"
  }'

200

4XX

200

No body

OK