Set up an SMS Channel for Apidaze

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

Requirements

The Yeastar PBX should meet the following requirements:
  • Firmware: Version 37.19.0.22 or later
  • Plan: Enterprise Plan (EP) or Ultimate Plan (UP)
  • Domain Name: PBX can be remotely accessed via a domain name.
    Note:
    • 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 fail to receive messages.
    • If you use a self-managed domain name, make sure you have installed a valid domain certificate for the domain name, otherwise the messaging channel will encounter authentication failure, or will fail to receive messages.
    For more information about the domain configuration, see the following topics:

Supported message types and limits

Supported message types
The Apidaze SMS channel supports text messages and multimedia messages (MMS), where the supported MMS file types are determined by Apidaze.
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. 100 MB
  • File retention period: 72 hours

Prerequisites

You have obtained the following information from the Apidaze Service Provider:
  • API key
  • Secret
  • Phone number used for message sending and receiving
    Note: If business needs to communicate with US-based customers, make sure that the phone number has been completed with 10DLC registration to avoid disruption in message delivery.

Procedure

Step 1. Create and configure an SMS channel on PBX

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

    • Name: Enter a name to help you identify the channel.
    • ITSP: Select Apidaze.
    • API Key: Enter the API key obtained from Apidaze.
    • Secret: Enter the Secret obtained from Apidaze.
  4. In the Messaging Setting tab, configure the channel.
    1. In the Message Sending Rate field, 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 checkbox of Close Session Automatically, then set the timeout in the Session Timeout (Days) field.

    3. In the Accompanying Text for Chat File field, specify the default text that will be sent along with chat files.

      The message recipient will see the text displayed alongside the chat files.

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

      • Number: Enter the purchased number or specify an Alphanumeric Sender ID.
        Note: The phone number should be 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.
    5. Click Save.
  5. Click Save.

Step 2. Configure webhook in Apidaze

  1. On PBX web portal, go to Messaging > Message Channel.
  2. Click the SMS channel you created.
  3. In the Authentication tab, select a desired URL from the Webhook URL drop-down list, then copy the URL.

  4. In Apidaze, configure messaging webhook for the phone number using the PBX's webhook URL to receive inbound messages.

Result

  • A messaging channel is created successfully. You can see the channel displayed in the Messaging Channel 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. If you want to calculate the actual cost of sent messages, consult with the SMS service provider for the precise number of messages transmitted, as long text messages (longer than 160 characters) are automatically split into segments and then re-assembled when they are received, increasing the number 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.