TRANXACT.AI Help

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.

Type REST6 operationsBase path /api/crm/channel-connectionsPublished as /api/v1/channel-connections

Download specification (OpenAPI 3.1) Screen: Connected Channels

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 › 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.
Tablecrm.channel_connections · 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/channel-connectionsList connected channels

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",
      "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

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",
  "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.

FieldTypeRequiredDescription
platform_codetextYesPlatform
codetextYesCode
nametextYesName
name_localtextNoLocal name
external_tenanttextNoTenant id — For Teams: Microsoft Entra admin center > Overview > Tenant ID (the directory id). Not a secret.
external_accounttextNoAccount 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_numbertextNoOutbound number
from_emailtextNoFrom address
from_nametextNoFrom name
reply_totextNoReply to
base_urltextNoBase address — For Teams calls: this server’s public https address, which Graph sends call events to. Meetings and presence do not need it.
auth_typetextNoAuthentication
client_idtextNoClient id — For Teams: Entra admin center > App registrations > your app > Application (client) ID.
scopes_textNoScopes
webhook_pathtextNoWebhook 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_enabledbooleanNoRecord calls — Recording without telling the caller is unlawful in most places, and it is a different decision from being able to.
recording_announcementtextNoWhat the caller is told
transcription_enabledbooleanNoTranscribe
statustextNoStatus
Allowed: draft testing active suspended error expired
daily_send_capintegerNoMost sends a day
rate_per_minuteintegerNoMost a minute
notestextNoNotes
is_activebooleanNoActive

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

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
platform_codetextYesPlatform
codetextYesCode
nametextYesName
name_localtextNoLocal name
external_tenanttextNoTenant id — For Teams: Microsoft Entra admin center > Overview > Tenant ID (the directory id). Not a secret.
external_accounttextNoAccount 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_numbertextNoOutbound number
from_emailtextNoFrom address
from_nametextNoFrom name
reply_totextNoReply to
base_urltextNoBase address — For Teams calls: this server’s public https address, which Graph sends call events to. Meetings and presence do not need it.
auth_typetextNoAuthentication
client_idtextNoClient id — For Teams: Entra admin center > App registrations > your app > Application (client) ID.
scopes_textNoScopes
webhook_pathtextNoWebhook 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_enabledbooleanNoRecord calls — Recording without telling the caller is unlawful in most places, and it is a different decision from being able to.
recording_announcementtextNoWhat the caller is told
transcription_enabledbooleanNoTranscribe
statustextNoStatus
Allowed: draft testing active suspended error expired
daily_send_capintegerNoMost sends a day
rate_per_minuteintegerNoMost a minute
notestextNoNotes
is_activebooleanNoActive

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

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/channel-connections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/channel-connections/{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/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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
platform_codetextread, writePlatform
codetextread, writeCode
nametextread, writeName
name_localtextread, writeLocal name
external_tenanttextread, writeTenant id — For Teams: Microsoft Entra admin center > Overview > Tenant ID (the directory id). Not a secret.
external_accounttextread, writeAccount 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_numbertextread, writeOutbound number
from_emailtextread, writeFrom address
from_nametextread, writeFrom name
reply_totextread, writeReply to
base_urltextread, writeBase address — For Teams calls: this server’s public https address, which Graph sends call events to. Meetings and presence do not need it.
auth_typetextread, writeAuthentication
client_idtextread, writeClient id — For Teams: Entra admin center > App registrations > your app > Application (client) ID.
credential_cipherbytearead onlyCredential cipher
credential_last4textread onlyCredential last4
token_expires_attimestamp with time zoneread onlyToken expires at
scopes_textread, writeScopes
webhook_pathtextread, writeWebhook 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_cipherbytearead onlyWebhook secret cipher
recording_enabledbooleanread, writeRecord calls — Recording without telling the caller is unlawful in most places, and it is a different decision from being able to.
recording_announcementtextread, writeWhat the caller is told
transcription_enabledbooleanread, writeTranscribe
statustextread, writeStatus
Allowed: draft testing active suspended error expired
last_checked_attimestamp with time zoneread onlyLast checked at
last_errortextread onlyLast error
daily_send_capintegerread, writeMost sends a day
rate_per_minuteintegerread, writeMost a minute
notestextread, writeNotes
is_activebooleanread, writeActive
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
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
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 › Connected Channels 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.