What APIs does MyOperator provide? (Full reference + Postman collection)
MyOperator API Reference – Postman Documentation Links
An API (Application Programming Interface) is a set of HTTP endpoints that let your software read or write MyOperator resources—such as call logs, recordings, and click-to-call actions—without using the UI.
MyOperator provides the following API groups: WhatsApp Business APIs (templates, campaigns, phone numbers/messages/media), Contact APIs, OBD APIs (outbound dialer/calling), User APIs, Call APIs, and Webhooks (New & Deprecated) for inbound event payloads.
📄 Full Postman Collection: https://documenter.getpostman.com/view/38426694/2sAXqy3evq
⚠️ Note: Different API groups use different base URLs and authentication methods. Refer to the authentication box at the top of each section before integrating.
Authentication Summary
| API Group | Base URL | Auth Method | Where to Find Keys |
|---|---|---|---|
| WhatsApp Business APIs Contact APIs | https://publicapi.myoperator.co | WABA Authentication Keyx-api-key header | MyOperator Panel → API & Webhook → WhatsApp APIs → WhatsApp API Key |
| OBD APIs | https://obd-api.myoperator.co/obd-api-v1 | Calling API Keysx-api-key + secret-key headers | MyOperator Panel → API & Webhook → Calling APIs → Endpoint Details |
| User APIs Call APIs | https://developers.myoperator.co | Calling API Tokentoken query/body param | MyOperator Panel → API & Webhook → Calling APIs → Endpoint Details |
| Webhooks (New & Deprecated) | Inbound payloads to your endpoint | N/A – payloads sent by MyOperator to your server | — |
📱 How do I start using the APIs?
1. Check your plan: full API and webhook access is on the SUV and Enterprise AI plans. If the API & Webhook tab shows "Please contact support to use this feature," contact your Account Manager or support@myoperator.com.
2. Get your credentials in the panel: APIs & Webhook → Developer API → (WhatsApp or Calling API) → Manage → Generate credentials → Endpoint details.
3. Use the base URL and authentication for the API group you need (see the table above).
4. Test your requests with the Postman collection.
5. If you need help with an integration, see "How do I get help with API/CRM integrations?
📱 WhatsApp Business APIs
🔐 Authentication – WABA API KeyBase URL:
Header:
Find it: MyOperator Panel → APIs & Webhook → Developer API → WhatsApp APIs→ WhatsApp API Key
https://publicapi.myoperator.coHeader:
x-api-key: <your-waba-authentication-key>Find it: MyOperator Panel → APIs & Webhook → Developer API → WhatsApp APIs→ WhatsApp API Key
Templates
- POSTCreate Template
- GETList Templates
- GETFetch Template By ID
- GETFetch Template By Name
- DELETEDelete Template By ID
Campaigns
Phone Numbers, Messages & Media
- GETList Phone Numbers
- POSTSend Message
- POSTUpload Media
👤 Contact APIs
🔐 Authentication – WABA API Key (same as WhatsApp Business APIs)Base URL:
Header:
Find it: MyOperator Panel → APIs & Webhook → Developer API → WhatsApp APIs→ WhatsApp API Key
https://publicapi.myoperator.coHeader:
x-api-key: <your-waba-authentication-key>Find it: MyOperator Panel → APIs & Webhook → Developer API → WhatsApp APIs→ WhatsApp API Key
- POSTCreate Contact
- POSTCreate Contact with Custom Fields
- POSTSearch Contacts
- GETFetch Contacts
- GETFetch Contacts with Custom Fields
- GETFetch Contact by ID
- GETFilter Contact by Phone Number
- PATCHUpdate Contact by Phone Number
- PATCHUpdate Contact by ID
- DELETEDelete Contact by ID
📞 OBD APIs
🔐 Authentication – Calling API KeysBase URL:
Headers required:
Find it: MyOperator Panel → APIs & Webhook → Developer API →Calling APIs→ Endpoint Details
https://obd-api.myoperator.co/obd-api-v1Headers required:
x-api-key: <your-calling-x-api-key>secret-key: <your-calling-secret-key>Find it: MyOperator Panel → APIs & Webhook → Developer API →Calling APIs→ Endpoint Details
- POSTCall (OBD)
👥 User APIs
Can I get, create or update users through an API? Yes. Use the User APIs: GET Get Users, POST Create User and PUT Update User. They use the Calling API Token (pass it as the token query or body parameter) with the base URL https://developers.myoperator.co. Full request and response details are in the Postman collection:
🔐 Authentication – Calling API TokenBase URL:
Pass as query param or body:
Find it: MyOperator Panel → APIs & Webhook → Developer API → Calling APIs→ Endpoint Details → Authentication
https://developers.myoperator.coPass as query param or body:
token=<your-calling-api-token>Find it: MyOperator Panel → APIs & Webhook → Developer API → Calling APIs→ Endpoint Details → Authentication
- GETGet Users
- POSTCreate User
- PUTUpdate User
📋 Call APIs
🔐 Authentication – Calling API TokenBase URL:
Pass as query param or body:
Find it: MyOperator Panel → APIs & Webhook → Developer API → Calling APIs→ Endpoint Details → Authentication
https://developers.myoperator.coPass as query param or body:
token=<your-calling-api-token>Find it: MyOperator Panel → APIs & Webhook → Developer API → Calling APIs→ Endpoint Details → Authentication
🔔 Webhooks – New
ℹ️ Inbound Payloads – No Auth Required from Your SideThese are payloads sent by MyOperator to your server. Configure your webhook endpoint URL in the MyOperator Panel. MyOperator will POST events to your URL.
Calls
- POSTcall.initiated
- POSTcall.dial_begin
- POSTcall.answered
- POSTcall.end
- POSTcall.summary
- POSTdisposition
WABA
- POSTmessage.received
- POSTmessage.sent
- POSTmessage.read
- POSTmessage.delivered
- POSTmessage.failed
- POSTmessage.link_tracking
- POSTconversation.assign
- POSTconversation.close
🔕 Webhooks – Deprecated (Use New Webhooks instead)
⚠️ These webhook events are deprecated.Migrate to the new Webhooks (above) for continued support. Payloads are inbound — sent by MyOperator to your configured endpoint.