Create Call
Start a call using a blueprint or a custom configuration.
Authorization
The API Key you generated using the Struct Dashboard.
Request Body
application/jsonThe ID of the blueprint to use to create the call from. The blueprint contains the first name, last name and phone number of the recipient of the call.
The first name of the callee. Will override the blueprint referenced by blueprintId if given.
The last name of the callee. Will override the blueprint referenced by blueprintId if given.
The phone number of the callee. Will override the blueprint referenced by blueprintId if given.
Custom variables to provide to the prompt, first message and goodbye message templates for this call. The field names must match column names you've created in your project. Any values provided here will override the values defined in the referenced blueprint. An error response will be returned if a field is referenced in one of your templates that is not provided in this object or in the referenced blueprint.
You must provide either a blueprintId
or both a firstName
and phoneNumber
field in order to create a call.