Skip to navigation

Request a callback

View as Markdown

Also available as the MCP tool request_callback.

Authentication

AuthorizationBearer

Your Truvo API key, sent as a bearer token. The prefix selects sandbox (trv_sandbox_) or live (trv_live_).

Headers

Truvo-VersionenumRequiredDefaults to 2026-09-26

The contract revision of this request, which every operation in this document requires. This document describes 2026-09-26. Served revisions: 2026-09-26. A missing header, or one that names no served revision exactly, answers invalid_version (400), and its field error lists the served revisions in allowed_values, newest first.

Allowed values:

Request

This endpoint expects an object.
phonestringRequired1-32 characters
The number Truvo should call, a US number a person can answer.
namestringOptional1-200 characters
The person's name, when they gave one.
reasonstringOptional1-500 characters
Why the person wants a call, in their words.
quote_request_idstringOptionalformat: "^qreq_[a-z0-9]{8,64}$"
The quote request the person wants help with, when they have one.
lineenumOptional
The line the person is asking about, when they named one.
Allowed values:
statestringOptionalformat: "^[A-Z]{2}$"
The US state the person is asking about, when they named one.

Response headers

Request-Idstringformat: "^req_[0-9a-f]{16}$"

The ID of this answer. An error body repeats it as request_id.

Truvo-Versionstringformat: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"

The contract revision of this answer: the revision that the request named in Truvo-Version. A 404, and a refusal sent before Truvo knows your revision (401, 413, a 429 for failed authentication, and a 400 invalid_version), name the current revision and take its shape.

RateLimit-LimitintegerOptional
The calls this window allows, for the limit you're closest to reaching. The window is one minute or one UTC day. A fixed window allows a burst of up to twice the limit across a window edge.
RateLimit-RemainingintegerOptional
The calls left in the current window.
RateLimit-ResetintegerOptional
Seconds until the current window ends and the count resets.

Response

Queue a call back to the person on the staffed advisor line. Truvo folds a repeat ask for the same number into the open callback.
idstringformat: "^cbr_[0-9a-f]{32}$"
The ID of this callback request.
statusenum

queued is a new request. already_queued means this number already had an open callback, and Truvo folded this ask into it.

Allowed values:

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
413
Content Too Large Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error