API reference
Campaigns
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/campaigns
Outbound campaigns, oldest first.
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[].mode | string | Yes | |
data[].purpose | string | Yes | |
data[].status | string | Yes | |
data[].queueId | string (uuid) or null | Yes | |
data[].createdAt | string (date-time) | Yes | |
data[].updatedAt | string (date-time) | 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/campaigns' \
-H "Authorization: Bearer $CC_TOKEN"GET /api/v1/campaigns/{id}
One campaign.
Parameters
| Name | In | Type | Required | Constraints |
|---|---|---|---|---|
id | path | string (uuid) | Yes |
Response
200 JSON with these fields.
| Field | Type | Required | Constraints |
|---|---|---|---|
id | string (uuid) | Yes | |
name | string | Yes | |
mode | string | Yes | |
purpose | string | Yes | |
status | string | Yes | |
queueId | string (uuid) or null | Yes | |
createdAt | string (date-time) | Yes | |
updatedAt | string (date-time) | Yes |
Errors
400, 401, 403, 404, 409, 429. What each status means
Example request
curl -X GET 'https://api.ringura.com/api/v1/campaigns/0192f5a0-7c1e-7d3a-9b2e-3f4a5b6c7d8e' \
-H "Authorization: Bearer $CC_TOKEN"