Integrations
Once you subscribe a plan, you can integrate your bot through different channels. This page shows some channel specific settings.
Table of Contents
IVR
IVR Actions
The IVR actions section describes the current external actions available in BOTSchool IVR channel.
The set of possible actions and their attributes is shown in the following sections. Each section represents a different action.
ask
| Parameter | Description |
|---|---|
| type | Corresponds to the type of audio resource to be played before the input menu for the BOT. Possible values: • audio_file Default value: audio_file. |
| prompt | Main ad to collect voice interaction for the BOT. |
| silence_prompt | Announcement to signal silence. |
| retries | Maximum number of retries to get usage input. |
play
Announcement type to play. This action allows ads to be played whether they are audio, text or data files.
| Parameter | Description |
|---|---|
| type mandatory |
Possible values: • audio_file • tts • play_data |
| sub_type | This attribute is only valid for the play_data type. Possible values: • DATE - Plays a date using the format DD-MM-YYYY. Accepts dates since 1-1-1910 to 31-12-9999 Example: ⚬ 15-02-1999 - February 15, 1999 • TIME - Plays a time duration by the format [HH]:[MM]:[SS]. Examples: ⚬ 1:2:3 - one hour two minutes and three seconds ⚬ 1:2: - one hour and two minutes ⚬ 1::3 - one hour and three seconds ⚬ :2:3 - two minutes and three seconds ⚬ :2:- two minutes ⚬ ::3 - three seconds • HOUR - Plays a clock time by the format [HH]:[MM]:[SS]. Examples: ⚬ 1:2:3 - one hour two minutes and three second am ⚬ 13:2: - one hour an two minutes pm ⚬ :2:3 - two minutes and three seconds ⚬ :2: - two minutes ⚬ ::3 - three seconds • MONEY - Plays an amount of money by the format: ⚬ XXXX$XX for Euros and cents followed by the conversion to portuguese escudos being the escudo cents converted to escudos. ⚬ XXXX%XX for an alternative coin of the given country, in the portuguese version, the alternative coin will be the escudo (until 2002/02/28). ⚬ XXXXRXX for brazilian Real and Real cents. Examples: ⚬ 1$20 - one euro and twenty cents, which corresponds to two hundred and forty one escudos ⚬ $20 - twenty cents, which corresponds to forty escudos ⚬ 7%05 - seven escudos and five cents ⚬ +120% - one hundred and twenty escudos • NATNUM - Plays a real number (accepts values from 999999999 to 999999999, as much in the integer part as in the decimal part). Examples: ⚬ 10,21 - ten comma twenty one ⚬ .7962 - zero point seven nine six two ⚬ 0.0 - zero point zero ⚬ 3801 - three thousand eight hundred and one ⚬ 1.002 - one point zero zero two ⚬ 35, - thirty five comma zero • DIGIT - Plays a number (up to 31 digits in InoVox and 63 in WMS) digit by digit. Examples: ⚬ 056 - zero five six ⚬ 2079518 - two zero seven nine five one eight • ASCII - Plays an alphanumeric sequence char by char. Example: ⚬ abc056 - a bee cee zero five six |
| resource mandatory |
Corresponds to the resource to be played for the user and depends on the defined type: • audio_file - path to the audio file. If the path to the file starts with file: it is an absolute path, otherwise the path is relative. • tts - text to be synthesized. • play_data - data to be reproduced in the respective format. |
| node_id | Alphanumeric identifier used for traceability of the flow traveled in the service. |
| language_speaker | This attribute is only valid for the play_data type and serves to specify the voice of the ads to be used in the reproduction of data in the respective action. The parameter is not mandatory, if not included, the language_speaker passed by ABC will be used. Example: WMS, LMed03, PT1620x, etc |
| language_code | This attribute is only valid for the play_data type and serves to specify the language to be used in the reproduction of data in the respective action. The parameter is not mandatory, if not included, the language_speaker passed by ABC will be used. Example: PT, EN etc |
transfer
| Parameter | Description |
|---|---|
| destination mandatory |
The value of this attribute depends on the transfer type. In the case of transfer of type tel it is possible to define a transfer to a tel URI (RFC3966). Example: • +1-202-456-1414 In the case of transfer of type sip it is possible to define a transfer to a sip URI (RFC4458). Examples: • sip:alice@atlanta.com • sip:alice:secretword@atlanta.com • transport=tcp sips:alice@atlanta.com?subject=project+x&priority=urgent sip:+1-212-555-1212:1234@gateway.com • user=phone sips:1212@gateway.com sip:alice@192.0.2.4 |
| type | Type of transfer to be performed. Possible values: • tel - a transfer with tromboning to a specific MSISDN destination. Example: transfer {destination:961234567, type:tel, node_id:NBOT020} • sip - a transfer without using tromboning to a specific destination address. Example: type:sip, destination:187@127.0.0.1, node_id:NBOT020 Default value: sip. |
| resource | Corresponds to the path to the audio file to be played before the transfer. If the path to the file starts with file: it is an absolute path, otherwise the path is relative. |
hangup
Call termination. This action indicates that the call must be terminated.
| Parameter | Description |
|---|---|
| node_id | Alphanumeric identifier used to trace the flow traveled in the service. |
dtmfmode
Definition of the interaction mode by dtmf. From this action, all interactions become dtmf.
| Parameter | Description |
|---|---|
| type | Allows you to define whether the input by dtmf will be with only one digit (menu) or multiple digits. Possible values: • menu • digits Default value: digits. |
voicemode
Setting the voice interaction mode. From this action onwards, all interactions are made by voice.
| Parameter | Description |
|---|---|
| language | Definition of the language to be used in recognition and tts. Possible values: https://cloud.google.com/speech-to-text/docs/languages Default value: pt-PT. |
| language_asr | Language definition to be used for ASR (only). Possible values: https://cloud.google.com/speech-to-text/docs/languages Other providers may have slight variations. |
| language_tts | Language definition to be used for TTS (only). Possible values: https://cloud.google.com/speech-to-text/docs/languages Other providers may have slight variations. |
| tts_voice | Definition of the voice to use in TTS. If not defined, the default values of the TTS motor are used. Possible values depend on provider TTS. |
info
| Parameter | Description |
|---|---|
| info_value | With this action it is possible to change simple variables of the main context of the service in the BOT. This action allows a BOT program to update properties of the main context of the IVR service. From now, it will be possible to change the following properties: • callernumber • callingnumber • clientid • diversion • globalcallid Example: info_value:clientid=12345 |
The Whatsapp integration section describes the current available integration between BOTSchool and Whatsapp API. The set of possible answers allowed in channel whatsapp and their limitions is shown in the following sections. Each section represents a different answer type.
Plain Text
A plain text answer can be a max of 4096 characters long, and only supports Bold, italics and strike-through message formatting already implemented in the plain text editor available in Botschool. By default, the mobile WhatsApp application recognizes URLs and makes them clickable. Make sure the URL begins with http:// or https://. A hostname is required, IP addresses are not matched. All links configured in the plain text editor are converted (for whatsapp channel only) to their http:// or https:// format.
Media
A media answers in whatsapp application include image, video, audio and document. URL e Filename (only for type document) fields are mandatory.
Only the following mime-types are allowed:
Cards
Not available for whatsapp application.
Buttons
Interactive Messages for Whatsapp application can be shown to the user in two different ways:
Reply Buttons: Answers configured with up to 3 options — each option is a button. This type of message offers a quicker way for users to make a selection.
List Buttons: When more than 3 options are configured instead of the reply buttons whatsapp will show a list up to 10 options.
Constraints:
- Each option for Reply Buttons can only have max 20 characters and 24 characters for options in List Buttons.
- Title field is mandatory and follows the same rules for plain text answers.
- The text shown for each option is the one defined in the label field.
- The text shown in each option is the same text that will be sent to Botschool upon being selected by the user.
Location
To make use of whatsapp location message the following constraints are in place:
- Latitude and Longitude fields are mandatory.
Address and Name field are only used to show more info to user.
