openapi: 3.0.1
info:
  version: ''
  title: Airtel IoT
  contact:
    email: m2m.support@airtel.com
  description: "# Overview\n ## Introduction\n <div class=\"iot-intro\">Airtel IoT Developer Portal showcases\
    \ APIs that allows you\n to access data of the CMP Billable account from any external application.\
    \ Using the APIs, you\n can perform almost all the operations that you perform through the CMP portal\
    \ including Managing\n SIM Inventory, Changing SIM state (Test Mode, Activate, Change Plan, Safe custody),\
    \ Monitoring\n data usage, Performing bulk operations and so on.</div>\n                     \n In\
    \ this section, you’ll learn Airtel IoT Developer Portal Dashboard.\n\n   ## API Credentials\n   This\
    \ section provide static details of Customer which will be used for accessing APIs.\n\n \n   <div\
    \ class=\"bullet-list\">  Key Authentication   </div>\n    <div class=\"bullet-list-content\" > A\
    \ Unique Identification Secret Key per Customer, must be passed in Headers while calling API and will\
    \ be used for Authentication purpose.</div>\n   \n\n   <div class=\"bullet-list\" > Customer Information\
    \  </div>\n  <div class=\"bullet-list-content\" > Customer Information will show details of Customer\
    \ Developer Account. This shows Customer Id, Customer Account No, Email Id, iv-user, Name, Developer\
    \ Created By and Developer Created On. Some of these information will be used in accessing APIs.</div>\n\
    \n\n   <div class=\"bullet-list\" > OAuth2.0  </div>\n  <div class=\"bullet-list-content\" > Customer\
    \ has to use unique Client Id and Client Secret mentioned in OAuth Credential table for Authentication\
    \ of APIs.</div>\n  \n\n ## Usage Information\n This section provide Customer API usages details.\
    \ This can show details based on different timestamps:       \n   \n ## Activating your first SIM\
    \ \n\n <div id=\"auth-2.0-page\" ><section class=\"kong-doc\"><h2>Generating OAuth 2.0 token</h2>\
    \ <p>\n       The OAuth 2.0 authorization code grant will be used by customer to gain access to protected\n\
    \       resources, such as APIs.\n       This set of APIs shall allow user to generate Access Token\
    \ and refresh Access Token to perform\n       any action on CMP via the API gateway.\n     </p> <h2><a\
    \ id=\"Request_an_Access_Token_0\"></a>Request an Access Token</h2> <p>To get a token by using the\
    \ client Id &amp; Client Secret, send a POST request to the <code>/developer/generate/authtoken</code></p>\
    \ <h1><a id=\"auth-request\"></a>Sample Request</h1> <pre><code>curl -X POST \"https://openapi.airtel.in/iot/api/developer/generate/authtoken\"\
    \n         -H \"accept: application/json\"\n         -H \"apikey: XXXXXXXXXXXXXXXXXXXXXX\"\n     \
    \    -H \"iv-user: XXXXXXXXXXXXXXXXXXXXXX\"\n         -H \"Content-Type: application/x-www-form-urlencoded\"\
    \n         -d \"client_id=XXXXXXXXXXXXXXXXXXXXXX&amp;client_secret=XXXXXXXXXXXXXXXXXXXXXX\"\n    \
    \   </code></pre> <h1><a id=\"auth-response\"></a>Sample Response</h1> <pre><code>{\n           \"\
    data\": {\n             \"refresh_token\": \"XXXXXXXXXXXXXXXXXXXXXX\",\n             \"token_type\"\
    : \"bearer\",\n             \"access_token\": \"XXXXXXXXXXXXXXXXXXXXXX\",\n             \"expires_in\"\
    : 1800\n           }\n         }\n         </code></pre> &nbsp; &nbsp; &nbsp; &nbsp;You can generate\
    \ same request response from Airtel IoT Developer Portal. To do so :\n           <ul><li>Navigate\
    \ to <em>Documentation</em> → <em>Account Authorization</em> → <em>Generate Access Token</em> → <em>Test\
    \ Endpoint</em></li> <li>Put values of <strong>apikey</strong>, <strong>client_id</strong>, <strong>client_secret</strong>,\
    \ <strong>iv-user</strong> in mentioned text fields from Dashboard</li> <li><strong>Make API Call</strong>.</li></ul></section></div>\n\
    \n <div id=\"sim-inventory-page\" ><section class=\"kong-doc\"><h1>Fetch SIM Inventory</h1> <p>\n\
    \       This API shall allow user to fetch the details of SIMs on that Customer\n       Account. It\
    \ can fetch the details of one or more SIMs at a time.\n     </p> <h1><a id=\"sim-inventory-request\"\
    ></a>Sample Request</h1> \n     <pre><code>curl -X GET \"https://openapi.airtel.in/iot/api/customer/details/basket/0/sims\n\
    \       ?pageNo=1&amp;pageSize=1&amp;simStatus=INITIAL\"\n       -H \"accept: application/json\"\n\
    \       -H \"Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXX\"\n       -H \"apikey: XXXXXXXXXXXXXXXXXXXXXX\"\
    \n       -H \"customer-id: XXXX\"\n       -H \"iv-user: XXXXXXXXXXXXXXXXXXXXXX\"\n     </code></pre>\
    \ <h1><a id=\"sim-inventory-response\"></a>Sample Response</h1> <pre><code>{\n       \"data\":\n \
    \      {\n         \"sims\": [\n         {\n           \"simId\": \"5165173\",\n           \"mobileNo\"\
    : \"51967694502\",\n           \"simNo\": \"9999000000000000000\",\n           \"imsi\": \"30811010404043400\"\
    ,\n           \"lsi\": \" \",\n           \"status\": \"INITIAL\",\n           \"isPaired\": \"0\"\
    ,\n           \"isPrepaidSim\": \"0\",\n           \"circleName\": \"DELHI\",\n           \"planCode\"\
    : \"M2M_PLN_0324\",\n           \"planName\": \"VTS 49 special plan(without voice with sms)\",\n \
    \          \"description\": \"VTS 49 special plan(without voice with sms)\",\n           \"dataType\"\
    : \"2G\",\n           \"dataUnits\": \"250\",\n           \"planType\": \"0\"\n         }\n      \
    \   ],\n         \"total\": \"10000\"\n       }\n     }\n     </code></pre> \n        &nbsp; &nbsp;\
    \ &nbsp; &nbsp;You can generate same request response from Airtel IoT Developer Portal. To do so :\n\
    \       <ul><li>Navigate to <em>Documentation</em> → <em>Manage SIMs</em> → <em>Fetch SIMs</em> →\
    \ <em>Test Endpoint</em></li> <li>Replace Bearer Token from access token generated from\n        \
    \   <a id=\"go-to-auth\" class=\"nav-link\">Generating OAuth 2.0 token</a></li><li>Put values of <strong>apikey</strong>,\
    \ <strong>iv-user</strong> &amp; <strong>customer-id</strong> in mentioned text fields from Dashboard.</li>\
    \ <li>Select <strong>simStatus</strong> as <strong>INITIAL</strong></li> <li><strong>Make API Call</strong>.</li></ul></section></div>\n\
    \ \n <div ><section class=\"kong-doc\"><h1 id=\"fetch-plans-page\">Fetch Plans</h1> <p>\n       This\
    \ API shall allow user to fetch the details of Plans that are associated with the Customer\n     \
    \  Account. It returns the Plan code, plan name, plan description and whether it is a test plan or\n\
    \       actual plan as defined on the account.\n     </p> <h1 id=\"fetchPlans-request\"> Sample Request</h1><h1><pre><code>curl\
    \ -X GET \"https://openapi.airtel.in/iot/api/customer/details/plans\"\n         -H \"accept: application/json\"\
    \n         -H \"Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXX\"\n         -H \"apikey: XXXXXXXXXXXXXXXXXXXXXX\"\
    \n         -H \"customer-id: XXXX\"\n         -H \"iv-user: XXXXXXXXXXXXXXXXXXXXXX\"\n       </code></pre></h1><h1\
    \ id=\"fetchPlans-response\">Sample Response</h1> <pre><code>{\n         \"data\": [\n         {\n\
    \           \"planCode\": \"M2M_PLN_0001\",\n           \"planName\": \"M2M-2G-1GB PLAN\",\n     \
    \      \"planDescription\": \"M2M-2G-1GB PLAN\",\n           \"testPlan\": false\n         },\n  \
    \       {\n           \"planCode\": \"M2M_PLN_0003\",\n           \"planName\": \"M2M 3G - 100 MB\
    \ PLAN\",\n           \"planDescription\": \"M2M 3G - 100 MB PLAN\",\n           \"testPlan\": true\n\
    \         }\n         ]\n       }\n     </code></pre> &nbsp; &nbsp; &nbsp; &nbsp;You can generate\
    \ same request response from Airtel IoT Developer Portal. To do so :\n         <ul><li>Navigate to\
    \ <em>Documentation</em> → <em>Account Details</em> → <em>Fetch Customer Plans</em> → <em>Test Endpoint</em></li>\
    \ <li>Replace Bearer Token from access token generated from\n             <a id=\"go-to-auth\" class=\"\
    nav-link\">Generating OAuth 2.0 token</a></li> <li>Put values of <strong>apikey</strong>, <strong>iv-user</strong>\
    \ &amp; <strong>customer-id</strong> in mentioned text fields from Dashboard.</li> <li><strong>Make\
    \ API Call</strong>.</li></ul></section></div>\n       <div id=\"activate-sim-page\" ><section class=\"\
    kong-doc\"><h1>Perform Activation</h1> <p>\n       This API shall allow user to change the state of\
    \ SIM from Available (Initial to Activate) to\n       Active with Plan that is associated with the\
    \ Billable account. It requires inputs as mobile\n       number and plan code.\n     </p> <h1 id=\"\
    activate-sim-request\"> Sample Request</h1><h1><pre><code>curl -X POST \"https://openapi.airtel.in/iot/api/om/job/sim/activate\"\
    \n         -H \"accept: application/json\"\n         -H \"Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXX\"\
    \n         -H \"apikey: XXXXXXXXXXXXXXXXXXXXXXXXX\"\n         -H \"customer-id: XXXX\"\n         -H\
    \ \"iv-user: XXXXXXXXXXXXXXXXXXXXXXXXX\"\n         -H \"Content-Type: application/json\"\n       \
    \  -d \"{ \\\"simDOList\\\": [ { \\\"mobileNO\\\": \\\"51967694502\\\",\n         \\\"planDO\\\":\
    \ { \\\"planCode\\\": \\\"M2M_PLN_0001\\\" } } ]}\"\n       </code></pre></h1><h1><a id=\"activate-sim-response\"\
    ></a>Sample Response</h1> <pre><code>{\n       \"data\": {\n           \"jobId\": 795405,\n      \
    \     \"jobType\": \"ACTIVATE_SIM\",\n           \"orderCount\": 0,\n           \"successCount\":\
    \ 0,\n           \"failureCount\": 0,\n           \"inProgressCount\": 0,\n           \"rejectedCount\"\
    : 0,\n           \"orderInitiateDate\": \"25-04-2019 03:35:40 PM\",\n           \"statusMessage\"\
    : \"Your request is in progress\"\n       }\n   }\n   </code></pre> &nbsp; &nbsp; &nbsp; &nbsp;You\
    \ can generate same request response from Airtel IoT Developer Portal. To do so :\n   <ul><li>Navigate\
    \ to <em>Documentation</em> → <em>New Orders</em> → <em>Activate Sim</em> → <em>Activate Sim</em>\
    \ → <em>Test Endpoint</em></li> <li>Replace Bearer Token from access token generated from\n     <a\
    \ id=\"go-to-auth\" class=\"nav-link\">Generating OAuth 2.0 token</a></li> <li>Put values of <strong>apikey</strong>,\
    \ <strong>iv-user</strong> &amp; <strong>customer-id</strong> in mentioned text fields from Dashboard.</li>\
    \ <li>Put mobileNo in body fetched from response of API\n     <a id=\"go-to-sim-inventory\" class=\"\
    nav-link\">Fetch SIM Inventory</a></li> <li>Put planCode in body fetched from response of API\n  \
    \   <a id=\"go-to-fetch-plans\" class=\"nav-link\"> Fetch Plans </a></li> <li><strong>Make API Call</strong>.</li></ul><hr>\
    \ <p><strong>NOTE</strong><br>\n   The JobId in the response is important to track the status of activation\
    \ order. The details of JobId can be fetched from Fetch Jobs API. There shall be Order ID(s) within\
    \ a JobId to view status of specific Order(s) in a JobId.</p> <hr></section></div>\n"
security: []
servers:
- url: https://m2m.airteliot.co.in/iot/api/
tags:
- name: Account Authorization
  description: This set of APIs shall allow user to generate Access Token and refresh Access Token to
    perform any action on CMP via the API gateway.
- name: SIM LifeCycle
  description: This API shall allow user to change the state of SIMs.
- name: SIM LifeCycle Bulk
  description: This API shall allow user to change the state of SIMs.
- name: Job Status
  description: This API will allow user to fetch Job details for any operations being performed in that
    Billable account.
- name: Device & Session Information
  description: To data usage on a specific SIM, this API will allow user to get total data allocation,
    available data, used data, device information & session information for the SIM.
- name: Whitelisting
  description: This set of APIs to manage whitelisting numbers on Airtel IoT portal in Batch
