Hanzo
OpenapiTel

Dials.

Dials. An `agent` names a Hanzo assistant to answer it; the call is refused up front when no assistant plane is configured, because a call that connects…

POST /v1/tel/calls

Addresshttps://api.hanzo.ai/v1/tel/calls
MethodPOST
Operationpost_tel_calls
AuthAuthorization: Bearer $HANZO_API_KEY

Dials. An agent names a Hanzo assistant to answer it; the call is refused up front when no assistant plane is configured, because a call that connects to silence has already cost the person who answered it.

Request

5 fields, body application/json (required).

FieldInTypeRequiredDescription
agentbodystringAgent hands the answered call to a Hanzo assistant by name instead of connecting it to a person.
frombodystringFrom is the number to call FROM, in E.164.
recordbodybooleanRecord is a per-call flag rather than a product.
tobodystringTo is the number to call, in E.164.
webhookbodystringWebhook is a URL the carrier posts this call's events to as it progresses.

Response

StatusBodyMeaning
201Callcreated

201 body — 6 fields.

FieldInTypeAlwaysDescription
agentbodystringAgent names the Hanzo assistant handling the call.
frombodystringFrom is the calling number in E.164.
idbodystringID is the carrier's handle for the call — what a hangup or a lookup names.
orgbodystringOrg is the tenant the call was placed for or received by.
statusbodystringStatus is where the call is: "queued", "ringing", "answered", "completed" or "failed".
tobodystringTo is the called number in E.164.

Failure carries the platform error shape — see Errors.

Examples

hanzo tel calls create

Tel API · All Hanzo APIs · Interactive reference

How is this guide?

On this page