Map a VoiceLink DID to a client

POST

voicelink

dids

map

curl --request POST \
  --url https://api.vocobase.com/api/v2/voicelink/dids/map \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "connection_id": "9b7f1c44-c87f-4f0c-9124-3c802a9c1a20",
  "client_id": 415,
  "did_id": 812,
  "call_recording": 1,
  "user_status": 2,
  "description": "Sales outbound DID"
}
'

{
  "success": true,
  "data": {}
}

Authorizations

Authorization

string

header

required

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

Body

application/json

client_id

integer

required

VoiceLink client ID.

did_id

integer

required

VoiceLink DID ID.

call_recording

enum<integer>

required

Available options:

0,

1

connection_id

string<uuid>

Optional unless multiple active VoiceLink connections exist.

user_status

enum<integer>

Mapping status: 2 = assigned (active), 4 = inactive. VoiceLink rejects other values.

Available options:

2,

4

user_expiry_date

string<date>

description

string

client_auto_renew

enum<integer>

Available options:

0,

1

Response

DID mapping 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.

Sync VoiceLink state and readinessFetches remote VoiceLink clients, DIDs, available DIDs, bots, and routing, then compares them with Vocobase local PhoneNumber rows. By default, remote DIDs are imported into Vocobase local inventory; pass `import_dids: false` for a read-only readiness check. Sync does not silently delete local data.

Map a VoiceLink DID to a client

curl --request POST \
  --url https://api.vocobase.com/api/v2/voicelink/dids/map \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "connection_id": "9b7f1c44-c87f-4f0c-9124-3c802a9c1a20",
  "client_id": 415,
  "did_id": 812,
  "call_recording": 1,
  "user_status": 2,
  "description": "Sales outbound DID"
}
'

{
  "success": true,
  "data": {}
}