API reference
Messages
2 operations. Base URL: https://api.ringura.com/api/v1. Authenticate with a bearer token that carries the scope named on each operation.
GET /api/v1/conversations/{id}/messages
A conversation's messages across its threads, oldest first.
Parameters
| Name | In | Type | Required | Constraints |
|---|---|---|---|---|
id | path | string (uuid) | Yes | |
limit | query | integer | No | 1 to 200 |
cursor | query | string | No | at most 400 characters |
Response
200 JSON with these fields.
| Field | Type | Required | Constraints |
|---|---|---|---|
data | array of object | Yes | |
data[].id | string (uuid) | Yes | |
data[].conversationId | string (uuid) | Yes | |
data[].interactionId | string (uuid) | Yes | |
data[].direction | string | Yes | one of "inbound", "outbound", "internal" |
data[].kind | string | Yes | |
data[].body | string or null | Yes | |
data[].status | string | Yes | |
data[].sentAt | string (date-time) | Yes | |
data[].author | object | Yes | |
data[].author.kind | string or null | Yes | |
data[].author.agentId | string (uuid) or null | Yes | |
data[].author.label | string or null | Yes | |
data[].aiGenerated | boolean | Yes | |
data[].aiProvenance | object or null | Yes | free-form object |
nextCursor | string or null | Yes |
Errors
400, 401, 403, 404, 409, 429. What each status means
Example request
curl -X GET 'https://api.ringura.com/api/v1/conversations/0192f5a0-7c1e-7d3a-9b2e-3f4a5b6c7d8e/messages' \
-H "Authorization: Bearer $CC_TOKEN"POST /api/v1/conversations/{id}/messages
Send a text or an approved WhatsApp template on one of the conversation's threads (web chat, WhatsApp, e-mail or SMS), under every rule the console applies.
Parameters
| Name | In | Type | Required | Constraints |
|---|---|---|---|---|
id | path | string (uuid) | Yes | |
Idempotency-Key | header | string | No | matches ^[A-Za-z0-9_.:-]{8,100}$ |
Request body
JSON (Content-Type: application/json).
| Field | Type | Required | Constraints |
|---|---|---|---|
interactionId | string (uuid) | Yes | |
type | string | Yes | one of "text", "template" |
body | string | No | 1-4096 characters |
template | object | No | |
template.name | string | Yes | at most 512 characters |
template.language | string | Yes | at most 20 characters |
template.parameters | object | No | free-form object |
Response
201 JSON with these fields.
| Field | Type | Required | Constraints |
|---|---|---|---|
messageId | string (uuid) | Yes | |
status | string | Yes | |
replayed | boolean | Yes |
Errors
400, 401, 403, 404, 409, 422, 429. What each status means
Example request
curl -X POST 'https://api.ringura.com/api/v1/conversations/0192f5a0-7c1e-7d3a-9b2e-3f4a5b6c7d8e/messages' \
-H "Authorization: Bearer $CC_TOKEN" \
-H 'Idempotency-Key: order-2027-0001' \
-H 'Content-Type: application/json' \
-d '{
"interactionId": "0192f5a0-7c1e-7d3a-9b2e-3f4a5b6c7d8e",
"type": "text"
}'