{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"3b40131c-27db-49e6-8dee-c0e568c1c9c3","name":"MiMSMS API v2","description":"## Getting Started with MiMSMS API v2\n\nWelcome to the **MiMSMS Bulk SMS API v2**. Before you start integrating the API into your application, please follow the steps below to set up your credentials and configure your account properly.\n\n---\n\n## Step 1: API Key Activation & Credentials\n\n### API Username\n\nYour **API Username** is the same **email address** you use to log in to the MiMSMS SMS panel at [sms.mimsms.com](https://sms.mimsms.com). You do not need a separate username — just use your panel login email.\n\n### Finding & Managing Your API Key\n\nNavigate to:\n\n> [sms.mimsms.com](https://sms.mimsms.com) **→ Utility → Developer** \n  \n\nFrom this menu you can:\n\n- **View** your existing API Key\n    \n- **Activate** your API Key (must be activated before use)\n    \n- **Re-generate** your API Key (if your current key is compromised or you need a new one)\n    \n\n> ⚠️ **Important:** Your API Key must be **activated** before you can make any API calls. If your requests are returning authentication errors, please check that your API Key is active from this menu. \n  \n\n---\n\n## Step 2: IP Address & Domain Whitelisting\n\nFor security purposes, MiMSMS API requires you to **whitelist your server's IP address and domain name** before API calls will be accepted. This prevents unauthorized use of your API Key.\n\nNavigate to:\n\n> [sms.mimsms.com](https://sms.mimsms.com) **→ Utility → Developer** \n  \n\nFrom this menu you can add:\n\n- Your **web server or hosting server's IP address**\n    \n- Your **domain name** (e.g., `messages.com.bd`)\n    \n\n### For Localhost / Local Development\n\nIf you are building or testing a **localhost-based application** (e.g., running on your local PC or development machine), you will not have a dedicated server IP. In this case:\n\n- Use your **ISP-provided fixed IP address** instead of a server IP.\n    \n- You can find your current public IP by visiting [https://whatismyip.com](https://whatismyip.com).\n    \n- Contact your ISP if you do not have a fixed/static IP assigned to your connection.\n    \n\n> ⚠️ **Note:** Dynamic IPs will not work reliably for whitelisting. Always use a **fixed/static IP** for production or development environments. \n  \n\n---\n\n## Step 3: Sender ID\n\nA **Sender ID** is the name or number that appears as the sender when your recipients receive an SMS. MiMSMS supports two types of Sender IDs:\n\n| Type | Description |\n| --- | --- |\n| **Masking** | A custom name (e.g., your brand name) shown to the recipient. Used for Transactional/promotional/marketing SMS. |\n| **Non-Masking** | A numeric mobile number used as the sender. Typically used for low cost promotional SMS. |\n\nTo view your available Sender IDs, navigate to:\n\n> [sms.mimsms.com](https://sms.mimsms.com) **→ Utility → Sender ID** \n  \n\nUse the exact Sender ID listed here in your API requests under the `senderName` parameter. Using an unregistered or incorrect Sender ID will cause your API request to fail.\n\n---\n\n## Quick Reference\n\n| Parameter | Where to Find |\n| --- | --- |\n| `userName` | Your MiMSMS panel login email address |\n| `apiKey` | sms.mimsms.com → Utility → Developer |\n| `senderName` | sms.mimsms.com → Utility → Sender ID |\n\n---\n\n> 💡 **Need Help?** If you face any issues with API integration, please contact MiMSMS support through the portal at [www.mimsms.com](https://www.mimsms.com).","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"14759893","team":1618148,"collectionId":"3b40131c-27db-49e6-8dee-c0e568c1c9c3","publishedId":"2sBXwpNBna","public":true,"publicUrl":"https://apidoc.mimsms.com","privateUrl":"https://go.postman.co/documentation/14759893-3b40131c-27db-49e6-8dee-c0e568c1c9c3","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"Access MiMSMS Bulk SMS API documentation to integrate fast, secure, and scalable SMS gateway services in Bangladesh. Send transactional and promotional SMS via simple REST API. Includes authentication, delivery reports, and real-time messaging support for developers and SaaS platforms."},{"name":"title","value":"Bulk SMS API Documentation | Fast and Reliable SMS Gateway for Bangladesh"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.11.6","publishDate":"2026-06-05T11:06:27.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Bulk SMS API Documentation | Fast and Reliable SMS Gateway for Bangladesh","description":"Access MiMSMS Bulk SMS API documentation to integrate fast, secure, and scalable SMS gateway services in Bangladesh. Send transactional and promotional SMS via simple REST API. Includes authentication, delivery reports, and real-time messaging support for developers and SaaS platforms."},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"MiMSMS Production","id":"3ccf8980-f3d6-4804-813c-86ee6b183ba3","owner":"14759893","values":[],"published":true}],"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/5a19907e0ce4b7d8c39ff3f61ac0e0aa333da80e7b0872abc40c5c8dcc610fa4","favicon":"https://mimsms.com/favicon.ico"},"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"},{"label":"MiMSMS Production","value":"14759893-3ccf8980-f3d6-4804-813c-86ee6b183ba3"}],"canonicalUrl":"https://apidoc.mimsms.com/view/metadata/2sBXwpNBna"}