Skip to content

MoceanAPI/monday-automation

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

63 Commits
 
 
 
 

Repository files navigation

Mocean monday.com SMS Automation User Documentation

Looking for other documentation ?

Contents

Features

  • Automatically send SMS when new Item is created
  • Automatically send SMS on specific date
  • Automatically send SMS when the status value changed
  • Automatically send SMS when the column value changed
  • Automatically send Voice Call (Text to speech) when new Item is created
  • Automatically send Voice Call (Text to speech) on specific date
  • Automatically send Voice Call (Text to speech) when the status value changed
  • Automatically send Voice Call (Text to speech) when the column value changed

Installation

  1. Select the board you would like to install MoceanAPI Automation

  2. Click on Integrate image

  3. Click on Integrations Center and Search for Mocean in the search bar and install MoceanAPI - Automation image

  4. Choose the automation that fits your needs and click Add to board image

  5. Enter your Mocean API Credentials and the sender image

  6. After you've successfully authenticated, you will be redirected back to Monday.com to customize your Automation Recipe image

  7. After customizing your Automation Recipe, click on Add to board at bottom right

  8. When the automation is triggered, the SMS log will be displayed in the MoceanAPI - Item App if you installed.

image

Non-Supported Trigger Methods

  1. Sending SMS when an item is created
    • The new item created does not have a phone field value upon creation.
    • Workaround would be to set up an automation recipe: When Column Changes, Send SMS to Phone from Your Business Name and manually update the phone column after new item is created.
  2. Sending to subitems is not supported at the moment

Notifications and Updates in monday.com

If you'd like to disable receiving notifications and updates in monday.com whenever an automated SMS is triggered, you can configure it in the Update API Credentials Page

  1. First navigate to MoceanAPI - Send SMS app or MoceanAPI - SMS Broadcast app. image

  2. Then click on the Update API Credentials Link. You can then configure whether you'd like to receive notifications in monday.com for every automated SMS sent image

Custom Date Time format

Sometimes you may want to display a different format for your date time column in your SMS sent using Automation, you can do it by specifying your desired format in the Update API Credentials Page

Date Formats

  • YYYY: 4-digit year '2019'
  • YY: 2-digit year '19'
  • MMMM: Full-length month 'June'
  • MMM: 3 character month 'Jun'
  • MM: Month of the year, zero-padded '06'
  • M: Month of the year '6'
  • DD: Day of the month, zero-padded '01'
  • D: Day of the month '1'
  • Do: Day of the month with numeric ordinal contraction '1st'

Time Format

  • HH: hour of day from 0-24, zero-padded, '14'
  • H: hour of day from 0-24, '14'
  • hh: hour of day on 12-hour clock, zero-padded, '02'
  • h: hour of the day on 12 hour clock, '2'
  • mm: minute, zero-padded, '04'
  • m: minute, '4'
  • ss: second, zero-padded
  • s: second
  • A: 'AM' or 'PM'
  • a: 'am' or 'pm'

Example

Below is an example how you can combine both Date & Time format to create a customized date time format.

Value Result
ddd, YYYY MMM DD, h:mm A Wed, 2022 Aug 10, 9:32 AM
MMMM d, YYYY HH:mm August 3, 2022 09:32

Country Setting

Sometimes your data might not include a country code for the phone number, you can specify the country setting and we will automatically convert the number to the equivalent of your chosen country code. For eg: the number 0123456789 will be converted to 60123456789 for the country Malaysia (MY)

image

Configure this setting if you only send to one country and the phone number doesn't have a prepended country code

We will always prioritize the country code we get from your monday.com item

image

Voice Call

Contact us here to setup your account for voice call capability.

Virtual Number

By default, the Number we use to call your recipient is: 63001 which may be identified as Spam number when your recipient receive the call. To avoid this and get better answering chance, we suggest you to buy a virtual number from us here

