Skip to main content
POST
/
voicelink
/
bots
Create a VoiceLink WebSocket bot
curl --request POST \
  --url https://api.vocobase.com/api/v2/voicelink/bots \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "connection_id": "9b7f1c44-c87f-4f0c-9124-3c802a9c1a20",
  "bot_name": "Vocobase +918011223344",
  "client_id": 415,
  "status": 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
​
bot_name
string
required

Display name for the WebSocket bot.

​
client_id
integer
required

VoiceLink client ID the bot belongs to.

Required range: x >= 1
​
connection_id
string<uuid>

Optional unless multiple active VoiceLink connections exist. connectionId is accepted for backwards compatibility.

​
websocket_url
string<uri>

Optional WebSocket URL. Omit to point the bot at the Vocobase Pipecat Cloud bot endpoint.

​
webhook_url
string

Optional VoiceLink webhook URL for call events.

​
status
enum<integer>
default:1

Bot status: 1 active (default), 0 inactive.

Available options:
0,
1

Response

VoiceLink bot 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.