Omnichannel

GET /v1/channel-kinds#

List channel kinds. The channel types you can configure.

Responses

Example request

curl "https://api.voiceland.ai/v1/channel-kinds" \
  -H "Authorization: Bearer VL_API_KEY"

Example response

{
  "kinds": [
    "http",
    "slack",
    "telegram",
    "discord"
  ]
}

GET /v1/channels#

List channels. Your configured delivery channels.

Responses

Example request

curl "https://api.voiceland.ai/v1/channels" \
  -H "Authorization: Bearer VL_API_KEY"

Example response

{
  "channels": []
}

DELETE /v1/channels/{name}#

Delete a channel. Deletes a channel.

Parameters

Responses

Example request

curl -X DELETE "https://api.voiceland.ai/v1/channels/{name}" \
  -H "Authorization: Bearer VL_API_KEY"

GET /v1/channels/{name}#

Get a channel. Returns one channel by name.

Parameters

Responses

Example request

curl "https://api.voiceland.ai/v1/channels/{name}" \
  -H "Authorization: Bearer VL_API_KEY"

PUT /v1/channels/{name}#

Create or update a channel. Configures a delivery channel (webhook, chat platform, …).

Parameters

Request body

application/json Schema: ChannelPutRequest

Responses

Example request

curl -X PUT "https://api.voiceland.ai/v1/channels/{name}" \
  -H "Authorization: Bearer VL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "endpoint": "https://example.com/hook",
  "kind": "http",
  "label": "Ops"
}'

POST /v1/channels/{name}/test#

Test a channel. Sends a test delivery to the channel and returns the attempt result.

Parameters

Responses

Example request

curl -X POST "https://api.voiceland.ai/v1/channels/{name}/test" \
  -H "Authorization: Bearer VL_API_KEY"

Example response

{
  "channel": "ops-webhook",
  "http_status": 200
}

GET /v1/subscriptions#

List subscriptions. Your omnichannel event-routing rules.

Responses

Example request

curl "https://api.voiceland.ai/v1/subscriptions" \
  -H "Authorization: Bearer VL_API_KEY"

Example response

{
  "subscriptions": []
}

DELETE /v1/subscriptions/{name}#

Delete a subscription. Deletes a subscription.

Parameters

Responses

Example request

curl -X DELETE "https://api.voiceland.ai/v1/subscriptions/{name}" \
  -H "Authorization: Bearer VL_API_KEY"

PUT /v1/subscriptions/{name}#

Create or update a subscription. Routes selected events to one or more channels, with an optional filter/schedule. A live subscription (no schedule, enabled) over call events is the real-time event webhooks capability; digests, disabled subscriptions, and live subscriptions that list only account alerts (kpi.*, calls.dial_cap_approaching, eval.drift_regression, report.ai_operations) or the chat takeover family (chat.takeover_*) are accepted on every plan.

Parameters

Request body

application/json Schema: SubscriptionPutRequest

Responses

Example request

curl -X PUT "https://api.voiceland.ai/v1/subscriptions/{name}" \
  -H "Authorization: Bearer VL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "channels": [
    "ops-webhook"
  ],
  "enabled": true,
  "event_types": [
    "call.hangup"
  ]
}'

GET /v1/text-agents#

List text agents. Your chat-only agents.

Responses

Example request

curl "https://api.voiceland.ai/v1/text-agents" \
  -H "Authorization: Bearer VL_API_KEY"

Example response

{
  "text_agents": []
}

DELETE /v1/text-agents/{name}#

Delete a text agent. Deletes a text agent.

Parameters

Responses

Example request

curl -X DELETE "https://api.voiceland.ai/v1/text-agents/{name}" \
  -H "Authorization: Bearer VL_API_KEY"

GET /v1/text-agents/{name}#

Get a text agent. Returns one text agent by name.

Parameters

Responses

Example request

curl "https://api.voiceland.ai/v1/text-agents/{name}" \
  -H "Authorization: Bearer VL_API_KEY"

PUT /v1/text-agents/{name}#

Create or update a text agent. Configures a chat-only agent.

Parameters

Request body

application/json Schema: TextAgent

Responses

Example request

curl -X PUT "https://api.voiceland.ai/v1/text-agents/{name}" \
  -H "Authorization: Bearer VL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "greeting": "Hi! How can I help?",
  "name": "support-chat",
  "system_prompt": "You are Acme'\''s helpful support assistant. Answer questions about orders and shipping."
}'

Schemas#

ChannelPutRequest#

Configure a delivery channel.

Error#

Error envelope returned for non-2xx responses.

SubscriptionAction#

SubscriptionFilter#

SubscriptionPutRequest#

Route events to channels.

TextAgent#

A chat-only (text) agent.