Automations
Trigger an automation call for one customer, and cancel it before it is dialled. You build automations in the console. See Triggering calls.
Trigger an automation call
Authenticated with an organization API key holding service_configuration:write; the project is the automation's. A revoked or expired key may keep working for up to 60 seconds.
path Parameters
automation_idAutomation id, sig_ prefixed
Headers
Signals-VersionThe supported API snapshot to use for this request.
Trigger an automation call › Request Body
phone_number^\+[1-9][0-9]{6,14}$ · requiredThe number to call, in E.164.
event_idYour id for this request; a repeat answers the first run. One is made when omitted.
metadataKept with the run as sent; at most 4096 bytes of JSON.
nameThe recipient's name, the template's {{name}}.
Template values: at most 40, keyed ^[a-zA-Z][a-zA-Z0-9_]{0,63}$.
Trigger an automation call › Responses
A repeat of an earlier event_id; the first run as it is now.
createdAtidrecipientNumberrunIdsignalIdThe automation's id.
statusCancel a triggered automation call
Authenticated with an organization API key holding service_configuration:write; the project is the automation's. A revoked or expired key may keep working for up to 60 seconds.
path Parameters
automation_idAutomation id, sig_ prefixed
Headers
Signals-VersionThe supported API snapshot to use for this request.
Cancel a triggered automation call › Request Body
event_idThe event_id the run was triggered with.
Cancel a triggered automation call › Responses
The run: finished as no_longer_owed if it had not been dialed, else unchanged.
createdAtidrecipientNumberrunIdsignalIdThe automation's id.
status