Agents and variables

An agent decides what is said on the call. In the API it is called scriptId.

Find the ID

Open the agent in the dashboard. The number in the URL is the ID:

app.scalysis.com/call-agent/2207   →   "scriptId": 2207

Test the agent from the dashboard before using it in the API.

If the agent’s script contains {brand_name} or {{brand_name}}, every call must send a value for it. Send it as a normal field in the body:

{
  "scriptId": 2207,
  "customerPhone": "9149874123",
  "brand_name": "Acme Store"
}

Missing one returns 400:

{ "success": false, "error": "Missing required script variables: brand_name" }

These variables fill from the normal call fields. You do not need to send them twice.

Any other variable (like brand_name) is sent with its own name. brand_name and brandName both work.

Agents set to inbound only cannot place calls. You get 400 if you use one.