Fortinet black logo

FortiVoice Phone System Administration Guide

Configuring SMS

Configuring SMS

The short message service (SMS) allows FortiVoice users to send and receive text messages to and from contacts with cellular phone numbers. Those contacts are external to the FortiVoice phone system.

Phone users exchange text messages by using the FortiFone softclient for mobile and FortiFone softclient for desktop.

To configure SMS, review and complete the following sections:

  1. Prerequisites
  2. Configuring SMS settings
  3. Configuring inbound call routing for SMS
  4. Configuring outbound call routing for SMS
  5. Using the FortiFone softclient (desktop and mobile) to send and receive text messages

Prerequisites

  • Open a FortiCare ticket to ask for the creation of an SMS account and its association with your FortiVoice phone system by logging in to your FortiCloud account, going to Support > Create a Ticket, and following the prompts. For additional details, see the FortiCare documentation in FortiCloud Account Services.
    • After the creation of your SMS account is complete, Fortinet can share the following SMS settings with you:
      • IP address or hostname of the chat server
      • Username and password of the Admin account
      • Username and password of the XMPP account

      • XMPP resource part

  • The configuration of a FortiCall trunk or other SMS supported VoIP trunk is complete. For details, see Configuring VoIP trunks.

  • Contact the service provider of the FortiCall trunk to enable SMS for every phone number.
  • To receive and send text messages, users must use the FortiFone softclient for mobile or FortiFone softclient for desktop.
  • The FortiVoice phone system must include the following entitlement and license:
    • Unified Communications Services entitlement
    • FortiFone softclient license

      For complete details about purchasing, registering, and uploading a license, see Licensing in the FortiVoice Cookbook.

Configuring SMS settings

This section focuses on the configuration of SMS settings. If you need more information about the other phone system related settings, see Configuring system capacity.

Prior to starting this procedure, make sure that Fortinet has created your SMS account and shared the SMS settings with you.

  1. Go to Phone System > Setting > Miscellaneous.
  2. Go to the SMS Setting section and configure the following:

    GUI field

    Description

    Chat server

    Enter the IP address or hostname of the chat server.

    Admin user name

    The user name must be admin.

    Admin password

    Enter the password for the admin user. To show the password, click the eye icon.

    XMPP user name

    The name must be smspbx.

    XMPP password

    Enter the password for the XMPP user name. To show the password, click the eye icon.

    XMPP resource part

    Enter a tag to identify a specific FortiVoice phone system.

  3. Click Apply.

Configuring inbound call routing for SMS

Configure inbound call routing for users with extensions on the FortiVoice phone system to receive text messages from contacts with cellular phone numbers.

Note

Each user that wants to send and receive text messages must have a DID number associated with its extension.

  1. Go to Call Routing > Inbound > DID Mapping.
  2. Click New and select Voice - Advanced or edit an existing entry.
  3. Configure the following:

    GUI field

    Description

    Enabled

    Select to activate this DID setting.

    Rule name

    Enter a name for this DID setting.

    Route SMS

    Select to activate the routing of SMS messages to the extension.

    Condition

    • Trunk: Select the trunk used for dialing the DID numbers.
    • Schedule: Leave the schedule as any_time.
    • For Caller ID Match, complete the following steps:
      1. Click New.
      2. In Pattern name, select Match Number Only.
      3. In Number, set the caller ID pattern. For details, see Pattern-matching syntax and Pattern-matching examples.
      4. Click Create.

    Additional Action

    • Inbound caller ID modification: If you want to modify the caller ID (the number, not the name), configure the setting in Phone System> Profile > Caller ID Modification, and then select it here.
    • Inbound fallback action: SMS does not support this setting.

    Number Mapping

    Each user that wants to send and receive text messages must have a DID number associated with its extension.

    To create a DID number for an extension, complete the following steps:

    1. Click New.
    2. Add a DID number.
    3. Add an Extension that you want to map to the DID number. The extension supports digits from 0 to 9 and a maximum of 16 digits.
    4. In Description, add any notes you have for the mapping.
    5. In Option, keep Inbound and Outbound enabled.
    6. Leave Caller Number Patterns empty.
  4. Click Create.

Configuring outbound call routing for SMS

Configure outbound call routing for users with extensions on the FortiVoice phone system to send text messages to contacts with cellular phone numbers.

  1. Go to Call Routing > Outbound > Outbound.
  2. Click New.
  3. Configure the following:

    GUI field

    Description

    Enabled

    Select to activate this dial plan.

    Name

    Enter a name for this plan.

    Emergency Call

    SMS does not support this setting.

    Route SMS

    Select to activate the routing of SMS messages to cellular phone numbers.

    Retain original caller ID

    SMS does not support this setting.

    Caller ID Match

    Leave this field empty.

    Dialed Number Match

    With dialed number pattern matching, you can create one phone number pattern in your dial plan that matches many different numbers.

    The dialed numbers matching this pattern will follow this dial plan rule.

    For information about adding a dialed number match, see Creating dialed number match.

    Call Handling

    To configure the call handling action for sending SMS messages, complete the following steps:

    1. Click New.
    2. In Schedule, select any_time.
    3. In Action, select Allow.
    4. In Outgoing Trunk, select the applicable trunk.
    5. In Caller ID modification, select None.
    6. In Delay, select 0.
  4. Click Create.

Using the FortiFone softclient (desktop and mobile) to send and receive text messages

For details about using the FortiFone softclient for desktop to send and receive text messages, see the FortiFone Softclient for Desktop User Guide.

For details about using the FortiFone softclient for mobile to send and receive text messages, see the FortiFone Softclient for iOS User Guide or FortiFone Softclient for Android User Guide.

