Mocean API API Documentation
This is the complete API documentation for connecting to the Mocean API API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.
MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.
Meet Mocean API: Send SMS and verification codes, run number lookups, place voice calls, and manage WhatsApp templates with Mocean API. Keep reading to get started.
Quickstart
Before you run your first Mocean API request, you need three things:
- A MindCloud account — sign in or create an account at MindCloud.
- A MindCloud API Key — create one in API Keys. Keep it on your server.
- At least one Mocean API connection — create or choose one in Connections. Note its
connectionId.
Every Mocean API action uses the same URL pattern:
https://connect.mindcloud.co/v1/universal/moceanAPI/latest/actions/{actionSlug}You need a MindCloud API Key and a Mocean API connection. Then call an action such as Check Verify Code:
curl --request GET \
--url "https://connect.mindcloud.co/v1/universal/moceanAPI/latest/actions/check-verify-code" \
--header "Authorization: Bearer $MINDCLOUD_API_KEY" \
--get \
--data-urlencode "connectionId=$CONNECTION_ID"Every response comes back in the same envelope, with your rows in a data array:
{
"success": true,
"data": [
{ "id": "1042", "name": "Ava" }
],
"meta": {}
}After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.
Authentication
Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected Mocean API account that should run the action. MindCloud stores and refreshes the Mocean API credentials behind that connection, so you never send provider tokens with your requests.
Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions. Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs.
Mocean API actions
All 34 published actions for this Mocean API version. Each page documents the endpoint, arguments, and response controls.
- GETCheck Verify Code
- POSTCreate WhatsApp Template
- DELETEDelete WhatsApp Template
- GETDownload Recording
- GETDownload WhatsApp Rich Media
- PUTEdit WhatsApp Template
- GETGet Account Pricing
- GETGet Balance
- GETGet Message Status
- GETGet Number Lookup Pricing
- GETGet SMS Pricing
- GETGet Verify Pricing
- GETGet WhatsApp Template
- PUTHang Up Call
- GETList WhatsApp Templates
- GETRequest Async Number Lookup
- GETRequest Number Lookup
- POSTResend Verify Code SMS
- POSTResend Verify Code SMS With Lookup
- POSTSend Binary SMS
- POSTSend Bulk SMS
- POSTSend Flash SMS
- POSTSend Scheduled SMS
- POSTSend SMS
- POSTSend SMS With Delivery Report
- POSTSend Unicode SMS
- POSTSend Verify Code SMS
- POSTSend Verify Code SMS With Lookup
- POSTSend Verify Code Telegram
- POSTVoice Call Collect Digits
- POSTVoice Call Play Audio
- POSTVoice Call Record Call
- POSTVoice Call Say Message
- POSTVoice Call Transfer
Related apps
More Communication apps on the Universal API, behind the same REST shape. Or browse all apps.