openapi: 3.0.0
info:
  title: MiMSMS API v2
  description: >-
    ## Getting Started with MiMSMS API v2


    Welcome 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.


    ---


    ## Step 1: API Key Activation & Credentials


    ### API Username


    Your **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.


    ### Finding & Managing Your API Key


    Navigate to:


    > [sms.mimsms.com](https://sms.mimsms.com) **→ Utility → Developer** 
      

    From this menu you can:


    - **View** your existing API Key
        
    - **Activate** your API Key (must be activated before use)
        
    - **Re-generate** your API Key (if your current key is compromised or you
    need a new one)
        

    > ⚠️ **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. 
      

    ---


    ## Step 2: IP Address & Domain Whitelisting


    For 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.


    Navigate to:


    > [sms.mimsms.com](https://sms.mimsms.com) **→ Utility → Developer** 
      

    From this menu you can add:


    - Your **web server or hosting server's IP address**
        
    - Your **domain name** (e.g., `messages.com.bd`)
        

    ### For Localhost / Local Development


    If 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:


    - Use your **ISP-provided fixed IP address** instead of a server IP.
        
    - You can find your current public IP by visiting
    [https://whatismyip.com](https://whatismyip.com).
        
    - Contact your ISP if you do not have a fixed/static IP assigned to your
    connection.
        

    > ⚠️ **Note:** Dynamic IPs will not work reliably for whitelisting. Always
    use a **fixed/static IP** for production or development environments. 
      

    ---


    ## Step 3: Sender ID


    A **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:


    | Type | Description |

    | --- | --- |

    | **Masking** | A custom name (e.g., your brand name) shown to the
    recipient. Used for Transactional/promotional/marketing SMS. |

    | **Non-Masking** | A numeric mobile number used as the sender. Typically
    used for low cost promotional SMS. |


    To view your available Sender IDs, navigate to:


    > [sms.mimsms.com](https://sms.mimsms.com) **→ Utility → Sender ID** 
      

    Use 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.


    ---


    ## Quick Reference


    | Parameter | Where to Find |

    | --- | --- |

    | `userName` | Your MiMSMS panel login email address |

    | `apiKey` | sms.mimsms.com → Utility → Developer |

    | `senderName` | sms.mimsms.com → Utility → Sender ID |


    ---


    > 💡 **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).
  contact: {}
  version: '2.0'
servers:
  - url: https://api.mimsms.com/api
    variables: {}
paths:
  /V2/SMS:
    post:
      tags:
        - Misc
      summary: SendSMS (T)
      description: >-
        Sends a transactional SMS to a single recipient via the POST method.
        Transactional messages (type `T`) are used for OTPs, alerts, and
        notifications, and are delivered at any time regardless of DND status.


        > **Note:** Maximum **1 receiver number** is allowed for Transactional
        SMS (`T`). 
          

        **Endpoint:**


        ```

        POST https://api.mimsms.com/api/V2/SMS

        Content-Type: application/json

        {
          "apiKey": "YOUR_API_KEY",
          "userName": "your@email.com",
          "senderName": "YourSenderID",
          "transactionType": "T",
          "mobileNumber": "8801XXXXXXXXX",
          "message": "Hello from MiMSMS!"
        }

         ```

        **Body Parameters:**  

        | Field | Type | Required | Description |  

        | --- | --- | --- | --- |  

        | Request Header | content-type: application/json | Yes | Header |  

        | `apiKey` | string | Yes | Your MiMSMS API key |  

        | `userName` | string | Yes | Your registered account email |  

        | `senderName` | string | Yes | Sender ID or number |  

        | `transactionType` | string | Yes | Must be `"T"` for transactional |  

        | `mobileNumber` | string | Yes | Recipient mobile number |  

        | `message` | string | Yes | SMS content |  

        | `campaignName` | string | No | Optional label for the campaign |
      operationId: SendSMS(T)
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/SendSMSTRequest'
                - example:
                    apiKey: ALPHABITAGAMMA
                    userName: demo@mimsms.com
                    campaignName: 'null'
                    senderName: '8809612444598'
                    transactionType: T
                    mobileNumber: '8801777712720'
                    message: >-
                      Welcome to MiMSMS v2 API. This is a test sms from
                      api/V2/SMS POST method
            example:
              apiKey: ALPHABITAGAMMA
              userName: demo@mimsms.com
              campaignName: 'null'
              senderName: '8809612444598'
              transactionType: T
              mobileNumber: '8801777712720'
              message: >-
                Welcome to MiMSMS v2 API. This is a test sms from api/V2/SMS
                POST method
        required: true
      responses:
        '200':
          description: OK
          headers:
            ':status':
              content:
                text/plain:
                  schema:
                    type: string
                  example: '200'
            content-length:
              content:
                text/plain:
                  schema:
                    type: string
                  example: '254'
            content-type:
              content:
                text/plain:
                  schema:
                    type: string
                  example: application/json; charset=utf-8
            server:
              content:
                text/plain:
                  schema:
                    type: string
                  example: Microsoft-IIS/10.0
            x-powered-by:
              content:
                text/plain:
                  schema:
                    type: string
                  example: ASP.NET
            x-powered-by-plesk:
              content:
                text/plain:
                  schema:
                    type: string
                  example: PleskWin
            date:
              content:
                text/plain:
                  schema:
                    type: string
                  example: Wed, 03 Jun 2026 16:41:07 GMT
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/SendSMST'
                  - example:
                      statusCode: '206'
                      status: Failed
                      trxnId: A8XCTVMJPEGDI30
                      responseResult: Invalid Mobile Number
                      numberQty: ''
                      success_Data: null
                      error_Data:
                        - res_Code: '206'
                          error: Invalid Mobile Number
                          failedNumbers: ''
                          errorParm: '8801777712720'
              example:
                statusCode: '206'
                status: Failed
                trxnId: A8XCTVMJPEGDI30
                responseResult: Invalid Mobile Number
                numberQty: ''
                success_Data: null
                error_Data:
                  - res_Code: '206'
                    error: Invalid Mobile Number
                    failedNumbers: ''
                    errorParm: '8801777712720'
      deprecated: false
      security: []
  /V2/Send:
    get:
      tags:
        - Misc
      summary: SendSMS (T)
      description: >-
        Sends a transactional SMS to a single recipient via query string
        parameters using the GET method. Suitable for simple integrations where
        a JSON body is not preferred.


        **Endpoint:** `GET https://api.mimsms.com/api/V2/Send`


        **Query Parameters:**

        | Parameter | Type | Required | Description |

        | --- | --- | --- | --- |

        | `userName` | string | Yes | Your registered account email |

        | `apiKey` | string | Yes | Your MiMSMS API key |

        | `mobileNumber` | string | Yes | Recipient mobile number |

        | `senderName` | string | Yes | Sender ID or number |

        | `transactionType` | string | Yes | Must be `T` for transactional |

        | `message` | string | Yes | SMS content |
      operationId: GetSendSMS(T)
      parameters:
        - name: userName
          in: query
          description: ''
          required: true
          style: form
          explode: true
          schema:
            type: string
            example: demo@mimsms.com
        - name: apiKey
          in: query
          description: ''
          required: true
          style: form
          explode: true
          schema:
            type: string
            example: ALPHABITAGAMMA
        - name: mobileNumber
          in: query
          description: ''
          required: true
          style: form
          explode: true
          schema:
            type: integer
            format: int64
            example: 8801844909020
        - name: senderName
          in: query
          description: ''
          required: true
          style: form
          explode: true
          schema:
            type: integer
            format: int64
            example: 8809612444598
        - name: transactionType
          in: query
          description: ''
          required: true
          style: form
          explode: true
          schema:
            type: string
            example: T
        - name: message
          in: query
          description: ''
          required: true
          style: form
          explode: true
          schema:
            type: string
            example: V2 SendSMS GET API. Welcome to MiMSMS
      responses:
        '200':
          description: OK
          headers:
            ':status':
              content:
                text/plain:
                  schema:
                    type: string
                  example: '200'
            content-type:
              content:
                text/plain:
                  schema:
                    type: string
                  example: application/json; charset=utf-8
            server:
              content:
                text/plain:
                  schema:
                    type: string
                  example: Microsoft-IIS/10.0
            x-powered-by:
              content:
                text/plain:
                  schema:
                    type: string
                  example: ASP.NET
            x-powered-by-plesk:
              content:
                text/plain:
                  schema:
                    type: string
                  example: PleskWin
            date:
              content:
                text/plain:
                  schema:
                    type: string
                  example: Wed, 03 Jun 2026 08:38:08 GMT
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/SendSMST1'
                  - example:
                      statusCode: '200'
                      status: Success
                      responseResult: SMS Send Successfuly
                      trxnId: BS8GLB0SEII1P2Z
                      numberQty: '1'
                      success_Data:
                        - mobNumber: '8801844909020'
                          trackingId: BS8GLB0SEII1P2Z
                          sms_Count: 1
                          lang_Type: Text
                      error_Data: []
              example:
                statusCode: '200'
                status: Success
                responseResult: SMS Send Successfuly
                trxnId: BS8GLB0SEII1P2Z
                numberQty: '1'
                success_Data:
                  - mobNumber: '8801844909020'
                    trackingId: BS8GLB0SEII1P2Z
                    sms_Count: 1
                    lang_Type: Text
                error_Data: []
      deprecated: false
      security: []
  /V2/OneToMany:
    post:
      tags:
        - Misc
      summary: OneToMany
      description: >-
        Broadcasts a single message to multiple recipients in one request using
        a structured `smsData` array. Each entry in the array contains a
        recipient mobile number. Ideal for bulk notifications where all
        recipients receive the same message.


        > **Note:** A maximum of **1000 numbers** can be used in a single
        request.


        **Endpoint:**

        ```

        POST https://api.mimsms.com/api/V2/OneToMany

        Content-Type: application/json

        {
          "apiKey": "YOUR_API_KEY",
          "userName": "your@email.com",
          "senderName": "YourSenderID",
          "message": "Hello from MiMSMS!",
          "smsData": [
            { "mobNumber": "8801XXXXXXXXX" },
            { "mobNumber": "8801YYYYYYYYY" }
          ]
        }

        ```


        **Body Parameters:**

        | Field | Type | Required | Description |

        | --- | --- | --- | --- |

        | Request Header | content-type: application/json | Yes | Header |

        | `apiKey` | string | Yes | Your MiMSMS API key |

        | `userName` | string | Yes | Your registered account email |

        | `senderName` | string | Yes | Sender ID or number |

        | `message` | string | Yes | Message content to broadcast |

        | `smsData` | array | Yes | Array of `{ "mobNumber": "..." }` objects |
      operationId: OneToMany
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/OneToManyRequest'
                - example:
                    apiKey: ALPHABITAGAMMA
                    userName: demo@mimsms.com
                    senderName: '8809612444598'
                    message: V2 OneToMany POST API. Welcome to MiMSMS
                    smsData:
                      - mobNumber: '8801777712720'
                      - mobNumber: '8801844909020'
            example:
              apiKey: ALPHABITAGAMMA
              userName: demo@mimsms.com
              senderName: '8809612444598'
              message: V2 OneToMany POST API. Welcome to MiMSMS
              smsData:
                - mobNumber: '8801777712720'
                - mobNumber: '8801844909020'
        required: true
      responses:
        '200':
          description: OK
          headers:
            ':status':
              content:
                text/plain:
                  schema:
                    type: string
                  example: '200'
            content-length:
              content:
                text/plain:
                  schema:
                    type: string
                  example: '353'
            content-type:
              content:
                text/plain:
                  schema:
                    type: string
                  example: application/json; charset=utf-8
            server:
              content:
                text/plain:
                  schema:
                    type: string
                  example: Microsoft-IIS/10.0
            x-powered-by:
              content:
                text/plain:
                  schema:
                    type: string
                  example: ASP.NET
            x-powered-by-plesk:
              content:
                text/plain:
                  schema:
                    type: string
                  example: PleskWin
            date:
              content:
                text/plain:
                  schema:
                    type: string
                  example: Wed, 03 Jun 2026 08:39:26 GMT
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/OneToMany'
                  - example:
                      statusCode: '200'
                      status: Success
                      trxnId: A44PHQVATYVGFMJ
                      responseResult: Send Successfuly
                      numberQty: '2'
                      success_Data:
                        - mobNumber: '8801777712720'
                          trackingId: TRX6391609436647428600
                          sms_Count: 1
                          lang_Type: Text
                        - mobNumber: '8801844909020'
                          trackingId: TRX6391609436647445311
                          sms_Count: 1
                          lang_Type: Text
                      error_Data: []
              example:
                statusCode: '200'
                status: Success
                trxnId: A44PHQVATYVGFMJ
                responseResult: Send Successfuly
                numberQty: '2'
                success_Data:
                  - mobNumber: '8801777712720'
                    trackingId: TRX6391609436647428600
                    sms_Count: 1
                    lang_Type: Text
                  - mobNumber: '8801844909020'
                    trackingId: TRX6391609436647445311
                    sms_Count: 1
                    lang_Type: Text
                error_Data: []
      deprecated: false
      security: []
    get:
      tags:
        - Misc
      summary: OneToMany
      description: >-
        Broadcasts a single message to multiple recipients via query string
        parameters using the GET method. Recipient numbers are passed as a
        comma-separated list.


        **Endpoint:** `GET https://api.mimsms.com/api/V2/OneToMany`


        **Query Parameters:**

        | Parameter | Type | Required | Description |

        | --- | --- | --- | --- |

        | `userName` | string | Yes | Your registered account email |

        | `apiKey` | string | Yes | Your MiMSMS API key |

        | `mobNumber` | string | Yes | Recipient number(s), comma-separated |

        | `senderName` | string | Yes | Sender ID or number |

        | `transactionType` | string | Yes | `T` (transactional) or `P`
        (promotional) |

        | `message` | string | Yes | Message content to broadcast |
      operationId: GetOneToMany
      parameters:
        - name: userName
          in: query
          description: ''
          required: true
          style: form
          explode: true
          schema:
            type: string
            example: demo@mimsms.com
        - name: apiKey
          in: query
          description: ''
          required: true
          style: form
          explode: true
          schema:
            type: string
            example: ALPHABITAGAMMA
        - name: mobNumber
          in: query
          description: ''
          required: true
          style: form
          explode: true
          schema:
            type: string
            example: 8801844909020,8801713537347
        - name: senderName
          in: query
          description: ''
          required: true
          style: form
          explode: true
          schema:
            type: integer
            format: int64
            example: 8809612444598
        - name: transactionType
          in: query
          description: ''
          required: true
          style: form
          explode: true
          schema:
            type: string
            example: T
        - name: message
          in: query
          description: ''
          required: true
          style: form
          explode: true
          schema:
            type: string
            example: V2 OneToMany GET API. Welcome to MiM SMS OneToMany
      responses:
        '200':
          description: OK
          headers:
            ':status':
              content:
                text/plain:
                  schema:
                    type: string
                  example: '200'
            content-length:
              content:
                text/plain:
                  schema:
                    type: string
                  example: '353'
            content-type:
              content:
                text/plain:
                  schema:
                    type: string
                  example: application/json; charset=utf-8
            server:
              content:
                text/plain:
                  schema:
                    type: string
                  example: Microsoft-IIS/10.0
            x-powered-by:
              content:
                text/plain:
                  schema:
                    type: string
                  example: ASP.NET
            x-powered-by-plesk:
              content:
                text/plain:
                  schema:
                    type: string
                  example: PleskWin
            date:
              content:
                text/plain:
                  schema:
                    type: string
                  example: Wed, 03 Jun 2026 08:40:25 GMT
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/OneToMany'
                  - example:
                      statusCode: '200'
                      status: Success
                      trxnId: HGKOXE9SD20DO2L
                      responseResult: Send Successfuly
                      numberQty: '2'
                      success_Data:
                        - mobNumber: '8801844909020'
                          trackingId: TRX6391609442584957990
                          sms_Count: 1
                          lang_Type: Text
                        - mobNumber: '8801713537347'
                          trackingId: TRX6391609442584959661
                          sms_Count: 1
                          lang_Type: Text
                      error_Data: []
              example:
                statusCode: '200'
                status: Success
                trxnId: HGKOXE9SD20DO2L
                responseResult: Send Successfuly
                numberQty: '2'
                success_Data:
                  - mobNumber: '8801844909020'
                    trackingId: TRX6391609442584957990
                    sms_Count: 1
                    lang_Type: Text
                  - mobNumber: '8801713537347'
                    trackingId: TRX6391609442584959661
                    sms_Count: 1
                    lang_Type: Text
                error_Data: []
      deprecated: false
      security: []
  /V2/DSMS:
    post:
      tags:
        - Misc
      summary: DynamicSMS
      description: >-
        Sends personalised SMS messages to multiple recipients in a single
        request. Each recipient in the `smsData` array receives a unique,
        individually crafted message. Ideal for personalised notifications,
        invoices, or account-specific alerts.


        > **Note:** A maximum of **1000 numbers** can be used in a single
        request.


        **Endpoint:**

        ```

        POST https://api.mimsms.com/api/V2/DSMS

        Content-Type: application/json

        {
          "apiKey": "YOUR_API_KEY",
          "userName": "your@email.com",
          "senderName": "YourSenderID",
          "smsData": [
            { "mobNumber": "8801XXXXXXXXX", "message": "Hello User 1!" },
            { "mobNumber": "8801YYYYYYYYY", "message": "Hello User 2!" }
          ]
        }

        ```


        **Body Parameters:**

        | Field | Type | Required | Description |

        | --- | --- | --- | --- |

        | Request Header | content-type: application/json | Yes | Header |

        | `apiKey` | string | Yes | Your MiMSMS API key |

        | `userName` | string | Yes | Your registered account email |

        | `senderName` | string | Yes | Sender ID or number |

        | `smsData` | array | Yes | Array of `{ "mobNumber": "...", "message":
        "..." }` objects |
      operationId: DynamicSMS
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/DynamicSMSRequest'
                - example:
                    apiKey: ALPHABITAGAMMA
                    userName: demo@mimsms.com
                    senderName: '8809612444598'
                    smsData:
                      - mobNumber: '8801844909020'
                        message: Welcome to MiM SMS Dynamic SMS V2 API SMS 1
                      - mobNumber: '8801713537347'
                        message: Welcome to MiM SMS Dynamic SMS V2 API SMS 2
            example:
              apiKey: ALPHABITAGAMMA
              userName: demo@mimsms.com
              senderName: '8809612444598'
              smsData:
                - mobNumber: '8801844909020'
                  message: Welcome to MiM SMS Dynamic SMS V2 API SMS 1
                - mobNumber: '8801713537347'
                  message: Welcome to MiM SMS Dynamic SMS V2 API SMS 2
        required: true
      responses:
        '200':
          description: OK
          headers:
            ':status':
              content:
                text/plain:
                  schema:
                    type: string
                  example: '200'
            content-length:
              content:
                text/plain:
                  schema:
                    type: string
                  example: '353'
            content-type:
              content:
                text/plain:
                  schema:
                    type: string
                  example: application/json; charset=utf-8
            server:
              content:
                text/plain:
                  schema:
                    type: string
                  example: Microsoft-IIS/10.0
            x-powered-by:
              content:
                text/plain:
                  schema:
                    type: string
                  example: ASP.NET
            x-powered-by-plesk:
              content:
                text/plain:
                  schema:
                    type: string
                  example: PleskWin
            date:
              content:
                text/plain:
                  schema:
                    type: string
                  example: Wed, 03 Jun 2026 11:57:33 GMT
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/DynamicSMS'
                  - example:
                      statusCode: '200'
                      status: Success
                      trxnId: JGDB446KN1N6I14
                      responseResult: Send Successfuly
                      numberQty: '2'
                      success_Data:
                        - mobNumber: '8801844909020'
                          trackingId: TRX6391610625331410870
                          sms_Count: 1
                          lang_Type: Text
                        - mobNumber: '8801713537347'
                          trackingId: TRX6391610625331412491
                          sms_Count: 1
                          lang_Type: Text
                      error_Data: []
              example:
                statusCode: '200'
                status: Success
                trxnId: JGDB446KN1N6I14
                responseResult: Send Successfuly
                numberQty: '2'
                success_Data:
                  - mobNumber: '8801844909020'
                    trackingId: TRX6391610625331410870
                    sms_Count: 1
                    lang_Type: Text
                  - mobNumber: '8801713537347'
                    trackingId: TRX6391610625331412491
                    sms_Count: 1
                    lang_Type: Text
                error_Data: []
      deprecated: false
      security: []
  /IncomingApi/PullSMS:
    get:
      tags:
        - Misc
      summary: PullSMS (Incoming)
      description: >-
        Retrieves inbound SMS messages received on your MiMSMS number. Use this
        endpoint to poll and fetch incoming messages sent by your customers or
        subscribers.


        **Endpoint:** `GET https://api.mimsms.com/api/IncomingApi/PullSMS`


        **Query Parameters:**

        | Parameter | Type | Required | Description |

        | --- | --- | --- | --- |

        | `userName` | string | Yes | Your registered account email |

        | `apiKey` | string | Yes | Your MiMSMS API key |
      operationId: PullSMS(Incoming)
      parameters:
        - name: UserName
          in: query
          description: ''
          required: true
          style: form
          explode: true
          schema:
            type: string
            example: demo@mimsms.com
        - name: Apikey
          in: query
          description: ''
          required: true
          style: form
          explode: true
          schema:
            type: string
            example: ALPHABITAGAMMA
      responses:
        '200':
          description: OK
          headers:
            ':status':
              content:
                text/plain:
                  schema:
                    type: string
                  example: '200'
            content-length:
              content:
                text/plain:
                  schema:
                    type: string
                  example: '226'
            content-type:
              content:
                text/plain:
                  schema:
                    type: string
                  example: application/json; charset=utf-8
            server:
              content:
                text/plain:
                  schema:
                    type: string
                  example: Microsoft-IIS/10.0
            x-powered-by:
              content:
                text/plain:
                  schema:
                    type: string
                  example: ASP.NET
            x-powered-by-plesk:
              content:
                text/plain:
                  schema:
                    type: string
                  example: PleskWin
            date:
              content:
                text/plain:
                  schema:
                    type: string
                  example: Wed, 03 Jun 2026 12:57:32 GMT
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/PullSMSIncoming'
                  - example:
                      statusCode: '200'
                      status: Success
                      messageId: '44582'
                      sender: '8801844909020'
                      receiver: '8809617621065'
                      message_Text: Welcome to test incoming messages
                      message_time: 6/3/2026 9:48:16 AM
                      trxnId: 28VV94LEGE69T4M
              example:
                statusCode: '200'
                status: Success
                messageId: '44582'
                sender: '8801844909020'
                receiver: '8809617621065'
                message_Text: Welcome to test incoming messages
                message_time: 6/3/2026 9:48:16 AM
                trxnId: 28VV94LEGE69T4M
      deprecated: false
      security: []
  /V2/Schedule:
    post:
      tags:
        - Misc
      summary: ScheduleSMS (T)
      description: >-
        Schedules a transactional SMS for future delivery at a specified date
        and time. Recipients and messages are defined in the `smsData` array,
        allowing different messages per recipient. The `scheduleTime` must be in
        ISO 8601 format.


        > **Note:** Schedule time must be set in 30-minute intervals (e.g.
        `15:30:00`, `16:00:00`).


        **Endpoint:**

        ```

        POST https://api.mimsms.com/api/V2/Schedule

        Content-Type: application/json

        {
          "apiKey": "YOUR_API_KEY",
          "userName": "your@email.com",
          "senderName": "YourSenderID",
          "transactionType": "T",
          "scheduleTime": "2026-06-03T15:30:00",
          "smsData": [
            { "mobNumber": "8801XXXXXXXXX", "message": "Hello from MiMSMS!" }
          ]
        }

        ```


        **Body Parameters:**

        | Field | Type | Required | Description |

        | --- | --- | --- | --- |

        | Request Header | content-type: application/json | Yes | Header |

        | `apiKey` | string | Yes | Your MiMSMS API key |

        | `userName` | string | Yes | Your registered account email |

        | `senderName` | string | Yes | Sender ID or number |

        | `campaignName` | string | No | Label for the scheduled campaign |

        | `transactionType` | string | Yes | Must be `"T"` for transactional |

        | `scheduleTime` | string | Yes | Scheduled delivery time in ISO 8601
        format (e.g. `2026-06-03T15:30:00`) |

        | `smsData` | array | Yes | Array of `{ "mobNumber": "...", "message":
        "..." }` objects |
      operationId: ScheduleSMS(T)
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/ScheduleSMSTRequest'
                - example:
                    apiKey: ALPHABITAGAMMA
                    userName: demo@mimsms.com
                    senderName: '8809612444598'
                    campaignName: Test Schedule
                    transactionType: T
                    scheduleTime: '2026-06-03T15:00:00'
                    smsData:
                      - mobNumber: '8801844909020'
                        message: >-
                          Welcome to MiM SMS Schedule SMS V2 API for
                          Transactional
            example:
              apiKey: ALPHABITAGAMMA
              userName: demo@mimsms.com
              senderName: '8809612444598'
              campaignName: Test Schedule
              transactionType: T
              scheduleTime: '2026-06-03T15:00:00'
              smsData:
                - mobNumber: '8801844909020'
                  message: Welcome to MiM SMS Schedule SMS V2 API for Transactional
        required: true
      responses:
        '200':
          description: OK
          headers:
            ':status':
              content:
                text/plain:
                  schema:
                    type: string
                  example: '200'
            content-length:
              content:
                text/plain:
                  schema:
                    type: string
                  example: '252'
            content-type:
              content:
                text/plain:
                  schema:
                    type: string
                  example: application/json; charset=utf-8
            server:
              content:
                text/plain:
                  schema:
                    type: string
                  example: Microsoft-IIS/10.0
            x-powered-by:
              content:
                text/plain:
                  schema:
                    type: string
                  example: ASP.NET
            x-powered-by-plesk:
              content:
                text/plain:
                  schema:
                    type: string
                  example: PleskWin
            date:
              content:
                text/plain:
                  schema:
                    type: string
                  example: Wed, 03 Jun 2026 08:44:01 GMT
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/ScheduleSMST'
                  - example:
                      statusCode: '200'
                      status: Success
                      trxnId: 1AUNY953UY1L6ZB
                      responseResult: Send Successfuly
                      numberQty: '1'
                      success_Data:
                        - mobNumber: '8801844909020'
                          trackingId: TRX6391609464102270240
                          sms_Count: 1
                          lang_Type: Text
                      error_Data: []
              example:
                statusCode: '200'
                status: Success
                trxnId: 1AUNY953UY1L6ZB
                responseResult: Send Successfuly
                numberQty: '1'
                success_Data:
                  - mobNumber: '8801844909020'
                    trackingId: TRX6391609464102270240
                    sms_Count: 1
                    lang_Type: Text
                error_Data: []
      deprecated: false
      security: []
  /V2/DlrApi:
    post:
      tags:
        - Misc
      summary: Report (DLR)
      description: >-
        Fetches the delivery report (DLR) for a previously sent SMS using its
        tracking ID. Use this to confirm whether a message was successfully
        delivered to the recipient's handset.


        > **Note:** Delivery reports are available approximately 5 minutes after
        the SMS has been sent.


        **Endpoint:**

        ```

        POST https://api.mimsms.com/api/V2/DlrApi

        Content-Type: application/json

        {
          "apiKey": "YOUR_API_KEY",
          "userName": "your@email.com",
          "mobileNumber": "8801XXXXXXXXX",
          "trackingId": "TRX6391610625331410870"
        }

        ```


        **Body Parameters:**

        | Field | Type | Required | Description |

        | --- | --- | --- | --- |

        | Request Header | content-type: application/json | Yes | Header |

        | `apiKey` | string | Yes | Your MiMSMS API key |

        | `userName` | string | Yes | Your registered account email |

        | `mobileNumber` | string | Yes | Recipient mobile number |

        | `trackingId` | string | Yes | Transaction tracking ID returned when
        the SMS was sent (e.g. `TRX639159024304712728`) |


        ## Operator Delivery Status (DLR) Code


        | Error Code Name | Error Description | Operator Retry Policy |

        | --- | --- | --- |

        | Delivered | Delivered in Handset | 0 |

        | Absent subscriber for SM | Subscriber handset is not logged onto the
        network due to it being turned off or out of coverage, likely to have
        been unavailable for 12 hours or more | 3 |

        | Undelivered | Rejection due to subscriber handset not having the
        memory capacity to receive the message, likely to have been in state for
        12 hours or more | 0 |

        | Subscriber Busy | MSC is busy handling an existing transaction with
        the handset, the subscriber could be currently receiving an SMS at
        exactly the same time | 3 |

        | Unidentified subscriber | MT number is unknown in the MT network's MSC
        | 0 |

        | Barred subscriber | A Barred Number is a number that cannot receive
        SMS. That could be related to unpaid bills, black listed by the carrier,
        requested by the user | 0 |

        | Illegal subscriber | Sender ID Block by operators for Illegal SMS
        Traffic | 0 |

        | SMS Failed | Sender ID Block by operators for Illegal SMS Traffic | 0
        |

        | System failure | Rejection due to SS7 protocol or network failure | 3
        |

        | SMS Failed | Network failure in SMSC Link | 3 |

        | SMSC Timeout-abort | SMSC timeout | 3 |
      operationId: Report(DLR)
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/ReportDLRRequest'
                - example:
                    apiKey: ALPHABITAGAMMA
                    userName: demo@mimsms.com
                    mobileNumber: '8801844909020'
                    trackingId: TRX6391610625331410870
            example:
              apiKey: ALPHABITAGAMMA
              userName: demo@mimsms.com
              mobileNumber: '8801844909020'
              trackingId: TRX6391610625331410870
        required: true
      responses:
        '200':
          description: OK
          headers:
            ':status':
              content:
                text/plain:
                  schema:
                    type: string
                  example: '200'
            content-length:
              content:
                text/plain:
                  schema:
                    type: string
                  example: '139'
            content-type:
              content:
                text/plain:
                  schema:
                    type: string
                  example: application/json; charset=utf-8
            server:
              content:
                text/plain:
                  schema:
                    type: string
                  example: Microsoft-IIS/10.0
            x-powered-by:
              content:
                text/plain:
                  schema:
                    type: string
                  example: ASP.NET
            x-powered-by-plesk:
              content:
                text/plain:
                  schema:
                    type: string
                  example: PleskWin
            date:
              content:
                text/plain:
                  schema:
                    type: string
                  example: Wed, 03 Jun 2026 08:45:06 GMT
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/ReportDLR'
                  - example:
                      statusCode: '200'
                      status: Ok
                      trackingId: BGTDT4REUMZXFWV
                      dlrCode: '0'
                      operatorStatus: DELIVERED
                      mobileNumber: '8801777712720'
              example:
                statusCode: '200'
                status: Ok
                trackingId: BGTDT4REUMZXFWV
                dlrCode: '0'
                operatorStatus: DELIVERED
                mobileNumber: '8801777712720'
      deprecated: false
      security: []
  /V2/BalanceCheck:
    post:
      tags:
        - Misc
      summary: Balance Check
      description: >-
        Checks the remaining SMS credit balance on your MiMSMS account via the
        POST method. Returns the current available balance.


        **Endpoint:**

        ```

        POST https://api.mimsms.com/api/V2/BalanceCheck

        Content-Type: application/json

        {
          "apiKey": "YOUR_API_KEY",
          "userName": "your@email.com"
        }

        ```


        **Body Parameters:**

        | Field | Type | Required | Description |

        | --- | --- | --- | --- |

        | Request Header | content-type: application/json | Yes | Header |

        | `userName` | string | Yes | Your registered account email |

        | `apiKey` | string | Yes | Your MiMSMS API key |
      operationId: BalanceCheck
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/BalanceCheckRequest'
                - example:
                    userName: demo@mimsms.com
                    apiKey: ALPHABITAGAMMA
            example:
              userName: demo@mimsms.com
              apiKey: ALPHABITAGAMMA
        required: true
      responses:
        '200':
          description: OK
          headers:
            ':status':
              content:
                text/plain:
                  schema:
                    type: string
                  example: '200'
            content-length:
              content:
                text/plain:
                  schema:
                    type: string
                  example: '82'
            content-type:
              content:
                text/plain:
                  schema:
                    type: string
                  example: application/json; charset=utf-8
            server:
              content:
                text/plain:
                  schema:
                    type: string
                  example: Microsoft-IIS/10.0
            x-powered-by:
              content:
                text/plain:
                  schema:
                    type: string
                  example: ASP.NET
            x-powered-by-plesk:
              content:
                text/plain:
                  schema:
                    type: string
                  example: PleskWin
            date:
              content:
                text/plain:
                  schema:
                    type: string
                  example: Wed, 03 Jun 2026 08:46:27 GMT
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/BalanceCheck'
                  - example:
                      statusCode: '200'
                      status: Ok
                      trxnId: P6BKLTRMA8ZB75T
                      responseResult: '1'
              example:
                statusCode: '200'
                status: Ok
                trxnId: P6BKLTRMA8ZB75T
                responseResult: '1'
      deprecated: false
      security: []
    get:
      tags:
        - Misc
      summary: BalanceCheck
      description: >-
        Checks the remaining SMS credit balance on your MiMSMS account via query
        string parameters using the GET method.


        **Endpoint:** `GET https://api.mimsms.com/api/V2/BalanceCheck`


        **Query Parameters:**

        | Parameter | Type | Required | Description |

        | --- | --- | --- | --- |

        | `userName` | string | Yes | Your registered account email |

        | `apiKey` | string | Yes | Your MiMSMS API key |
      operationId: GetBalanceCheck
      parameters:
        - name: userName
          in: query
          description: ''
          required: true
          style: form
          explode: true
          schema:
            type: string
            example: demo@mimsms.com
        - name: apiKey
          in: query
          description: ''
          required: true
          style: form
          explode: true
          schema:
            type: string
            example: ALPHABITAGAMMA
      responses:
        '200':
          description: OK
          headers:
            ':status':
              content:
                text/plain:
                  schema:
                    type: string
                  example: '200'
            content-type:
              content:
                text/plain:
                  schema:
                    type: string
                  example: application/json; charset=utf-8
            server:
              content:
                text/plain:
                  schema:
                    type: string
                  example: Microsoft-IIS/10.0
            x-powered-by:
              content:
                text/plain:
                  schema:
                    type: string
                  example: ASP.NET
            x-powered-by-plesk:
              content:
                text/plain:
                  schema:
                    type: string
                  example: PleskWin
            date:
              content:
                text/plain:
                  schema:
                    type: string
                  example: Wed, 03 Jun 2026 08:47:17 GMT
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/BalanceCheck1'
                  - example:
                      statusCode: '200'
                      status: Ok
                      responseResult: '51'
              example:
                statusCode: '200'
                status: Ok
                responseResult: '51'
      deprecated: false
      security: []
components:
  schemas:
    SendSMSTRequest:
      title: SendSMSTRequest
      required:
        - apiKey
        - userName
        - campaignName
        - senderName
        - transactionType
        - mobileNumber
        - message
      type: object
      properties:
        apiKey:
          type: string
        userName:
          type: string
        campaignName:
          type: string
        senderName:
          type: string
        transactionType:
          type: string
        mobileNumber:
          type: string
        message:
          type: string
      example:
        apiKey: ALPHABITAGAMMA
        userName: demo@mimsms.com
        campaignName: 'null'
        senderName: '8809612444598'
        transactionType: T
        mobileNumber: '8801777712720'
        message: >-
          Welcome to MiMSMS v2 API. This is a test sms from api/V2/SMS POST
          method
    SendSMST:
      title: SendSMST
      required:
        - statusCode
        - status
        - trxnId
        - responseResult
        - numberQty
        - success_Data
        - error_Data
      type: object
      properties:
        statusCode:
          type: string
        status:
          type: string
        trxnId:
          type: string
        responseResult:
          type: string
        numberQty:
          type: string
        success_Data:
          type: string
          nullable: true
        error_Data:
          type: array
          items:
            $ref: '#/components/schemas/ErrorDatum'
          description: ''
      example:
        statusCode: '206'
        status: Failed
        trxnId: A8XCTVMJPEGDI30
        responseResult: Invalid Mobile Number
        numberQty: ''
        success_Data: null
        error_Data:
          - res_Code: '206'
            error: Invalid Mobile Number
            failedNumbers: ''
            errorParm: '8801777712720'
    ErrorDatum:
      title: ErrorDatum
      required:
        - res_Code
        - error
        - failedNumbers
        - errorParm
      type: object
      properties:
        res_Code:
          type: string
        error:
          type: string
        failedNumbers:
          type: string
        errorParm:
          type: string
      example:
        res_Code: '206'
        error: Invalid Mobile Number
        failedNumbers: ''
        errorParm: '8801777712720'
    SendSMST1:
      title: SendSMST1
      required:
        - statusCode
        - status
        - responseResult
        - trxnId
        - numberQty
        - success_Data
        - error_Data
      type: object
      properties:
        statusCode:
          type: string
        status:
          type: string
        responseResult:
          type: string
        trxnId:
          type: string
        numberQty:
          type: string
        success_Data:
          type: array
          items:
            $ref: '#/components/schemas/SuccessDatum'
          description: ''
        error_Data:
          type: array
          items:
            type: string
          description: ''
      example:
        statusCode: '200'
        status: Success
        responseResult: SMS Send Successfuly
        trxnId: BS8GLB0SEII1P2Z
        numberQty: '1'
        success_Data:
          - mobNumber: '8801844909020'
            trackingId: BS8GLB0SEII1P2Z
            sms_Count: 1
            lang_Type: Text
        error_Data: []
    SuccessDatum:
      title: SuccessDatum
      required:
        - mobNumber
        - trackingId
        - sms_Count
        - lang_Type
      type: object
      properties:
        mobNumber:
          type: string
        trackingId:
          type: string
        sms_Count:
          type: integer
          format: int32
        lang_Type:
          type: string
      example:
        mobNumber: '8801844909020'
        trackingId: BS8GLB0SEII1P2Z
        sms_Count: 1
        lang_Type: Text
    
    
    
    OneToManyRequest:
      title: OneToManyRequest
      required:
        - apiKey
        - userName
        - senderName
        - message
        - smsData
      type: object
      properties:
        apiKey:
          type: string
        userName:
          type: string
        senderName:
          type: string
        message:
          type: string
        smsData:
          type: array
          items:
            $ref: '#/components/schemas/SmsDatum'
          description: ''
      example:
        apiKey: ALPHABITAGAMMA
        userName: demo@mimsms.com
        senderName: '8809612444598'
        message: V2 OneToMany POST API. Welcome to MiMSMS
        smsData:
          - mobNumber: '8801777712720'
          - mobNumber: '8801844909020'
    SmsDatum:
      title: SmsDatum
      required:
        - mobNumber
      type: object
      properties:
        mobNumber:
          type: string
      example:
        mobNumber: '8801777712720'
    OneToMany:
      title: OneToMany
      required:
        - statusCode
        - status
        - trxnId
        - responseResult
        - numberQty
        - success_Data
        - error_Data
      type: object
      properties:
        statusCode:
          type: string
        status:
          type: string
        trxnId:
          type: string
        responseResult:
          type: string
        numberQty:
          type: string
        success_Data:
          type: array
          items:
            $ref: '#/components/schemas/SuccessDatum'
          description: ''
        error_Data:
          type: array
          items:
            type: string
          description: ''
      example:
        statusCode: '200'
        status: Success
        trxnId: A44PHQVATYVGFMJ
        responseResult: Send Successfuly
        numberQty: '2'
        success_Data:
          - mobNumber: '8801777712720'
            trackingId: TRX6391609436647428600
            sms_Count: 1
            lang_Type: Text
          - mobNumber: '8801844909020'
            trackingId: TRX6391609436647445311
            sms_Count: 1
            lang_Type: Text
        error_Data: []
    DynamicSMSRequest:
      title: DynamicSMSRequest
      required:
        - apiKey
        - userName
        - senderName
        - smsData
      type: object
      properties:
        apiKey:
          type: string
        userName:
          type: string
        senderName:
          type: string
        smsData:
          type: array
          items:
            $ref: '#/components/schemas/SmsDatum1'
          description: ''
      example:
        apiKey: ALPHABITAGAMMA
        userName: demo@mimsms.com
        senderName: '8809612444598'
        smsData:
          - mobNumber: '8801844909020'
            message: Welcome to MiM SMS Dynamic SMS V2 API SMS 1
          - mobNumber: '8801713537347'
            message: Welcome to MiM SMS Dynamic SMS V2 API SMS 2
    SmsDatum1:
      title: SmsDatum1
      required:
        - mobNumber
        - message
      type: object
      properties:
        mobNumber:
          type: string
        message:
          type: string
      example:
        mobNumber: '8801844909020'
        message: Welcome to MiM SMS Dynamic SMS V2 API SMS 1
    DynamicSMS:
      title: DynamicSMS
      required:
        - statusCode
        - status
        - trxnId
        - responseResult
        - numberQty
        - success_Data
        - error_Data
      type: object
      properties:
        statusCode:
          type: string
        status:
          type: string
        trxnId:
          type: string
        responseResult:
          type: string
        numberQty:
          type: string
        success_Data:
          type: array
          items:
            $ref: '#/components/schemas/SuccessDatum'
          description: ''
        error_Data:
          type: array
          items:
            type: string
          description: ''
      example:
        statusCode: '200'
        status: Success
        trxnId: JGDB446KN1N6I14
        responseResult: Send Successfuly
        numberQty: '2'
        success_Data:
          - mobNumber: '8801844909020'
            trackingId: TRX6391610625331410870
            sms_Count: 1
            lang_Type: Text
          - mobNumber: '8801713537347'
            trackingId: TRX6391610625331412491
            sms_Count: 1
            lang_Type: Text
        error_Data: []
    PullSMSIncoming:
      title: PullSMSIncoming
      required:
        - statusCode
        - status
        - messageId
        - sender
        - receiver
        - message_Text
        - message_time
        - trxnId
      type: object
      properties:
        statusCode:
          type: string
        status:
          type: string
        messageId:
          type: string
        sender:
          type: string
        receiver:
          type: string
        message_Text:
          type: string
        message_time:
          type: string
        trxnId:
          type: string
      example:
        statusCode: '200'
        status: Success
        messageId: '44582'
        sender: '8801844909020'
        receiver: '8809617621065'
        message_Text: Welcome to test incoming messages
        message_time: 6/3/2026 9:48:16 AM
        trxnId: 28VV94LEGE69T4M
    ScheduleSMSTRequest:
      title: ScheduleSMSTRequest
      required:
        - apiKey
        - userName
        - senderName
        - campaignName
        - transactionType
        - scheduleTime
        - smsData
      type: object
      properties:
        apiKey:
          type: string
        userName:
          type: string
        senderName:
          type: string
        campaignName:
          type: string
        transactionType:
          type: string
        scheduleTime:
          type: string
        smsData:
          type: array
          items:
            $ref: '#/components/schemas/SmsDatum1'
          description: ''
      example:
        apiKey: ALPHABITAGAMMA
        userName: demo@mimsms.com
        senderName: '8809612444598'
        campaignName: Test Schedule
        transactionType: T
        scheduleTime: '2026-06-03T15:00:00'
        smsData:
          - mobNumber: '8801844909020'
            message: Welcome to MiM SMS Schedule SMS V2 API for Transactional
    ScheduleSMST:
      title: ScheduleSMST
      required:
        - statusCode
        - status
        - trxnId
        - responseResult
        - numberQty
        - success_Data
        - error_Data
      type: object
      properties:
        statusCode:
          type: string
        status:
          type: string
        trxnId:
          type: string
        responseResult:
          type: string
        numberQty:
          type: string
        success_Data:
          type: array
          items:
            $ref: '#/components/schemas/SuccessDatum'
          description: ''
        error_Data:
          type: array
          items:
            type: string
          description: ''
      example:
        statusCode: '200'
        status: Success
        trxnId: 1AUNY953UY1L6ZB
        responseResult: Send Successfuly
        numberQty: '1'
        success_Data:
          - mobNumber: '8801844909020'
            trackingId: TRX6391609464102270240
            sms_Count: 1
            lang_Type: Text
        error_Data: []
    ReportDLRRequest:
      title: ReportDLRRequest
      required:
        - apiKey
        - userName
        - mobileNumber
        - trackingId
      type: object
      properties:
        apiKey:
          type: string
        userName:
          type: string
        mobileNumber:
          type: string
        trackingId:
          type: string
      example:
        apiKey: ALPHABITAGAMMA
        userName: demo@mimsms.com
        mobileNumber: '8801844909020'
        trackingId: TRX6391610625331410870
    ReportDLR:
      title: ReportDLR
      required:
        - statusCode
        - status
        - trackingId
        - dlrCode
        - operatorStatus
        - mobileNumber
      type: object
      properties:
        statusCode:
          type: string
        status:
          type: string
        trackingId:
          type: string
        dlrCode:
          type: string
        operatorStatus:
          type: string
        mobileNumber:
          type: string
      example:
        statusCode: '200'
        status: Ok
        trackingId: BGTDT4REUMZXFWV
        dlrCode: '0'
        operatorStatus: DELIVERED
        mobileNumber: '8801777712720'
    BalanceCheckRequest:
      title: BalanceCheckRequest
      required:
        - userName
        - apiKey
      type: object
      properties:
        userName:
          type: string
        apiKey:
          type: string
      example:
        userName: demo@mimsms.com
        apiKey: ALPHABITAGAMMA
    BalanceCheck:
      title: BalanceCheck
      required:
        - statusCode
        - status
        - trxnId
        - responseResult
      type: object
      properties:
        statusCode:
          type: string
        status:
          type: string
        trxnId:
          type: string
        responseResult:
          type: string
      example:
        statusCode: '200'
        status: Ok
        trxnId: P6BKLTRMA8ZB75T
        responseResult: '1'
    BalanceCheck1:
      title: BalanceCheck1
      required:
        - statusCode
        - status
        - responseResult
      type: object
      properties:
        statusCode:
          type: string
        status:
          type: string
        responseResult:
          type: string
      example:
        statusCode: '200'
        status: Ok
        responseResult: '51'
tags:
  - name: Misc
    description: ''
