API reference
People
3 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/users
The tenant's console users and their roles.
Parameters
| Name | In | Type | Required | Constraints |
|---|---|---|---|---|
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[].email | string | Yes | |
data[].displayName | string | Yes | |
data[].role | string | Yes | |
data[].agentId | string (uuid) or null | Yes | |
data[].status | string | Yes | |
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/users' \
-H "Authorization: Bearer $CC_TOKEN"GET /api/v1/agents
Agents with their presence now.
Parameters
| Name | In | Type | Required | Constraints |
|---|---|---|---|---|
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[].displayName | string | Yes | |
data[].teamId | string (uuid) | Yes | |
data[].status | string | Yes | |
data[].presence | object | Yes | |
data[].presence.state | string or null | Yes | |
data[].presence.reason | string or null | Yes | |
data[].presence.since | string (date-time) or null | Yes | |
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/agents' \
-H "Authorization: Bearer $CC_TOKEN"GET /api/v1/queues
Queues and the channels they take.
Parameters
| Name | In | Type | Required | Constraints |
|---|---|---|---|---|
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[].name | string | Yes | |
data[].channels | array of string | Yes | |
data[].mode | string | Yes | |
data[].scheduleId | string (uuid) or null | Yes | |
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/queues' \
-H "Authorization: Bearer $CC_TOKEN"