Skip to main content
POST
Map a VoiceLink DID to a client

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.