SMS Service

This service incurs costs per execution.

We are happy to implement this in your bot if you want to use it. Please contact us for the details.

Send an SMS from your bot via Parloa's SMS provider.

By default, the sender is set to Parloa, but this can be customized to either send a different short code (up to 11 characters) or from a specific number. A custom sender needs to be whitelisted, which we are happy to do for you.

Service configuration

Branches

• success: SMS was submitted successfully.

• fail: SMS sending failed.

Input

• to: Recipient of the SMS. Must be a mobile phone number in international format, e.g. [phone]

• content: Content of the message. If more than 160 characters long, will be sent as multiple text messages

• sender: Optional: name of the sender. The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters. Must be whitelisted before it can be set!

• test: Optional: Call the service without actually sending the SMS. For testing purposes. Make this field non-empty to enable this flag.

• isUnicode Optional: Can be set if you want to send unicode characters like Hebrew, Chinese, Persian... Make this field non-empty to enable this flag.

Output

• error: Details on the error in case of failure

Possible Erros:

• No recipient specified : Check your to Input-field

• Invalid sender specified. Not allowed! : Parloa whitelisted sender & your input does not match.

Technical Configuration

• URL: https://parloaservices.azurewebsites.net/api/SMS?clientId=<CLIENT_ID>

• Header: x-functions-key: <AUTHCODE>

For authentication, replace <AUTHCODE> and <CLIENTID> with the values provided by your Parloa representative.

Additional Service Details

Purpose

The purpose of the SMS service provided by Parloa is to empower bots with the ability to seamlessly send text messages to users through Parloa's SMS provider. This feature enhances the communication capabilities of bots, enabling them to reach users directly on their mobile devices.

Target Users

For beginners: effortlessly send SMS in your bot. No technical knowledge required.

Key Features

• Sending SMS to mobile numbers

• Customizable Sender

• Able to send Unicode

Sample CURL

curl --location '<Parloa SMS Endpoint>' \
--header 'x-functions-key: <AUTHCODE>' \
--header 'Content-Type: application/json' \
--data '{
    "input": {
        "to": "<recipient>",
        "content": "From Parloa"
    }
}'

Additional Technical Specifications

External APIs used

• Send SMS with Brevo

Hosting Environment

EU only

Usage in Parloa

Sample configurations with Output

Configuration with valid sms call

This is a sample configuration for a valid sms call:

Result with valid sms call

Output from the debugger:

What the customer sees:

Configuration with invalid sender

This is a sample configuration with an invalid sender that is not whitelisted:

Result with invalid sender

Output from the debugger: