Save the queue AI worker and optional Voice AI agent

Agent must be a set-up, enabled voice profile in this workspace. Null uses the default. Turning on the worker clears its pause reason.

PUT

https://api.channelautomation.com/api/call-queues/{queueId}/ai-worker

Authorization

BearerAuth
HTTP Bearer (JWT)
required

Path parameters

queueId
string
required
format: uuid

Request body JSON

voice_agent_id
optional
string
or null
format: uuid
enabled
optional
boolean
max_concurrent
optional
integer
maximum: 5 · minimum: 1
first_message
optional
string
or null
maxLength: 220
context_template
optional
string
or null
maxLength: 4000

Returns

200

Saved worker settings

400

Invalid settings

403

Workspace owner or admin required

404

Queue not in this workspace

409

voice_agent_unavailable

503

Settings unavailable

Save the queue AI worker and optional Voice AI agent

curl --request PUT \
  --url 'https://api.channelautomation.com/api/call-queues/<queueId>/ai-worker' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "voice_agent_id": "2fc8d568-5ce2-4e51-baa8-38c877b5dd08",
  "enabled": true,
  "max_concurrent": 1,
  "first_message": "string",
  "context_template": "string"
}
'

const url = 'https://api.channelautomation.com/api/call-queues/<queueId>/ai-worker';
const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json', Authorization: 'Bearer <token>'},
  body: JSON.stringify({
    voice_agent_id: '2fc8d568-5ce2-4e51-baa8-38c877b5dd08',
    enabled: true,
    max_concurrent: 1,
    first_message: 'string',
    context_template: 'string'
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.channelautomation.com/api/call-queues/<queueId>/ai-worker"

payload = {
    "voice_agent_id": "2fc8d568-5ce2-4e51-baa8-38c877b5dd08",
    "enabled": True,
    "max_concurrent": 1,
    "first_message": "string",
    "context_template": "string"
}
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer <token>"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)