CRM · Interaction Centre
Call Scripts
What a call in a salesperson’s AI voice says. Only an approved script can be used, approved by somebody other than its author; changing an approved script makes a new version, and every call records the version it used. The AI-voice disclosure is always spoken before the script.
/api/crm/call-scriptsPublished as /api/v1/call-scriptsOverview
| 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 › Call Scripts 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.call_scripts · 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
9 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/crm/call-scriptsList call scripts
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",
"version": 10,
"name": "Example",
"purpose": "text",
"language": "en",
"body": "text",
"voicemail_body": "someone@example.com",
"offer_transfer": true,
"status": "draft",
"approved_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"approved_at": "2026-10-30T09:00:00Z",
"created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/crm/call-scripts?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/crm/call-scripts/{id}Read one call script
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",
"version": 10,
"name": "Example",
"purpose": "text",
"language": "en",
"body": "text",
"voicemail_body": "someone@example.com",
"offer_transfer": true,
"status": "draft",
"approved_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"approved_at": "2026-10-30T09:00:00Z",
"created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/crm/call-scripts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/call-scriptsCreate a call script
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Code |
name | text | Yes | Name |
purpose | text | No | Purpose — What the call is for: a follow-up, a renewal reminder, an appointment. |
language | text | No | Language Allowed: en es fr zh ja ko |
body | text | Yes | What is said — Spoken after the disclosure. Merge fields in double braces: {{contact.first_name}}, {{contact.last_name}}, {{contact.name}}, {{account.name}}, {{caller.name}}, {{caller.first_name}}, {{company.name}}, {{opportunity.name}}. A script may not claim to be a person or a real voice. |
voicemail_body | text | No | Voicemail message — Left after the beep when an answering machine takes the call (Twilio). The disclosure is spoken first here too. |
offer_transfer | boolean | No | Offer "press 1" to speak to the salesperson — Where the telephony platform supports it (Twilio, Teams) and the salesperson has given a number on My Voice. |
Sample body
{
"code": "COD-000001",
"name": "Example",
"body": "text",
"purpose": "text",
"language": "en",
"voicemail_body": "someone@example.com",
"offer_transfer": true
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"version": 10,
"name": "Example",
"purpose": "text",
"language": "en",
"body": "text",
"voicemail_body": "someone@example.com",
"offer_transfer": true,
"status": "draft",
"approved_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"approved_at": "2026-10-30T09:00:00Z",
"created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/call-scripts" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example","body":"text","purpose":"text","language":"en","voicemail_body":"someone@example.com","offer_transfer":true}'PUT/api/crm/call-scripts/{id}Change a call script
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 |
purpose | text | No | Purpose — What the call is for: a follow-up, a renewal reminder, an appointment. |
language | text | No | Language Allowed: en es fr zh ja ko |
body | text | Yes | What is said — Spoken after the disclosure. Merge fields in double braces: {{contact.first_name}}, {{contact.last_name}}, {{contact.name}}, {{account.name}}, {{caller.name}}, {{caller.first_name}}, {{company.name}}, {{opportunity.name}}. A script may not claim to be a person or a real voice. |
voicemail_body | text | No | Voicemail message — Left after the beep when an answering machine takes the call (Twilio). The disclosure is spoken first here too. |
offer_transfer | boolean | No | Offer "press 1" to speak to the salesperson — Where the telephony platform supports it (Twilio, Teams) and the salesperson has given a number on My Voice. |
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",
"version": 10,
"name": "Example",
"purpose": "text",
"language": "en",
"body": "text",
"voicemail_body": "someone@example.com",
"offer_transfer": true,
"status": "draft",
"approved_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"approved_at": "2026-10-30T09:00:00Z",
"created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/crm/call-scripts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example"}'DELETE/api/crm/call-scripts/{id}Delete a call script
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/call-scripts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/call-scripts/{id}/approveApprove
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
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/call-scripts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/approve" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/call-scripts/{id}/retireRetire
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
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/call-scripts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/retire" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/call-scripts/{id}/new-versionNew version
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
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/call-scripts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/new-version" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/call-scripts/{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/call-scripts/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 call script, 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 |
version | integer | read only | Version |
name | text | read, write | Name |
purpose | text | read, write | Purpose — What the call is for: a follow-up, a renewal reminder, an appointment. |
language | text | read, write | Language Allowed: en es fr zh ja ko |
body | text | read, write | What is said — Spoken after the disclosure. Merge fields in double braces: {{contact.first_name}}, {{contact.last_name}}, {{contact.name}}, {{account.name}}, {{caller.name}}, {{caller.first_name}}, {{company.name}}, {{opportunity.name}}. A script may not claim to be a person or a real voice. |
voicemail_body | text | read, write | Voicemail message — Left after the beep when an answering machine takes the call (Twilio). The disclosure is spoken first here too. |
offer_transfer | boolean | read, write | Offer "press 1" to speak to the salesperson — Where the telephony platform supports it (Twilio, Teams) and the salesperson has given a number on My Voice. |
status | text | read only | Status |
approved_by | uuid | read only | Approved by |
approved_at | timestamp with time zone | read only | Approved at |
created_by | uuid | read only | Created by |
created_at | timestamp with time zone | read only | Created at |
updated_by | uuid | read only | Updated by |
updated_at | timestamp with time zone | read only | Updated 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 |
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 › Call Scripts 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.