Configuring SMS

The short message service (SMS) allows FortiVoice users to send and receive text messages to and from contacts with cellular phone numbers. Those contacts are external to the FortiVoice phone system.

Phone users exchange text messages by using the FortiFone softclient for mobile and FortiFone softclient for desktop.

To configure SMS, review and complete the following sections:

  1. Prerequisites
  2. Configuring SMS settings
  3. Configuring inbound call routing for SMS
  4. Configuring outbound call routing for SMS
  5. Using the FortiFone softclient (desktop and mobile) to send and receive text messages

Prerequisites

  • Open a FortiCare ticket to ask for the creation of an SMS account and its association with your FortiVoice phone system by logging in to your FortiCloud account, going to Support > Create a Ticket, and following the prompts. For additional details, see the FortiCare documentation in FortiCloud Account Services.
    • After the creation of your SMS account is complete, Fortinet can share the following SMS settings with you:
      • IP address or hostname of the chat server
      • Username and password of the Admin account
      • Username and password of the XMPP account

      • XMPP resource part

  • The configuration of a FortiCall trunk or other SMS supported VoIP trunk is complete. For details, see Configuring VoIP trunks.

  • Contact the service provider of the FortiCall trunk to enable SMS for every phone number.
  • To receive and send text messages, users must use the FortiFone softclient for mobile or FortiFone softclient for desktop.
  • The FortiVoice phone system must include the following entitlement and license:
    • Unified Communications Services entitlement
    • FortiFone softclient license

      For complete details about purchasing, registering, and uploading a license, see Licensing in the FortiVoice Cookbook.

Configuring SMS settings

This section focuses on the configuration of SMS settings. If you need more information about the other phone system related settings, see Configuring system capacity.

Prior to starting this procedure, make sure that Fortinet has created your SMS account and shared the SMS settings with you.

  1. Go to Phone System > Setting > Miscellaneous.
  2. Go to the SMS Setting section and configure the following:

    GUI field

    Description

    Chat server

    Enter the IP address or hostname of the chat server.

    Admin user name

    The user name must be admin.

    Admin password

    Enter the password for the admin user. To show the password, click the eye icon.

    XMPP user name

    The name must be smspbx.

    XMPP password

    Enter the password for the XMPP user name. To show the password, click the eye icon.

    XMPP resource part

    Enter a tag to identify a specific FortiVoice phone system.

  3. Click Apply.

Configuring inbound call routing for SMS

Configure inbound call routing for users with extensions on the FortiVoice phone system to receive text messages from contacts with cellular phone numbers.

Note

Each user that wants to send and receive text messages must have a DID number associated with its extension.

  1. Go to Call Routing > Inbound > DID Mapping.
  2. Click New and select Voice - Advanced or edit an existing entry.
  3. Configure the following:

    GUI field

    Description

    Enabled

    Select to activate this DID setting.

    Rule name

    Enter a name for this DID setting.

    Route SMS

    Select to activate the routing of SMS messages to the extension.

    Condition

    • Trunk: Select the trunk used for dialing the DID numbers.
    • Schedule: Leave the schedule as any_time.
    • For Caller ID Match, complete the following steps:
      1. Click New.
      2. In Pattern name, select Match Number Only.
      3. In Number, set the caller ID pattern. For details, see Pattern-matching syntax and Pattern-matching examples.
      4. Click Create.

    Additional Action

    • Inbound caller ID modification: If you want to modify the caller ID (the number, not the name), configure the setting in Phone System> Profile > Caller ID Modification, and then select it here.
    • Inbound fallback action: SMS does not support this setting.

    Number Mapping

    Each user that wants to send and receive text messages must have a DID number associated with its extension.

    To create a DID number for an extension, complete the following steps:

    1. Click New.
    2. Add a DID number.
    3. Add an Extension that you want to map to the DID number. The extension supports digits from 0 to 9 and a maximum of 16 digits.
    4. In Description, add any notes you have for the mapping.
    5. In Option, keep Inbound and Outbound enabled.
    6. Leave Caller Number Patterns empty.
  4. Click Create.

Configuring outbound call routing for SMS

Configure outbound call routing for users with extensions on the FortiVoice phone system to send text messages to contacts with cellular phone numbers.

  1. Go to Call Routing > Outbound > Outbound.
  2. Click New.
  3. Configure the following:

    GUI field

    Description

    Enabled

    Select to activate this dial plan.

    Name

    Enter a name for this plan.

    Emergency Call

    SMS does not support this setting.

    Route SMS

    Select to activate the routing of SMS messages to cellular phone numbers.

    Retain original caller ID

    SMS does not support this setting.

    Caller ID Match

    Leave this field empty.

    Dialed Number Match

    With dialed number pattern matching, you can create one phone number pattern in your dial plan that matches many different numbers.

    The dialed numbers matching this pattern will follow this dial plan rule.

    For information about adding a dialed number match, see Creating dialed number match.

    Call Handling

    To configure the call handling action for sending SMS messages, complete the following steps:

    1. Click New.
    2. In Schedule, select any_time.
    3. In Action, select Allow.
    4. In Outgoing Trunk, select the applicable trunk.
    5. In Caller ID modification, select None.
    6. In Delay, select 0.
  4. Click Create.

Using the FortiFone softclient (desktop and mobile) to send and receive text messages

For details about using the FortiFone softclient for desktop to send and receive text messages, see the FortiFone Softclient for Desktop User Guide.

For details about using the FortiFone softclient for mobile to send and receive text messages, see the FortiFone Softclient for iOS User Guide or FortiFone Softclient for Android User Guide.