Fortinet white logo
Fortinet white logo

Administration Guide

Configuring text message settings for notifications

Configuring text message settings for notifications

For FortiRecorder to send SMS text messages to users or administrators, you must specify at least one service provider integration that FortiRecorder can use to send text messages.

To configure FortiRecorder to send text messages

  1. Go to System > Configuration >SMS.
  2. Click New.
  3. Configure the following settings:

    Setting Name

    Description

    Name

    Enter a unique name for the SMS provider settings.

    Description

    Enter a short description of the provider.

    Service provider

    Select either:

    • Twilio: The Twilio API.

    • Custom: Any text message service provider that accepts messages submitted via email or web API.

    If you selected Twilio, configure the following settings:

    Setting Name

    Description

    From number

    Enter the sender phone number that the text messages will use.

    Account SID

    Enter the account or service plan ID provided by your service provider.

    Auth token

    Enter the authentication token, or API key, for the account with your service provider.

    This setting is automatically obscured while you enter it to protect the credentials from being seen by cameras or unauthorized persons.

    Otherwise, in Type, select either:

    • SMTP such as for email relays

    • HTTP such as for REST APIs over HTTPS

    If using HTTP/HTTPS, configure the following settings:

    Setting Name

    Description

    HTTP URL

    Enter the scheme, domain name, and URL of your service provider's API, such as:

    https://example.com/sendsms

    Caution: Use HTTPS if possible (not plain HTTP). Plain HTTP sends data in clear text (not secure and encrypted), and could be intercepted and read or modified by attackers. Notifications from FortiRecorder could contain sensitive information, including the password or API key.

    HTTP method

    Select which HTTP method the API requires, either GET or POST.

    HTTP/S Parameters

    For each parameter that your service provider accepts or requires:

    1. Click New.

    2. If the parameter is sensitive information (for example, an API key or password) and you want to obscure its value while you enter it, enable Encrypt.

      Caution: If Encrypt is turned off, verify that no cameras or persons can see your screen, which would compromise security.

      Encrypt hides the display only. For a secure connection, also use HTTPS in HTTP URL.

    3. In Attribute, enter the name of the parameter.

    4. In Value, enter the parameter's value.

      Instead of fixed text, you can use variables; see the SMTP setting variables and the example below.

    5. Click Create.

    For example, if your service provider requires API requests in the following format:

    https://example.com:8080/sendsms?api_id=YOUR_ID&user=YOUR_USERNAME&to=+15555555555&text=YOUR_MESSAGE&password=YOUR_PASSWORD

    then the settings might be:

    HTTP URL

    https://example.com:8080/sendsms

    HTTP method

    Get

    HTTP/S Parameters

    Attribute

    Value

    api_id YOUR_ID
    user YOUR_USERNAME
    to {{:country_code}}{{:mobile_number}}
    text {{:message}}
    password ******

    If using SMTP, configure the following settings:

    Setting Name

    Description

    Email to

    Enter the recipient.

    Instead of entering a fixed recipient, you can use variables with the following tags:

    • {{:country_code}} — Country code portion of the SMS number field in the user's configuration.
    • {{:mobile_number} — Phone number portion of the SMS number field in the user's configuration.

    Email subject

    Enter a subject line.

    Email body

    Enter the message body.

    Instead of entering a fixed body, you can use a variable with the {{:message}} tag.

  4. ClickCreate.

  5. To test your settings, double-click the settings to open them. Expand the Test section and in Mobile number, enter the telephone number for your mobile phone. Then click Send.

    You should quickly receive a text message. If your phone does not show a notification about it, verify that the sender phone number is not blocked or flagged as a source of spam. Unknown senders' text messages may also be silent or sorted by category, depending on the mobile phone's preferences and OS version.

  6. After configuring the text message service provider, select it in features that trigger notifications. See Configuring notification triggers, Configuring alert email, and Configuring user and administrator accounts.

    You can customize the templates used by text message notifications. See Customizing email templates.

Configuring text message settings for notifications

Configuring text message settings for notifications

For FortiRecorder to send SMS text messages to users or administrators, you must specify at least one service provider integration that FortiRecorder can use to send text messages.

To configure FortiRecorder to send text messages

  1. Go to System > Configuration >SMS.
  2. Click New.
  3. Configure the following settings:

    Setting Name

    Description

    Name

    Enter a unique name for the SMS provider settings.

    Description

    Enter a short description of the provider.

    Service provider

    Select either:

    • Twilio: The Twilio API.

    • Custom: Any text message service provider that accepts messages submitted via email or web API.

    If you selected Twilio, configure the following settings:

    Setting Name

    Description

    From number

    Enter the sender phone number that the text messages will use.

    Account SID

    Enter the account or service plan ID provided by your service provider.

    Auth token

    Enter the authentication token, or API key, for the account with your service provider.

    This setting is automatically obscured while you enter it to protect the credentials from being seen by cameras or unauthorized persons.

    Otherwise, in Type, select either:

    • SMTP such as for email relays

    • HTTP such as for REST APIs over HTTPS

    If using HTTP/HTTPS, configure the following settings:

    Setting Name

    Description

    HTTP URL

    Enter the scheme, domain name, and URL of your service provider's API, such as:

    https://example.com/sendsms

    Caution: Use HTTPS if possible (not plain HTTP). Plain HTTP sends data in clear text (not secure and encrypted), and could be intercepted and read or modified by attackers. Notifications from FortiRecorder could contain sensitive information, including the password or API key.

    HTTP method

    Select which HTTP method the API requires, either GET or POST.

    HTTP/S Parameters

    For each parameter that your service provider accepts or requires:

    1. Click New.

    2. If the parameter is sensitive information (for example, an API key or password) and you want to obscure its value while you enter it, enable Encrypt.

      Caution: If Encrypt is turned off, verify that no cameras or persons can see your screen, which would compromise security.

      Encrypt hides the display only. For a secure connection, also use HTTPS in HTTP URL.

    3. In Attribute, enter the name of the parameter.

    4. In Value, enter the parameter's value.

      Instead of fixed text, you can use variables; see the SMTP setting variables and the example below.

    5. Click Create.

    For example, if your service provider requires API requests in the following format:

    https://example.com:8080/sendsms?api_id=YOUR_ID&user=YOUR_USERNAME&to=+15555555555&text=YOUR_MESSAGE&password=YOUR_PASSWORD

    then the settings might be:

    HTTP URL

    https://example.com:8080/sendsms

    HTTP method

    Get

    HTTP/S Parameters

    Attribute

    Value

    api_id YOUR_ID
    user YOUR_USERNAME
    to {{:country_code}}{{:mobile_number}}
    text {{:message}}
    password ******

    If using SMTP, configure the following settings:

    Setting Name

    Description

    Email to

    Enter the recipient.

    Instead of entering a fixed recipient, you can use variables with the following tags:

    • {{:country_code}} — Country code portion of the SMS number field in the user's configuration.
    • {{:mobile_number} — Phone number portion of the SMS number field in the user's configuration.

    Email subject

    Enter a subject line.

    Email body

    Enter the message body.

    Instead of entering a fixed body, you can use a variable with the {{:message}} tag.

  4. ClickCreate.

  5. To test your settings, double-click the settings to open them. Expand the Test section and in Mobile number, enter the telephone number for your mobile phone. Then click Send.

    You should quickly receive a text message. If your phone does not show a notification about it, verify that the sender phone number is not blocked or flagged as a source of spam. Unknown senders' text messages may also be silent or sorted by category, depending on the mobile phone's preferences and OS version.

  6. After configuring the text message service provider, select it in features that trigger notifications. See Configuring notification triggers, Configuring alert email, and Configuring user and administrator accounts.

    You can customize the templates used by text message notifications. See Customizing email templates.