List queued calls

GET

https://api.levrage.ai/v1/calls/queued

GET

/v1/calls/queued

import requests
url = "https://api.levrage.ai/v1/calls/queued"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.json())

{
  "data": [
    {
      "id": "string",
      "status": "string",
      "agent_id": "string",
      "phone_number": "string",
      "source_number": "string",
      "open": false,
      "metadata": {},
      "note": "string",
      "requests": 1,
      "scheduled_for": "2024-01-15T09:30:00Z",
      "expires_at": "2024-01-15T09:30:00Z",
      "placed_at": "2024-01-15T09:30:00Z",
      "session_id": "string",
      "call_status": "string",
      "retry": {},
      "attempts": 0,
      "tries": 1,
      "last_outcome": "string",
      "history": [
        {}
      ],
      "created_at": "2024-01-15T09:30:00Z",
      "updated_at": "2024-01-15T09:30:00Z",
      "finished_at": "2024-01-15T09:30:00Z"
    }
  ],
  "total": 1,
  "page": 1,
  "page_size": 1,
  "has_more": true,
  "request_id": "string",
  "timestamp": "2024-01-15T09:30:00Z",
  "success": true
}

Calls placed with POST /call outside calling hours, newest first. A waiting call goes out at scheduled_for; once placed, session_id is the call (GET /calls/{call_id}) and call_status its result.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

pageintegerOptional>=1Defaults to 1

Page number

page_sizeintegerOptional1-100Defaults to 20

Items per page

statusstring or nullOptional

waiting, calling, placed, completed, not_reached, failed, cancelled, expired

stateenum or nullOptional

open = still to go out or on the call; finished; cancelled

Allowed values:

phone_numberstring or nullOptional

Only this number's queued calls

Response

Successful Response

datalist of objects

totalinteger

pageinteger

page_sizeinteger

has_moreboolean

request_idstring

timestampdatetime

successbooleanOptionalDefaults to true

Errors

422

Unprocessable Entity Error