Sign in
latestOpenAPI 3.1.1Proprietary – Contact us for usage terms2026-08-20173183551.4 KB

9da73dd2f99e

calls

List current (live) calls

Retrieve the currently active (in-progress) calls. This endpoint uses POST to accept optional filter criteria in the request body. Live calls include ringing, answered, and on-hold calls. The response is a snapshot — it reflects the state at the exact moment of the request.

Visibility depends on your role: a standard user receives only their own current calls, while a user with supervisor or admin rights receives the whole team's current calls.

Note: send the request with the Content-Type: application/json header (even when the body is an empty {}), otherwise it is rejected with 415 Unsupported Media Type.

Permission: Calls Read required.

Monitoring: No impact — visibility is derived from your role (see above), not from the Monitoring flag.

post/calls/current

Request body

statusstring[] nullable
interfacestring[] nullable
direction'IN' | 'OUT' nullable
limit_countinteger nullable

Used to create a pagination cursor

limit_offsetinteger nullable

Used to create a pagination cursor

Example request

{
  "status": [
    "ANSWERED",
    "RINGING"
  ],
  "interface": [
    "SIP",
    "MOBILE"
  ],
  "advanced": {
    "ivrs": [
      {
        "ivr_id": 19479175,
        "numbers": [
          331797500010
        ],
        "scenarios": [
          19479175,
          19479176
        ]
      }
    ]
  },
  "limit_count": 1
}

Response

Successful operation

user_idinteger

The identifier of the user

team_idinteger

The identifier of the team

limit_offset_settedinteger
limit_count_settedinteger
total_current_calls_countinteger
current_calls_list_countinteger

Example response

{
  "user_id": 123456,
  "team_id": 654321,
  "limit_offset_setted": 19479170,
  "limit_count_setted": 1,
  "total_current_calls_count": 54783,
  "current_calls_list_count": 1,
  "current_calls_list": [
    {
      "call_id": "9058220947198957713",
      "type": "USER_CALL",
      "direction": "IN",
      "user_id": 123456,
      "ivr_id": 234567,
      "from_number": "Unknown",
      "to_number": "33123456789",
      "interface": "APP",
      "status": "ANSWERED",
      "channel_id": "d24da4f1-b267-4bb7-aea8-7f92296abe09",
      "creation_date": "2018-08-12T12:12:40.53Z"
    }
  ]
}