Skip to main content

Ringostat API. Working with custom statuses Ringostat Smart Phone.

Working with custom statuses Ringostat Smart Phone.

Written by Olga Kalchenko

1. Get all custom statuses in the project.

This method allows you to get a list of all existing custom statuses.Ringostat Smart Phone in the project.

Basic query parameters:

In order to get custom statuses, you need to create them.

To do this, go to the section “Ringostat Smart Phone Settings” > “Custom Status Settings”

Next, create new statuses.

Example query:

{
"id": 777,
"method": "getCustomStatuses",
"params": {
"projectId": 39071
}
}

Example answer:

{
"id": "777",
"result": [
{ "id": 1763, "title": "At lunch" },
{ "id": 1768, "title": "Break" },
{ "id": 1773, "title": "On the call" },
{ "id": 1778, "title": "On the move" }
],
"jsonrpc": "2.0"
}

2. Get information about employee statuses.

This method allows you to get information about when/who is in what status moved in the applicationRingostat Smart Phone andHow long was he there?

Basic query parameters:

Authorization key auth-key you can find it by going to the “Settings” > “Integration” > “Ringostat API” page. On this page you need to copy the Auth-key to pass it toHeaders в Auth-key.

Example query:

{
"id": 1,
"jsonrpc": "2.0",
"method": "getSipStatusDailyReport",
"params": {
"projectId": 68861,
"filter": {
"from": "2026-03-19",
"to": "2026-03-25"
}
}
}

Example answer:

{
"jsonrpc": "2.0",
"result": [
{"employee": "TEST CY", "online": "01:31:55", "offline": "10:13:15"},
{"employee": "AI IVR Test", "online": "11:44:49", "offline": "00:00:21"},
{"employee": "Sergiy Test", "online": "11:44:49", "offline": "00:00:21"}
"id": 1
],
}

Important: If an employee has two SIP accounts, one online and the other DND, then during this period the employee is considered online, and the DND status is not taken into account.

Similarly, if one of the sips is in the speaking status, then dnd, online and offline do not count, only speaking counts.by priority.

Did this answer your question?