Create Call — Hail docs

Header Parameters

authorization?string|null

Idempotency-Key?string|null

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

recipient_consent*Recipient Consent

Attestation that you have obtained the lawful consent required to contact this recipient. Hail does not verify consent itself — you are responsible for a lawful basis under TCPA/ePrivacy/PECR/CAN-SPAM/GDPR as applicable. Rejected (422) if not true.

consent_source?|

Where/how consent was obtained (e.g. 'signup form', 'prior customer relationship'). Required (non-empty) when message_type is 'marketing'.

consent_obtained_at?|

When consent was obtained, if known.

message_type?Message Type

'marketing' additionally requires a non-empty consent_source. Use 'informational' for transactional/service communications.

Default"informational"

Value in

"marketing"
"informational"

to*To

from?string|null

system_prompt?string|null

llm?|null

first_message?string|null

ai_disclosure?Ai Disclosure

Speak the AI self-disclosure line ('Hi, this is an AI assistant calling on behalf of ...') as the first thing on the call. Enabled by default. Disable only if you have verified the disclosure is not required for this call — 47 CFR 64.1200(b)(1) requires identifying the initiating business at the start of artificial-voice calls in the US, and several jurisdictions have AI bot-disclosure laws. Hail does not verify this for you. The agent still identifies itself as an AI if asked.

Defaulttrue

voice_config?

conversation_id?|null

metadata?

tools?array<string>|

Agent tools to allow on this call. Omitted: every tool the organization's configured channels support (new channels appear automatically). Empty list: no tools. Tool names are validated against the server's registry.

Response Body

`application/json`

curl -X POST "https://example.com/calls" \  -H "Content-Type: application/json" \  -d '{    "recipient_consent": true,    "to": "string"  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",  "conversation_id": "cc71b11a-25cd-4c2d-9950-df2cc38e3407",  "from_e164": "string",  "to_e164": "string",  "direction": "outbound",  "status": "queued",  "end_reason": "string",  "provider_call_sid": "string",  "livekit_room": "string",  "initial_prompt": "string",  "recording_s3_key": "string",  "requested_at": "2019-08-24T14:15:22Z",  "started_at": "2019-08-24T14:15:22Z",  "answered_at": "2019-08-24T14:15:22Z",  "ended_at": "2019-08-24T14:15:22Z"}

Header Parameters

Request Body

Response Body

201application/json

422application/json

429

`application/json`

`application/json`