List purchased VoiceLink DIDs

GET

voicelink

dids

purchased

curl --request GET \
  --url https://api.vocobase.com/api/v2/voicelink/dids/purchased \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "data": {
    "data": [
      {
        "id": 812,
        "did_id": 812,
        "did_number": "918011223344",
        "client_id": 415,
        "status": "active"
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

API key in format: rg_live_xxxx. Pass as a Bearer token in the Authorization header.

Query Parameters

connection_id

string<uuid>

Optional unless multiple active VoiceLink connections exist.

string

DID search term.

status

string

VoiceLink DID status filter.

did_type

integer

VoiceLink DID type filter.

client_id

integer

VoiceLink client ID filter.

per_page

integer

Required range: x >= 1

page

integer

Required range: x >= 1

Response

Purchased DIDs response.

A VoiceLink upstream response wrapped in the V2 success envelope. The data shape is forwarded from VoiceLink and may vary by endpoint.

success

boolean

required

data

required

VoiceLink upstream response body.

List available VoiceLink DIDsLists DIDs returned by VoiceLink as available for client mapping. Day-one scope is read-only for inventory: purchase, renew, KYC, wallet, and credit allocation operations are excluded.

List purchased VoiceLink DIDs

curl --request GET \
  --url https://api.vocobase.com/api/v2/voicelink/dids/purchased \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "data": {
    "data": [
      {
        "id": 812,
        "did_id": 812,
        "did_number": "918011223344",
        "client_id": 415,
        "status": "active"
      }
    ]
  }
}