Create a new phone script for AI-powered calls.

POST

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

POST

/v1/scripts/phone

1 const url = 'https://host.com/v1/scripts/phone';
2 const options = {
3   method: 'POST',
4   headers: {'X-API-Key': '<apiKey>', 'Content-Type': 'application/json'},
5   body: '{"agentName":"SupportBot 3000","greeting":"Hello, this is SupportBot 3000. How can I assist you today?","goodbye":"Thank you for calling. Have a great day!","faqs":[{}]}'
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   "agentName": "SupportBot 3000",
3   "greeting": "Hello, this is SupportBot 3000. How can I assist you today?",
4   "goodbye": "Thank you for calling. Have a great day!",
5   "useCaseAssociations": [
6     {
7       "id": "d3f9a1b2-4c6e-4f8a-9a2b-1e7f3c5d8a9e",
8       "order": 1,
9       "status": "active"
10     }
11   ],
12   "giveSurvey": true,
13   "faqs": [
14     {
15       "question": "What are your business hours?",
16       "answer": "Our business hours are Monday through Friday, 9 AM to 5 PM.",
17       "details": "We are closed on weekends and public holidays."
18     }
19   ],
20   "postCallScripts": [
21     {
22       "textScriptId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
23       "description": "Send follow-up email with appointment details."
24     }
25   ],
26   "voicemail": "Please leave a message after the beep, and we will get back to you as soon as possible.",
27   "voice": "en-US-Wavenet-D",
28   "voiceProvider": {
29     "value": "Google Cloud Text-to-Speech"
30   },
31   "knowledgeBase": {
32     "documentIds": [
33       "f1234567-89ab-4cde-0123-456789abcdef"
34     ],
35     "documentTags": [
36       "appointment",
37       "support",
38       "faq"
39     ]
40   },
41   "$type": "PhoneScript",
42   "id": "b7c8d9e0-f123-4567-89ab-cdef01234567",
43   "type": "phone",
44   "direction": "outbound",
45   "name": "Customer Support Script",
46   "status": "active"
47 }

Authentication

X-API-Keystring

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

Request

The phone script configuration including objectives and FAQs.

agentNamestring or nullRequired

Gets or sets the agent name.

greetingstring or nullRequired

Gets or sets the greeting.

goodbyestring or nullRequired

Gets or sets the goodBye.

faqslist of objects or nullRequired

Gets or sets the faq.

namestring or nullOptional

Gets or sets the Name.

directionstring or nullOptional

Gets or sets the direction.

useCaseAssociationslist of objects or nullOptional

Gets or sets the UseCase associations.

voicemailstring or nullOptional

Gets or sets the voicemail.

voicestring or nullOptional

Gets or sets the voice.

voiceProviderobjectOptional

giveSurveybooleanOptional

Gets or sets the GiveSurvey indicator.

postCallScriptslist of objects or nullOptional

Gets or sets the list of post-call script actions to run after call ends.

knowledgeBaseobjectOptional

Response

Created

agentNamestring or null

Gets or sets the agent's name.

greetingstring or null

Gets or sets the greeting.

goodbyestring or null

Gets or sets the goodBye.

useCaseAssociationslist of objects or null

Gets or sets the UseCase associations.

giveSurveyboolean

Gets or sets the GiveSurvey indicator.

faqslist of objects or null