- name: KYC Manager
  description: This set of APIs to manage SIM KYC details.
- name: Messaging Centre
  description: These set of APIs allow lifecycle management of the Messaging Centre functionality
- name: Account Details
  description: This set of APIs fetch various details about a Billable Customer Account including Customer
    Profile, Plan details, User details and so on.
- name: Inventory Management
  description: This set of APIs fetch various details about Sim details, Basket details and so on in the
    account.
x-tagGroups:
- name: Manage Customer APIs
  tags:
  - Account Authorization
  - Account Details
  - Inventory Management
- name: New Orders APIs
  tags:
  - SIM LifeCycle
- name: Bulk Orders APIs
  tags:
  - SIM LifeCycle Bulk
- name: Jobs APIs
  tags:
  - Job Status
- name: Device Details APIs
  tags:
  - Device & Session Information
- name: Whitelisting APIs
  tags:
  - Whitelisting
- name: KYC APIs
  tags:
  - KYC Manager
- name: Messaging Centre APIs
  tags:
  - Messaging Centre
paths:
  /auth/v2/generate/authtoken:
    post:
      tags:
      - Account Authorization
      summary: Generate Access Token
      description: This API shall allow user to generate Access Token to be used while doing any operations
        on the portal via APIs. **As per our recent upgrade, a new attribute 'refresh_expires_in' has
        been added to the response field which would display the time (in seconds) after which the refresh
        token would expire.**
      operationId: generateAccessTokenUsingPOST
      parameters:
      - name: apikey
        in: header
        description: apikey
        required: true
        schema:
          type: string
      - name: iv-user
        in: header
        description: Developer Account User ID
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              required:
              - client_id
              - client_secret
              properties:
                client_id:
                  type: string
                  description: Unique ID to Authorize Customer (shared during On-Boarding process)
                client_secret:
                  type: string
                  description: Developer Account Secret Key (shared during On-Boarding process) that shall
                    be used to generate Token
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: object
                  properties: {}
        '201':
          description: Resource Created Successfully
          content: {}
        '400':
          description: Request Message is not correct
          content: {}
        '500':
          description: Internal Server Error.
          content: {}
      deprecated: false
  /auth/v2/refresh/authtoken:
    post:
      tags:
      - Account Authorization
      summary: Refresh Access Token
      description: This API shall allow user to refresh Access Token to be used while doing any operations
        on the portal via APIs.
      operationId: refreshAccessTokenUsingPOST
      parameters:
      - name: apikey
        in: header
        description: apikey
        required: true
        schema:
          type: string
      - name: iv-user
        in: header
        description: Developer Account User ID
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              required:
              - refresh_token
              properties:
                refresh_token:
                  type: string
                  description: Token used to refresh access_token
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: object
                  properties: {}
        '201':
          description: Resource Created Successfully
          content: {}
        '400':
          description: Request Message is not correct
          content: {}
        '500':
          description: Internal Server Error.
          content: {}
      deprecated: false
  /job/activate/test/sims:
    post:
      tags:
      - 'SIM LifeCycle '
      summary: Activate SIM in Test Mode
      description: This API shall allow user to change the state of SIM from Available (Ready to Activate)
        to Activate in Test Mode. It requires inputs as mobile number and plan code.
      operationId: activateTestSimsUsingPOST
      parameters:
      - name: Authorization
        in: header
        description: Authorization Header (Value must be like Bearer <Developer Access Token>)
        required: true
        schema:
          type: string
          default: Bearer XXXXXXXXXXXXXX
      - name: apikey
        in: header
        description: Developer API Key
        required: true
        schema:
          type: string
      - name: customer-id
        in: header
        description: 'Unique ID to identify Customer (shared during On-Boarding process) '
        required: true
        schema:
          type: integer
          format: int64
      - name: iv-user
        in: header
        description: Developer Account User ID
        required: true
        schema:
          type: string
      requestBody:
        description: generateOrder
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerateOrderWithPlan'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobVO'
        '201':
          description: Resource Created Successfully
          content: {}
        '400':
          description: Request Message is not correct
          content: {}
        '500':
          description: Internal Server Error.
          content: {}
      deprecated: false
      x-codegen-request-body-name: generateOrder
  /job/activate/sim/from/test:
    post:
      tags:
      - SIM LifeCycle
      summary: Activate SIM from Test Mode
      description: This API shall allow user to change the Bill Plan on a particular SIM from test plan
        to the commercial plan associated with that Billable account. It requires inputs as mobile number
        and target plan code.
      operationId: activateSimFromTestUsingPOST
      parameters:
      - name: Authorization
        in: header
        description: Authorization Header (Value must be like Bearer <Developer Access Token>)
        required: true
        schema:
          type: string
          default: Bearer XXXXXXXXXXXXXX
      - name: apikey
        in: header
        description: Developer API Key
        required: true
        schema:
          type: string
      - name: customer-id
        in: header
        description: 'Unique ID to identify Customer (shared during On-Boarding process) '
        required: true
        schema:
          type: integer
          format: int64
      - name: iv-user
        in: header
        description: Developer Account User ID
        required: true
        schema:
          type: string
      requestBody:
        description: changePlanOrder
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerateOrderWithPlan'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobVO'
        '201':
          description: Resource Created Successfully
          content: {}
        '400':
          description: Request Message is not correct
          content: {}
        '500':
          description: Internal Server Error.
          content: {}
      deprecated: false
      x-codegen-request-body-name: changePlanOrder
  /job/change/plan:
    post:
      tags:
      - SIM LifeCycle
      summary: Change Plan
      description: This API shall allow user to change the Bill Plan on a particular SIM from one Plan
        to the other Plan associated with that Billable account. It requires inputs as mobile number and
        target plan code.
      operationId: changePlanUsingPOST
      parameters:
      - name: Authorization
        in: header
        description: Authorization Header (Value must be like Bearer <Developer Access Token>)
        required: true
        schema:
          type: string
          default: Bearer XXXXXXXXXXXXXX
      - name: apikey
        in: header
        description: Developer API Key
        required: true
        schema:
          type: string
      - name: customer-id
        in: header
        description: 'Unique ID to identify Customer (shared during On-Boarding process) '
        required: true
        schema:
          type: integer
          format: int64
      - name: iv-user
        in: header
        description: Developer Account User ID
        required: true
        schema:
          type: string
      requestBody:
        description: changePlanOrder
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerateOrderWithPlan'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobVO'
        '201':
          description: Resource Created Successfully
          content: {}
        '400':
          description: Request Message is not correct
          content: {}
        '500':
          description: Internal Server Error.
          content: {}
      deprecated: false
      x-codegen-request-body-name: changePlanOrder
  /bulk/sim/download/template:
    post:
      tags:
      - SIM LifeCycle Bulk
      summary: Bulk Order Template Download
      description: This API call is used to download the Bulk template for performing Bulk Operations
        on the account. It returns the file in excel format for that Billable account.
      operationId: downloadBulkOrderTemplateUsingPOST
      parameters:
      - name: Authorization
        in: header
        description: Authorization Header (Value must be like Bearer <Developer Access Token>)
        required: true
        schema:
          type: string
          default: Bearer XXXXXXXXXXXXXX
      - name: apikey
        in: header
        description: Developer API Key
        required: true
        schema:
          type: string
      - name: customer-id
        in: header
        description: 'Unique ID to identify Customer (shared during On-Boarding process) '
        required: true
        schema:
          type: integer
          format: int64
      - name: iv-user
        in: header
        description: Developer Account User ID
        required: true
        schema:
          type: string
      requestBody:
        description: basketDO
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DownloadTemplate'
        required: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DownloadHistoryVO'
        '201':
          description: Resource Created Successfully
          content: {}
        '400':
          description: Request Message is not correct
          content: {}
        '500':
          description: Internal Server Error.
          content: {}
      deprecated: false
      x-codegen-request-body-name: basketDO
  /bulk/sim/upload:
    post:
      tags:
      - SIM LifeCycle Bulk
      summary: Bulk Upload
      description: This API call is used to upload the Bulk Operations template for performing Bulk Operations
        on the account. It returns the Job ID along with Order counts in success, failure or rejected
        status and number status.
      operationId: bulkUploadUsingPOST
      parameters:
      - name: Authorization
        in: header
        description: Authorization Header (Value must be like Bearer <Developer Access Token>)
        required: true
        schema:
          type: string
          default: Bearer XXXXXXXXXXXXXX
      - name: apikey
        in: header
        description: Developer API Key
        required: true
        schema:
          type: string
      - name: customer-id
        in: header
        description: 'Unique ID to identify Customer (shared during On-Boarding process) '
        required: true
        schema:
          type: integer
          format: int64
      - name: iv-user
        in: header
        description: Developer Account User ID
        required: true
        schema:
          type: string
      requestBody:
        content:
          multipart/form-data:
            schema:
              required:
              - file
              properties:
                action:
                  description: action
                basketId:
                  description: basketId
                file:
                  type: string
                  description: File to upload.
                  format: binary
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobVO'
        '201':
          description: Resource Created Successfully
          content: {}
        '400':
          description: Request Message is not correct
          content: {}
        '500':
          description: Internal Server Error.
          content: {}
      deprecated: false
  /bulk/download/history:
    get:
      tags:
      - Inventory Management
      summary: Download History
      description: This API call is used to get the records for downloading files from Download History
        page that are processed for Download on the portal. It returns the Download Type, Requested and
        Completion date, status of download, and file name.
      operationId: fetchDownloadHistoryUsingGET
      parameters:
      - name: Authorization
        in: header
        description: Authorization Header (Value must be like Bearer <Developer Access Token>)
        required: true
        schema:
          type: string
          default: Bearer XXXXXXXXXXXXXX
      - name: apikey
        in: header
        description: Developer API Key
        required: true
        schema:
          type: string
      - name: customer-id
        in: header
        description: 'Unique ID to identify Customer (shared during On-Boarding process) '
        required: true
        schema:
          type: integer
          format: int64
      - name: iv-user
        in: header
        description: Developer Account User ID
        required: true
        schema:
          type: string
      - name: pageNo
        in: query
        description: Page Number in case of pagination. Default Page No. is 1.
        allowEmptyValue: false
        schema:
          type: integer
          format: int32
          default: 1
      - name: pageSize
        in: query
        description: Page Size in pagination. Default Page Size is 25 and Maximum is 100.
        allowEmptyValue: false
        schema:
          type: integer
          format: int32
          default: 25
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DownloadHistoriesVo'
        '400':
          description: Request Message is not correct
          content: {}
        '500':
          description: Internal Server Error.
          content: {}
      deprecated: false
  /bulk/download/{downloadFileId}:
    get:
      tags:
      - Inventory Management
      summary: Download File
      description: This API call is used to download the file which is available or ready to download
        after processing from Download History Page.
      operationId: downloadTemplateFileUsingGET
      parameters:
      - name: Authorization
        in: header
        description: Authorization Header (Value must be like Bearer <Developer Access Token>)
        required: true
        schema:
          type: string
          default: Bearer XXXXXXXXXXXXXX
      - name: apikey
        in: header
        description: Developer API Key
        required: true
        schema:
          type: string
      - name: customer-id
        in: header
        description: 'Unique ID to identify Customer (shared during On-Boarding process) '
        required: true
        schema:
          type: integer
          format: int64
      - name: downloadFileId
        in: path
        description: downloadFileId
        required: true
        schema:
          type: integer
          format: int64
      - name: iv-user
        in: header
        description: Developer Account User ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/vnd.ms-excel:
              schema:
                type: string
                format: byte
        '400':
          description: Request Message is not correct
          content: {}
        '500':
          description: Internal Server Error.
          content: {}
      deprecated: false
  /job/all:
    get:
      tags:
      - Job Status
      summary: Fetch Jobs
      description: For all orders initiated on CMP, single or Bulk, there is a Job ID that gets generated
        for all orders. One Job ID may have one or multiple Order IDs. This API will allow user to fetch
        Job details in that Billable account.
      operationId: fetchJobsUsingGET
      parameters:
      - name: Authorization
        in: header
        description: Authorization Header (Value must be like Bearer <Developer Access Token>)
        required: true
        schema:
          type: string
          default: Bearer XXXXXXXXXXXXXX
      - name: apikey
        in: header
        description: Developer API Key
        required: true
        schema:
          type: string
      - name: customer-id
        in: header
        description: 'Unique ID to identify Customer (shared during On-Boarding process) '
        required: true
        schema:
          type: integer
          format: int64
      - name: displayRejectedRecords
        in: query
        description: Show Rejected Jobs
        allowEmptyValue: false
        schema:
          type: boolean
          default: true
      - name: endDate
        in: query
        description: End Date in a date range to fetch Job IDs. Format DD/MM/YYY
        allowEmptyValue: false
        schema:
          type: string
      - name: iv-user
        in: header
        description: Developer Account User ID
        required: true
        schema:
          type: string
      - name: jobId
        in: query
        description: Job ID, in case a particular Job ID to be fetched
        allowEmptyValue: false
        schema:
          type: integer
          format: int64
      - name: jobType
        in: query
        description: Job Type as defined in CMP
        allowEmptyValue: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - ACTIVATE_SIM
            - CHANGE_PLAN
            - SAFE_CUSTODY
            - OUT_OF_SAFE_CUSTODY
            - SWAP_SIM
            - DOWNLOAD_SIM
            - BASKET_DETAIL
            - BULK_DISCONNECTION
            - ACTIVATE_SIM_FOR_BASKET
            - BULK_UPLOAD
            - BASKET_OPERATION
            - ACTIVATE_TEST_SIM
            - ACCOUNT_BULK_UPLOAD
            - BULK_TEMP_DISCONNECTION
            - BULK_SMS_WHITELISTING
            - BULK_GROUP_CHANGE
          enum:
          - ACTIVATE_SIM
          - CHANGE_PLAN
          - SAFE_CUSTODY
          - OUT_OF_SAFE_CUSTODY
          - SWAP_SIM
          - DOWNLOAD_SIM
          - BASKET_DETAIL
          - BULK_DISCONNECTION
          - ACTIVATE_SIM_FOR_BASKET
          - BULK_UPLOAD
          - BASKET_OPERATION
          - ACTIVATE_TEST_SIM
          - ACCOUNT_BULK_UPLOAD
          - BULK_TEMP_DISCONNECTION
          - BULK_SMS_WHITELISTING
          - BULK_GROUP_CHANGE
      - name: mobileNo
        in: query
        description: Mobile Number, in case Job IDs for a particular mobile number needs to be fetched
        allowEmptyValue: false
        schema:
          type: string
      - name: pageNo
        in: query
        description: Page Number in case of pagination. Default Page No. is 1.
        allowEmptyValue: false
        schema:
          type: integer
          format: int32
          default: 1
      - name: pageSize
        in: query
        description: Page Size in pagination. Default Page Size is 25 and Maximum is 100.
        allowEmptyValue: false
        schema:
          type: integer
          format: int32
          default: 25
      - name: startDate
        in: query
        description: Start Date in a date range to fetch Job IDs. Format DD/MM/YYY
        allowEmptyValue: false
        schema:
          type: string
      - name: status
        in: query
        description: Status of Job IDs
        allowEmptyValue: false
        schema:
          type: string
          enum:
          - SUCCESS
          - FAILURE
          - IN_PROGRESS
          - REJECTED
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Jobs'
        '400':
          description: Request Message is not correct
          content: {}
        '500':
          description: Internal Server Error.
          content: {}
      deprecated: false
  /job/{jobId}/order:
    get:
      tags:
      - Job Status
      summary: Fetch Order IDs
      description: To fetch Order IDs in single Job ID, this API will allow user to fetch single or multiple
        Order IDs in a Job in that Billable account.
      operationId: fetchOrdersUsingGET
      parameters:
      - name: Authorization
        in: header
        description: Authorization Header (Value must be like Bearer <Developer Access Token>)
        required: true
        schema:
          type: string
          default: Bearer XXXXXXXXXXXXXX
      - name: apikey
        in: header
        description: Developer API Key
        required: true
        schema:
          type: string
      - name: customer-id
        in: header
        description: 'Unique ID to identify Customer (shared during On-Boarding process) '
        required: true
        schema:
          type: integer
          format: int64
      - name: iv-user
        in: header
        description: Developer Account User ID
        required: true
        schema:
          type: string
      - name: jobId
        in: path
        description: Job ID, in case order in a particular Job ID to be fetched
        required: true
        schema:
          type: integer
          format: int64
      - name: mobileNo
        in: query
        description: Mobile Number, in case Order IDs for a particular mobile number needs to be fetched
        allowEmptyValue: false
        schema:
          type: string
      - name: pageNo
        in: query
        description: Page Number in case of pagination. Default Page No. is 1.
        allowEmptyValue: false
        schema:
          type: integer
          format: int32
          default: 1
      - name: pageSize
        in: query
        description: Page Size in pagination. Default Page Size is 25 and Maximum is 100.
        allowEmptyValue: false
        schema:
          type: integer
          format: int32
          default: 25
      - name: status
        in: query
        description: Status of Order ID
        allowEmptyValue: false
        schema:
          type: string
          enum:
          - SUCCESS
          - FAILURE
          - IN_PROGRESS
          - REJECTED
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Orders'
        '400':
          description: Request Message is not correct
          content: {}
        '500':
          description: Internal Server Error.
          content: {}
      deprecated: false
  /sim/device/info:
    get:
      tags:
      - Device & Session Information
      summary: Get Device Info
      description: Once the SIM is active on the network and inserted in a device to use data, this API
        will allow user to fetch device related parameters including IMEI, previous IMEI, device make
        / model, device type, etc.
      operationId: fetchDeviceInfoUsingGET
      parameters:
      - name: Authorization
        in: header
        description: Authorization Header (Value must be like Bearer <Developer Access Token>)
        required: true
        schema:
          type: string
          default: Bearer XXXXXXXXXXXXXX
      - name: apikey
        in: header
        description: Developer API Key
        required: true
        schema:
          type: string
      - name: customer-id
        in: header
        description: 'Unique ID to identify Customer (shared during On-Boarding process) '
        required: true
        schema:
          type: integer
          format: int64
      - name: iv-user
        in: header
        description: Developer Account User ID
        required: true
        schema:
          type: string
      - name: mobileNo
        in: query
        description: Mobile No.
        required: true
        allowEmptyValue: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceIMEIResponseVO'
        '400':
          description: Request Message is not correct
          content: {}
        '500':
          description: Internal Server Error.
          content: {}
      deprecated: false
  /sim/data/usage:
    get:
      tags:
      - Device & Session Information
      summary: Get Data Usage
      description: To fetch real-time data usage on a specific SIM, this API will allow user to get total
        data allocation, available data and used data for the SIM.
      operationId: fetchDataUsageUsingGET
      parameters:
      - name: Authorization
        in: header
        description: Authorization Header (Value must be like Bearer <Developer Access Token>)
        required: true
        schema:
          type: string
          default: Bearer XXXXXXXXXXXXXX
      - name: apikey
        in: header
        description: Developer API Key
        required: true
        schema:
          type: string
      - name: customer-id
        in: header
        description: 'Unique ID to identify Customer (shared during On-Boarding process) '
        required: true
        schema:
          type: integer
          format: int64
      - name: iv-user
        in: header
        description: Developer Account User ID
        required: true
        schema:
          type: string
      - name: mobileNo
        in: query
        description: Mobile No.
        required: true
        allowEmptyValue: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataUsageResponseVO'
        '400':
          description: Request Message is not correct
          content: {}
        '500':
          description: Internal Server Error.
          content: {}
      deprecated: false
  /wt/numbers:
    get:
      tags:
      - Whitelisting
      summary: 'Fetch SMS Whitelisted Number '
      description: Fetch SMS Whitelisted Number by msisdn, simNo,basketName,pageNo,pagesize
      operationId: fetchSMSWhitelistedNumbersUsingGET
      parameters:
      - name: Authorization
        in: header
        description: Authorization Header (Value must be like Bearer <Developer Access Token>)
        required: true
        schema:
          type: string
          default: Bearer XXXXXXXXXXXXXX
      - name: apikey
        in: header
        description: Developer API Key
        required: true
        schema:
          type: string
      - name: basketId
        in: query
        description: Basket ID
        allowEmptyValue: false
        schema:
          type: integer
          format: int32
      - name: customer-id
        in: header
        description: 'Unique ID to identify Customer (shared during On-Boarding process) '
        required: true
        schema:
          type: integer
          format: int64
      - name: iv-user
        in: header
        description: Developer Account User ID
        required: true
        schema:
          type: string
      - name: msisdn
        in: query
        description: msisdn
        allowEmptyValue: false
        schema:
          type: string
      - name: pageNo
        in: query
        description: Page Number in case of pagination. Default Page No. is 1.
        allowEmptyValue: false
        schema:
          type: integer
          format: int32
          default: 1
      - name: pageSize
        in: query
        description: Page Size in pagination. Default Page Size is 25 and Maximum is 100.
        allowEmptyValue: false
        schema:
          type: integer
          format: int32
          default: 25
      - name: simNo
        in: query
        description: SIM Number
        allowEmptyValue: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SMSWTLResponse'
        '400':
          description: Request Message is not correct
          content: {}
        '500':
          description: Internal Server Error.
          content: {}
      deprecated: false
  /wt/numbers/batch:
    post:
      tags:
      - Whitelisting
      summary: SMS Batch Whitelisting API
      description: SMS batch whitelisting on Airtel IoT portal. Minimum 1 and Maximum 100 MSISDN can be
        whitelisted at once
      operationId: smsWhitelistedNumbersBatchUsingPOST
      parameters:
      - name: Authorization
        in: header
        description: Authorization Header (Value must be like Bearer <Developer Access Token>)
        required: true
        schema:
          type: string
          default: Bearer XXXXXXXXXXXXXX
      - name: apikey
        in: header
        description: Developer API Key
        required: true
        schema:
          type: string
      - name: customer-id
        in: header
        description: 'Unique ID to identify Customer (shared during On-Boarding process) '
        required: true
        schema:
          type: integer
          format: int64
      - name: iv-user
        in: header
        description: Developer Account User ID
        required: true
        schema:
          type: string
      requestBody:
        description: requestDO
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SmsWhitelistBatchDO'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobVO'
        '201':
          description: Resource Created Successfully
          content: {}
        '400':
          description: Request Message is not correct
          content: {}
        '500':
          description: Internal Server Error.
          content: {}
      deprecated: false
      x-codegen-request-body-name: requestDO
  /kyc/sim/details:
    get:
      tags:
      - KYC Manager
      summary: Fetch SIM KYC Details
      description: FetchSIMKYCDetails API
      operationId: fetchSimKycDetailsListUsingGET
      parameters:
      - name: Authorization
        in: header
        description: Authorization Header (Value must be like Bearer <Developer Access Token>)
        required: true
        schema:
          type: string
          default: Bearer XXXXXXXXXXXXXX
      - name: activationDate
        in: query
        description: Activation date range on which SIMs will be filtered. Format DD/MM/YYYY - DD/MM/YYYY
        allowEmptyValue: false
        schema:
          type: string
      - name: apikey
        in: header
        description: Developer API Key
        required: true
        schema:
          type: string
      - name: basketId
        in: query
        description: basketId
        schema:
          type: integer
          format: int32
          default: 0
      - name: complianceDate
        in: query
        description: Compliance Date range on which SIMs will be filtered. Format DD/MM/YYYY - DD/MM/YYYY
        allowEmptyValue: false
        schema:
          type: string
      - name: customer-id
        in: header
        description: 'Unique ID to identify Customer (shared during On-Boarding process) '
        required: true
        schema:
          type: integer
          format: int64
      - name: iv-user
        in: header
        description: Developer Account User ID
        required: true
        schema:
          type: string
      - name: msisdn
        in: query
        description: Mobile No.
        allowEmptyValue: false
        schema:
          type: string
      - name: pageNo
        in: query
        description: pageNo
        schema:
          type: integer
          format: int32
          default: 1
      - name: pageSize
        in: query
        description: pageSize
        schema:
          type: integer
          format: int32
          default: 25
      - name: simNo
        in: query
        description: Sim No
        allowEmptyValue: false
        schema:
          type: string
      - name: status
        in: query
        description: Filter Type on which SIMs will be filtered. The allowed type are Compliant / Non-Compliant
          /Pending
        allowEmptyValue: false
        schema:
          type: string
          enum:
          - COMPLIANT
          - NON_COMPLIANT
          - PENDING
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimKycDetailsWOPlan'
        '400':
          description: Request Message is not correct
          content: {}
        '500':
          description: Internal Server Error.
          content: {}
      deprecated: false
  /kyc/sim/update:
    post:
      tags:
      - KYC Manager
      summary: Update SIM KYC details
      description: UpdateSIMKycDetails API
      operationId: updateSimKycDetailsUsingPOST
      parameters:
      - name: Authorization
        in: header
        description: Authorization Header (Value must be like Bearer <Developer Access Token>)
        required: true
        schema:
          type: string
          default: Bearer XXXXXXXXXXXXXX
      - name: apikey
        in: header
        description: Developer API Key
        required: true
        schema:
          type: string
      - name: customer-id
        in: header
        description: 'Unique ID to identify Customer (shared during On-Boarding process) '
        required: true
        schema:
          type: integer
          format: int64
      - name: iv-user
        in: header
        description: Developer Account User ID
        required: true
        schema:
          type: string
      requestBody:
        description: requestDo
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SimKycDo'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateSimKycResponseVo'
        '201':
          description: Resource Created Successfully
          content: {}
        '400':
          description: Request Message is not correct
          content: {}
        '500':
          description: Internal Server Error.
          content: {}
      deprecated: false
      x-codegen-request-body-name: requestDo
  /billing/quota:
    get:
      tags:
      - Messaging Centre
      summary: Fetch SMS Quota
      description: This API will fetch the available SMS Quota balance.
      operationId: fetchSMSQuotaDetailsUsingGET
      parameters:
      - name: Authorization
        in: header
        description: Authorization Header (Value must be like Bearer <Developer Access Token>)
        required: true
        schema:
          type: string
          default: Bearer XXXXXXXXXXXXXX
      - name: apikey
        in: header
        description: Developer API Key
        required: true
        schema:
          type: string
      - name: customer-id
        in: header
        description: 'Unique ID to identify Customer (shared during On-Boarding process) '
        required: true
        schema:
          type: integer
          format: int64
      - name: iv-user
        in: header
        description: Developer Account User ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SMSQuotaVO'
        '400':
          description: Request Message is not correct
          content: {}
        '500':
          description: Internal Server Error.
          content: {}
      deprecated: false
  /billing/history:
    get:
      tags:
      - Messaging Centre
      summary: Fetch Billing History
      description: This API will be used to fetch Plan Subscribe / Un-Subscribe history.
      operationId: fetchPurchaseHistoryUsingGET
      parameters:
      - name: Authorization
        in: header
        description: Authorization Header (Value must be like Bearer <Developer Access Token>)
        required: true
        schema:
          type: string
          default: Bearer XXXXXXXXXXXXXX
      - name: apikey
        in: header
        description: Developer API Key
        required: true
        schema:
          type: string
      - name: customer-id
        in: header
        description: 'Unique ID to identify Customer (shared during On-Boarding process) '
        required: true
        schema:
          type: integer
          format: int64
      - name: iv-user
        in: header
        description: Developer Account User ID
        required: true
        schema:
          type: string
      - name: pageNo
        in: query
        description: Page Number in case of pagination. Default Page No. is 1.
        allowEmptyValue: false
        schema:
          type: integer
          format: int32
          default: 1
      - name: pageSize
        in: query
        description: Page Size in pagination. Default Page Size is 25 and Maximum is 100.
        allowEmptyValue: false
        schema:
          type: integer
          format: int32
          default: 25
      - name: purchaseEndDate
        in: query
        description: Purchase Date / Transaction Date to fetch billing history. Format DD/MM/YYYY
        allowEmptyValue: false
        schema:
          type: string
      - name: purchaseStartDate
        in: query
        description: Purchase Date / Transaction Date to fetch billing history. Format DD/MM/YYYY
        allowEmptyValue: false
        schema:
          type: string
      - name: subscriptionEvent
        in: query
        description: Type of event which user want to filter.
        allowEmptyValue: false
        schema:
          type: string
          enum:
          - Purchase
          - Auto_Renew
          - Unsubscribe
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerPlanResponseVO'
        '400':
          description: Request Message is not correct
          content: {}
        '500':
          description: Internal Server Error.
          content: {}
      deprecated: false
  /template/:
    get:
      tags:
      - Messaging Centre
      summary: Fetch SMS Template Details
      description: This API will be used to fetch the list of Template Name and Template ID created on
        Messaging Centre on CMP. These templates details will be used to send SMS using 'Send SMS' or
        'Send Batch SMS' feature.
      operationId: fetchTemplatesUsingGET
      parameters:
      - name: Authorization
        in: header
        description: Authorization Header (Value must be like Bearer <Developer Access Token>)
        required: true
        schema:
          type: string
          default: Bearer XXXXXXXXXXXXXX
      - name: apikey
        in: header
        description: Developer API Key
        required: true
        schema:
          type: string
      - name: customer-id
        in: header
        description: 'Unique ID to identify Customer (shared during On-Boarding process) '
        required: true
        schema:
          type: integer
          format: int64
      - name: fetchOnlyActiveTemplates
        in: query
        description: Pass true to fetch only Active Templates on which SMS can be sent.
        allowEmptyValue: false
        schema:
          type: boolean
      - name: iv-user
        in: header
        description: Developer Account User ID
        required: true
        schema:
          type: string
      - name: pageNo
        in: query
        description: Page Number in case of pagination. Default Page No. is 1.
        allowEmptyValue: false
        schema:
          type: integer
          format: int32
          default: 1
      - name: pageSize
        in: query
        description: Page Size in pagination. Default Page Size is 25 and Maximum is 100.
        allowEmptyValue: false
        schema:
          type: integer
          format: int32
          default: 25
      - name: templateName
        in: query
        description: Template Name to Search
        allowEmptyValue: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SmsTemplateView'
        '400':
          description: Request Message is not correct
          content: {}
        '500':
          description: Internal Server Error.
          content: {}
      deprecated: false
  /send:
    post:
      tags:
      - Messaging Centre
      summary: Send SMS
      description: This API is used to initiate request for sending SMS on M2M SIMs. A single job can
        be used to send SMS to a maximum of 100 MSISDNs. This is an asynchronous API which will take input
        in specified JSON format mentioning MSISDN(s) and Template ID. In return it will provide a Job
        ID by which status of Job created by request can be tracked using 'Fetch SMS Jobs' and 'Fetch
        SMS Job Orders' APIs.
      operationId: sendSMSUsingPOST
      parameters:
      - name: Authorization
        in: header
        description: Authorization Header (Value must be like Bearer <Developer Access Token>)
        required: true
        schema:
          type: string
          default: Bearer XXXXXXXXXXXXXX
      - name: apikey
        in: header
        description: Developer API Key
        required: true
        schema:
          type: string
      - name: customer-id
        in: header
        description: 'Unique ID to identify Customer (shared during On-Boarding process) '
        required: true
        schema:
          type: integer
          format: int64
      - name: iv-user
        in: header
        description: Developer Account User ID
        required: true
        schema:
          type: string
      requestBody:
        description: smsBatchDO
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SMSBatchDO'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobVO'
        '201':
          description: Resource Created Successfully
          content: {}
        '400':
          description: Request Message is not correct
          content: {}
        '500':
          description: Internal Server Error.
          content: {}
      deprecated: false
      x-codegen-request-body-name: smsBatchDO
  /send/custom/message:
    post:
      tags:
      - Messaging Centre
      summary: Send Custom SMS
      description: 'This API is used to initiate request for sending either Text or Binary SMS on M2M
        SIMs. A single job can be used to send SMS to a maximum of 10 MSISDNs. This is an asynchronous
        API which will take input in specified JSON format mentioning MSISDN(s) and Custom Message. In
        return it will provide a Job ID by which status of Job created by request can be tracked using
        ''Fetch SMS Jobs'' and ''Fetch SMS Job Orders'' APIs. Use API for below mentioned scenarios </br><ul><li><u>Send
        Text SMS</u> : Pass <b>binarySMS</b> value as <b>false</b>. Maximum allowed content length of
        <b>customMessage</b> is 160 characters.</li><li><u>Send Binary SMS</u> : Pass <b>binarySMS</b>
        value as <b>true</b>. Maximum allowed content length of <b>customMessage</b> is 1000 characters.
        And content must be in 8-bit Binary format</li></ul>'
      operationId: sendCustomSMSUsingPOST
      parameters:
      - name: Authorization
        in: header
        description: Authorization Header (Value must be like Bearer <Developer Access Token>)
        required: true
        schema:
          type: string
          default: Bearer XXXXXXXXXXXXXX
      - name: apikey
        in: header
        description: Developer API Key
        required: true
        schema:
          type: string
      - name: customer-id
        in: header
        description: 'Unique ID to identify Customer (shared during On-Boarding process) '
        required: true
        schema:
          type: integer
          format: int64
      - name: iv-user
        in: header
        description: Developer Account User ID
        required: true
        schema:
          type: string
      requestBody:
        description: customSMSBatchDO
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomSMSBatchDO'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobVO'
        '201':
          description: Resource Created Successfully
          content: {}
        '400':
          description: Request Message is not correct
          content: {}
        '500':
          description: Internal Server Error.
          content: {}
      deprecated: false
      x-codegen-request-body-name: customSMSBatchDO
  /download/batch/template:
    post:
      tags:
      - Messaging Centre
      summary: Download Batch SMS Template
      description: This API call is used to download the Batch template for performing 'Send Batch SMS'
        Operations on the account. It returns the file in excel format.
      operationId: downloadBulkSMSTemplateUsingPOST
      parameters:
      - name: Authorization
        in: header
        description: Authorization Header (Value must be like Bearer <Developer Access Token>)
        required: true
        schema:
          type: string
          default: Bearer XXXXXXXXXXXXXX
      - name: apikey
        in: header
        description: Developer API Key
        required: true
        schema:
          type: string
      - name: customer-id
        in: header
        description: 'Unique ID to identify Customer (shared during On-Boarding process) '
        required: true
        schema:
          type: integer
          format: int64
      - name: iv-user
        in: header
        description: Developer Account User ID
        required: true
        schema:
          type: string
      requestBody:
        description: downloadTemplateDO
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DownloadTemplateDO'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DownloadSmsTemplateVO'
        '201':
          description: Resource Created Successfully
          content: {}
        '400':
          description: Request Message is not correct
          content: {}
        '500':
          description: Internal Server Error.
          content: {}
      deprecated: false
      x-codegen-request-body-name: downloadTemplateDO
  /send/batch:
    post:
      tags:
      - Messaging Centre
      summary: Send Batch SMS
      description: This API is used to initiate request for sending SMS on M2M SIMs in Batch. This is
        an asynchronous API which will take input in excel file mentioning MSISDN(s) and Template Name.
        In return it will provide a Job ID by which status of Job created by request can be tracked using
        'Fetch SMS Jobs' and 'Fetch SMS Job Orders' APIs. Batch SMS template can be used to send SMS to
        up to 5,000 numbers in a single job.
      operationId: sendBatchSMSUsingPOST
      parameters:
      - name: Authorization
        in: header
        description: Authorization Header (Value must be like Bearer <Developer Access Token>)
        required: true
        schema:
          type: string
          default: Bearer XXXXXXXXXXXXXX
      - name: apikey
        in: header
        description: Developer API Key
        required: true
        schema:
          type: string
      - name: customer-id
        in: header
        description: 'Unique ID to identify Customer (shared during On-Boarding process) '
        required: true
        schema:
          type: integer
          format: int64
      - name: iv-user
        in: header
        description: Developer Account User ID
        required: true
        schema:
          type: string
      requestBody:
        content:
          multipart/form-data:
            schema:
              required:
              - file
              properties:
                basketId:
                  description: basketId
                file:
                  type: string
                  description: File to upload.
                  format: binary
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkSms'
        '201':
          description: Resource Created Successfully
          content: {}
        '400':
          description: Request Message is not correct
          content: {}
        '500':
          description: Internal Server Error.
          content: {}
      deprecated: false
  /box:
    get:
      tags:
      - Messaging Centre
      summary: Fetch SMS History
      description: This API is used to fetch history of both Incoming as well as Outgoing Messages received
        on Messaging Centre. API also provide a list of filters by which data specific to a MSISDN, Message
        Type, Sent Date etc. can be fetched.
      operationId: fetchMessageHistoryUsingGET
      parameters:
      - name: Authorization
        in: header
        description: Authorization Header (Value must be like Bearer <Developer Access Token>)
        required: true
        schema:
          type: string
          default: Bearer XXXXXXXXXXXXXX
      - name: apikey
        in: header
        description: Developer API Key
        required: true
        schema:
          type: string
      - name: customer-id
        in: header
        description: 'Unique ID to identify Customer (shared during On-Boarding process) '
        required: true
        schema:
          type: integer
          format: int64
      - name: endDate
        in: query
        description: End Date in a date range to fetch Job IDs. Format DD/MM/YYY
        allowEmptyValue: false
        schema:
          type: string
      - name: iv-user
        in: header
        description: Developer Account User ID
        required: true
        schema:
          type: string
      - name: messageType
        in: query
        description: Message types. Available types are - incoming/outgoing.
        allowEmptyValue: false
        schema:
          type: string
          enum:
          - Incoming
          - Outgoing
      - name: msisdn
        in: query
        description: Mobile Number, in case Job IDs for a particular mobile number needs to be fetched
        allowEmptyValue: false
        schema:
          type: string
      - name: pageNo
        in: query
        description: Page Number in case of pagination. Default Page No. is 1.
        allowEmptyValue: false
        schema:
          type: integer
          format: int32
          default: 1
      - name: pageSize
        in: query
        description: Page Size in pagination. Default Page Size is 25 and Maximum is 100.
        allowEmptyValue: false
        schema:
          type: integer
          format: int32
          default: 25
      - name: startDate
        in: query
        description: Start Date in a date range to fetch Job IDs. Format DD/MM/YYY
        allowEmptyValue: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageHistory'
        '400':
          description: Request Message is not correct
          content: {}
        '500':
          description: Internal Server Error.
          content: {}
      deprecated: false
  /job/history:
    get:
      tags:
      - Messaging Centre
      summary: Fetch SMS Jobs
      description: This API is used to fetch Jobs created while sending SMS either by 'Send SMS' or 'Send
        Batch SMS' feature. Using Job IDs mentioned in response of API, customer can fetch the details
        of SMS sent in that particular Job.
      operationId: fetchJobHistoryUsingGET
      parameters:
      - name: Authorization
        in: header
        description: Authorization Header (Value must be like Bearer <Developer Access Token>)
        required: true
        schema:
          type: string
          default: Bearer XXXXXXXXXXXXXX
      - name: apikey
        in: header
        description: Developer API Key
        required: true
        schema:
          type: string
      - name: customer-id
        in: header
        description: 'Unique ID to identify Customer (shared during On-Boarding process) '
        required: true
        schema:
          type: integer
          format: int64
      - name: endDate
        in: query
        description: End Date in a date range to fetch Job IDs. Format DD/MM/YYY
        schema:
          type: string
      - name: iv-user
        in: header
        description: Developer Account User ID
        required: true
        schema:
          type: string
      - name: jobId
        in: query
        description: Job ID, in case a particular Job ID to be fetched
        allowEmptyValue: false
        schema:
          type: integer
          format: int64
      - name: jobType
        in: query
        description: jobType
        schema:
          type: string
          enum:
          - Sync
          - Send_SMS
          - Batch_SMS
      - name: msisdn
        in: query
        description: msisdn
        schema:
          type: string
      - name: pageNo
        in: query
        description: Page Number in case of pagination. Default Page No. is 1.
        allowEmptyValue: false
        schema:
          type: integer
          format: int32
          default: 1
      - name: pageSize
        in: query
        description: Page Size in pagination. Default Page Size is 25 and Maximum is 100.
        allowEmptyValue: false
        schema:
          type: integer
          format: int32
          default: 25
      - name: startDate
        in: query
        description: Start Date in a date range to fetch Job IDs. Format DD/MM/YYY
        schema:
          type: string
      - name: status
        in: query
        description: Status of SMS
        allowEmptyValue: false
        schema:
          type: string
          enum:
          - In_Progress
          - Success
          - Failed
          - Error
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobVoResponse'
        '400':
          description: Request Message is not correct
          content: {}
        '500':
          description: Internal Server Error.
          content: {}
      deprecated: false
  /order/detail:
    get:
      tags:
      - Messaging Centre
      summary: Fetch SMS Job Orders
      description: This API is used to fetch line item details of each SMS sent to MSISDN either by 'Send
        SMS' or 'Send Batch SMS' feature in a Job. Job ID used in this API can be fetched from Fetch SMS
        Jobs.
      operationId: fetchSmsOrderDetailsUsingGET
      parameters:
      - name: Authorization
        in: header
        description: Authorization Header (Value must be like Bearer <Developer Access Token>)
        required: true
        schema:
          type: string
          default: Bearer XXXXXXXXXXXXXX
      - name: apikey
        in: header
        description: Developer API Key
        required: true
        schema:
          type: string
      - name: customer-id
        in: header
        description: 'Unique ID to identify Customer (shared during On-Boarding process) '
        required: true
        schema:
          type: integer
          format: int64
      - name: iv-user
        in: header
        description: Developer Account User ID
        required: true
        schema:
          type: string
      - name: jobId
        in: query
        description: jobId
        required: true
        schema:
          type: integer
          format: int32
      - name: msisdn
        in: query
        description: msisdn
        schema:
          type: string
      - name: pageNo
        in: query
        description: Page Number in case of pagination. Default Page No. is 1.
        allowEmptyValue: false
        schema:
          type: integer
          format: int32
          default: 1
      - name: pageSize
        in: query
        description: Page Size in pagination. Default Page Size is 25 and Maximum is 100.
        allowEmptyValue: false
        schema:
          type: integer
          format: int32
          default: 25
      - name: status
        in: query
        description: Status of SMS
        allowEmptyValue: false
        schema:
          type: string
          enum:
          - In_Progress
          - Success
          - Failed
          - Error
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderVOResponse'
        '400':
          description: Request Message is not correct
          content: {}
        '500':
          description: Internal Server Error.
          content: {}
      deprecated: false
  /device/diagnose/radius:
    get:
      tags:
      - Device & Session Information
      summary: Device Diagnose API.
      description: Fetch Device Diagnose Radius Attributes.
      operationId: deviceDiagnoseRadiusUsingGET
      parameters:
      - name: Authorization
        in: header
        description: Authorization Header (Value must be like Bearer <Developer Access Token>)
        required: true
        schema:
          type: string
          default: Bearer XXXXXXXXXXXXXX
      - name: apikey
        in: header
        description: Developer API Key
        required: true
        schema:
          type: string
      - name: customer-id
        in: header
        description: 'Unique ID to identify Customer (shared during On-Boarding process) '
        required: true
        schema:
          type: integer
          format: int64
      - name: endDate
        in: query
        description: End DateTime For AAA Radius.  Format DD/MM/YYYY
        allowEmptyValue: false
        schema:
          type: string
      - name: iv-user
        in: header
        description: Developer Account User ID
        required: true
        schema:
          type: string
      - name: mobileNo
        in: query
        description: Mobile No.
        required: true
        allowEmptyValue: false
        schema:
          type: string
      - name: pageNo
        in: query
        description: Page Number in case of pagination. Default Page No. is 1.
        allowEmptyValue: false
        schema:
          type: integer
          format: int32
          default: 1
      - name: pageSize
        in: query
        description: Page Size in pagination for AAA session details. Default Page Size is 20 and Maximum
          is 100.
        allowEmptyValue: false
        schema:
          type: integer
          format: int32
          default: 20
      - name: startDate
        in: query
        description: Start DateTime For AAA Radius. Format DD/MM/YYYY
        allowEmptyValue: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceRadiusResponseVO'
        '400':
          description: Request Message is not correct
          content: {}
        '500':
          description: Internal Server Error.
          content: {}
      deprecated: false
  /details/:
    get:
      tags:
      - Account Details
      summary: Fetch Customer Profile
      description: This API shall allow user to fetch the overall profile of Customer as created at the
        time of On-Boarding.
      operationId: fetchCustomerProfileUsingGET
      parameters:
      - name: Authorization
        in: header
        description: Authorization Header (Value must be like Bearer <Developer Access Token>)
        required: true
        schema:
          type: string
          default: Bearer XXXXXXXXXXXXXX
      - name: apikey
        in: header
        description: Developer API Key
        required: true
        schema:
          type: string
      - name: customer-id
        in: header
        description: 'Unique ID to identify Customer (shared during On-Boarding process) '
        required: true
        schema:
          type: integer
          format: int64
      - name: iv-user
        in: header
        description: Developer Account User ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerDetailsVO'
        '400':
          description: Request Message is not correct
          content: {}
        '500':
          description: Internal Server Error.
          content: {}
      deprecated: false
  /details/stats:
    get:
      tags:
      - Account Details
      summary: Fetch Customer Statistics
      description: This API shall allow user to fetch the SIM Inventory statistics of a Customer Account
        at any given time. It returns the summary of SIM inventory as itâs shown on CMP portal.
      operationId: fetchCustomerStatsUsingGET
      parameters:
      - name: Authorization
        in: header
        description: Authorization Header (Value must be like Bearer <Developer Access Token>)
        required: true
        schema:
          type: string
          default: Bearer XXXXXXXXXXXXXX
      - name: apikey
        in: header
        description: Developer API Key
        required: true
        schema:
          type: string
      - name: customer-id
        in: header
        description: 'Unique ID to identify Customer (shared during On-Boarding process) '
        required: true
        schema:
          type: integer
          format: int64
      - name: iv-user
        in: header
        description: Developer Account User ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerStats'
        '400':
          description: Request Message is not correct
          content: {}
        '500':
          description: Internal Server Error.
          content: {}
      deprecated: false
  /details/plans:
    get:
      tags:
      - Account Details
      summary: Fetch Customer Plans
      description: This API shall allow user to fetch the details of Plans that are associated with the
        Customer Account. It returns the Plan code, plan name and plan description as defined on the account.
      operationId: fetchCustomerPlansUsingGET_1
      parameters:
      - name: Authorization
        in: header
        description: Authorization Header (Value must be like Bearer <Developer Access Token>)
        required: true
        schema:
          type: string
          default: Bearer XXXXXXXXXXXXXX
      - name: apikey
        in: header
        description: Developer API Key
        required: true
        schema:
          type: string
      - name: customer-id
        in: header
        description: 'Unique ID to identify Customer (shared during On-Boarding process) '
        required: true
        schema:
          type: integer
          format: int64
      - name: iv-user
        in: header
        description: Developer Account User ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PlanDetailsVO'
        '400':
          description: Request Message is not correct
          content: {}
        '500':
          description: Internal Server Error.
          content: {}
      deprecated: false
  /job/sim/activate:
    post:
      tags:
      - SIM LifeCycle
      summary: Activate SIM
      description: This API shall allow user to change the state of SIM from Available (Ready to Activate)
        to Active with Plan that is associated with the Billable account. It requires inputs as mobile
        number and plan code.
      operationId: activateSimsUsingPOST
      parameters:
      - name: Authorization
        in: header
        description: Authorization Header (Value must be like Bearer <Developer Access Token>)
        required: true
        schema:
          type: string
          default: Bearer XXXXXXXXXXXXXX
      - name: apikey
        in: header
        description: Developer API Key
        required: true
        schema:
          type: string
      - name: customer-id
        in: header
        description: 'Unique ID to identify Customer (shared during On-Boarding process) '
        required: true
        schema:
          type: integer
          format: int64
      - name: iv-user
        in: header
        description: Developer Account User ID
        required: true
        schema:
          type: string
      requestBody:
        description: generateOrder
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerateOrderWithPlan'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobVO'
        '201':
          description: Resource Created Successfully
          content: {}
        '400':
          description: Request Message is not correct
          content: {}
        '500':
          description: Internal Server Error.
          content: {}
      deprecated: false
      x-codegen-request-body-name: generateOrder
  /job/sim/swap:
    post:
      tags:
      - SIM LifeCycle
      summary: Swap SIM
      description: In case the user wishes to replace SIM card associated with a Mobile number, in case
        of any issue with the SIM, this API shall allow user to change the SIM on that Billable account.
        It requires inputs as source SIM and target SIM number.
      operationId: swapSimUsingPOST
      parameters:
      - name: Authorization
        in: header
        description: Authorization Header (Value must be like Bearer <Developer Access Token>)
        required: true
        schema:
          type: string
          default: Bearer XXXXXXXXXXXXXX
      - name: apikey
        in: header
        description: Developer API Key
        required: true
        schema:
          type: string
      - name: customer-id
        in: header
        description: 'Unique ID to identify Customer (shared during On-Boarding process) '
        required: true
        schema:
          type: integer
          format: int64
      - name: iv-user
        in: header
        description: Developer Account User ID
        required: true
        schema:
          type: string
      requestBody:
        description: swapSim
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SwapSim'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobVO'
        '201':
          description: Resource Created Successfully
          content: {}
        '400':
          description: Request Message is not correct
          content: {}
        '500':
          description: Internal Server Error.
          content: {}
      deprecated: false
      x-codegen-request-body-name: swapSim
  /bulk/dataUsages/download:
    post:
      tags:
      - Device & Session Information
      summary: Bulk Data Usage
      description: This API call is used to initiate download of Bulk data usage file from a specific
        Basket. It returns the file name along with creation and completion date for that basket. Since,
        the number of SIMs in a basket is restricted to 5000, hence the maximum number of SIMs in this
        Bulk data usage file will be 5000.
      operationId: downloadDataUsagesUsingPOST
      parameters:
      - name: Authorization
        in: header
        description: Authorization Header (Value must be like Bearer <Developer Access Token>)
        required: true
        schema:
          type: string
          default: Bearer XXXXXXXXXXXXXX
      - name: apikey
        in: header
        description: Developer API Key
        required: true
        schema:
          type: string
      - name: customer-id
        in: header
        description: 'Unique ID to identify Customer (shared during On-Boarding process) '
        required: true
        schema:
          type: integer
          format: int64
      - name: iv-user
        in: header
        description: Developer Account User ID
        required: true
        schema:
          type: string
      requestBody:
        description: basketDO
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BasketDO'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DownloadHistoryVO'
        '201':
          description: Resource Created Successfully
          content: {}
        '400':
          description: Request Message is not correct
          content: {}
        '500':
          description: Internal Server Error.
          content: {}
      deprecated: false
      x-codegen-request-body-name: basketDO
  /voice/numbers:
    get:
      tags:
      - Whitelisting
      summary: Fetch Voice Whitelist Numbers from CMP
      description: This API will fetch all numbers for Voice Whitelist on CMP portal with existing whitelisted
        records
      operationId: fetchVoiceWhitelistedNumbersUsingGET
      parameters:
      - name: Authorization
        in: header
        description: Authorization Header (Value must be like Bearer <Developer Access Token>)
        required: true
        schema:
          type: string
          default: Bearer XXXXXXXXXXXXXX
      - name: apikey
        in: header
        description: Developer API Key
        required: true
        schema:
          type: string
      - name: customer-id
        in: header
        description: 'Unique ID to identify Customer (shared during On-Boarding process) '
        required: true
        schema:
          type: integer
          format: int64
      - name: iv-user
        in: header
        description: Developer Account User ID
        required: true
        schema:
          type: string
      - name: msisdn
        in: query
        description: msisdn
        allowEmptyValue: false
        schema:
          type: string
      - name: pageNo
        in: query
        description: Page Number in case of pagination. Default Page No. is 1.
        allowEmptyValue: false
        schema:
          type: integer
          format: int32
          default: 1
      - name: pageSize
        in: query
        description: Page Size in pagination. Default Page Size is 25 and Maximum is 100.
        allowEmptyValue: false
        schema:
          type: integer
          format: int32
          default: 25
      - name: simNo
        in: query
        description: SIM Number
        allowEmptyValue: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WhitelistResponse'
        '400':
          description: Request Message is not correct
          content: {}
        '500':
          description: Internal Server Error.
          content: {}
      deprecated: false
    post:
      tags:
      - Whitelisting APIs
      summary: Update Voice Whitelist Number API in CMP
      description: This API will update the Voice Whitelist number in CMP. Customer can Add, Update or
        Delete whitelisted numbers with this API
      operationId: updateVoiceWhitelistNumberUsingPOST
      parameters:
      - name: Authorization
        in: header
        description: Authorization Header (Value must be like Bearer <Developer Access Token>)
        required: true
        schema:
          type: string
          default: Bearer XXXXXXXXXXXXXX
      - name: apikey
        in: header
        description: Developer API Key
        required: true
        schema:
          type: string
      - name: customer-id
        in: header
        description: 'Unique ID to identify Customer (shared during On-Boarding process) '
        required: true
        schema:
          type: integer
          format: int64
      - name: iv-user
        in: header
        description: Developer Account User ID
        required: true
        schema:
          type: string
      requestBody:
        description: requestDO
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WhitelistNumberDO'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobVO'
        '201':
          description: Resource Created Successfully
          content: {}
        '400':
          description: Request Message is not correct
          content: {}
        '500':
          description: Internal Server Error.
          content: {}
      deprecated: false
      x-codegen-request-body-name: requestDO
  /bulk/sim/inventory/download:
    get:
      tags:
      - Inventory Management
      summary: Download SIM Inventory
      description: This API call returns the SIM inventory file in excel format for that Billable account.
      operationId: downloadSimInventoryOrderUsingGET
      parameters:
      - name: Authorization
        in: header
        description: Authorization Header (Value must be like Bearer <Developer Access Token>)
        required: true
        schema:
          type: string
          default: Bearer XXXXXXXXXXXXXX
      - name: apikey
        in: header
        description: Developer API Key
        required: true
        schema:
          type: string
      - name: customer-id
        in: header
        description: 'Unique ID to identify Customer (shared during On-Boarding process) '
        required: true
        schema:
          type: integer
          format: int64
      - name: iv-user
        in: header
        description: Developer Account User ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DownloadHistoryVO'
        '400':
          description: Request Message is not correct
          content: {}
        '500':
          description: Internal Server Error.
          content: {}
      deprecated: false
  /details/baskets:
    get:
      tags:
      - Inventory Management
      summary: Fetch Customer Baskets
      description: This API shall allow user to fetch the details of Baskets that are created on that
        Customer Account. It can fetch the details of a particular basket at any given point. It returns
        the SIM details in that basket with different states (Active, Available, Safe Custody, Test Mode,
        Suspended) along with Basket description and user details to whom that basket is assigned.
      operationId: fetchCustomerBasketsUsingGET
      parameters:
      - name: Authorization
        in: header
        description: Authorization Header (Value must be like Bearer <Developer Access Token>)
        required: true
        schema:
          type: string
          default: Bearer XXXXXXXXXXXXXX
      - name: apikey
        in: header
        description: Developer API Key
        required: true
        schema:
          type: string
      - name: basketId
        in: query
        description: Basket ID
        allowEmptyValue: false
        schema:
          type: integer
          format: int64
      - name: basketName
        in: query
        description: Basket Name
        allowEmptyValue: false
        schema:
          type: string
      - name: customer-id
        in: header
        description: 'Unique ID to identify Customer (shared during On-Boarding process) '
        required: true
        schema:
          type: integer
          format: int64
      - name: detailedView
        in: query
        description: ${detailedView.notes}
        allowEmptyValue: false
        schema:
          type: boolean
          default: true
      - name: iv-user
        in: header
        description: Developer Account User ID
        required: true
        schema:
          type: string
      - name: myBaskets
        in: query
        description: My Baskets(Basket Onwer)
        allowEmptyValue: false
        schema:
          type: boolean
          default: false
        example: false
      - name: pageNo
        in: query
        description: Page Number in case of pagination. Default Page No. is 1.
        allowEmptyValue: false
        schema:
          type: integer
          format: int32
          default: 1
      - name: pageSize
        in: query
        description: Page Size in pagination. Default Page Size is 25 and Maximum is 100.
        allowEmptyValue: false
        schema:
          type: integer
          format: int32
          default: 25
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Baskets'
        '400':
          description: Request Message is not correct
          content: {}
        '500':
          description: Internal Server Error.
          content: {}
      deprecated: false
  /job/sim/voluntary/suspend:
    post:
      tags:
      - SIM LifeCycle
      summary: Safe Custody
      description: In case the user wishes to voluntarily suspend the SIM card for sometime, there is
        an option to put the SIM in safe custody. This API shall allow user to put the SIM in safe custody
        on that Billable account. It requires inputs as mobile number.
      operationId: safeCustodyUsingPOST
      parameters:
      - name: Authorization
        in: header
        description: Authorization Header (Value must be like Bearer <Developer Access Token>)
        required: true
        schema:
          type: string
          default: Bearer XXXXXXXXXXXXXX
      - name: apikey
        in: header
        description: Developer API Key
        required: true
        schema:
          type: string
      - name: customer-id
        in: header
        description: 'Unique ID to identify Customer (shared during On-Boarding process) '
        required: true
        schema:
          type: integer
          format: int64
      - name: iv-user
        in: header
        description: Developer Account User ID
        required: true
        schema:
          type: string
      requestBody:
        description: generateOrder
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerateOrder'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobVO'
        '201':
          description: Resource Created Successfully
          content: {}
        '400':
          description: Request Message is not correct
          content: {}
        '500':
          description: Internal Server Error.
          content: {}
      deprecated: false
      x-codegen-request-body-name: generateOrder
  /job/sim/voluntary/resume:
    post:
      tags:
      - SIM LifeCycle
      summary: Out of Safe Custody
      description: In case the user wishes to change the number state from Suspended to Active state,
        this API shall allow user to do the same on that Billable account. It requires inputs as mobile
        number.
      operationId: outOfSafeCustodyUsingPOST
      parameters:
      - name: Authorization
        in: header
        description: Authorization Header (Value must be like Bearer <Developer Access Token>)
        required: true
        schema:
          type: string
          default: Bearer XXXXXXXXXXXXXX
      - name: apikey
        in: header
        description: Developer API Key
        required: true
        schema:
          type: string
      - name: customer-id
        in: header
        description: 'Unique ID to identify Customer (shared during On-Boarding process) '
        required: true
        schema:
          type: integer
          format: int64
      - name: iv-user
        in: header
        description: Developer Account User ID
        required: true
        schema:
          type: string
      requestBody:
        description: generateOrder
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerateOrder'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobVO'
        '201':
          description: Resource Created Successfully
          content: {}
        '400':
          description: Request Message is not correct
          content: {}
        '500':
          description: Internal Server Error.
          content: {}
      deprecated: false
      x-codegen-request-body-name: generateOrder
  /job/temp/disconnect:
    post:
      tags:
      - SIM LifeCycle
      summary: Temp Disconnection
      description: This API is used to initiate disconnection of M2M SIMs. Initially, SIMs will go into
        temporary disconnection for 5 days and then SIMs will be permanently disconnected on completion
        of 5 days.
      operationId: tempDisconnectionUsingPOST
      parameters:
      - name: Authorization
        in: header
        description: Authorization Header (Value must be like Bearer <Developer Access Token>)
        required: true
        schema:
          type: string
          default: Bearer XXXXXXXXXXXXXX
      - name: apikey
        in: header
        description: Developer API Key
        required: true
        schema:
          type: string
      - name: customer-id
        in: header
        description: 'Unique ID to identify Customer (shared during On-Boarding process) '
        required: true
        schema:
          type: integer
          format: int64
      - name: iv-user
        in: header
        description: Developer Account User ID
        required: true
        schema:
          type: string
      requestBody:
        description: generateOrder
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GeneratedTempDisconnectOrder'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobVO'
        '201':
          description: Resource Created Successfully
          content: {}
        '400':
          description: Request Message is not correct
          content: {}
        '500':
          description: Internal Server Error.
          content: {}
      deprecated: false
      x-codegen-request-body-name: generateOrder
  /job/td/resume:
    post:
      tags:
      - SIM LifeCycle
      summary: Resume from TD
      description: This API is used to resume SIMs from temporary disconnection within 5 days of initiation
        of disconnection.
      operationId: tdResumeUsingPOST
      parameters:
      - name: Authorization
        in: header
        description: Authorization Header (Value must be like Bearer <Developer Access Token>)
        required: true
        schema:
          type: string
          default: Bearer XXXXXXXXXXXXXX
      - name: apikey
        in: header
        description: Developer API Key
        required: true
        schema:
          type: string
      - name: customer-id
        in: header
        description: 'Unique ID to identify Customer (shared during On-Boarding process) '
        required: true
        schema:
          type: integer
          format: int64
      - name: iv-user
        in: header
        description: Developer Account User ID
        required: true
        schema:
          type: string
      requestBody:
        description: generateOrder
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerateOrder'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobVO'
        '201':
          description: Resource Created Successfully
          content: {}
        '400':
          description: Request Message is not correct
          content: {}
        '500':
          description: Internal Server Error.
          content: {}
      deprecated: false
      x-codegen-request-body-name: generateOrder
  /details/basket/{basketId}/sims:
    get:
      tags:
      - Inventory Management
      summary: Fetch SIMs.
      description: This API shall allow user to fetch the details of SIMs in a particular Basket on that
        Customer Account. It can fetch the details of one or more SIMs at a time from a particular basket
        including SIM details, Plan details, SIM status, and other required details of SIMs in basket
        as it is shown on the CMP portal.
      operationId: fetchCustomerSimsUsingGET
      parameters:
      - name: Authorization
        in: header
        description: Authorization Header (Value must be like Bearer <Developer Access Token>)
        required: true
        schema:
          type: string
          default: Bearer XXXXXXXXXXXXXX
      - name: apikey
        in: header
        description: Developer API Key
        required: true
        schema:
          type: string
      - name: basketId
        in: path
        description: Basket ID
        required: true
        schema:
          type: integer
          format: int64
          default: 0
      - name: customer-id
        in: header
        description: 'Unique ID to identify Customer (shared during On-Boarding process) '
        required: true
        schema:
          type: integer
          format: int64
      - name: filterValue
        in: query
        description: Value on which Sims to be filtered
        allowEmptyValue: false
        schema:
          type: string
      - name: iv-user
        in: header
        description: Developer Account User ID
        required: true
        schema:
          type: string
      - name: pageNo
        in: query
        description: Page Number in case of pagination. Default Page No. is 1.
        allowEmptyValue: false
        schema:
          type: integer
          format: int32
          default: 1
      - name: pageSize
        in: query
        description: Page Size in pagination. Default Page Size is 25 and Maximum is 100.
        allowEmptyValue: false
        schema:
          type: integer
          format: int32
          default: 25
      - name: simFilterType
        in: query
        description: 'Filter Type on which Sims to be filtered. The allowed types are MSISDN / SIM '
        allowEmptyValue: false
        schema:
          type: string
          enum:
          - MSISDN
          - SIM_NO
          - IMSI
      - name: simStatus
        in: query
        description: Status of SIM(s) being fetched from a basket
        allowEmptyValue: false
        schema:
          type: string
          enum:
          - INITIAL
          - ACTIVE
          - SAFE_CUSTODY
          - ACTIVATED_ON_TEST_MODE
          - IN_PROGRESS
          - SUSPENDED
          - TEMP_DISCONNECT
          - ACTIVE_AND_SAFE_CUSTODY
          - ACTIVE_AND_TEMP_DISCONNECT
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Sims'
        '400':
          description: Request Message is not correct
          content: {}
        '500':
          description: Internal Server Error.
          content: {}
      deprecated: false
