Operations
Operations

Get lead callback

Read this agent's lead callback webhook (set up with set_lead_callback): whether it is on, the caller ID, brief, opener, calling window, timezone and ring timeout, plus its lead requests newest first (the 20 most recent by default; since, until and limit up to 200 read a date range), each with its status, reason, time, the number's last three digits, the lead's time zone when the submission sent one, and the call's sessionId. Statuses: dialled (the call was placed; open it by sessionId), scheduled (arrived outside the calling window; dialAt is when it will be called), duplicate (the same number already being dialled or scheduled), rejected (reason do_not_call, agent_not_published, from_number_not_owned, daily_cap on rows from before 2026-10-11, trigger_daily_cap, queue_full, trigger_disabled or expired), failed (the voice runtime refused the dial; reason is its error code, e.g. spend_capped), calling (a dial in flight). A dialled row with reason unconfirmed means the runtime's reply was lost (a timeout or network fault): the call may have gone out, so it counts as dialled. A lead on the do-not-call list gets the same answer as a duplicate at the webhook, but its row says rejected / do_not_call. Each request's id is the leadRequestId the lead.received and lead.updated webhooks carry, so a date range here reconciles those events. Rows are deleted after 30 days. Use it to answer 'did the agent call that lead back', to check the webhook is working, or before changing its settings. The webhook URL itself is never shown again after it is minted; set_lead_callback with rotate: true issues a new one.

POST
/operations/get_lead_callback

Authorization

bearerAuth
AuthorizationBearer <token>

A personal access token from Settings > API tokens.

In: header

Header Parameters

Idempotency-Key?string

A key you choose, such as a UUID, that makes this POST safe to retry. Within 24 hours the same key and request answers with the first successful answer and runs nothing, the same key with a different request answers 422 idempotency_key_reused, and a key whose request is still running answers 409 idempotency_key_in_use. A failed request keeps nothing, so the same key runs it again.

Length1 <= length <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/operations/get_lead_callback" \  -H "Content-Type: application/json" \  -d '{    "agent": "string"  }'
{}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ],
  "estimate": {},
  "retryAfterSeconds": 0
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ],
  "estimate": {},
  "retryAfterSeconds": 0
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ],
  "estimate": {},
  "retryAfterSeconds": 0
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ],
  "estimate": {},
  "retryAfterSeconds": 0
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ],
  "estimate": {},
  "retryAfterSeconds": 0
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ],
  "estimate": {},
  "retryAfterSeconds": 0
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ],
  "estimate": {},
  "retryAfterSeconds": 0
}