{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"22cee0ce-0a1f-4383-a2c6-a2d223fb5845","name":"MyOperator API Document","description":"MyOperator offers an HTTP-based API that follows REST principles, allowing easy integration with standard HTTP clients like cURL. The API URLs are structured around resources, with requests formatted in form-encoded style and responses delivered in JSON.\n\nThe API uses two HTTP methods based on the operation type:\n\n- **GET**: For read-only operations, such as retrieving a single resource or listing multiple resources.\n- **POST**: For write operations that modify the state of a resource.\n    \n\n## Request\n\nThe HTTP method (such as GET or POST) defines the type of operation performed on a resource. For GET requests, query parameters can be used to specify additional options. For POST requests, parameters supply the data needed for write operations, such as creating or updating resources.\n\n## Response\n\nThe response is in JSON format. Currently, MyOperator does not support any other response format.\n\n## Concepts\n\nAs you explore the MyOperator WhatsApp API and its documentation, you'll encounter various concepts, variables, and terms essential to understanding its functionality. Below is a guide to these key concepts and where you can locate them within the MyOperator app.\n\n**Base URL:** The base URL is to access the public APIs. You can use [https://publicapi.myoperator.co](https://publicapi.myoperator.co/) to access the public APIs\n\n**Api Key:** MyOperator authenticates your API requests using your account's API keys. You can find the keys on Myoperator Panel > Manage > Whatsapp APIs> Whats app API Key\n\n**Company id:** A unique identifier of company in MyOperator. You can find the company ID on Myoperator Panel > Manage > Whatsapp APIs> company id\n\n**Phone number id:** A unique identifier of Whatsapp phone number in MyOperator. You can find the ID by \"List Phone numbers\" or Go to Myoperator Panel > Manage > WhatsApp >WhatsApp Accounts >Phone number id\n\n**Waba id:** A unique identifier of Whatsapp account. You can find the waba ID on Myoperator Panel > Manage > WhatsApp >Whatsapp Accounts >WABA ID\n\n**Template Variables:** Template variables are used to send the template with variable. You can find the template variables in list template API or in Myoperator panel→ Manage→ WhatsApp→ Templates, hover on the variable to see the template variable name.\n\n**Media ID:** Media ID is used to send the media(image/video/document) template You can use the \"upload media\" API which will return the media ID.\n\n# Errors and Status Codes\n\nStandard HTTP error codes are returned in the case of a failure. 2xx codes indicate a successful message; 4xx codes indicate an error caused by information provided by the client; and 5xx codes indicate an error on MyOperator servers.\n\n## Status Codes\n\n| Status Code | Meaning |\n| --- | --- |\n| 200 | OK |\n| 201 | Created |\n| 400 | Bad Request |\n| 404 | Not found |\n| 403 | Forbidden |\n| 500 | Internal Server Error |\n\n## Error Codes\n\n| Code | Meaning |\n| --- | --- |\n| CHAT_4001 | Insufficient balance |\n| CHAT_0301 | Waba not approved by Meta |\n| CHAT_0302 | Waba company is disabled by chat service |\n| CHAT_0303 | Phone number is disabled by chat service |\n| CHAT_0304 | Phone number not onboarded yet |\n| CHAT_0305 | Phone number not connected with Meta |\n| CHAT_0004 | Service inactive |\n| CHAT_0306 | Phone number does not exist (sender phone number) |\n\n## Language Support\n\n| Code | Name |\n| --- | --- |\n| **en** | English |\n| **en_US** | English (US) |\n| **en_GB** | English (UK) |\n| **af** | Afrikaans |\n| **sq** | Albanian |\n| **ar** | Arabic |\n| **az** | Azerbaijani |\n| **bn** | Bengali |\n| **bg** | Bulgarian |\n| **ca** | Catalan |\n| **zh_CN** | Chinese (CHN) |\n| **zh_HK** | Chinese (HKG) |\n| **zh_TW** | Chinese (TAI) |\n| **hr** | Croatian |\n| **cs** | Czech |\n| **da** | Danish |\n| **nl** | Dutch |\n| **et** | Estonian |\n| **fil** | Filipino |\n| **fi** | Finnish |\n| **fr** | French |\n| **ka** | Georgian |\n| **de** | German |\n| **el** | Greek |\n| **gu** | Gujarati |\n| **ha** | Hausa |\n| **he** | Hebrew |\n| **hi** | Hindi |\n| **hu** | Hungarian |\n| **id** | Indonesian |\n| **ga** | Irish |\n| **it** | Italian |\n| **ja** | Japanese |\n| **kn** | Kannada |\n| **kk** | Kazakh |\n| **rw_RW** | Kinyarwanda |\n| **ko** | Korean |\n| **ky_KG** | Kyrgyz (Kyrgyzstan) |\n| **lo** | Lao |\n| **lv** | Latvian |\n| **lt** | Lithuanian |\n| **mk** | Macedonian |\n| **ms** | Malay |\n| **ml** | Malayalam |\n| **mr** | Marathi |\n| **nb** | Norwegian |\n| **fa** | Persian |\n| **pl** | Polish |\n| **pt_BR** | Portuguese (BR) |\n| **pt_PT** | Portuguese (POR) |\n| **pa** | Punjabi |\n| **ro** | Romanian |\n| **ru** | Russian |\n| **sr** | Serbian |\n| **sk** | Slovak |\n| **sl** | Slovenian |\n| **es** | Spanish |\n| **es_AR** | Spanish (ARG) |\n| **es_ES** | Spanish (SPA) |\n| **es_MX** | Spanish (MEX) |\n| **sw** | Swahili |\n| **sv** | Swedish |\n| **ta** | Tamil |\n| **te** | Telugu |\n| **th** | Thai |\n| **tr** | Turkish |\n| **uk** | Ukrainian |\n| **ur** | Urdu |\n| **uz** | Uzbek |\n| **vi** | Vietnamese |\n| **zu** | Zulu |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"38426694","collectionId":"22cee0ce-0a1f-4383-a2c6-a2d223fb5845","publishedId":"2sAXqy3evq","public":true,"publicUrl":"https://documenter-api.postman.tech/view/38426694/2sAXqy3evq","privateUrl":"https://go.postman.co/documentation/38426694-22cee0ce-0a1f-4383-a2c6-a2d223fb5845","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/e75d0b01-3622-42d0-a9df-680cddcfe4f4/bXlvcC1sb2dvLWFsbGlub25lY3gucG5n","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":"https://content.pstmn.io/e75d0b01-3622-42d0-a9df-680cddcfe4f4/bXlvcC1sb2dvLWFsbGlub25lY3gucG5n","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2024-09-27T11:29:58.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/e75d0b01-3622-42d0-a9df-680cddcfe4f4/bXlvcC1sb2dvLWFsbGlub25lY3gucG5n","logoDark":"https://content.pstmn.io/e75d0b01-3622-42d0-a9df-680cddcfe4f4/bXlvcC1sb2dvLWFsbGlub25lY3gucG5n"}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sAXqy3evq"}