API reference

Interactions

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/interactions`

Calls, chats and threads, oldest first.

Parameters of GET /api/v1/interactions
Name	In	Type	Required	Constraints
`limit`	query	integer	No	1 to 200
`cursor`	query	string	No	at most 400 characters
`conversationId`	query	string (uuid)	No
`channel`	query	string	No	at most 20 characters

200 JSON with these fields.

Response fields of GET /api/v1/interactions
Field	Type	Required
`data`	array of object	Yes
`data[].id`	string (uuid)	Yes
`data[].conversationId`	string (uuid)	Yes
`data[].type`	string	Yes
`data[].channel`	string	Yes
`data[].direction`	string	Yes
`data[].status`	string	Yes
`data[].startedAt`	string (date-time)	Yes
`data[].endedAt`	string (date-time) or null	Yes
`data[].remoteAddress`	string or null	Yes
`data[].localAddress`	string or null	Yes
`nextCursor`	string or null	Yes

400, 401, 403, 404, 409, 429. What each status means

curl -X GET 'https://api.ringura.com/api/v1/interactions' \
  -H "Authorization: Bearer $CC_TOKEN"

One call, chat or thread.

Parameters of GET /api/v1/interactions/{id}
Name	In	Type	Required	Constraints
`id`	path	string (uuid)	Yes

200 JSON with these fields.

Response fields of GET /api/v1/interactions/{id}
Field	Type	Required
`id`	string (uuid)	Yes
`conversationId`	string (uuid)	Yes
`type`	string	Yes
`channel`	string	Yes
`direction`	string	Yes
`status`	string	Yes
`startedAt`	string (date-time)	Yes
`endedAt`	string (date-time) or null	Yes
`remoteAddress`	string or null	Yes
`localAddress`	string or null	Yes

400, 401, 403, 404, 409, 429. What each status means

curl -X GET 'https://api.ringura.com/api/v1/interactions/0192f5a0-7c1e-7d3a-9b2e-3f4a5b6c7d8e' \
  -H "Authorization: Bearer $CC_TOKEN"