Skip to main content
POST

Authorizations

Authorization
string
header
required

API key from your Sarj.ai dashboard.

Body

application/json
phone_number
string
required

Phone number to call in E.164 format: + and the country code, with no national trunk 0 (for example +966512345678, not +9660512345678 or 0966512345678). Undialable numbers are rejected with 422.

Example:

"+966512345678"

scenario_id
string
required

Active scenario UUID from the dashboard.

Minimum string length: 1
Example:

"550e8400-e29b-41d4-a716-446655440000"

variables
Variables · object

Template variables to inject into the scenario.

language
enum<string>
default:ar

Call language.

Available options:
en,
ar,
ur
scheduled_at
string<date-time> | null

Future dial time with timezone, 10 minutes to 30 days ahead. Omitted or null: dial now.

schedule_config_id
string | null

Retry policy ID. Omitted: use the scenario's default policy, if configured.

Example:

"01890000-0000-7000-8000-000000000000"

Response

Call accepted. Use the returned ID to track its outcome.

data
PublicCall · object
required
meta
ResponseMeta · object
required

Request metadata.