Set up an SMS Channel for Flowroute

This topic describes how to set up a Flowroute SMS channel on Yeastar P-Series Cloud Edition, so that agents in your business can receive and reply to SMS messages from customers on their Linkus UC Clients.

Requirements

Platform Requirement
Yeastar PBX
  • Plan: Enterprise Plan (EP) or Ultimate Plan (UP)
  • Firmware: Version 84.12.0.32 or later
  • Domain Name: Due to the limitation of the third-party platform, the domain name must NOT contain underscore character(s), otherwise the messaging channel will encounter authentication failure, or will not be able to receive messages.
  • Domain Certificate: A valid domain certificate is installed.
    Note: If the root domain of your Cloud PBX is NOT the standard Yeastar-provided domains (ycmcloud.com, yeastarcloud.com, or yeastarycm.co.za), you NEED to install a valid domain certificate for the PBX first, otherwise the messaging channel will encounter authentication failure, or will not be able to receive messages.
Flowroute API Version: v2.1
Note: You can check or update the API version on Flowroute (Path: PREFERENCE > API Control > SMS Webhook Version).

Supported message types and limits

Supported message types
The Flowroute SMS channel supports text messages and multimedia messages (MMS), where the supported MMS file types are determined by Flowroute. For more information, see Flowroute supported MMS file types.
Important: When sending multimedia messages (such as images), the SMS service provider downloads the files from a link provided by the PBX. Therefore, if you have set Allowed Country/Region IP Access Protection rule, make sure that you have allowed the IP access from the country where the SMS service provider is located, otherwise the file transmission would fail.
Limits
  • File size: Max. 525 KB
  • File retention period: 24 hours

Procedure

Step 1. Obtain a Webhook URL on PBX

Obtain a Webhook URL from PBX web portal first, which is required when you configure a number for SMS on Flowroute.

  1. Log in to PBX web portal, go to Messaging > Messaging Channel.
  2. Click Add, and select SMS.
  3. In the ITSP drop-down list, select Flowroute.

    A Webhook URL for Flowroute is generated and displayed in the Webhook URL field.

    Note: The URL will change once you leave the current page, please make sure you use the latest Webhook URL for the configuration on Flowroute.

  4. Note down the Webhook URL.

Step 2. Configure a number for SMS on Flowroute

Important: According to US legislation (A2P 10DLC SMS), 10DLC (10-digit Long Code) phone numbers that are used for A2P (Application-to-Person) messaging MUST be registered, otherwise SMS messages sent to US numbers from the unregistered 10DLC numbers will be blocked. If your business communicates with a US-based audience, you should confirm the registration requirements with the SMS service provider and complete the phone number registration to avoid disruption in message delivery.
Log in to Flowroute portal, and complete the following settings:
  1. Enable the messaging feature for the desired DID number.

  2. Configure messaging webhook according to your needs.
    • If you only need to receive callback notification for inbound messages sent from a specific number, configure messaging webhook with PBX's Webhook URL for the number individually.

    • If you need to receive callback notification for inbound messages sent from all the numbers in your account, configure global messaging webhook with PBX's Webhook URL as shown below.

  3. Create an API key for the integration with PBX.
    Important: You MUST note down the generated key in the pop-up window, as it is only displayed ONCE.

  4. Note down the Access Key of the API key.

Step 3. Create and configure an SMS channel on PBX

Create an SMS channel on PBX, and configure the channel with the authentication information and number obtained from Flowroute.

  1. Log in to PBX web portal, go to Messaging > Messaging Channel.
  2. Click Add, and select SMS.
  3. In the Authentication tab, enter the authentication information of Flowroute.

  4. In the Messaging Settings tab, configure the channel.
    1. In the Message Sending Rate drop-down list, specify the number of messages that PBX can send per second.
      Note:
      • If the number of messages to send exceeds the set value, PBX will arrange the messages in queue and send them at the sending rate.
      • If the sending rate set in PBX exceeds the limit set by the SMS service provider, it may result in message delivery failures. Contact your SMS service provider to confirm the sending rate limit of your account and increase the limit as needed.
    2. Optional: If you want the system to automatically close the sessions that have been inactive for a specific period of time, select the Close Session Automatically option, then set the timeout in the Session Timeout (Days) field.

    3. In the Number section, click Add to add a message routing rule.

      • Number: Enter the purchased number in E.164 format ([+][country code][phone number]). For example, +14102161183.
      • Destination for Inbound Messaging: Specify the destination of inbound messages from the number.
        Option Description
        Extension If selected, choose an extension from the Extension drop-down list.

        Only the extension user can receive inbound messages from the number.

        Message Queue If selected, choose a queue from the Message Queue drop-down list.

        All the agents in the selected message queue can receive inbound message(s) of new sessions in the queue. However, only the user who picks up a session will be able to receive and respond to the follow-up inbound messages in the session.

      • Extensions allowed to create messaging sessions: Select the extensions that are allowed to initiate a messaging session with customers.
    4. Click Save.
  5. Click Save.

Result

  • A messaging channel is created successfully. You can see the channel displayed in the Messaging list with Status showing .

  • PBX automatically tracks and records the number of messages sent and received on the channel, where the Total column indicates the total number of sent messages, including both successfully sent messages and failed ones.
    Note:
    • For sent messages, PBX only tracks the number of the messages sent from agents' Linkus UC Clients. Therefore, if you want to calculate the accurate cost of sent messages, check with the SMS service provider, as long text messages (longer than 160 characters) are automatically split into segments and then re-assembled when they are received, increasing the number and cost of sent messages.
    • You can filter the statistics by a time period using the time filter.

What to do next

Send text messages to the phone number and see if the specified agent can receive messages on his or her Linkus UC Client.