CRM · Interaction Centre
Interactions
Every call, chat, meeting and message with a customer. The disposition is the field that makes a desk countable and the one most often left empty.
/api/crm/callsPublished as /api/v1/callsOverview
| 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 › Interactions 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.calls · 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/callsList interactions
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",
"call_no": "CAL-000001",
"connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"queue_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"channel": "text",
"direction": "inbound",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"contact_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"lead_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"case_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"opportunity_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"from_address": "text",
"to_address": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/crm/calls?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/crm/calls/{id}Read one interaction
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",
"call_no": "CAL-000001",
"connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"queue_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"channel": "text",
"direction": "inbound",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"contact_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"lead_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"case_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"opportunity_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"from_address": "text",
"to_address": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/crm/calls/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/callsCreate a interaction
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
connection_id | uuid | No | Through |
queue_id | uuid | No | Queue |
channel | text | No | Channel |
direction | text | No | Direction Allowed: inbound outbound internal |
account_id | uuid | No | Customer |
contact_id | uuid | No | Contact |
lead_id | uuid | No | Lead id |
case_id | uuid | No | Case |
opportunity_id | uuid | No | Opportunity id |
from_address | text | No | From |
to_address | text | No | To |
caller_name | text | No | Caller |
agent_user_id | uuid | No | Taken by |
status | text | No | Status |
disposition | text | No | What it was about |
outcome | text | No | Outcome |
subject | text | No | Subject |
subject_local | text | No | Local subject |
notes | text | No | Notes |
notes_local | text | No | Local notes |
sentiment | text | No | Sentiment |
Sample body
{
"connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"queue_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"channel": "text",
"direction": "inbound"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"call_no": "CAL-000001",
"connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"queue_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"channel": "text",
"direction": "inbound",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"contact_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"lead_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"case_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"opportunity_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"from_address": "text",
"to_address": "text"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/calls" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"connection_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","queue_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","channel":"text","direction":"inbound"}'PUT/api/crm/calls/{id}Change a interaction
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 |
|---|---|---|---|
connection_id | uuid | No | Through |
queue_id | uuid | No | Queue |
channel | text | No | Channel |
direction | text | No | Direction Allowed: inbound outbound internal |
account_id | uuid | No | Customer |
contact_id | uuid | No | Contact |
lead_id | uuid | No | Lead id |
case_id | uuid | No | Case |
opportunity_id | uuid | No | Opportunity id |
from_address | text | No | From |
to_address | text | No | To |
caller_name | text | No | Caller |
agent_user_id | uuid | No | Taken by |
status | text | No | Status |
disposition | text | No | What it was about |
outcome | text | No | Outcome |
subject | text | No | Subject |
subject_local | text | No | Local subject |
notes | text | No | Notes |
notes_local | text | No | Local notes |
sentiment | text | No | Sentiment |
Sample body
{
"connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"queue_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"call_no": "CAL-000001",
"connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"queue_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"channel": "text",
"direction": "inbound",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"contact_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"lead_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"case_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"opportunity_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"from_address": "text",
"to_address": "text"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/crm/calls/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"connection_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","queue_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'DELETE/api/crm/calls/{id}Delete a interaction
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/calls/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/calls/{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/calls/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 interaction, 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 |
call_no | text | read only | Call no |
connection_id | uuid | read, write | Through |
queue_id | uuid | read, write | Queue |
channel | text | read, write | Channel |
direction | text | read, write | Direction Allowed: inbound outbound internal |
account_id | uuid | read, write | Customer |
contact_id | uuid | read, write | Contact |
lead_id | uuid | read, write | Lead id |
case_id | uuid | read, write | Case |
opportunity_id | uuid | read, write | Opportunity id |
from_address | text | read, write | From |
to_address | text | read, write | To |
caller_name | text | read, write | Caller |
agent_user_id | uuid | read, write | Taken by |
external_id | text | read only | External id |
conference_url | text | read only | Conference url |
status | text | read, write | Status |
started_at | timestamp with time zone | read only | Started at |
queued_at | timestamp with time zone | read only | Queued at |
answered_at | timestamp with time zone | read only | Answered at |
ended_at | timestamp with time zone | read only | Ended at |
wait_seconds | integer | read only | Wait seconds |
talk_seconds | integer | read only | Talk seconds |
hold_seconds | integer | read only | Hold seconds |
wrap_seconds | integer | read only | Wrap seconds |
transfer_count | integer | read only | Transfer count |
within_target | boolean | read only | Within target |
disposition | text | read, write | What it was about |
outcome | text | read, write | Outcome |
subject | text | read, write | Subject |
subject_local | text | read, write | Local subject |
notes | text | read, write | Notes |
notes_local | text | read, write | Local notes |
sentiment | text | read, write | Sentiment |
created_case_id | uuid | read only | Created case id |
created_opportunity_id | uuid | read only | Created opportunity id |
created_lead_id | uuid | read only | Created lead id |
interaction_id | uuid | read only | Interaction id |
recorded | boolean | read only | Recorded |
recording_url | text | read only | Recording url |
transcript_id | uuid | read only | Transcript id |
cost | numeric | read only | Cost |
currency | text | read only | Currency |
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 |
ai_voice | boolean | read only | Ai voice |
voice_profile_id | uuid | read only | Voice profile id |
call_script_id | uuid | read only | Call script id |
call_script_version | integer | read only | Call script version |
ai_token_hash | text | read only | Ai token hash |
ai_token_expires_at | timestamp with time zone | read only | Ai token expires at |
ai_transfer | boolean | read only | Ai transfer |
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 › Interactions 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.