CRM · Interaction Centre
Connected Channels
Teams, Zoom, Twilio, a contact centre, an email provider — what this company can actually reach a customer through, and what each one is capable of. Microsoft Teams calls, meetings and presence are set up here: register an app in Microsoft Entra, grant it the Graph application permissions Calls.Initiate.All, OnlineMeetings.ReadWrite.All, Presence.Read.All and CallRecords.Read.All with admin consent, enter its tenant id and client id below, save its client secret with "Set the credential", then press "Test it" — the test names anything still missing. TRANXACT starts the call or meeting and logs it; the conversation itself happens in Teams.
/api/crm/channel-connectionsPublished as /api/v1/channel-connectionsDownload specification (OpenAPI 3.1) Screen: Connected Channels
Overview
| 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 › Connected Channels 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.channel_connections · 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/channel-connectionsList connected channels
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",
"platform_code": "PLA-000001",
"code": "COD-000001",
"name": "Example",
"name_local": "Example",
"external_tenant": "text",
"external_account": "text",
"from_number": "FRO-000001",
"from_email": "someone@example.com",
"from_name": "Example",
"reply_to": "text",
"base_url": "https://example.com",
"auth_type": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/crm/channel-connections?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/crm/channel-connections/{id}Read one connected channel
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",
"platform_code": "PLA-000001",
"code": "COD-000001",
"name": "Example",
"name_local": "Example",
"external_tenant": "text",
"external_account": "text",
"from_number": "FRO-000001",
"from_email": "someone@example.com",
"from_name": "Example",
"reply_to": "text",
"base_url": "https://example.com",
"auth_type": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/crm/channel-connections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/channel-connectionsCreate a connected channel
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
platform_code | text | Yes | Platform |
code | text | Yes | Code |
name | text | Yes | Name |
name_local | text | No | Local name |
external_tenant | text | No | Tenant id — For Teams: Microsoft Entra admin center > Overview > Tenant ID (the directory id). Not a secret. |
external_account | text | No | Account or audience id — For Teams calls to phone numbers: the object id of the resource account calls are placed from (Teams admin center > Voice > Resource accounts, the account with the number and the Teams Phone licence). Graph places a call to a number only from that account. |
from_number | text | No | Outbound number |
from_email | text | No | From address |
from_name | text | No | From name |
reply_to | text | No | Reply to |
base_url | text | No | Base address — For Teams calls: this server’s public https address, which Graph sends call events to. Meetings and presence do not need it. |
auth_type | text | No | Authentication |
client_id | text | No | Client id — For Teams: Entra admin center > App registrations > your app > Application (client) ID. |
scopes | _text | No | Scopes |
webhook_path | text | No | Webhook path — For Teams calls: the path of the calling webhook set on the Azure Bot registered for the same app (Microsoft Teams channel, Calling enabled). Graph refuses to place a call without one. |
recording_enabled | boolean | No | Record calls — Recording without telling the caller is unlawful in most places, and it is a different decision from being able to. |
recording_announcement | text | No | What the caller is told |
transcription_enabled | boolean | No | Transcribe |
status | text | No | Status Allowed: draft testing active suspended error expired |
daily_send_cap | integer | No | Most sends a day |
rate_per_minute | integer | No | Most a minute |
notes | text | No | Notes |
is_active | boolean | No | Active |
Sample body
{
"platform_code": "PLA-000001",
"code": "COD-000001",
"name": "Example",
"name_local": "Example",
"external_tenant": "text",
"external_account": "text",
"from_number": "FRO-000001"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"platform_code": "PLA-000001",
"code": "COD-000001",
"name": "Example",
"name_local": "Example",
"external_tenant": "text",
"external_account": "text",
"from_number": "FRO-000001",
"from_email": "someone@example.com",
"from_name": "Example",
"reply_to": "text",
"base_url": "https://example.com",
"auth_type": "text"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/channel-connections" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"platform_code":"PLA-000001","code":"COD-000001","name":"Example","name_local":"Example","external_tenant":"text","external_account":"text","from_number":"FRO-000001"}'PUT/api/crm/channel-connections/{id}Change a connected channel
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 |
|---|---|---|---|
platform_code | text | Yes | Platform |
code | text | Yes | Code |
name | text | Yes | Name |
name_local | text | No | Local name |
external_tenant | text | No | Tenant id — For Teams: Microsoft Entra admin center > Overview > Tenant ID (the directory id). Not a secret. |
external_account | text | No | Account or audience id — For Teams calls to phone numbers: the object id of the resource account calls are placed from (Teams admin center > Voice > Resource accounts, the account with the number and the Teams Phone licence). Graph places a call to a number only from that account. |
from_number | text | No | Outbound number |
from_email | text | No | From address |
from_name | text | No | From name |
reply_to | text | No | Reply to |
base_url | text | No | Base address — For Teams calls: this server’s public https address, which Graph sends call events to. Meetings and presence do not need it. |
auth_type | text | No | Authentication |
client_id | text | No | Client id — For Teams: Entra admin center > App registrations > your app > Application (client) ID. |
scopes | _text | No | Scopes |
webhook_path | text | No | Webhook path — For Teams calls: the path of the calling webhook set on the Azure Bot registered for the same app (Microsoft Teams channel, Calling enabled). Graph refuses to place a call without one. |
recording_enabled | boolean | No | Record calls — Recording without telling the caller is unlawful in most places, and it is a different decision from being able to. |
recording_announcement | text | No | What the caller is told |
transcription_enabled | boolean | No | Transcribe |
status | text | No | Status Allowed: draft testing active suspended error expired |
daily_send_cap | integer | No | Most sends a day |
rate_per_minute | integer | No | Most a minute |
notes | text | No | Notes |
is_active | boolean | No | Active |
Sample body
{
"platform_code": "PLA-000001",
"code": "COD-000001"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"platform_code": "PLA-000001",
"code": "COD-000001",
"name": "Example",
"name_local": "Example",
"external_tenant": "text",
"external_account": "text",
"from_number": "FRO-000001",
"from_email": "someone@example.com",
"from_name": "Example",
"reply_to": "text",
"base_url": "https://example.com",
"auth_type": "text"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/crm/channel-connections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"platform_code":"PLA-000001","code":"COD-000001"}'DELETE/api/crm/channel-connections/{id}Delete a connected channel
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/channel-connections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/channel-connections/{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/channel-connections/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 connected channel, 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 |
platform_code | text | read, write | Platform |
code | text | read, write | Code |
name | text | read, write | Name |
name_local | text | read, write | Local name |
external_tenant | text | read, write | Tenant id — For Teams: Microsoft Entra admin center > Overview > Tenant ID (the directory id). Not a secret. |
external_account | text | read, write | Account or audience id — For Teams calls to phone numbers: the object id of the resource account calls are placed from (Teams admin center > Voice > Resource accounts, the account with the number and the Teams Phone licence). Graph places a call to a number only from that account. |
from_number | text | read, write | Outbound number |
from_email | text | read, write | From address |
from_name | text | read, write | From name |
reply_to | text | read, write | Reply to |
base_url | text | read, write | Base address — For Teams calls: this server’s public https address, which Graph sends call events to. Meetings and presence do not need it. |
auth_type | text | read, write | Authentication |
client_id | text | read, write | Client id — For Teams: Entra admin center > App registrations > your app > Application (client) ID. |
credential_cipher | bytea | read only | Credential cipher |
credential_last4 | text | read only | Credential last4 |
token_expires_at | timestamp with time zone | read only | Token expires at |
scopes | _text | read, write | Scopes |
webhook_path | text | read, write | Webhook path — For Teams calls: the path of the calling webhook set on the Azure Bot registered for the same app (Microsoft Teams channel, Calling enabled). Graph refuses to place a call without one. |
webhook_secret_cipher | bytea | read only | Webhook secret cipher |
recording_enabled | boolean | read, write | Record calls — Recording without telling the caller is unlawful in most places, and it is a different decision from being able to. |
recording_announcement | text | read, write | What the caller is told |
transcription_enabled | boolean | read, write | Transcribe |
status | text | read, write | Status Allowed: draft testing active suspended error expired |
last_checked_at | timestamp with time zone | read only | Last checked at |
last_error | text | read only | Last error |
daily_send_cap | integer | read, write | Most sends a day |
rate_per_minute | integer | read, write | Most a minute |
notes | text | read, write | Notes |
is_active | boolean | read, write | Active |
created_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
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 |
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 › Connected Channels 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.