Field reference

Request fields

Field	Type	Used in	Notes
`scriptId`	number	Call, campaign	Required. Agent ID.
`customerPhone`	string	Call, contacts	Required. `9149874123` or `+919149874123`.
`customerName`	string	Call, contacts	Fills `{customer_name}`.
`orderNumber`	string	Call, contacts	Fills `{order_number}`.
`orderNotes`	string	Call, contacts	Fills `{order_notes}`.
`customerAddress`	string	Call	Fills `{customer_address}`.
`customerEmail`	string	Call	Fills `{customer_email}`.
`productName`	string	Call	Fills `{product_name}`.
`totalPrice`	string	Call	Fills `{order_total}`.
`currency`	string	Call	Fills `{currency}`.
any variable	string	Call	Any other agent variable, by name, like `brand_name`.
`campaignName`	string	Call	Groups API calls under a name in the dashboard.
`contacts`	array	Campaign	List of people. Up to 2,000.
`csvText`	string	Campaign	CSV instead of `contacts`.
`phoneColumn`	string	Campaign	CSV phone column. Default `phone_number`.
`contextColumnHeaders`	string[]	Campaign	CSV columns the agent can use.
`name`	string	Campaign	Campaign name.
`maxConcurrency`	number	Campaign	Calls at once. Default `1`.
`startImmediately`	boolean	Campaign	Start on create. Default `false`.
`action`	string	Control	`start`, `pause` or `resume`.

Field	From	Notes
`success`	All	`false` means read `error`.
`error`	Errors	What went wrong, in plain words.
`order_id`	Trigger	Use it to get the result.
`call_status`	Trigger	`in_progress` when dialing.
`campaign_id`	Campaign	Use it to start, pause, resume.
`state`	Campaign	`not_started`, `running`, `paused`, `completed`, `stopped`.
`contact_count`	Campaign	Contacts accepted.
`callOutcome`	Result	Result label from the agent.
`summary`	Result	Short summary.
`transcript`	Result	`[{ speaker, text, timestamp? }]`.
`callDurationSec`	Result	Talk time in seconds.
`totalCallCost`	Result	Cost of the call.
`recordingUrl`	Result	Audio link, or `null` until saved.