Skip to main content
POST
/
voicelink
/
clients
Create a VoiceLink client
curl --request POST \
  --url https://api.vocobase.com/api/v2/voicelink/clients \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "connection_id": "9b7f1c44-c87f-4f0c-9124-3c802a9c1a20",
  "first_name": "Acme",
  "last_name": "Sales",
  "username": "acme-sales",
  "email": "voice@example.com",
  "password": "temporary-client-password",
  "channel_count": 5,
  "phone": "+918011223344",
  "is_active": 1
}
'
{
  "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
first_name
string
required
last_name
string
required
username
string
required
email
string<email>
required
password
string<password>
required
channel_count
integer
required
Required range: x >= 1
connection_id
string<uuid>

Optional unless multiple active VoiceLink connections exist.

phone
string
is_active
enum<integer>
Available options:
0,
1
negative_threshold
number
pulse_seconds
integer
inbound_rate
number
outbound_rate
number
plan_type
string

Response

VoiceLink client created.

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.