Vip numbers

List VIP numbers

Get a collection of VIP numbers.

GEThttp://127.0.0.1:8888/api/vip_numbers

Response

2004XX

OK

Body

application/json

countinteger (int64)

Total number of resource.

Example: 100

itemsarray of object

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/vip_numbers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "count": 100,
  "items": [
    {
      "id": {},
      "number": "text",
      "longitude": "text",
      "latitude": "text",
      "address": "text",
      "created_at": {},
      "updated_at": {},
      "expire_at": {},
      "enabled": false,
      "description": "text"
    }
  ]
}

Add VIP number

Create a new VIP number.

POSThttp://127.0.0.1:8888/api/vip_numbers

Body

application/json

numberstring

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

The address.

expire_atall of

VIP number's expire time.

enabledboolean

Enable the VIP number or not.

descriptionstring

VIP number's description.

Response

2004XX

OK

Body

application/json

idall of

The unique ID of VIP number.

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/vip_numbers', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "id": {}
}

Retrieve VIP number

Get details of the VIP number.

GEThttp://127.0.0.1:8888/api/vip_numbers/{id}

Path parameters

id*all of

The unique ID of VIP number.

Response

2004XX

OK

Body

application/json

idall of

The unique ID of VIP number.

numberstring

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

The address.

created_atall of

Exclusive number created at this time.

updated_atall of

VIP number's modified time.

expire_atall of

VIP number's expire time.

enabledboolean

Enable the VIP number or not.

descriptionstring

VIP number's description.

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/vip_numbers/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": {},
  "number": "text",
  "longitude": "text",
  "latitude": "text",
  "address": "text",
  "created_at": {},
  "updated_at": {},
  "expire_at": {},
  "enabled": false,
  "description": "text"
}

Update VIP number

Update a VIP number.

POSThttp://127.0.0.1:8888/api/vip_numbers/{id}

Path parameters

id*all of

The unique ID of VIP number.

Body

application/json

numberstring

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

The address.

expire_atall of

VIP number's expire time.

enabledboolean

Enable the VIP number or not.

descriptionstring

VIP number's description.

Response

2004XX

OK

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/vip_numbers/{id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();