After you've bought your virtual number, you can select the virtual number in your automation recipe

image

Voice Recording

If you've decided to send a Voice Recording instead of a Text To Speech, we have automation recipe that supports this. You will need to input the Recording Link

For the Recording Link input, you will need to supply a Direct Link to the recording like below.

image

Below, we will show you steps for 2 platform (Dropbox, Github) which you can upload your voice recording for free.

Upload voice recording to Dropbox

  1. Create an account in Dropbox

  2. Upload your audio file and copy the link to your audio file image

  3. Copy the parameter highlighted above from the uploaded URL and add it to the end of dl.dropboxusercontent.com, as demonstrated in the highlighted section below.  image

So the final URL you should paste in the Recording Link in your automation recipe is: https://dl.dropboxusercontent.com/s/mpx3yi0cbrgsxeq/welcome%20to%20moceanapi.mp3 image

Upload voice recording to Github

Important Files uploaded to public repository are accessible by everyone. If you want to limit access, we suggest you to go with Dropbox

Public Repository

  1. Sign up for an account in Github
  2. On your left navigation panel, click on New to create a new repository
  3. Give your repository a name. Eg: Audio Files
  4. Scroll to the bottom and click on Create Repository
  5. Upload your audio file image
  6. Click on Commit Changes
  7. Click on the newly uploaded file image
  8. Right click on View Raw and copy the link
  9. Paste the link in Recording Link in your automation recipe image

Whitelist IP Address

For added security, you should whitelist 192.168.4.1 IP address in your MoceanAPI Dashboard

To do so, follow these steps

  1. Go to MoceanAPI Dashboard
  2. Navigate to API Account
  3. Key in 192.168.4.1 into Allow IP field

image

