Start a single outbound call.

POST

https://host.com/v1/calls

X-API-Keystring

API Key authentication. Generate your API key in the Gail Portal under General > Integrations > API Keys.

The call request containing the destination and script configuration.

preRecordedbooleanRequired

tostring or nullRequired

externalIdstring or nullOptional

namestring or nullOptional

scriptIdstring or nullOptionalformat: "uuid"

scriptobjectOptional

taskIdstring or nullOptional

taskCustomermap from strings to any or nullOptional

taskLeadmap from strings to any or nullOptional

additionalDatamap from strings to strings or nullOptional

idstringformat: "uuid"

externalIdstring or null

namestring or null

preRecordedboolean

tostring or null

400

Bad Request Error

1	const url = 'https://host.com/v1/calls';
2	const options = {
3	method: 'POST',
4	headers: {'X-API-Key': '<apiKey>', 'Content-Type': 'application/json'},
5	body: '{"preRecorded":true,"to":"string"}'
6	};
7
8	try {
9	const response = await fetch(url, options);
10	const data = await response.json();
11	console.log(data);
12	} catch (error) {
13	console.error(error);
14	}