components:
  schemas:
    SMSQuotaVO:
      title: SMSQuotaVO
      type: object
      properties:
        expiryDate:
          type: string
          example: dd/MM/yyyy
        outgoingSMSBalance:
          type: integer
          format: int64
        rolloverSMSQuota:
          type: integer
          format: int64
        totalBalance:
          type: integer
          format: int64
    CustomerPlanResponseVO:
      title: CustomerPlanResponseVO
      type: object
      properties:
        customerPlanVOs:
          type: array
          items:
            $ref: '#/components/schemas/CustomerPlanVO'
        totalRecords:
          type: integer
          format: int64
    DeviceRadiusResponseVO:
      title: DeviceRadiusResponseVO
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/RadiusObjects'
        resCode:
          type: string
        resStatus:
          type: string
        totalCount:
          type: integer
          format: int32
    SMSWTLDetailsVO:
      title: SMSWTLDetailsVO
      type: object
      properties:
        basketName:
          type: string
        msisdn:
          type: string
        remainingOrderCount:
          type: string
        simNo:
          type: string
        whitelistNumber1:
          type: string
        whitelistNumber2:
          type: string
        whitelistNumber3:
          type: string
        whitelistNumber4:
          type: string
        whitelistType1:
          type: string
        whitelistType2:
          type: string
        whitelistType3:
          type: string
        whitelistType4:
          type: string
    SimDetailsVO:
      title: SimDetailsVO
      type: object
      properties:
        activationDate:
          type: string
        basketId:
          type: string
        circleName:
          type: string
        dataType:
          type: string
        dataUnits:
          type: string
        description:
          type: string
        imsi:
          type: string
        inProgressJob:
          type: string
        inProgressJobOrder:
          type: string
        isPaired:
          type: string
        isPrepaidSim:
          type: string
        lsi:
          type: string
        mobileNo:
          type: string
        onboardingDate:
          type: string
        parentBasketId:
          type: string
        planCode:
          type: string
        planName:
          type: string
        planType:
          type: string
        safeCustodyDate:
          type: string
        simApnVO:
          type: array
          items:
            $ref: '#/components/schemas/SimApnVO'
        simId:
          type: string
        simInfo1:
          type: string
        simInfo2:
          type: string
        simInfo3:
          type: string
        simNo:
          type: string
        simTrailEndTime:
          type: string
        simTrailStartTime:
          type: string
        status:
          type: string
    GenerateOrder:
      title: GenerateOrder
      required:
      - simDOList
      type: object
      properties:
        simDOList:
          type: array
          description: List of SIM
          items:
            $ref: '#/components/schemas/SimDO'
    SMSWTLResponse:
      title: SMSWTLResponse
      type: object
      properties:
        smsWTDetailsVO:
          type: array
          items:
            $ref: '#/components/schemas/SMSWTLDetailsVO'
        total:
          type: integer
          format: int32
    WhitelistNumberDO:
      title: WhitelistNumberDO
      type: object
      properties:
        msisdn:
          type: string
        whitelistNumber1:
          type: string
          description: Whitelist Number 1
        whitelistNumber2:
          type: string
          description: Whitelist Number 2
        whitelistNumber3:
          type: string
          description: Whitelist Number 3
        whitelistNumber4:
          type: string
          description: Whitelist Number 4
        whitelistNumberType1:
          type: string
          description: provide whitelist type from one of the allowed values
          example: ${whitelist.type.example}
          enum:
          - ${INCOMING
          - OUTGOING
          - INCOMINGANDOUTGOING}
        whitelistNumberType2:
          type: string
          description: provide whitelist type from one of the allowed values
          example: ${whitelist.type.example}
          enum:
          - ${INCOMING
          - OUTGOING
          - INCOMINGANDOUTGOING}
        whitelistNumberType3:
          type: string
          description: provide whitelist type from one of the allowed values
          example: ${whitelist.type.example}
          enum:
          - ${INCOMING
          - OUTGOING
          - INCOMINGANDOUTGOING}
        whitelistNumberType4:
          type: string
          description: provide whitelist type from one of the allowed values
          example: ${whitelist.type.example}
          enum:
          - ${INCOMING
          - OUTGOING
          - INCOMINGANDOUTGOING}
    GenerateOrderWithPlan:
      title: GenerateOrderWithPlan
      required:
      - simDOList
      type: object
      properties:
        simDOList:
          type: array
          description: List of SIM
          items:
            $ref: '#/components/schemas/SimDOWithPlan'
    DeviceAttributesDO:
      title: DeviceAttributesDO
      type: object
      properties:
        attrName:
          type: string
        attrValue:
          type: string
    SMSBatchDO:
      title: SMSBatchDO
      type: object
      properties:
        simsDO:
          type: array
          items:
            $ref: '#/components/schemas/SimDO'
    SmsTemplateView:
      title: SmsTemplateView
      type: object
      properties:
        smsTemplates:
          type: array
          items:
            $ref: '#/components/schemas/SmsTemplate'
        totalRecords:
          type: integer
          format: int32
    CustomerPlanVO:
      title: CustomerPlanVO
      type: object
      properties:
        active:
          type: boolean
        allowedOutgoingSMSCount:
          type: integer
          format: int64
        billingPeriod:
          type: string
        daysValidity:
          type: integer
          format: int64
        description:
          type: string
        effectiveRatePerSMS:
          type: string
        expiryDate:
          type: string
        messageExpiryDays:
          type: integer
          format: int64
        monthlyRental:
          type: integer
          format: int64
        outgoingSMSBalance:
          type: integer
          format: int64
        planCode:
          type: string
        planName:
          type: string
        purchaseDateWithoutTime:
          type: string
        purchasedDate:
          type: string
        subscriptionEvent:
          type: string
    DataSegregation:
      title: DataSegregation
      type: object
      properties:
        activePlanQuota:
          $ref: '#/components/schemas/ActivePlanQuota'
        rolloverQuota:
          $ref: '#/components/schemas/RolloverQuota'
    SimApnVO:
      title: SimApnVO
      type: object
      properties:
        attachedApnIp:
          type: string
        attachedApnIpType:
          type: string
        attachedApnName:
          type: string
        attchedApnType:
          type: string
    DownloadHistoryVO:
      title: DownloadHistoryVO
      type: object
      properties:
        basketName:
          type: string
          description: Basket Name
        completionDate:
          type: string
          description: Download Request Completion Date and Time
        creationDate:
          type: string
          description: Download Request Creation Date and Time
        downloadFileId:
          type: integer
          description: Download Request ID
          format: int64
        downloadType:
          type: string
          description: Download Type
        extension:
          type: string
          description: File Extension
        fileName:
          type: string
          description: File Name
        progress:
          type: integer
          description: File Download Progress
          format: int32
        status:
          type: string
          description: Download Status
    DataUsageResponseVO:
      title: DataUsageResponseVO
      type: object
      properties:
        basketName:
          type: string
          description: Basket Name
        dataSegregation:
          $ref: '#/components/schemas/DataSegregation'
        dataUsageFound:
          type: boolean
        dataUsageUnits:
          type: string
        error:
          type: string
          description: Error Message
        mobileNo:
          type: string
          description: Mobile Number
        planCode:
          type: string
          description: Plan Code
        planName:
          type: string
          description: Plan Name
        prepaid:
          type: boolean
        remainingDataUsage:
          type: string
          description: Remaining Data
        simNo:
          type: string
          description: SIM Number
        totalDataUsage:
          type: string
          description: Total Data Usage
        usedDataUsage:
          type: string
          description: Used Data
    OrderVO:
      title: OrderVO
      type: object
      properties:
        mobileNo:
          type: string
        orderCompletionTime:
          type: string
        orderId:
          type: integer
          format: int64
        orderInitiateDate:
          type: string
        orderStatus:
          type: string
        orderType:
          type: string
        remarks:
          type: string
        simNo:
          type: string
    Baskets:
      title: Baskets
      type: object
      properties:
        baskets:
          type: array
          items:
            $ref: '#/components/schemas/BasketDetailsVO'
        totalActiveSims:
          type: string
        totalAvailableSims:
          type: string
        totalBaskets:
          type: string
        totalInActiveSims:
          type: string
        totalInProgressSims:
          type: string
        totalSafeCustodySims:
          type: string
        totalSims:
          type: string
        totalSuspendedSims:
          type: string
        totalTestModeSims:
          type: string
    BasketDetailsVO:
      title: BasketDetailsVO
      type: object
      properties:
        activeSims:
          type: string
        availableSims:
          type: string
        basketId:
          type: string
        basketName:
          type: string
        basketPermission:
          type: string
        creationDate:
          type: string
        customerId:
          type: string
        emailId:
          type: string
        firstName:
          type: string
        inActiveSims:
          type: string
        inProgressSims:
          type: string
        lastName:
          type: string
        managedBy:
          type: string
        mobileNo:
          type: string
        parentBasketId:
          type: string
        remarks:
          type: string
        safeCustodySims:
          type: string
        suspendedSims:
          type: string
        testModeSims:
          type: string
        totalSims:
          type: string
    CustomerContactsVO:
      title: CustomerContactsVO
      type: object
      properties:
        emailAddress:
          type: string
        isPrimary:
          type: string
        mobileNo:
          type: string
        type:
          type: string
    CustomSMSBatchDO:
      title: CustomSMSBatchDO
      type: object
      properties:
        customMessageDOS:
          type: array
          items:
            $ref: '#/components/schemas/CustomMessageDO'
    SimDOWithPlan:
      title: SimDOWithPlan
      required:
      - mobileNO
      type: object
      properties:
        mobileNO:
          type: string
          description: Mobile No.
        planDO:
          $ref: '#/components/schemas/PlanDO'
    UpdateSimKycResponseVo:
      title: UpdateSimKycResponseVo
      type: object
      properties:
        message:
          type: string
    MessageHistory:
      title: MessageHistory
      type: object
      properties:
        messageDetails:
          type: array
          items:
            $ref: '#/components/schemas/Sms'
        total:
          type: integer
          format: int32
    DownloadHistoriesVo:
      title: DownloadHistoriesVo
      type: object
      properties:
        downloadHistories:
          type: array
          items:
            $ref: '#/components/schemas/DownloadHistoryView'
        total:
          type: string
    PlanDO:
      title: PlanDO
      required:
      - planCode
      type: object
      properties:
        planCode:
          type: string
          description: Plan Code
    Sms:
      title: Sms
      type: object
      properties:
        message:
          type: string
        messageDate:
          type: string
        messageFailureCode:
          type: string
        messageJobId:
          type: integer
          format: int64
        messageOrderId:
          type: integer
          format: int64
        messageStatus:
          type: string
        messageStatusRemarks:
          type: string
        messageText:
          type: string
        messageType:
          type: string
        msisdn:
          type: string
        sentBy:
          type: string
        shortCode:
          type: string
        status:
          type: string
        templateName:
          type: string
    OrderVOResponse:
      title: OrderVOResponse
      type: object
      properties:
        orderVOs:
          type: array
          items:
            $ref: '#/components/schemas/OrderVO'
        total:
          type: integer
          format: int64
    Sims:
      title: Sims
      type: object
      properties:
        sims:
          type: array
          items:
            $ref: '#/components/schemas/SimDetailsVO'
        total:
          type: string
    DownloadHistoryView:
      title: DownloadHistoryView
      type: object
      properties:
        basketName:
          type: string
          description: Basket Name
        completionDate:
          type: string
          description: Download Request Completion Date and Time
        creationDate:
          type: string
          description: Download Request Creation Date and Time
        downloadFileId:
          type: integer
          description: Download Request ID
          format: int64
        downloadType:
          type: string
          description: Download Type
        extension:
          type: string
          description: File Extension
        fileName:
          type: string
          description: File Name
        progress:
          type: integer
          description: File Download Progress
          format: int32
        status:
          type: string
          description: Download Status
    SimDO:
      title: SimDO
      required:
      - mobileNO
      type: object
      properties:
        mobileNO:
          type: string
          description: Mobile No.
    Orders:
      title: Orders
      type: object
      properties:
        orders:
          type: array
          items:
            $ref: '#/components/schemas/OrderVO'
        total:
          type: string
    DownloadTemplateDO:
      title: DownloadTemplateDO
      type: object
      properties:
        basketId:
          type: integer
          format: int32
        smsData:
          type: string
          enum:
          - Y
          - N
    PlanDetailsVO:
      title: PlanDetailsVO
      type: object
      properties:
        planCode:
          type: string
        planDescription:
          type: string
        planName:
          type: string
        testPlan:
          type: boolean
    DownloadTemplate:
      title: DownloadTemplate
      required:
      - basketId
      type: object
      properties:
        action:
          type: string
          enum:
          - ALL
          - ACTIVATE_ORDER
          - CHANGE_ORDER
          - ACTIVATE_TEST_ORDER
        basketId:
          type: integer
          description: Basket ID
          format: int64
    SmsWhitelistBatchDO:
      title: SmsWhitelistBatchDO
      type: object
      properties:
        simWTDoList:
          type: array
          items:
            $ref: '#/components/schemas/SmsWhitelistNoDO'
    JobVoResponse:
      title: JobVoResponse
      type: object
      properties:
        jobs:
          type: array
          items:
            $ref: '#/components/schemas/JobVO'
        total:
          type: string
    JobVO:
      title: JobVO
      type: object
      properties:
        errorFileName:
          type: string
          description: Error File Name
        errorItemsCount:
          type: integer
          description: Count of Error items in uploaded file.
          format: int32
        failureCount:
          type: integer
          description: Failure Order Count
          format: int32
        inProgressCount:
          type: integer
          description: In Progress Order Count
          format: int32
        jobId:
          type: integer
          description: Job ID, in case a particular Job ID to be fetched
          format: int64
        jobType:
          type: string
          description: Job Type as defined in CMP
        orderCompletionTime:
          type: string
          description: End Date in a date range to fetch Job IDs
        orderCount:
          type: integer
          description: Order Count
          format: int32
        orderInitiateDate:
          type: string
          description: Start Date in a date range to fetch Job IDs
        rejectedCount:
          type: integer
          description: Rejected Order Count
          format: int32
        requestedOrderItems:
          type: integer
          description: Count of items requested in uploaded file.
          format: int32
        statusCode:
          type: string
          description: Job Status Code
        statusMessage:
          type: string
          description: Status of Job IDs
        successCount:
          type: integer
          description: Success Order Count
          format: int32
        uploadFileName:
          type: string
          description: Upload File Name
    ActivePlanQuota:
      title: ActivePlanQuota
      type: object
      properties:
        allocatedQuota:
          type: string
        availableQuota:
          type: string
        quotaUnit:
          type: string
    Jobs:
      title: Jobs
      type: object
      properties:
        jobs:
          type: array
          items:
            $ref: '#/components/schemas/JobVO'
        total:
          type: string
    SimKycDetailsWOPlanVO:
      title: SimKycDetailsWOPlanVO
      type: object
      properties:
        activationDate:
          type: string
        complianceDate:
          type: string
        kycCompletionDate:
          type: string
        mobileNo:
          type: string
        simNo:
          type: string
        simStatus:
          type: string
        status:
          type: string
    GeneratedTempDisconnectOrder:
      title: GeneratedTempDisconnectOrder
      required:
      - reason
      - simDOList
      type: object
      properties:
        reason:
          type: string
          description: Disconnection Reason.
          enum:
          - NUMBER_NOT_REQUIRED
          - PRICING_CONCERN
          - NETWORK_COVERAGE_ISSUE
          - BILLING_OR_COLLECTION_ISSUE
          - CONTRACT_EXPIRED
        simDOList:
          type: array
          description: List of SIM
          items:
            $ref: '#/components/schemas/SimDO'
    SimKycDo:
      title: SimKycDo
      required:
      - custodianAddress
      - custodianName
      - deviceImei
      - deviceModel
      - deviceType
      - mobileNo
      - registrationNo
      type: object
      properties:
        attribute1:
          type: string
        attribute2:
          type: string
        attribute3:
          type: string
        attribute4:
          type: string
        attribute5:
          type: string
        custodianAddress:
          type: string
          description: custodian address.
        custodianName:
          type: string
          description: custodian name.
        deviceImei:
          type: string
          description: device imei.
        deviceModel:
          type: string
          description: device model.
        deviceType:
          type: string
          description: type of device.
          enum:
          - VEHICLE_TRACKING
          - SMART_METER
          - ASSET_TRACKING
          - POS_MACHINE
          - HOME_AUTOMATION
          - INDUSTRIAL_AUTOMATION
          - SURVEILLANCE
          - PERSONAL_TRACKER
          - TRAFFIC_MANAGEMENT
          - OTHERS
        deviceTypeOthers:
          type: string
          description: Device Type(Others)
        mobileNo:
          type: string
          description: mobilerNumber for which kyc needs to be done.
        registrationNo:
          type: string
          description: registration number.
    DownloadSmsTemplateVO:
      title: DownloadSmsTemplateVO
      type: object
      properties:
        basketName:
          type: string
        completionDate:
          type: string
        creationDate:
          type: string
        downloadFileId:
          type: integer
          format: int32
        downloadType:
          type: string
        extension:
          type: string
        fileName:
          type: string
        progress:
          type: integer
          format: int32
        status:
          type: string
    BulkSms:
      title: BulkSms
      type: object
      properties:
        createdBy:
          type: string
        customerId:
          type: integer
          format: int64
        errorFileName:
          type: string
        failureOrders:
          type: integer
          format: int32
        jobCreationTime:
          type: string
          format: date-time
        jobId:
          type: integer
          format: int64
        jobStatus:
          type: string
        jobType:
          type: string
        rejectedOrders:
          type: integer
          format: int32
        successOrders:
          type: integer
          format: int32
        totalOrders:
          type: integer
          format: int32
        uploadFileName:
          type: string
    SimKycDetailsWOPlan:
      title: SimKycDetailsWOPlan
      type: object
      properties:
        simKycList:
          type: array
          items:
            $ref: '#/components/schemas/SimKycDetailsWOPlanVO'
        totalRecords:
          type: integer
          format: int64
    SwapSim:
      title: SwapSim
      type: object
      properties:
        existingSIMNo:
          type: string
        newSIMNo:
          type: string
    WhitelistVO:
      title: WhitelistVO
      type: object
      properties:
        basketName:
          type: string
        msisdn:
          type: string
        remainingOrderCount:
          type: integer
          format: int32
        simNo:
          type: string
        voiceWhitelisted:
          type: string
        whitelistNumber1:
          type: string
        whitelistNumber2:
          type: string
        whitelistNumber3:
          type: string
        whitelistNumber4:
          type: string
        whitelistType1:
          type: string
        whitelistType2:
          type: string
        whitelistType3:
          type: string
        whitelistType4:
          type: string
    DeviceFrequencyDO:
      title: DeviceFrequencyDO
      type: object
      properties:
        band:
          type: string
        technology:
          type: string
    CustomerPreferencesVO:
      title: CustomerPreferencesVO
      type: object
      properties:
        additionalCustEmailId:
          type: string
        additionalCustMobileNo:
          type: string
        additionalCustName:
          type: string
        additionalCustomerEmailId:
          type: string
        additionalCustomerMobileNo:
          type: string
        additionalCustomerName:
          type: string
        alternatePhoneNumber:
          type: string
        attribute1:
          type: string
        attribute2:
          type: string
        attribute3:
          type: string
        attribute4:
          type: string
        attribute5:
          type: string
        createdBy:
          type: string
        createdOn:
          type: string
        defaultAddress:
          type: string
        defaultEmail:
          type: string
        lastUpdatedBy:
          type: string
        lastUpdatedOn:
          type: string
        notifyActivationSim:
          type: boolean
        notifyBasketCreated:
          type: boolean
        notifyByEmail:
          type: boolean
        notifyBySMS:
          type: boolean
        notifyBySms:
          type: boolean
        notifyFreshOrder:
          type: boolean
        notifyLOC:
          type: boolean
        notifyLoc:
          type: boolean
        notifyPlanChange:
          type: boolean
        notifyPlanChanged:
          type: boolean
        notifySimActivation:
          type: boolean
        prepaidCustomer:
          type: boolean
        primaryPhoneNumber:
          type: string
        primaryPhoneNumberSetDefault:
          type: boolean
    SmsWhitelistNoDO:
      title: SmsWhitelistNoDO
      required:
      - msisdn
      type: object
      properties:
        msisdn:
          type: string
          description: Mobile No.
        whitelistNumber1:
          type: string
          description: First number for whitelist
        whitelistNumber2:
          type: string
          description: Second number for whitelist
        whitelistNumber3:
          type: string
          description: Third number for whitelist
        whitelistNumber4:
          type: string
          description: Fourth number for whitelist
        whitelistNumberType1:
          type: string
          example: INCOMING
          enum:
          - ${SmsWhitelistNoDO.SMSWtlTypes.allowableValues}
        whitelistNumberType2:
          type: string
          example: INCOMING
          enum:
          - ${SmsWhitelistNoDO.SMSWtlTypes.allowableValues}
        whitelistNumberType3:
          type: string
          example: OUTGOING
          enum:
          - ${SmsWhitelistNoDO.SMSWtlTypes.allowableValues}
        whitelistNumberType4:
          type: string
          example: OUTGOING
          enum:
          - ${SmsWhitelistNoDO.SMSWtlTypes.allowableValues}
    CustomerAddressVO:
      title: CustomerAddressVO
      type: object
      properties:
        addressLine1:
          type: string
        addressLine2:
          type: string
        addressLine3:
          type: string
        addressType:
          type: string
        billingAddress:
          type: string
        city:
          type: string
        country:
          type: string
        pincode:
          type: string
        state:
          type: string
    BasketDO:
      title: BasketDO
      required:
      - basketId
      type: object
      properties:
        basketId:
          type: integer
          description: Basket ID
          format: int64
    SmsTemplate:
      title: SmsTemplate
      type: object
      properties:
        createdBy:
          type: string
        createdOn:
          type: string
        lastUpdatedBy:
          type: string
        lastUpdatedOn:
          type: string
        status:
          type: string
        templateId:
          type: number
        templateName:
          type: string
        templateTxt:
          type: string
        totalRecords:
          type: number
        version:
          type: number
    RolloverQuota:
      title: RolloverQuota
      type: object
      properties:
        allocatedQuota:
          type: string
        availableQuota:
          type: string
        quotaUnit:
          type: string
    CustomMessageDO:
      title: CustomMessageDO
      required:
      - binarySMS
      - customMessage
      - mobileNO
      type: object
      properties:
        binarySMS:
          type: boolean
          description: 'false'
        customMessage:
          type: string
          description: Message to send against Mobile Number. Maximum length of message can be 160 characters.
        mobileNO:
          type: string
          description: Mobile No.
    CustomerStats:
      title: CustomerStats
      type: object
      properties:
        totalActiveSims:
          type: string
        totalAvailableSims:
          type: string
        totalBaskets:
          type: string
        totalInActiveSims:
          type: string
        totalInProgressSims:
          type: string
        totalSafeCustodySims:
          type: string
        totalSims:
          type: string
        totalSuspendedSims:
          type: string
        totalTempDisconnectedSims:
          type: string
        totalTestModeSims:
          type: string
        userStats:
          type: array
          items:
            $ref: '#/components/schemas/UserStats'
    UserStats:
      title: UserStats
      type: object
      properties:
        firstName:
          type: string
        lastName:
          type: string
        totalUserBaskets:
          type: string
        totalUserSims:
          type: string
        userId:
          type: string
    CustomerDetailsVO:
      title: CustomerDetailsVO
      type: object
      properties:
        aadhaarNo:
          type: string
        accountCategory:
          type: string
        accountType:
          type: string
        activeSIMs:
          type: integer
          format: int32
        address:
          type: string
        alternatePhoneNumber:
          type: string
        apn:
          type: string
        attribute1:
          type: string
        attribute2:
          type: string
        availableSIMs:
          type: integer
          format: int32
        billCycle:
          type: string
        billCycleCutOff:
          type: string
        billMedia:
          type: string
        billType:
          type: string
        billingAddress:
          type: string
        billingCycle:
          type: string
        caAccountNo:
          type: string
        circleId:
          type: string
        cmpType:
          type: string
        companyCode:
          type: string
        coordinatorEmailId:
          type: string
        coordinatorMobile:
          type: string
        coordinatorName:
          type: string
        createdBy:
          type: string
        createdOn:
          type: string
        creditLimit:
          type: string
        crm:
          type: string
        custClass:
          type: string
        custRank:
          type: string
        customerAccountNumber:
          type: string
        customerAddressVO:
          type: array
          items:
            $ref: '#/components/schemas/CustomerAddressVO'
        customerBillableId:
          type: string
        customerCircleId:
          type: string
        customerContactsVO:
          type: array
          items:
            $ref: '#/components/schemas/CustomerContactsVO'
        customerId:
          type: integer
          format: int32
        customerName:
          type: string
        customerPreferencesVO:
          $ref: '#/components/schemas/CustomerPreferencesVO'
        customerType:
          type: string
        emailAddress:
          type: string
        groupAccount:
          type: string
        groupAccountServ:
          type: string
        gstNo:
          type: string
        inActiveSIMs:
          type: integer
          format: int32
        inProgressSIMs:
          type: integer
          format: int32
        kycAgreementTime:
          type: string
        kycIPAddress:
          type: string
        kycagreed:
          type: boolean
        lastUpdatedBy:
          type: string
        lastUpdatedOn:
          type: string
        liveCustomer:
          type: boolean
        localAddress:
          type: string
        m2mSolution:
          type: string
        maxBasketSize:
          type: integer
          format: int32
        panNo:
          type: string
        parentAccountNumber:
          type: string
        permanentAddress:
          type: string
        preferredLanguage:
          type: string
        primaryLSI:
          type: string
        primaryPhoneNumber:
          type: string
        primaryPhoneSetDefault:
          type: boolean
        primaryServiceNo:
          type: string
        productType:
          type: string
        safeCustodySIMs:
          type: integer
          format: int32
        secondaryLSI:
          type: string
        secondaryServiceNo:
          type: string
        status:
          type: string
        tanNo:
          type: string
        tdsPercentage:
          type: string
        testModeSIMs:
          type: integer
          format: int32
        tinNo:
          type: string
        totalBasketCount:
          type: integer
          format: int32
        totalCustomer:
          type: integer
          format: int32
        totalNoOfSim:
          type: integer
          format: int32
        totalSIMs:
          type: integer
          format: int32
        uinNo:
          type: string
        userAcceptingKYC:
          type: string
    WhitelistResponse:
      title: WhitelistResponse
      type: object
      properties:
        total:
          type: integer
          format: int32
        whitelistDetails:
          type: array
          items:
            $ref: '#/components/schemas/WhitelistVO'
    RadiusObjects:
      title: RadiusObjects
      type: object
      properties:
        3GPPIMEISV:
          type: string
        3GPPIMSI:
          type: string
        3GPPIMSIMCCMNC:
          type: string
        3GPPRATType:
          type: string
        3GPPSessionStopIndicator:
          type: integer
          format: int64
        acctInputPackets:
          type: string
        acctOutputPackets:
          type: string
        acctSessionId:
          type: string
        acctStatusType:
          type: string
        acctTerminateCause:
          type: string
        calledStationId:
          type: string
        callingStationId:
          type: string
        framedIPAddress:
          type: string
        sessionStartTimestamp:
          type: string
        sessionStopTimestamp:
          type: string
        totalActiveSession:
          type: string
    DeviceIMEIResponseVO:
      title: DeviceIMEIResponseVO
      type: object
      properties:
        deviceAttributes:
          type: array
          description: Device Attributes List
          items:
            $ref: '#/components/schemas/DeviceAttributesDO'
        deviceFrequencies:
          type: array
          description: Device Frequencies List.
          items:
            $ref: '#/components/schemas/DeviceFrequencyDO'
        deviceIMEI:
          type: string
          description: Device IMEI
        deviceIMEIChanged:
          type: boolean
        deviceModelNumber:
          type: string
          description: Device Model Number.
        deviceName:
          type: string
          description: Device Name
        deviceType:
          type: string
          description: Device Type
        operatingSystemName:
          type: string
          description: Operating System Name.
        operatingSystemProvider:
          type: string
          description: Operating System Provider
        operatingSystemVersion:
          type: string
          description: Operating System Version
        otaSupport:
          type: string
          description: OTA Support
        previousDeviceIMEI:
          type: string
          description: Previous Device IMEI