Sign in
latestOpenAPI 3.1.0PortSIP2026-08-105581112.6 MB

577415d4a3d5

CTI

Retrieve VIP number

Get details of the VIP number.

get/vip_numbers/{id}

Path parameters

idstring required

The unique ID of the resource.

Example:NzAwNTUxOTA5NzczMTQ4MTYw

The unique ID of the VIP number.

Response

OK

idstring

The unique ID of the resource.

numberstring

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

longitudestring

VIP number's longitude.

latitudestring

VIP number's latitude.

addressstring

The address.

created_atstring date_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

updated_atstring date_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

expire_atstring date_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

enabledboolean

Enable the VIP number or not.

descriptionstring

VIP number's description.

Example response

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "created_at": "2017-07-21T17:32:28Z",
  "updated_at": "2017-07-21T17:32:28Z",
  "expire_at": "2017-07-21T17:32:28Z"
}