FAQ

  1. Can I get Test Credits ?
  • You can get 20 FREE credits. Please note that once you make a top-up, the free credits will be removed.
  1. What means by 20 credits, 1 credit = EUR 1?
  • No, during the trial period, 1 credit equals 1 SMS. So, with 20 credits, you can test 20 SMS.
  1. Can I request more trial credits?
  • Yes, of course! If you'd like to test further, feel free to request from us.
  1. Can I send international messages?
  • Yes. We are an international SMS provider. You can send out SMS both locally and internationally. The price for each country varies, do check out our pricing list here
  1. What is the maximum characters per SMS I can put into the message?
  • English messages can be up to 160 characters, while for Unicode text messages (including Arabic, Chinese, etc.), the limit is 70 characters.
  1. Do you support long message content?
  • Yes, you can send long message content and your credit will be deducted based on the length of the message content.
  1. Is there a limit to how many numbers I can send at one time?
  • There is no limit on numbers to be sent in one go.
  1. What format does my phone number need to be in?
  • Mobile phone numbers need to be entered in international formatting with the country code and without spaces, plus signs or leading zeros. Example: Country code 60 for country Malaysia, 60123456789
  1. What is the character limit for the sender/sender ID?
  • The alpha sender ID can be a maximum of 11 characters, while the numeric sender can consist of up to 15 digits.
  1. I attempted to send messages to US numbers, but they failed to be delivered. Why?
  • Message content that is not registered will result in a failure. To comply with US regulations, it’s essential to buy a number and undergo a use case verification before you can send SMS to your customers.
  1. Can I utilize my personal mobile or landline number as the sender for SMS to the US?
  • No, it’s necessary to purchase a dedicated number, such as a Toll-Free Number, and complete the use case verification process.
  1. How do I go about obtaining or purchasing a Toll Free Number in the US/Canada?
  • Steps:
  1. Complete the number registration form available here
  2. Proceed with the payment.
  3. After your registration is accepted and approved, you’ll be able to send and receive SMS using your Toll Free Number.
  1. What is the expected timeframe for number approval?
  • The duration varies, but typically it takes approximately 2-3 weeks.
  1. I am currently having an US / Canada TFN / 10DLC from another provider. I want to use the same number on your platform. Is that possible?
  • Yes, it is possible. We would need a LoA (Letter of Agency) signed to allow us to take over the SMS part of the number. Please contact us for further assistance.
  1. Why my SMS failed to deliver?
  • You may have set an invalid sender ID, alphanumeric sender ID must be less than 12 characters, and numeric sender ID must be less than 16 characters. Another common issue is you did not specify the correct phone number format including country code. Example: Country code 60 for country Malaysia, 60123456789
  1. I would like to send my content to the US and Canada, but it has been changed to 'Customer ABC just booked an appointment'. May I know why?
  • This occurs because, during the trial period, your content is automatically replaced with that message. To comply with regulations, you will need to purchase a number and verify your use case in order to send your own content. You can download the necessary form here, and we’ll assist you in obtaining a Toll-Free number. Once you have it, you’ll be able to send your content freely.
  1. I want to purchase SMS credits, how to top up my account?
  • Easy & fast, just follow a few steps below:
  1. Login to your account at https://dashboard.moceanapi.com/login
  2. Go to Top Up page on left menu
  3. Select Payment
  4. Pay with credit card / PayPal Your account will be credited instantly and enjoy texting!
  1. Why I cannot buy a Virtual Number?
  • This is due to your account is under trial mode or has insufficient balance. Please top up before proceeding with number purchase.
  1. Why I cannot get monday.com Notifications after receiving an SMS reply?
  • You will need to connect your Monday.com account with us. We have a video for you to follow along to connect your Monday.com account and MoceanAPI. Check it out here
  1. Do I need a Virtual Number to send 1-Way SMS?
  • No, you don’t need a Virtual Number to send 1-Way SMS, unless you are sending SMS to recipients in the US & Canada.
  1. Can I send SMS with shortener URL to United States (US)?
  • Public URL shorteners, such as bit.ly and TinyURL, are not allowed. Please check here for more info.
  1. What is forbidden message categories for SMS in the US/Canada?
  • The messaging use cases described here are strictly prohibited. Even if your specific use case isn't explicitly listed as prohibited, certain types of message content may still face restrictions. For example, using shared or free public URL shorteners is not allowed and could result in filtering. Please make sure that any shortened URLs you use are company-branded.
  1. US Toll Free Number (TFN) SMS delivery features
Section TOLL FREE
Introduction A few years ago Operators started allowing SMS to be delivered via the toll free number pool that was previously only for voice calls. Toll free numbers are also 10 digits long but all start with one of the following dial codes: 1800, 1888, 1877, 1866, 1855, 1844 or 1833. This route allows for handset DLR (delivery receipt) instead of the less accurate gateway DLR provided on 10 DLC. The route also did not have a volume limit per sender like long codes do so it was ideal for business use. Additionally, the service comes with auto responders built in for STOP, HELP and CANCEL responses from mobile subscribers, and has a gateway maintained opt-out database per sender. The route currently has the same content restrictions as 10 DLC.
Type of Number & Example Toll-Free Number (Example: 18885555555)
Suggested Use Cases Low - Medium volumes, 2FA, Non-Marketing & Marketing, Customer Service, Alert Notifications
Approval Process To send messages through this route, we must obtain approval from the toll-free gateway for our campaigns. Although they require less information than TCR for 10DLC, their content guidelines are still strict. If the campaign volume is less than 25,000 per month, we can proceed without official gateway approval, but we must adhere to all regulations, and our support department must review the verification form submitted.
Time to register 5-15 business days
Canadian Reach Yes
2-Way Possible Yes
Concatenated Yes
Unicode Yes
How to order Download TFN registration form here

Did not find what you're looking for ?

Do raise a support ticket with our Support Team at [email protected].

Feature Request

Do raise a support ticket with our Support Team at [email protected].

Feedback

Send feedback to our Support Team at [email protected].

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published