TRANXACT.AI Help

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.

Type REST6 operationsBase path /api/crm/interaction-queuesPublished as /api/v1/interaction-queues

Download specification (OpenAPI 3.1) Screen: Queues

Overview

PackageCRM
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe 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.
Tablecrm.interaction_queues · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe 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

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"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

NameTypeDescription
idstring (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.

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
name_localtextNoLocal name
descriptiontextNoWhat it is for
connection_iduuidNoThrough
channels_textNoChannels
routingtextNoRouting — 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_textNoRequired skills
priorityintegerNoPriority
target_answer_secondsintegerNoAnswer within (seconds)
max_wait_secondsintegerNoLongest hold (seconds)
callback_after_secondsintegerNoOffer a callback after (seconds)
max_queue_lengthintegerNoMax queue length
wrap_up_secondsintegerNoWrap-up time (seconds)
business_hoursjsonbNoBusiness hours
out_of_hours_actiontextNoOut of hours
Allowed: voicemail message overflow reject callback
overflow_queue_iduuidNoOverflow to
greetingtextNoGreeting
greeting_localtextNoLocal greeting
is_activebooleanNoActive

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

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
name_localtextNoLocal name
descriptiontextNoWhat it is for
connection_iduuidNoThrough
channels_textNoChannels
routingtextNoRouting — 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_textNoRequired skills
priorityintegerNoPriority
target_answer_secondsintegerNoAnswer within (seconds)
max_wait_secondsintegerNoLongest hold (seconds)
callback_after_secondsintegerNoOffer a callback after (seconds)
max_queue_lengthintegerNoMax queue length
wrap_up_secondsintegerNoWrap-up time (seconds)
business_hoursjsonbNoBusiness hours
out_of_hours_actiontextNoOut of hours
Allowed: voicemail message overflow reject callback
overflow_queue_iduuidNoOverflow to
greetingtextNoGreeting
greeting_localtextNoLocal greeting
is_activebooleanNoActive

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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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, withLines

Response

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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
codetextread, writeCode
nametextread, writeName
name_localtextread, writeLocal name
descriptiontextread, writeWhat it is for
connection_iduuidread, writeThrough
channels_textread, writeChannels
routingtextread, writeRouting — 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_textread, writeRequired skills
priorityintegerread, writePriority
target_answer_secondsintegerread, writeAnswer within (seconds)
max_wait_secondsintegerread, writeLongest hold (seconds)
callback_after_secondsintegerread, writeOffer a callback after (seconds)
max_queue_lengthintegerread, writeMax queue length
wrap_up_secondsintegerread, writeWrap-up time (seconds)
business_hoursjsonbread, writeBusiness hours
holiday_calendar_iduuidread onlyHoliday calendar id
out_of_hours_actiontextread, writeOut of hours
Allowed: voicemail message overflow reject callback
overflow_queue_iduuidread, writeOverflow to
greetingtextread, writeGreeting
greeting_localtextread, writeLocal greeting
is_activebooleanread, writeActive
created_attimestamp with time zoneread onlyCreated at
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold CRM › Queues for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused 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.