Create calls

Dials.

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
agentbodystring—Agent hands the answered call to a Hanzo assistant by name instead of connecting it to a person.
frombodystring—From is the number to call FROM, in E.164.
recordbodyboolean—Record is a per-call flag rather than a product.
tobodystring—To is the number to call, in E.164.
webhookbodystring—Webhook is a URL the carrier posts this call's events to as it progresses.

Response

StatusBodyMeaning
201tel.Callcreated
defaultproblem-detailsrefused

201 body — 6 fields.

FieldInTypeAlwaysDescription
agentbodystring—Agent names the Hanzo assistant handling the call.
frombodystring—From is the calling number in E.164.
idbodystring—ID is the carrier's handle for the call — what a hangup or a lookup names.
orgbodystring—Org is the tenant the call was placed for or received by.
statusbodystring—Status is where the call is: "queued", "ringing", "answered", "completed" or "failed".
tobodystring—To is the called number in E.164.

Failure carries the platform error shape — see Errors.

Examples

hanzo tel calls create
import { Configuration, TelApi } from 'hanzoai';

const api = new TelApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postTelCalls({ agent: "<agent>", from: "<from>" });
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import TelApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = TelApi(client).post_tel_calls(agent="<agent>", from="<from>")
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.TelAPI.PostTelCalls(context.Background()).Execute()
if err != nil {
	return err
}
use hanzo_client::apis::{configuration::Configuration, tel_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = tel_api::post_tel_calls(&cfg, Default::default()).await?;
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.TelApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new TelApi(client).postTelCalls();
curl -X POST https://api.hanzo.ai/v1/tel/calls \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "agent": "<agent>",
       "from": "<from>"
     }'

MCP reaches tel through the tel tool, which names its 10 operations with its own verbs — this one among them, under a name only MCP declares. describe explains any of them:

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "describe",
         "arguments": {
           "op": "list_tel_calls"
         }
       }
     }'

Tel API · All Hanzo APIs · Interactive reference

Was this page useful?