Request an AI call

POSThttps://api.norreach.app/v1/calls

Asks the AI caller to call a SAVED contact (contact_id — never a free-typed number), optionally under a campaign and with one of your voice agents. It is an API send: it waits in Approvals when the workspace (or the campaign) approves before sending, or when the key lacks approvals:decide; approve: true (with approvals:decide) approves it at once. Up front: suppressed, do-not-contact, no lawful basis or quiet hours → 422 send_blocked with reason; a number in a country the workspace doesn't call → 422 send_blocked country_off; the API's hourly cap (30 calls per workspace) → 429. The engine checks everything again when it dials. Follow it with GET /calls/{id}.

⚠ calls:placeRole must allow: calls.placeIdempotency-Key requiredSupports dry_runReaches peopleOperation id: request_call

POST/calls

curl -X POST "https://api.norreach.app/v1/calls" \
  -H "Authorization: Bearer $NORREACH_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "contact_id": "7d1c3b2a-5e4f-4a1b-9c8d-0e1f2a3b4c5d",
  "voice_agent_id": "9c0d1e2f-3a4b-4c5d-8e6f-7a8b9c0d1e2f"
}'

Request an AI call

{
  "object": "send_request",
  "id": "0d1e2f3a-4b5c-4d6e-9f7a-8b9c0d1e2f3a",
  "kind": "call",
  "channel": "call",
  "contact_id": "7d1c3b2a-5e4f-4a1b-9c8d-0e1f2a3b4c5d",
  "status": "awaiting_approval",
  "approval_key": "rule_send:0d1e2f3a-4b5c-4d6e-9f7a-8b9c0d1e2f3a",
  "note": "It waits in Approvals until someone says yes."
}

Authorizations

Authorizationstringheaderrequired

Bearer authentication: send Authorization: Bearer <key>, with an API key or an OAuth access token. The key needs the scope calls:place. API keys and scopes

Query parameters

dry_runbooleanquery

Run every check and return what would happen, changing nothing.

Headers

Idempotency-Keystringheaderrequired

Any unique string (≤ 255). The same key with the same request returns the first answer for 24 hours.

Body

application/json

contact_idstring (uuid)required

An id (UUID).

campaign_idstring (uuid)

An id (UUID).

voice_agent_idstring (uuid)

One of GET /voice-agents (default: the campaign's or the workspace's).

approveboolean

Response

202application/json— Request an AI call

object"send_request"required

idstring (uuid) | nullrequired

The request's id — poll GET /messages/{id} or GET /calls/{id} with it.

kindenumrequired

One of:messagecall

channelstringrequired

contact_idstring (uuid)required

An id (UUID).

statusenumrequired

awaiting_approval = it waits in Approvals; queued = approved, it goes out within a minute through the send checks.

One of:awaiting_approvalqueueddry_run

approval_keystring | nullrequired

The Approvals key (approve it with POST /approvals/{key}/approve).

notestringrequired

wouldobject

Dry run: what would happen.

Show child attributes

would.statusenumrequired

One of:awaiting_approvalqueued

Errors

Errors are application/problem+json with a stable code.

Status	Code	Meaning
400	`bad_request`	The request couldn't be read.
400	`unknown_field`	The request has a field this operation doesn't know.
400	`idempotency_key_required`	This operation needs an Idempotency-Key header.
401	`unauthorized`	A valid API key is required.
403	`insufficient_scope`	This API key doesn't have the scope this operation needs.
403	`feature_not_enabled`	The API isn't switched on for this workspace.
403	`role_forbidden`	The key's creator's role can't do this.
404	`not_found`	That doesn't exist.
409	`idempotency_in_progress`	A request with this Idempotency-Key is still running.
409	`outreach_paused`	Outreach is paused for this workspace.
413	`too_large`	The request body is too large.
422	`validation_failed`	The request has invalid fields.
422	`idempotency_mismatch`	This Idempotency-Key was used with a different request.
422	`send_blocked`	This can't be sent to this person.
429	`rate_limited`	Too many requests. Slow down and try again.
429	`send_cap_reached`	The workspace's sending limit for now is reached.
500	`server_error`	Something went wrong on our side.
503	`unavailable`	The API isn't available right now. Try again shortly.

POST/calls

curl -X POST "https://api.norreach.app/v1/calls" \
  -H "Authorization: Bearer $NORREACH_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "contact_id": "7d1c3b2a-5e4f-4a1b-9c8d-0e1f2a3b4c5d",
  "voice_agent_id": "9c0d1e2f-3a4b-4c5d-8e6f-7a8b9c0d1e2f"
}'

Request an AI call

{
  "object": "send_request",
  "id": "0d1e2f3a-4b5c-4d6e-9f7a-8b9c0d1e2f3a",
  "kind": "call",
  "channel": "call",
  "contact_id": "7d1c3b2a-5e4f-4a1b-9c8d-0e1f2a3b4c5d",
  "status": "awaiting_approval",
  "approval_key": "rule_send:0d1e2f3a-4b5c-4d6e-9f7a-8b9c0d1e2f3a",
  "note": "It waits in Approvals until someone says yes."
}