List VoiceLink clients - Vocobase API

GET

voicelink

clients

List VoiceLink clients

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

{
  "success": true,
  "data": {
    "data": [
      {
        "id": 415,
        "first_name": "Acme",
        "last_name": "Sales",
        "username": "acme-sales",
        "email": "voice@example.com",
        "status": 1,
        "channel_count": 5
      }
    ]
  }
}

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

VoiceLink client search term.

status

integer

VoiceLink client status filter.

per_page

integer

VoiceLink page size.

Required range: x >= 1

page

integer

VoiceLink page number.

Required range: x >= 1

Response

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

Create a VoiceLink clientCreates a client in VoiceLink through the selected active VoiceLink connection. VoiceLink remains the source of truth for remote client ownership and status.

List VoiceLink clients

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

{
  "success": true,
  "data": {
    "data": [
      {
        "id": 415,
        "first_name": "Acme",
        "last_name": "Sales",
        "username": "acme-sales",
        "email": "voice@example.com",
        "status": 1,
        "channel_count": 5
      }
    ]
  }
}