CRM · Services and actions
Interaction
The interaction service of CRM: 10 operation(s).
/api/crm/interactionOverview
| 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 › Interaction 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. |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
10 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/crm/interaction/platformsPlatforms
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/crm/interaction/platforms" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/interaction/connections/{id}/credentialConnections credential
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):
token, key, client_secret, auth_token, passwordResponse
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/connections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/credential" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"token":"value","key":"value","client_secret":"value","auth_token":"value","password":"value"}'POST/api/crm/interaction/connections/{id}/events-addressConnections events address
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/interaction/connections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/events-address" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/interaction/connections/{id}/testConnections test
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/interaction/connections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/test" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/interaction/callCall
Request body
The keys this action reads (* = required; "one of" lists the only values):
fromUserId, to*, connectionId, queueId, accountId, contactId, leadId, caseId, subject, channel; channel one of voice|video|meeting|chat|sms|whatsapp|email|social|callback|internalResponse
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/call" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"fromUserId":"value","to":"value","connectionId":"value","queueId":"value","accountId":"value","contactId":"value"}'POST/api/crm/interaction/logLog
Request body
The keys this action reads (* = required; "one of" lists the only values):
channel, direction, accountId, contactId, leadId, caseId, opportunityId, from, to, callerName, subject, notes, disposition, outcome, sentiment, startedAt, talkSeconds; channel one of voice|video|meeting|chat|sms|whatsapp|email|social|callback|internal; direction one of inbound|outbound|internal; sentiment one of positive|neutral|negative|mixedResponse
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/log" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"channel":"value","direction":"value","accountId":"value","contactId":"value","leadId":"value","caseId":"value"}'POST/api/crm/interaction/calls/{id}/closeCalls close
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):
reopen, disposition, outcome, notes, sentiment, priority, amount; sentiment one of positive|neutral|negative|mixedResponse
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/calls/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/close" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"reopen":"value","disposition":"value","outcome":"value","notes":"value","sentiment":"value","priority":"value"}'POST/api/crm/interaction/presencePresence
Request body
The keys this action reads (* = required; "one of" lists the only values):
state, reason; state one of available|busy|on_call|wrap_up|break|training|meeting|away|do_not_disturb|offlineResponse
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/presence" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"state":"value","reason;":"value"}'POST/api/crm/interaction/presence/syncPresence sync
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/interaction/presence/sync" \
-H "Authorization: Bearer $TOKEN"GET/api/crm/interaction/boardBoard
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/crm/interaction/board" \
-H "Authorization: Bearer $TOKEN"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 › Interaction 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.