Configure Receive Message

Configure to receive SMS, auto-reply, forward, and trigger URL with a VMN and keyword.

Configure to receive messages

You need to configure a dedicated long code or short code to receive incoming SMS from end-users.

To configure a number for the Receive Message feature, perform the following steps:

  1. Sign in to your Kaleyra.io account.
  2. Go to Channels > SMS option.
  3. Click Manage.
    The SMS channel menu bar appears.
  4. Click on Receive Messages.
    The list of Receive SMS Configurations appears.
  1. To configure a new Receive Message, click + New Configuration.

📘

Notes:

  • From the Select Recipient Number drop-down, if you are selecting a shared short code, then the Default Configuration option gets disabled.
  • The shared short code can be configured for multiple unrelated business organizations but the keyword associated with shared short code can not be shared by multiple accounts.
  1. In the Select SMS Recipient section, enter the recipient VMN details in the following fields.
    1. Select Recipient Number—Select a recipient number. This is the VMN configured to receive the SMS sent by your customers. This field is mandatory.
    2. Keyword—Enter a keyword that you share with the customers to receive messages for an appropriate action.
      This field is mandatory for configurations other than the default configuration.
      When the default configuration is not set, you must use this keyword along with your message to send the message successfully. In the case of shared short code, the system will check that the keyword is not already in use for the same shared SC by another organization and that if so, an error will be thrown.
    3. Keyword Expiry—Select a date on which the keyword expires.
      This field is mandatory, for configurations other than the default configuration.
      When a keyword expires, the incoming messages with that keyword are not processed.

📘

Note:

You can use the Edit Configuration option in the Configurations section to add in the other details later.

  1. In the Configuration section, enter the Receive SMS configuration details in the following fields. You can use one or more options in this section to take the appropriate actions based on your customers' preferences that are determined by the keywords.
  1. Auto Reply—You can send an auto reply message to a customer whenever a message that has the matching keyword is received from the customer. You can either send the auto reply as soon as you receive a message or schedule it to be sent later.
    1. Sender ID—Select a sender ID using which you want to send the response back to the customer.
    2. Enter your text message here—Type the text that you want to send as a response to the customer. This field is mandatory.
    3. SMS Route—Select the SMS route using which the message should be sent to the customer.
    4. Template ID—Based on the region/country in which the account registration is made, the template ID field is mandatory (when the Auto Reply option is selected).
      For example, to send a message to a customer in India, you must select a template ID.
    5. Reply Type
      Instant Reply—Select this option, if you want to send an auto reply message immediately after receiving a message.
      Scheduled Reply—Select this option, if the reply message should be sent at a later date and time. Using the calendar icon, first select the date and the time to send the auto reply message.
  2. Forward—You can configure to forward the received SMS to another phone number along with the customer's phone number details.
    1. Sender ID—Select the sender ID using which the incoming SMS should be forwarded.
    2. SMS Route—Select the SMS route based on the type of business transaction with the customer.
    3. Template ID—This field appears only when you select a phone number from India to forward the message. This field is mandatory.
      For customers from other countries than India, the Template ID field does not appear. A template that matches the message text will be used for sending the message.
    4. Email Forward—Enter the email ID to which the SMS should be delivered for further action.
  3. Trigger URL— Select this option, if you want to use a trigger URL (webhook URL) to track the messages received and the responses sent back to the customer.

📘

Notes:

  • You can configure the trigger URL (webhook) or a callback profile ID to receive notifications for all the mobile originated (MO) messages or by the specific keywords.
  • For keywords specific to the MOs, create new configurations that include the keyword and the webhook URL as described in the following Trigger URL steps.
  • For all the MOs, create a default configuration (without the keyword) and the webhook URL as described in the trigger URL section.
  1. Trigger URL—Specify the trigger URL for the GET method.
    1. The URL must be in the format:
      Example: <http://website.com/api.php?mobile={mob}&message={message}>
      The URL must contain the mobile number and the message.
    2. Request Body—Enter the request body for the POST method that includes the message and the mobile number of the customer.
    3. Request Type—Specify the request type for the content. ‘application/json’ request type is supported.

OR

Callback ID—Select this option, if you already have a callback profile created.

📘

Note:

Make sure to refer to a callback ID created for the POST method to capture the MO message body.

For more information on how to create callback profiles, see Callback Profiles

  1. Select Opt-in settings toggle button to set the VMN with the specified keyword as an opt-in configuration.
    An end-customer who has opted in will receive all the messages from the VMN.
  2. Select Opt-out settings toggle button to set the VMN with the specified keyword as an opt-out configuration.
    An end-customer who has opted-out will not receive any further messages from the VMN. You can specify if the opt-out apply only to the selected VMN or to all configured VMN. In the first case, the opted-out end-user can still receive messages related to configuration of other VMN; in the latter case, the opted-out end-user will not receive any more message from any of the configured VMN in your account.

If you enable the Opt-out setting, by default the Configured Sender ID is enabled and it will work only for the specific sender IDs but when you select All Sender IDs, it will work for all the sender IDs. You need to save the settings once you make any changes.

You can only select one of these toggle options in a single configuration.

📘

Note:

  • The Reply Type scheduling applies only when the keyword is valid.
  • The forwarded SMS messages are listed on the Channels > SMS > Analytics page.
  • Based on the keyword and the actions that you have defined on the configuration page for a VMN, the end user receive the corresponding opt-in or opt-out services.