CRM · Interaction Centre
Queues
What customers wait in. The columns are the promises a desk makes: answer within this many seconds, offer a callback rather than hold past this.
/api/crm/interaction-queuesPublished as /api/v1/interaction-queuesOverview
| Package | CRM |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold CRM › Queues on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen. |
| Table | crm.interaction_queues · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
6 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/crm/interaction-queuesList queues
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"name_local": "Example",
"description": "text",
"connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"channels": [],
"routing": "text",
"required_skills": [],
"priority": 10,
"target_answer_seconds": 10,
"max_wait_seconds": 10,
"callback_after_seconds": 10
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/crm/interaction-queues?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/crm/interaction-queues/{id}Read one queue
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"name_local": "Example",
"description": "text",
"connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"channels": [],
"routing": "text",
"required_skills": [],
"priority": 10,
"target_answer_seconds": 10,
"max_wait_seconds": 10,
"callback_after_seconds": 10
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/crm/interaction-queues/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/interaction-queuesCreate a queue
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Code |
name | text | Yes | Name |
name_local | text | No | Local name |
description | text | No | What it is for |
connection_id | uuid | No | Through |
channels | _text | No | Channels |
routing | text | No | Routing — Longest idle is the fair one. Skill-based is the useful one and needs the skills to be kept up to date, which is why it is not the default. |
required_skills | _text | No | Required skills |
priority | integer | No | Priority |
target_answer_seconds | integer | No | Answer within (seconds) |
max_wait_seconds | integer | No | Longest hold (seconds) |
callback_after_seconds | integer | No | Offer a callback after (seconds) |
max_queue_length | integer | No | Max queue length |
wrap_up_seconds | integer | No | Wrap-up time (seconds) |
business_hours | jsonb | No | Business hours |
out_of_hours_action | text | No | Out of hours Allowed: voicemail message overflow reject callback |
overflow_queue_id | uuid | No | Overflow to |
greeting | text | No | Greeting |
greeting_local | text | No | Local greeting |
is_active | boolean | No | Active |
Sample body
{
"code": "COD-000001",
"name": "Example",
"name_local": "Example",
"description": "text",
"connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"channels": []
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"name_local": "Example",
"description": "text",
"connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"channels": [],
"routing": "text",
"required_skills": [],
"priority": 10,
"target_answer_seconds": 10,
"max_wait_seconds": 10,
"callback_after_seconds": 10
}Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/interaction-queues" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example","name_local":"Example","description":"text","connection_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","channels":[]}'PUT/api/crm/interaction-queues/{id}Change a queue
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Code |
name | text | Yes | Name |
name_local | text | No | Local name |
description | text | No | What it is for |
connection_id | uuid | No | Through |
channels | _text | No | Channels |
routing | text | No | Routing — Longest idle is the fair one. Skill-based is the useful one and needs the skills to be kept up to date, which is why it is not the default. |
required_skills | _text | No | Required skills |
priority | integer | No | Priority |
target_answer_seconds | integer | No | Answer within (seconds) |
max_wait_seconds | integer | No | Longest hold (seconds) |
callback_after_seconds | integer | No | Offer a callback after (seconds) |
max_queue_length | integer | No | Max queue length |
wrap_up_seconds | integer | No | Wrap-up time (seconds) |
business_hours | jsonb | No | Business hours |
out_of_hours_action | text | No | Out of hours Allowed: voicemail message overflow reject callback |
overflow_queue_id | uuid | No | Overflow to |
greeting | text | No | Greeting |
greeting_local | text | No | Local greeting |
is_active | boolean | No | Active |
Sample body
{
"code": "COD-000001",
"name": "Example"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"name_local": "Example",
"description": "text",
"connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"channels": [],
"routing": "text",
"required_skills": [],
"priority": 10,
"target_answer_seconds": 10,
"max_wait_seconds": 10,
"callback_after_seconds": 10
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/crm/interaction-queues/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example"}'DELETE/api/crm/interaction-queues/{id}Delete a queue
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{ "deleted": true }Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/crm/interaction-queues/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/interaction-queues/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
overrides, preview, withLinesResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/interaction-queues/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'Data model
Every field of a queue, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
org_unit_id | uuid | read only | Org unit id |
code | text | read, write | Code |
name | text | read, write | Name |
name_local | text | read, write | Local name |
description | text | read, write | What it is for |
connection_id | uuid | read, write | Through |
channels | _text | read, write | Channels |
routing | text | read, write | Routing — Longest idle is the fair one. Skill-based is the useful one and needs the skills to be kept up to date, which is why it is not the default. |
required_skills | _text | read, write | Required skills |
priority | integer | read, write | Priority |
target_answer_seconds | integer | read, write | Answer within (seconds) |
max_wait_seconds | integer | read, write | Longest hold (seconds) |
callback_after_seconds | integer | read, write | Offer a callback after (seconds) |
max_queue_length | integer | read, write | Max queue length |
wrap_up_seconds | integer | read, write | Wrap-up time (seconds) |
business_hours | jsonb | read, write | Business hours |
holiday_calendar_id | uuid | read only | Holiday calendar id |
out_of_hours_action | text | read, write | Out of hours Allowed: voicemail message overflow reject callback |
overflow_queue_id | uuid | read, write | Overflow to |
greeting | text | read, write | Greeting |
greeting_local | text | read, write | Local greeting |
is_active | boolean | read, write | Active |
created_at | timestamp with time zone | read only | Created at |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold CRM › Queues for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused by the same validation as the screen; the error names the field and why |
Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.