Welcome to the Sakari Messaging REST API Documentation
Sakari provides an advanced platform for large scale customized SMS communication.
REST is a web-service protocol that lends itself to rapid development using everyday HTTP and JSON technology.
Find out more about our product offeringQuickstart Guide
We've created a quickstart guide to get you up and running in 5 minutes. Click here to access it.
PostMan Collection
We've created a simple set of examples using PostMan.
You'll need to setup three environment variables in PostMan - AccountId, ClientId and ClientSecret.
How to Find Your Credentials
To authenticate against the API, you'll need:
- client id
- client secret
- account id
To retrieve these, login to your Sakari account and click on the 'cog' icon in the top right corner.
Versioning
The latest version is v1. We introduce new versions with any breaking changes.
The API uses an open schema model, which means servers may add extra properties to responses.
Testing
We provide examples using curl and client SDKs. Let us know if you'd like to see an SDK in a language not currently available.
Throttling / Limits
We impose limits on API calls to prevent abuse. Contact us if you need a higher limit.
Errors
{"success": false,"error": {"code"":"CONT-001","message"":"Invalid mobile number"}}
Pagination
Most GET calls return a subset of data. The API returns a pagination object with:
{"pagination": {"offset": 0,"limit": 10,"totalCount": 21}}