- MoceanAPI - SMS Broadcast Documentation
- MoceanAPI - Send SMS Documentation
- MoceanAPI - Omnichannel Messaging (Current)
- MoceanAPI - SMS Automation Documentation
- SMS Sender ID Country List
-
Select the board you would like to install MoceanAPI Two Way SMS App
-
Click on one of the items in the board and click on the
+sign
- Search for
Moceanin the search bar and install theMoceanAPI - Two Way SMS
- After installing the app, you will need to
Authenticateyour account
- Enter your Mocean API Credentials and the sender
- After you've successfully authenticated, you will be redirected back to
monday.com
Important If you would like to enable the sending of two-way SMS, kindly get in touch with our sales team here to initiate the setup process.
Follow the steps below to buy a non US virtual number
- Navigate to Buy virtual number page
- Select the country of the virtual number you'd like to own
- After selecting your desired number, click on Buy
Follow the steps below to buy a US virtual number. We will guide you through the information required to own a US virtual number.
- Please contact our sales team here for detailed configuration
- Before you can send SMS, you will need to specify the
Phone columnin the settings
-
You'll need to buy a virtual number here to receive the SMS from your recipients
-
You can then select your virtual numbers in the
Virtual Numbersdropdown menu
- If you would like to enable the sending of two-way SMS, kindly get in touch with our sales team here to initiate the setup process.
- Our App will automatically populate the
Phone numberfield if it detects a value in the specifiedPhone Column - Select the virtual number you owned in
Virtual Numbersdropdown menu. - Compose the SMS you would like to send and click on Send SMS.
- The SMS status will be shown at the bottom of the SMS card
SMS Statuses
- Pending = SMS is awaiting Delivery Report (SMS may have already been sent)
- Fail = SMS failed to deliver
- Success = SMS delivered
-
Open the app and click on Update API Credentials
-
Navigate to SMS Templates via Side navigation bar
-
Click on the Create button to create a new SMS template
- Click on Save button to save your SMS template
-
Open the Two Way SMS app
-
Simply select the SMS Template you'd like to use in your message
-
Click on Send SMS to send the SMS
- You will need to
Connect your monday.com account to MoceanAPI - Navigate to
Update API Credentials page
- Click on
Connect MoceanAPI - Continue the process until you're redirected back to the
Update API Credentials page - You can now proceed to
enableordisablereceiving notifications in monday.com on every SMS reply - Configure the Person Column you'd like to receive notifications on every SMS replies
- Now just send the SMS as usual and we'll send you a
notificationin monday.com on every new SMS reply
Want to get notified on other channels ? Talk to our Support
For added security, you should whitelist 192.168.4.1 IP address in your MoceanAPI Dashboard
To do so, follow these steps
- Go to MoceanAPI Dashboard
- Navigate to API Account
- Key in
192.168.4.1into Allow IP field
- Can I get Test Credits ?
You can get 20 FREE credits and credits. Please note that once you make a top-up, the free credits will be removed.
- Can I send international messages?
Yes. We are an international SMS provider. You can send out SMS both locally and internationally based on our price list.
- 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.
- Can I send long message content?
Yes, you can send long message content and your credit will be deducted based on the length of the message content.
- 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.
- 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.
- 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.
- 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.
- 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.
- How do I go about obtaining or purchasing a number in the US/Canada?
a) Complete the number registration form available here
b) Proceed with the payment.
c) During the pending registration approval phase, a number will be provided for sending SMS on a smaller scale.
d) After your registration is approved, you'll be able to send and receive SMS without volume limitations.
- What is the expected timeframe for number approval?
The duration varies, but typically it takes approximately a month or less.
- Why my SMS failed to deliver ?
You may have set an invalid sender id, alphanumeric sender id must be less than 12 characters, 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. eg: Country code 60 for country malaysia, 60123456789
- How to top up my account ?
Click here and select your payment method of choice (Paypal and credit card)
- Why I cannot buy a Virtual Number ?
Your account is under trial mode or has insufficient balance. Please top up before proceeding with number purchase.
- 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 account and MoceanAPI. https://youtu.be/P1DG6grBlQ0?si=W5NeYJnKODJP7Knk&t=60
- Do I need to buy a number to send 1-Way SMS?
No, you don't need to buy a number to send 1-Way SMS except for USA & Canada.
- SMS Compliance Guidelines
Below are some general guidelines / best practices you can follow:
Obtain proper consent: You must obtain consent from the mobile subscriber before sending any SMS messages. The consent should be opt-in and clearly disclose the frequency and nature of messages. Include opt-out instructions: Every SMS message should include clear and easy-to-follow instructions on how to opt-out of receiving further messages. Provide customer support: Your SMS messaging program should include customer support options for subscribers to receive assistance Comply with content restrictions: SMS messages should comply with all content restrictions and regulations
- Campaigns Prohibited:
- Loan advertisements except for messages from direct lenders for secured loans
- Payday loans
- Credit repair
- Debt relief
- Pharmacy/Cannabis/Tobacco/Vape
- ED
- Work from home, 'secret shopper' and similar advertising campaigns
- Gambling/sweepstakes
- Cryptocurrencies
- Lead generation campaigns that indicate the sharing of collected information with third parties
- Messaging Prohibited:
- Message streams that result in excessive complaints or STOP commands typically indicate an unwanted message campaign and will not be allowed to continue.
- Phishing: Messages that attempt to obtain sensitive information, such as usernames, passwords, or financial information, through fraudulent means are strictly prohibited.
- Fraud or scams: Messages that deceive subscribers by promoting fraudulent or misleading offers, schemes, or scams are not allowed.
- Messages that use deceptive marketing practices or false claims to promote products or services are prohibited.
- Messages that distribute malware or direct subscribers to download apps from non-secure locations are strictly prohibited.
- Loan, debt consolidation, debt relief, and student loan programs from any enterprise that cannot grant the loan themselves: Enterprises that cannot grant loans themselves are not allowed to promote loan, debt consolidation, debt relief, and student loan programs.
- Affiliate lead generation for these financial programs is also prohibited.
- US SMS Delivery Option
| Section | 10DLC | TOLL FREE | DEDICATED SHORT CODE |
|---|---|---|---|
| Introduction | 10DLC is just the new name for sending primarily 1-way A2P messages over local long codes. In the past using local long codes was primarily for 2-way conversational traffic (P2P) but companies were using it for 1-way traffic as well. If you wanted to send any kind of volume of messages via long codes (more than a few hundred a day) you had to use a pool of senders because velocity filters would treat high volumes of messages coming from one sender as SPAM and automatically block the sender. Now with 10DLC registration you can send higher volumes of messages from a single sender. This works really well for sending under about 2,000 messages per day and if you or your customer wants a local sender in their area. External vetting is also available for an additional fee to get more than 2,000 messages per day per sender. | 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. | In the USA a short code is a dedicated 5 or 6 digit sender ID assigned to a specific brand for a specific purpose or campaign. A good example is a bank sending one time codes to their customers for 2 factor authentication. This is the most premium SMS service in the USA as it has handset DLR and goes through a lengthy vetting process. There are several requirements to get one of these codes approved, they take about 1-2 months to get fully approved and have significant monthly and setup fees, so they are typically used by larger corporations with very high volume sending. Client needs to show opt-in process and be able to handle auto responders for HELP/STOP/CANCEL as well as maintain opt-out database per campaign. |
| Type of Number & Example | Long Number (Example: 13458677777) | Toll-Free Number (Example: 18885555555) | 5 or 6 digit Short Code (Example: 12345) |
| Suggested Use Cases | High volumes, Marketing, 2FA, Alerts, 2FA, Notifications, Customer Care, Alerts, Higher Education, Low Volume Mixed, Marketing, Polling and Voting, Public Service Announcement | Low - Medium volumes, 2FA, Non-Marketing & Marketing, Customer Service, Alert Notifications | High Volume School/Flight/Appt reminders |
| Approval Process | To send messages via this route, it is necessary to register brands and campaigns with TCR (The Campaign Registry) as required by the Operators and interconnected gateways. TCR is an independent registry authorized to register brands and campaigns with T-Mobile and AT&T. Although Verizon, the other major USA operator, is currently not participating, registration requirements are not as strict at this time. Clients must show their opt-in process and ability to handle auto responders for HELP/STOP/CANCEL and maintain opt-out databases per campaign. | 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. | To send messages through this route, we must obtain campaign approval from the Operators. |
| Time to register | 2-7 business days | 5-15 business days | 1-2 months |
| Canadian Reach | Yes | Yes | No (User must purchase a Canadian Short Code) |
| 2-Way Possible | Yes | Yes | Yes |
| Concatenated | Yes | Yes | Yes |
| Unicode | Yes | Yes | Yes |
| How to order | Email your request to sales@moceanapi.com | Download TFN registration form here | Email your request to sales@moceanapi.com |
Start the whatsapp business registration process here
To try out a test WhatsApp account, contact sales here
-
You will need a WhatsApp Business Account to be able to send whatsapp using our app
-
Specify the
Phone Columnand thePeople Columnto notify you whenever there's a new WhatsApp reply
- You can then select your WhatsApp Business Account to use when sending whatsapp
-
Our App will automatically populate the
Phone numberfield if it detects a value in the specifiedPhone Column -
Select the whatsapp number you owned in
WhatsApp Businessdropdown menu. -
Select the approved WhatsApp Template you'd like to send to your users
-
Configure the value for the variables for your chosen template
- Your messages will appear in the chat
-
Our App will automatically populate the
Phone numberfield if it detects a value in the specifiedPhone Column -
Select the whatsapp number you owned in
WhatsApp Businessdropdown menu. -
Click on the media icon and upload the media you'd like to send (image, video, document)
-
You can enter the caption of the media and hit the send button
- The media you sent, will be shown in the chat together with its delivery status similar to whatsapp.
-
Our App will automatically populate the
Phone numberfield if it detects a value in the specifiedPhone Column -
Select the whatsapp number you owned in
WhatsApp Businessdropdown menu. -
Simply enter the texts you want to send and hit the send button
- The message you sent, will be available in the chat along with its delivery status
- How does the WhatsApp messaging feature work in the app?
Your composed messages will be sent to your user's whatsapp through our services
- What permissions or access does the app require to send WhatsApp messages?
You need to be an admin or have access to the board
- Can I send messages to multiple WhatsApp contacts at once?
Yes, you can use our monday.com broadcast app to broadcast your messages to multiple WhatsApp contacts
- Is it possible to schedule WhatsApp messages for future delivery?
Not possible at the moment
- Are media files (e.g., images, videos) supported in WhatsApp messages?
Yes, you'll be able to send any media files (images, videos, documents) using our app
- Can I track the delivery and read receipts of my WhatsApp messages?
Yes, you can track the delivery & read receipts via the ticks. Single tick shows that the message have been sent to our server Double tick indicates the message have been delivered to your intended recipient Double blue tick indicates the message have been seen by your intended recipient (this will only be shown if your recipient have enabled read receipts)
- How do I customize and personalize WhatsApp messages sent through the app?
You can simply select the values we've detected from your board in a dropdown menu using Variables
- Is there a mobile app for using this feature on smartphones?
We don't have this at the moment
- What should I do if I encounter issues with sending WhatsApp messages through the app?
Report this to our support team and we'll connect you with our developers
- Does Mocean provide a whatsapp number ?
No, you will have to use your own WhatsApp number.
Do raise a support ticket with our Support Team at support@moceanapi.com.
Send feedback to our Support Team at support@moceanapi.com.