Public Applications Only
The ServiceM8 Messaging API is only available to Public Applications. You will need to implement OAuth 2.0 Authentication and obtain an access token before you can use the Messaging API.
The ServiceM8 platform provides add-ons with messaging services. The advantage of sending messages via the platform is consistency. Your emails will take on email signatures users have pre-setup within their account, and Premium SMS services that users have enabled will be immediately available to your app.
Message Sending Quota
Your ServiceM8 Email and SMS Services have a set of sending limits to regulate the number of email & sms messages that you can send and the rate at which you can send them. Sending limits benefit all ServiceM8 customers because they help to maintain the trusted relationship between ServiceM8, customers and addons.
Sending limits help you to gradually ramp up your sending activity and decrease the likelihood that a mis-configuration will send messages to customers incorrectly.
The ServiceM8 sending limits are:
- Sending Quota – The maximum number of email/SMS messages that you can send in a 24-hour period. The sending quota reflects a rolling time period. Every time you try to send an email/SMS, ServiceM8 checks how many emails you sent in the previous 24 hours. As long as the total number of emails that you have sent is less than your quota, your send request will be accepted and your message will be sent. If you have already sent your full quota, your send request will be rejected with a throttling exception. For example, if your email sending quota is 500, and you sent 100 emails in the previous 24 hours, then you can send another 400 emails right away. If you have already sent 500 emails in the previous 24 hours, you will not be able to send more emails until some of the previous sending rolls out of its 24-hour window.
- Maximum Send Rate – The maximum number of email/SMS messages that you can send per minute. You can exceed this limit for short bursts, but not for a sustained period of time.
What Happens When You Reach Your Sending Limits
If you reach your sending limits you will receive one of the following errors:
- 429 Too Many Requests: Maximum sending rate exceeded
- 429 Too Many Requests: Daily message quota exceeded
Increasing Your Quota
Your sending limits will increase if you are sending high-quality messages and we detect that your utilisation is approaching your current limits. Often, the system will automatically increase your quota before you actually need it, and no further action is needed.
If your existing quota is not adequate for your needs and the system has not automatically increased your quota, you can open an Sending Quota Increase ticket in Support Center to increase your sending quota.
How to Use the Messaging API
Refer to the Messaging API Reference for details of the Messaging endpoint.
Updated about 6 years ago