CRM · Interaction Centre
My Voice
Record your consent and a sample of your own voice, so calls can be placed in it on your behalf. Every such call opens by saying it is an AI-generated voice. Only you can use your voice.
/api/crm/voice-profilesOverview
| 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 › My Voice 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
13 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/crm/voice-profiles/meMe
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/crm/voice-profiles/me" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/voice-profiles/me/recordingMe recording
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/voice-profiles/me/recording" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/voice-profiles/me/enrolMe enrol
Request body
The keys this action reads (* = required; "one of" lists the only values):
engineConnectionId, language, transferToResponse
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/voice-profiles/me/enrol" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"engineConnectionId":"value","language":"value","transferTo":"value"}'POST/api/crm/voice-profiles/me/testMe test
Request body
The keys this action reads (* = required; "one of" lists the only values):
textResponse
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/voice-profiles/me/test" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"text":"value"}'GET/api/crm/voice-profiles/me/clips/{id}Me clips
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/crm/voice-profiles/me/clips/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/voice-profiles/me/revokeMe revoke
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/voice-profiles/me/revoke" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/voice-profiles/me/callMe call
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/voice-profiles/me/call" \
-H "Authorization: Bearer $TOKEN"GET/api/crm/voice-profilesRead my voice
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/crm/voice-profiles" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/voice-profiles/{id}/disableDisable
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):
reasonResponse
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/voice-profiles/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/disable" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"reason":"value"}'POST/api/crm/voice-profiles/{id}/enableEnable
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):
reasonResponse
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/voice-profiles/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/enable" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"reason":"value"}'GET/api/crm/voice-profiles/settingsSettings
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/crm/voice-profiles/settings" \
-H "Authorization: Bearer $TOKEN"PUT/api/crm/voice-profiles/settingsSettings
Request body
The keys this action reads (* = required; "one of" lists the only values):
settingsResponse
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 PUT "https://demo.tranxact.ai/api/crm/voice-profiles/settings" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"settings":"value"}'POST/api/crm/voice-profiles/settings/check-engineSettings check engine
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/voice-profiles/settings/check-engine" \
-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 › My Voice 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.