Create a new blaster script for automated voice broadcasts.

POST

https://host.com/v1/scripts/blaster

POST

/v1/scripts/blaster

1 const url = 'https://host.com/v1/scripts/blaster';
2 const options = {
3   method: 'POST',
4   headers: {'X-API-Key': '<apiKey>', 'Content-Type': 'application/json'},
5   body: '{"message":"Hello, this is an automated reminder from Acme Corp. Your appointment with Sarah Chen is scheduled for tomorrow at 3 PM. Please reply YES to confirm or call us to reschedule."}'
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 }

1 {
2   "message": "Hello, this is an automated reminder from Acme Corp. Your appointment with Sarah Chen is scheduled for tomorrow at 3 PM. Please reply YES to confirm or call us to reschedule.",
3   "$type": "BlasterScript",
4   "id": "d4f5a8b2-9c3e-4f7a-8a1e-2b7c9f6d5e4a",
5   "type": "phone_blaster",
6   "direction": "outbound",
7   "name": "Appointment Reminder Script",
8   "status": "active"
9 }

Authentication

X-API-Keystring

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

Request

The blaster script configuration.

messagestring or nullRequired

Get or sets blaster script message.

namestring or nullOptional

Gets or sets the Name.

directionstring or nullOptional

Gets or sets the direction.

Response

Created

messagestring or null

Get or sets blaster script message.

Errors

400

Bad Request Error