Vip numbers

List VIP numbers

get

Get a collection of VIP numbers.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

countinteger · int64Optional

Total number of resource.

Example: 100

4XX

Error

get

/vip_numbers

HTTPcURLJavaScriptPython

GET /api/vip_numbers HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Add VIP number

post

Create a new VIP number.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

numberstring · min: 1 · max: 64Optional

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

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

longitudestringOptional

VIP number's longitude.

latitudestringOptional

VIP number's latitude.

addressstring · max: 128Optional

The address.

expire_atstring · date_timeOptional

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

Example: 2017-07-21T17:32:28Z

enabledbooleanOptional

Enable the VIP number or not.

descriptionstring · max: 1024Optional

VIP number's description.

Responses

200

OK

application/json

idstringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

4XX

Error

post

/vip_numbers

HTTPcURLJavaScriptPython

POST /api/vip_numbers HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 142

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

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Retrieve VIP number

get

Get details of the VIP number.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

idstringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

numberstring · min: 1 · max: 64Optional

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

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

longitudestringOptional

VIP number's longitude.

latitudestringOptional

VIP number's latitude.

addressstring · max: 128Optional

The address.

created_atstring · date_timeOptional

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

Example: 2017-07-21T17:32:28Z

updated_atstring · date_timeOptional

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

Example: 2017-07-21T17:32:28Z

expire_atstring · date_timeOptional

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

Example: 2017-07-21T17:32:28Z

enabledbooleanOptional

Enable the VIP number or not.

descriptionstring · max: 1024Optional

VIP number's description.

4XX

Error

get

/vip_numbers/{id}

HTTPcURLJavaScriptPython

GET /api/vip_numbers/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Update VIP number

post

Update a VIP number.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

application/json

numberstring · min: 1 · max: 64Optional

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

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

longitudestringOptional

VIP number's longitude.

latitudestringOptional

VIP number's latitude.

addressstring · max: 128Optional

The address.

expire_atstring · date_timeOptional

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

Example: 2017-07-21T17:32:28Z

enabledbooleanOptional

Enable the VIP number or not.

descriptionstring · max: 1024Optional

VIP number's description.

Responses

200

OK

No content

4XX

Error

post

/vip_numbers/{id}

HTTPcURLJavaScriptPython

POST /api/vip_numbers/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 142

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

No content