Mulesoft - Send automated SMS and MMS Globally

Updated 2 weeks ago

Introduction

Send automated SMS and MMS messages with Anypoint Studio and Design Center in MuleSoft. You can add messaging to any processes — send alerts, vital notifications, personalised messages and more. 

Follow the below steps below to set up and send automated messages via MuleSoft.

Deploy MuleSoft's Anypoint Studio

  1. To connect to Mulesoft, you’ll need your ClickSend API credentials. If you don’t have a ClickSend account, create an account here.
  2. Download Anypoint Studio and add the details required.

Add ClickSend to Anypoint Studio

  1. Once you have Anypoint Studio setup, you’ll need to add ClickSend. Just search 'ClickSend' in the Exchange.
  2. Select the ‘ClickSend Dependencies’ and click 'Add'. Then click ‘Save’.

Setup SMS as an action

  1. To start using SMS, drag the ‘Send SMS’ connector to your workflow in Anypoint Studio. [show GIF dragging SMS connector]
  2. Click on ‘Send SMS’ connector to open the connector settings. Then create a connection by clicking the plus button.
  3. Input your ClickSend API Credentials into the designated username and password fields. Then click ‘OK’ to save your credentials.
  4. Customise the SMS action by adding the phone number and message. You have the option to dynamically fetch the phone number and other parameters from either the trigger app or a webhook payload.
    How to use the message fields
    To: add the recipient's phone number
    From: add the sender number or name of the message (optional)
    Message: add the content of your outgoing message.
    Custom String: You can add specific, variable content to your SMS messages (optional). More info.

Setup MMS as an action

  1. To start using MMS, drag the ‘Send MMS’ connector to your workflow in Anypoint Studio. [show GIF dragging MMS connector]
  2. MMS uses the same connection configuration as SMS action. Please refer to step 6 if you haven't created a connection yet. [attach screenshot for MMS config].
  3. Once you've set up a connection between ClickSend and Mulesoft, you can personalise the MMS action by filling out the necessary fields — Recipient phone number, Subject, Message, and Media.
    You have the option to dynamically fetch the phone number and other parameters from either the trigger app or a webhook payload.Note: You can use either of the two of the below options for attaching your media file:
    1. File path: You can provide the path parameter to the locally hosted media file on your computer.
    2. File URL: a public media file URL.
    For more information about supported formats and sizes for MMS media, refer here.
    How to use the message fields
    To: add the recipient's phone number
    From: add your purchased MMS dedicated number or you can leave it blank to use our pool of shared numbers.
    Message: add the content of your outgoing message.
    Subject: It is a required field for the subjest of your MMS message.
    Media File: Select File path or File Url.
    Custom String: You can add specific, variable content to your SMS messages (optional). More info

Troubleshoot

If you’re having problems, please check the following:

  1. Check your Authentication. It should be using your ClickSend's username and API key not your ClickSend password.
  2. Make sure you have credit in your balance. Check and top up here.
  3. Fill in all required parameters in the payload. Required fields are to and message if it is for SMS and to, body, subject, message and media for MMS.
  4. If you are using Business name as Sender id and it's not functioning as expected, please review the following:
    1. Exceeded characters. Only 11 characters without space is allowed for Business name
    2. Global sending disabled on the country you are sending to. Please reach out to support for assistance. More info
    3. Country you are sending to does not support business name

FAQS

  1. Can I send messages from a business name/Alpha tags?
    - Yes, however some countries do not support business names/alpha tags. Find out which countries support sending via a business name here.
    - Note that your business name/alpha tags needs to be 11 characters or less, without spaces.
  2. How do I add a business name/alpha tags as the sender of my messages?
    -Add the 11 character business name/alpha tag on the 'From' field.

  1. Where can I get replies on my messages?
    -Find your outbound and inbound SMS history here.


How Did We Do?


Powered by HelpDocs (opens in a new tab)