openapi: '3.0.2'
info:
  title: Signalmash API Platform
  version: '1.0'
  description: "Every API request authenticates the user, which you may do through the customer's site by creating tokens. Customers can now use the same or different tokens for each activity they make, thanks to a single management location.</br>Log in to the portal, then go to the API Menu and select \"Tokens\" from the submenu.</br>
    To make a token, go to the right upper corner and click \"Add Token.\"</br>
    There will be a pop-up window. Choose the function (s) to link to the token."
servers:
  #  - url: http://localhost:4219
  - url: https://signalmashdbtest.gventure.info/api

components:
  securitySchemes:
    Bearer:
      type: apiKey
      name: Authorization
      in: header 

  tags:
    - name: Login
      description:
      externalDocs:
        url: http://docs.my-api.com/pet-operations.htm 

paths:  
  # /apilogin:
  #   post:
  #     description: <h3>The Login API is used to verify a user's API Username (Token Name) and API Key.  The function outputs your validated session token which is used to authenticate all your Signalmash API calls.</h3> 
  #     tags:
  #       - Login
  #     requestBody:
  #       required: true
  #       content:  
  #         application/x-www-form-urlencoded:  
  #           schema:
  #             type: object
  #             properties:
  #               Username:
  #                 type: string   
  #                 description: Enter Your Token Name 
  #               Password:
  #                 type: string  
  #                 description: Enter Your Api Key   
  #             required:
  #               - Username
  #               - Password        
  #     responses:
  #       '200': 
  #         description: Login  Successfully   
          
  # /deleteAccount:
  #   put:
  #     summary: Delete My Account
  #     description: <h3>This Function Will Provide Ability To Disable Accounts and Endpoints/Connections </h3>
  #     tags:
  #      - Account
  #     security:
  #       - Bearer: []  
  #     responses:
  #       '201':
  #         description: Account Detail Find Successfully.
  
  /checkBalance:
    get:
      summary: Get Account Balance.
      description: <h3>To Check balance</h3>
      tags:
        - Account
      parameters:
        - name: apiKey
          in: query
          description: Enter API Key
          required: true
          schema:
            type: string
      security:
        - Bearer: []   
      responses:
        '200':
          description: Balance Fetched Successfully.

  /webhookSubscription:
    put:
      summary: Subscribe API Webhook.
      description: <h3>Subscribe to receive notifications of an "event category". Make sure your network policy allows HTTP POST to be accepted from internet.</h3>
      tags:
        - Webhook
      security:
        - Bearer: []
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                eventCategory:
                  type: boolean
                  enum: [A2P Campaign]  
                  description: "Selete one option for perform"
                webhookEndpoint:
                   type: string      
                   description: "Enter webhookEndpoint</br>Example:http://www.webhook.php"       
              required:
                - eventCategory
                - webhookEndpoint
      responses:
        '201':
          description: webhookEndpoint Added Successfully    
      
  /get_did:
    get:
      summary: Get all DIDs
      description: <h3>This endpoint will return only the DID value for all DIDs</h3>
      tags:
       - Numbers
      parameters:

        - name: campaignKey
          in: query
          required: false
          schema:
            type: string

        - name: NPA
          in: query
          required: false
          schema:
            format: int32
            type: number

        - name: NXX
          in: query
          required: false
          schema:
            format: int32
            type: number

        - name: rateCenter
          in: query
          required: false
          schema:
            type: string
            
        - name: state
          in: query
          required: false
          schema:
            type: string

        - name: start_date
          in: query
          description: Start Date in yyyy-MM-dd format
          required: false
          schema:
            type: string

        - name: end_date
          in: query
          description: End Date in yyyy-MM-dd format
          required: false
          schema:
            type: string

        - name: page
          in: query
          required: false
          schema:
            format: int32
            type: number
            minimum: 1
            default: 1
            
        - name: recordsPerPage
          in: query
          description: Maximum Limit (1 - 500)
          required: false
          schema:
            format: int32
            type: number
            minimum: 1
            maximum: 500
            default: 500
      security:
        - Bearer: []
      responses:
        '200':
          description: DIDs Fetched Successfully. 
          
  /get_did_details:
    get:
      summary: Get DID's Detail
      description: <h3>This endpoint should ask for the parameter 'DID' and return full details for this single DID requested</h3>
      tags:
       - Numbers
      parameters:
        - name: DID
          in: query
          description: You can search NN,TF and Short-code number here.
          required: true
          schema:
            type: number
      security:
        - Bearer: []
      responses:
        '200':
          description: Record Fetched Successfully.

  /get_did_all:
    get:
      summary: Get all DIDs with Details
      description: <h3>This endpoint will return FULL output values for all DIDs</h3>
      tags:
       - Numbers
      parameters:
        - name: campaignKey
          in: query
          description: Enter campaignKey.
          required: false
          schema:
            type: string
        - name: connectionKey
          in: query
          description: Enter connectionKey.
          required: false
          schema:
            type: string
      security:
        - Bearer: []
      responses:
        '200':
          description: DIDs Fetched Successfully.

  /getstate:
    get:
      description: <h3>This function is provided to assist in developing phone number search applications.</br>This function outputs the list of all two letter state, province and region abbreviations in the North American Numbering Plan.</h3>
      tags:
       - Numbers
      security:
        - Bearer: []  
      responses:
        '200':
          description: State Find Successfully.   

  /getratecenter:
    get:
      description: <h3>This function is provided to assist in developing phone number search applications.</br>This function outputs the list of all Rate Centers abbreviations in a state. Rate Center abbreviations are related to cities but in larger cities will often be more specific.</h3>
      tags:
       - Numbers
      parameters:
        - name: State
          in: query
          description: The two letter state abbreviation. Example:NJ
          required: true
          schema:
            type: string
      security:
        - Bearer: []  
      responses:
        '200':
          description: Rate Center Find Successfully.   
          
  /getnpa:
    get:
      description: <h3>This function is provided to assist in developing phone number search applications.</br>This function outputs the list of all NPAs in a state. NPA is commonly referred to as an Area Code, the first three digits of a North American Numbering Plan phone number.</h3>
      tags:
       - Numbers
      parameters:
        - name: State
          in: query
          description: The two letter state abbreviation. Example:NJ
          required: true
          schema:
            type: string
      security:
        - Bearer: []  
      responses:
        '200':
          description: NPA Find Successfully.      
          
  /getnxx:
    get:
      description: <h3>This function is provided to assist in developing phone number search applications.</br>This function outputs the list of all NXXs in an NPA. NXX is commonly referred to as a prefix or exchange, the second three digits of a North American Numbering Plan phone number.</h3>
      tags:
       - Numbers
      parameters:
        - name: NPA
          in: query
          description: Commonly referred to as an Area Code, the first three digits of a North American Numbering Plan phone number</br>Example:201
          required: true
          schema:
            type: string
      security:
        - Bearer: []  
      responses:
        '200':
          description: NXX Find Successfully.           

  /searchbynpa:
    get:
      description: <h3>This function allows for real-time searching of phone numbers available to be purchased.</br>With this search option NPA (Area Code) and the desired phone number Quantity (Qty) being minimally specified, with NXX (Prefix) being allowed as an optional search parameter.</br>This function outputs a list of phone numbers available to be purchased matching the submitted search criteria.</h3>
      tags:
        - Numbers
      parameters:
        - name: NPA
          in: query
          description: Commonly referred to as an Area Code, the first three digits of a North American Numbering Plan phone number</br>Example:201
          required: true
          schema:
            type: string
        - name: NXX
          in: query
          description: The second three digits of a North American Numbering Plan phone number, commonly referred to as a prefix or exchange</br>Example:200
          schema:
            type: string    
        - name: Qty
          in: query
          description: Enter the quantity of phone numbers requested as an integer number</br>Example:1
          required: true
          schema:
            type: integer 
#        - name: CampaignId
#          in: query
#          description: Enter a text character</br>Example:1
#          schema:
#            type: string    
      security:
        - Bearer: []
      responses:
        '200':
          description: DID Find Successfully.
          
  /searchbyrate:
    get:
      description: <h3>This function allows for real-time searching of phone numbers available to be purchased.</br>With this search option Rate Center abbreviation (RateCenter), the two letter State abbreviation (State) and the desired phone number Quantity (Qty) are required search parameters.</br>This function outputs a list of phone numbers available to be purchased matching the submitted search criteria.</h3>
      tags:
        - Numbers
      parameters:
        - name: RateCenter
          in: query
          description: The Rate Center abbreviation (available via getratecenter API), which is a geographical Rate Exchange Area.</br>Example:JERSEYCITY
          required: true
          schema:
            type: string
        - name: State
          in: query
          description: The two letter state abbreviation. Example:NJ
          required: true
          schema:
            type: string    
        - name: Qty
          in: query
          description: Enter the quantity of phone numbers requested as an integer number</br>Example:1
          required: true
          schema:
            type: integer 
 #       - name: CampaignId
 #         in: query
 #         description: Enter a text character</br>Example:1
 #         schema:
 #           type: string     
      security:
        - Bearer: []  
      responses:
        '200':
          description: DID Find Successfully  

  /BuyTollfree:
    post:
      description: <h3>This function allows for Buy toll free phone numbers. Quantity (Qty) are required search parameters.
      tags:
        - Numbers
      parameters:
        - name: Quantity
          in: query
          description: Enter the quantity of toll free phone numbers requested as an integer number</br>Example:1
          required: true
          schema:
            type: integer    
      security:
        - Bearer: []
      responses:
        '200':
          description: Tollfree Number Buy Successfully.
                   
  /buy:
    post:
      description: <h3>This function allows for the real-time purchase of available local and toll free phone numbers.</br>Optionally, if you have already configured a set of Connection parameters you can apply these to the number when purchased.</br>If you would like the number to use all parameters from a Connection you may choose the Connection ID value and all connection values will be used.</br>You may also choose to override just the Inbound or Outbound Connection settings for a phone number.</h3>
      tags:
        - Numbers
      security:
        - Bearer: []
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                DID:          
                   type: string
                   description: "The ten digit phone number. Example:8632146398"
                Connection:
                   type: string
                   description: "The primary Connection ID key from your Connection.</br>Example:Cd9_iamCm7UUGPxpZtBEk574e6_5xC"  
                InboundSMS:
                   type: string  
                OutboundSMS:
                   type: string 
                InboundVoice:
                   type: string  
                   description: "The INBOUND ID key from your Connection.</br>Example:d-no90P36tJljlp9shYt7oT0nKlIQo"
                OutboundVoice:
                   type: string
                   description: "The OUTBOUND ID key from your Connection.</br>Example:vHveiRH3rV8qF40zbOTZnByW9GWNRz"    
              required:
                - DID     
      responses:
        '201':
          description: DID Number Purchase Successfully  


  /enablesms:
    post:
      description: <h3>This function allows you to provision A2P text messaging (SMS/MMS) services on a local phone number.</br>You must first complete your A2P Brand and Campaign registration process before you can enable messaging service.</h3>
      tags:
       - Numbers
      security:
        - Bearer: []
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                DID:          
                   type: string
                   description: "The ten digit phone number.</br>Example:8632146398"
                CampaignId:
                   type: string 
                   description: "The Campaign ID value from your registered A2P campaign.</br>Example:CWXYZAS"          
              required:
                - DID 
                - CampaignId
      responses:
        '201':
          description: Enable SMS  Successfully   

  /importNumber:
    post:
      summary: Import External Numbers.
      description: <h3>This function allows you to Import External Numbers.</h3>
      tags:
       - Numbers
      security:
        - Bearer: []
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                DID:          
                   type: string
                   minLength: 10
                   maxLength: 10
                   description: "The ten digit phone number.</br>Example:8632146398"          
              required:
                - DID                   
      responses:
        '201':
          description: Number is Imported Successfully 
          
  /disablesms:
    delete:
      description: <h3>This function allows you to remove A2P text messaging (SMS/MMS) services from a phone number.</h3>
      tags:
       - Numbers
      parameters:
        - name: DID
          in: query
          description: "The ten digit phone number. Example:8632146398"
          required: true
          schema:
            type: string
      security:
        - Bearer: []  
      responses:
        '200':
          description: Disable Offnet Successfully.         

  #/enablesmsstatus:
  #  get:
  #    description: <h3>This function allows you to check the registry status of A2P text messaging (SMS/MMS) services on a phone number.</h3>
  #    tags:
  #     - Numbers
  #    parameters:
  #      - name: DID
  #        in: query
  #        description: "The ten digit phone number.</br>Example:8632146398"
  #        required: true
  #        schema:
  #          type: string
  #    security:
  #      - Bearer: []  
  #    responses:
  #      '200':
  #        description: Offnet status Find Successfully.        

  #/enablesmsnotifications:
  #  get:
  #    description: <h3>To find the notifications using this API</h3>
  #    tags:
  #     - Numbers
  #    parameters:
  #      - name: TID
  #        in: query
  #        description: "It is a transaction id as integer number.First time put 0 and next time put higher value of 0 liks as 105</br>Example:0"
  #        required: true
  #        schema:
  #          type: string
  #    security:
  #      - Bearer: []  
  #    responses:
  #      '200':
  #        description: Offnet status Find Successfully.           

  /disconnect:
    post:
      description: "This function allows you to remove a phone number from your account.<b>NOTE :</b> This command cannot be undone.  All services will be removed from the phone number and the number will be released from your account and may not be able to be retrieved."
      tags:
       - Numbers
      security:
        - Bearer: []
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                DID:          # <!--- form field name
                  type: string    
                  description: "It is a ten digits phone number, Example:8463216998" 
              required:
                - DID          
      responses:
        '201':
          description: DID Disconnect Successfully   

  /setConnection:
    put:
      description: "This function allows you to Update Connection"
      tags:
       - Numbers
      security:
        - Bearer: []
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                DID:          # <!--- form field name
                  type: string    
                  description: It is a ten digits phone number, Example:8463216998
                ConnectionKey:
                  type: string    
                  description: Please Provide Connection Key 
              required:
                - DID 
                - ConnectionKey        
      responses:
        '201':
          description: Connection Update Successfully  

  /getnumberdetails:
    get:
      description: <h3>This function allows you to systematically ascertain information about USA and Canada phone numbers to help you determine if numbers belong to a valid range of phone numbers, the servicing network operator, location and type of number.</h3>
      tags:
       - Lookups
      parameters:        
        - name: DID
          in: query
          description: Enter 10 Digits Number. Example:8632146398
          required: true
          schema:
            type: number
        - name: lookupType
          in: query
          description: "Choose lookupType</br>Example: dnc"
          required: true
          schema:
            type: string
            enum: 
              - lrn
              - dnc
            default: lrn
      security:
        - Bearer: []  
      responses:
        '200':
          description: Network Operators Find Successfully.         

          
  /listconnection:
    get:
      description: <h3>Use this API to return configured connection information. The response will list available Connection Keys for use with your API calls. A connection contains the settings for all trunk group and related telephony settings. It also contains the information for directing your messaging replies.</h3>
      tags:
        - Connection
      security:
        - Bearer: []
      responses:
        '200':
          description: Get id Succesfully.

  /saveconnection:
    post:
      description: <h3>Use this API to Add a New Connection. The Connection Name is a required parameter.</h3>
      tags:
        - Connection
      security:
        - Bearer: []
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                connectionName:          
                   type: string
                   description: "Enter Connection Name</br>Example:TestConnection"       
              required:
                - connectionName    
      responses:
        '201':
          description: Connection Add Successfully.         

  /updateconnection:
    put:
      description: <h3>Use this API to Update to Connection - A valid connection key is required. A Connection Key, Connection Name of Record is required.</h3>
      tags:
        - Connection
      security:
        - Bearer: []
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                ConnectionKey:
                  type: string
                  description: "Enter Connection Key</br>Example:amxnjnchbed21443w" 
                connectionName:          
                   type: string
                   description: "Enter Connection Name</br>Example:TestConnection"         
              required:
                - ConnectionKey
                - connectionName  
      responses:
        '201':
          description: Connection Updated Successfully.  

  /setdefaultconnection:
    put:
      description: <h3>Use this API to Update to Connection default - A valid connection key is required. A Connection Key, of Record is required.</h3>
      tags:
       - Connection
      security:
        - Bearer: []
      parameters:
        - name : Connectionkey
          in: query
          description: Enter Connection Key.
          required: true
          schema:
            type: string
      responses:
        '201':
          description: Default Connection Changed Successfully
  
  /deleteconnection:
    delete:
      description: <h3>Use this API Procedure to delete a Connection.</h3>
      tags:
        - Connection
      security:
        - Bearer: []
      parameters:
        - name: ConnectionKey 
          in: query
          description: Enter Connection Key
          required: true
          schema:
            type: string     
      responses:
        '201': 
          description: Connection Deleted Successfully.  

  /addcredential:
    post:
      description: <h3>Use this API to Add Credentials for your Connection. Enter the Connection Key found in your List of Connections, along with the desired Username and Password. and Password should be minimum 8 and max 30 character long and At least One Uppercase Letter, One Lowercase Letter and At least One Number</h3>
      tags:
        - Connection
      security:
        - Bearer: []
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                ConnectionKey:
                  type: string
                  description: "Enter Connection Key</br>Example:amxnjnchbed21443w"
                Username:          
                   type: string
                   description: "Enter Username</br>Example:John"
                Password:
                   type: string      
                   description: "Enter Password</br>Example:John@123"       
              required:
                - Username
                - Password     
                - ConnectionKey
      responses:
        '201':
          description: Credential Added Successfully    

  /addip:
    post:
      description: <h3>Use this API to Add an IP to your Connection. The Connection Key to add the IP to is required.  An IP Address is required, which is the IP Address that you will be sending calls from.</h3>
      tags:
        - Connection
      security:
        - Bearer: []
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                ConnectionKey:
                  type: string
                  description: "Enter Connection Key</br>Example:amxnjnchbed21443w" 
                IP:          
                   type: array
                   description: "Enter IP</br>Example:127.0.0.1"      
              required:
                - IP  
                - ConnectionKey   
      responses:
        '201':
          description: IP Added Successfully.   

  /update_ip:
    put:
      description: <h3>Use this API to Update an IP for your Connection. A valid Connection Key is required. This is the IP Address that you are sending calls from.</h3>
      tags:
        - Connection
      security:
        - Bearer: []
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                ConnectionKey:
                  type: string
                  description: "Enter Connection Key</br>Example:amxnjnchbed21443w"  
                IP:          
                   type: array
                   description: "Enter IP</br>Example:127.0.0.1"      
              required:
                - IP  
                - ConnectionKey   
      responses:
        '201':
          description: IP Added Successfully.              

  /updatefqdn:
    put:
      description: <h3>Use this API to Add a FQDN - Fully Qualified Domain Name - to your Connection. A Connection Key, User and Type of Record is required.</h3>
      tags:
        - Connection
      security:
        - Bearer: []
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                ConnectionKey:
                  type: string
                  description: "Enter Connection Key</br>Example:amxnjnchbed21443w" 
                user:          
                   type: string
                   description: "Enter User</br>Example:Sumit"   
                type:   
                  type: string
                  enum: [A,SRV] 
                  default: A
                  description: "Choose One Value</br>Example:A"       
              required:
                - ConnectionKey
                - user  
                - type   
      responses:
        '201':
          description: FDQN Added Successfully.        

  /addforwardall:
    post:
      description: <h3>Use this API to Add a Forward All for your Connection. This will allow you to forward your calls to a phone number or another IP Address. A Connection Key is required.</h3>
      tags:
        - Connection
      security:
        - Bearer: []
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                ConnectionKey:
                  type: string
                  description: "Enter Connection Key</br>Example:amxnjnchbed21443w"
                forward_type:   
                  type: string
                  enum: [Sip uri,Number,IP Address,Group,Extension] 
                  default: Sip uri
                  description: "Choose One Value</br>Example:Sip uri"    
                forward:          
                   type: string
                   description: "Enter Value</br>Example:xyz"       
              required:
                - ConnectionKey 
                - forward_type     
                - forward
      responses:
        '201':
          description: Forward All Successfully. 


  /addhookUrls:
    post:
      description: <h3>Use this API to Add Webhook URLs. This is for adding a web hook for us to send a response, such as a message detail record or a text message. A Connection Key is required along with the URL for the Web Hook.</h3>
      tags:
        - Connection
      security:
        - Bearer: []
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                ConnectionKey:
                  type: string
                  description: "Enter Connection Key</br>Example: amxnjnchbed21443w"  
                Type:   
                  type: string
                  enum: [CDR Url,SMS Receive,SMS Status]
                  default: CDR Url
                  description: "Choose One Value</br>Example: CDR Url"
                Urls:
                  type: string
                  description: "Enter Webhook Url</br>Example: https://test.com"         
              required:
                - ConnectionKey
                - Type  
                - Urls 
      responses:
        '201':
          description: Webhook Urls Added Successfully.  

  /updatehookUrls:
    put:
      description: <h3>Use this API to Update Webhook URLs. This is for updating a web hook for us to send a response, such as a message detail record or a text message. A Connection Key is required along with the URL for the Web Hook.</h3>
      tags:
        - Connection
      security:
        - Bearer: []
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                ConnectionKey:
                  type: string
                  description: "Enter Connection Key</br>Example: amxnjnchbed21443w"  
                Type:   
                  type: string
                  enum: [CDR Url,SMS Receive,SMS Status]
                  default: CDR Url
                  description: "Choose One Value</br>Example: CDR Url"
                Urls:
                  type: string
                  description: "Enter Webhook Url</br>Example: https://test.com"         
              required:
                - ConnectionKey
                - Type  
                - Urls 
      responses:
        '201':
          description: Webhook Urls Updated Successfully.     

  /deletehookurls:
    delete:
      description: <h3>Use this API to Update Webhook URLs. This is for delete a web hook for us to send a response, such as a message detail record or a text message. A Connection Key and Type bothe are required for the Web Hook.</h3>
      tags:
        - Connection
      security:
        - Bearer: []
      parameters:
        - name: ConnectionKey
          in: query
          description: "Enter Connection Key</br>Example: amxnjnchbed21443w"
          required: true
          schema:
            type: string   
        - name: Type
          in: query
          description: "Choose one value</br>Example: CDR Url"
          required: true
          schema:
            type: string
            enum: 
              - CDR Url
              - SMS Receive
              - SMS Status
            default: CDR Url
      responses:
        '201': 
          description: Webhook Urls Deleted Successfully.       
        
   #<!-- Sms Api Path Write here >  
  /brandRelationship:
    get:
      summary: Get Brand Relationship Types
      description: <h3>Use this API procedure to Return Brands Relationships.</h3>
      tags:
        - Brands
      security:
        - Bearer: []   
      responses:
        '200':
          description: Brand Relationship Get Successfully.
          
  /brandVertical:
    get:
      summary: List All Vertical
      description: <h3>Use this API Procedure to Return Brand Vertical.</h3>
      tags:
        - Brands
      security:
        - Bearer: []   
      responses:
        '200':
          description: Brand Vertical Get Successfully.       
          
  /brandEntity:
    get:
      summary: Get Brand Entity Types
      description: <h3>Use this API Procedure to Return The Brand Entity.</h3>
      tags:
        - Brands
      security:
        - Bearer: []   
      responses:
        '200':
          description: Brand Entity Get Successfully.  
  
  /brandIdentityStatus:
    get:
      summary: Get Brand identity Statuses
      description: <h3>Use this API Procedure to Return The Brand Identity Statuses.</h3>
      tags:
        - Brands
      security:
        - Bearer: []   
      responses:
        '200':
          description: Brand Identity Statuses Get Successfully.  

  /altBusinessIdType:
    get:
      summary: Get alternative business ID type.
      description: <h3>Use this API Procedure to Return the List of altBusinessIdType.</h3>
      tags:
        - Brands
      security:
        - Bearer: []   
      responses:
        '200':
          description: AltBusinessIdType Get Successfully.  

  /stockExchange:
    get:
      summary: List all stock exchanges
      description: <h3>Use this API Procedure to Return the List of stockExchange.</h3>
      tags:
        - Brands
      security:
        - Bearer: []   
      responses:
        '200':
          description: stockExchange Get Successfully.  

  # /brandDCA:
  #   get:
  #     summary: List All DCAs
  #     description: <h3>Use this API Procedure to Return BrandDCA.</h3>
  #     tags:
  #       - Brands
  #     security:
  #       - Bearer: []   
  #     responses:
  #       '200':
  #         description: BrandDCA Get Successfully.  
        
  /brand:
    get:
      summary: Get Existing Brand By (brandId)
      description: <h3>Use this API procedure to return Brands.</h3>
      tags:
        - Brands
      parameters:
        - name: brandId
          in: query
          description: Enter brandId. Example:15
          required: true
          schema:
            brandId: string
      security:
        - Bearer: []   
      responses:
        '200':
          description: Brand Get Successfully.        

  /getbrands:
    get:
      summary: Get All Existing Brands
      description: <h3>Use this API procedure to return all Brands.</h3>
      tags:
        - Brands
      security:
        - Bearer: []   
      responses:
        '200':
          description: Brands Get Successfully.
  
  /registerbrand:
   post:
    summary: Register New Brand (Non-Blocking)
    description: "<h3>Use this API Procedure to Register a Brand.</h3>" 
    tags:
      - Brands
    security:
      - Bearer: []
    requestBody:
      required: true
      content:
        application/json:
          schema:
            type: object
            properties:
              entityType:         
                type: string   
                default: PRIVATE_PROFIT
                enum:
                  - PRIVATE_PROFIT
                  - PUBLIC_PROFIT
              firstName:         
                type: string  
                default: John   
              lastName:         
                type: string   
                default: Doe 
              displayName:         
                type: string
                default: ABC Name       
              companyName:         
                type: string  
                default: ABC Inc.
              ein:         
                type: string  
                default: 123456789
              einIssuingCountry:         
                type: string    
                default: US
              phone:         
                type: string 
                default: +12024567890
              street:         
                type: string  
                default: 123 6th Ave
              city:         
                type: string  
                default: New York
              state:         
                type: string  
                default: NY
              postalCode:         
                type: string
                default: 10001
              country:         
                type: string    
                default: US
              email:         
                type: string  
                default: johndoe@abc.com
              stockSymbol:         
                type: string  
                default: ABC
              stockExchange:         
                type: string  
                default: NASDAQ
              ipAddress:         
                type: string
              brandRelationship:
                type: string 
                default: BASIC_ACCOUNT
              website:
                type: string     
                default: http://www.abcmobile.com
              vertical:
                type: string
                default: RETAIL
              altBusinessId:
                type: string
              altBusinessIdType:
                type: string
                default: NONE
              referenceId:
                type: string
              tag:
                type: array
                default: []
              mobilePhone:
                type: string   
                default: +12024567890
            oneOf:
              - properties:
                  entityType:
                    type: string
                    enum: [PUBLIC_PROFIT]
                  businessContactEmail:
                    type: string
                    description: Email address of the business contact
                required:
                  - businessContactEmail
              - properties:
                  entityType:
                    type: string
                    enum: [PRIVATE_PROFIT]
    responses:
      '200':
        description: Register Brand Successfully!     
  
  /updateBrand:
    put:
      summary: Update Brand Properties
      description : 
      <b>NOTE : Any “Unverified” Brand can be resubmitted for verification on the “Brand Update” with a fee of $4 . And This operation enables the CSP to keep brand details updated in the registry.</b>
        <table border="1"><tbody><tr><th>Property Name</th><th>Update Support</th><th>Re-scoring Required</th></tr><tr><td>ein, einIssuingCountry, entityType</td><td>CSP API or CSP Portal.<b><i>Update allowed if brand has no external vet.</i></b></td><td>Yes</td></tr><tr> <td>fistName, lastName, displayName, companyName, website, street, city, state, postalCode, country, email, phone, vertical, stockSymbol, stockExchange</td> <td>CSP API or CSP Portal</td><td>Optional</td></tr><tr> <td>brandRelationship</td><td>CSP API or CSP Portal. <b><i>Brand relationship can only be updated once every 3 months.</i></b></td><td>Optional</td></tr></tbody></table>
      tags:
        - Brands
      security:
        - Bearer: []
      parameters:
        - name: brandId
          in: query
          description: Brand alphanumeric identifier (prefixed with letter 'B')
          required: true
          schema:
            type: string
      requestBody:
        description: Brand properties to be updated.
        required: true        
        content:
          application/json:              
             schema:
              type: object
              properties:
                entityType:
                  type: string
                  default : PRIVATE_PROFIT              
                firstName:
                  type: string
                  default : John
                lastName:
                  type: string 
                  default : Doe
                displayName:
                  type: string 
                  default : ABC Mobile
                companyName:
                  type: string 
                  default : ABC Inc.
                ein:
                  type: string 
                  default : 111111111
                einIssuingCountry:
                  type: string
                  default : US 
                phone:
                  type: string 
                  default: +12024567890
                street:
                  type: string 
                  default: 123 6th Ave
                city:
                  type: string 
                  default: New York
                state:
                  type: string 
                  default: NY
                postalCode:
                  type: string 
                  default: 10001
                country:
                  type: string 
                  default : US 
                email:
                  type: string 
                  default: abc@xyz.com
                stockSymbol:
                  type: string 
                  default: ABC
                stockExchange:
                  type: string 
                  default: NASDAQ
                ipAddress:
                  type: string 
                website:
                  type: string 
                  default : http://www.abcmobile.com
                brandRelationship:
                  type: string 
                  default : BASIC_ACCOUNT
                vertical:
                  type: string 
                  default : RETAIL
                altBusinessId:
                  type: string 
                altBusinessIdType:
                  type: string
                  default : NONE
                mobilePhone:
                  type: string
                  default : +12024567890
              oneOf:
              - properties:
                  entityType:
                    type: string
                    enum: [PUBLIC_PROFIT]
                  businessContactEmail:
                    type: string
                    description: Email address of the business contact
                required:
                  - businessContactEmail
              - properties:
                  entityType:
                    type: string
                    enum: [PRIVATE_PROFIT]
              required:
                - entityType
                - displayName
                - companyName
                - phone
                - street
                - city
                - state
                - postalCode
                - country
                - email
                - brandRelationship
      responses:
        '200':
          description:  Brand Updated Successfully. 

  /updateBrandIdentity:
    put:
      summary: Update Brand Identity Status
      description: <b>NOTE :</b> Any “Unverified” Brand can be resubmitted for verification on the “Brand Identity Status Update” with a fee of $4. 
      tags:
        - Brands
      security:
        - Bearer: []
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                brandId:
                  type: string 
                  description: "Enter brandId {HGVHJG}"
              required:
                - brandId
      responses:
        '200':
          description:  Brand Identity Status Updated.
  # /addbrand:
  #   post:
  #     description: "<h3>Use this API Procedure to Add a Brand.</h3>"
  #     tags:
  #       - Brands
  #     security:
  #       - Bearer: []
  #     requestBody:
  #       required: true
  #       content:
  #         application/x-www-form-urlencoded:
  #           schema:
  #             type: object
  #             properties:
  #               brand_key:         
  #                 type: string    
  #                 description: "It is a Brand Key, Example:#RGHFDFGH142"
  #               companyName:         
  #                 type: string    
  #                 description: "It is a Company Name, Example:DC" 
  #               displayName:         
  #                 type: string    
  #                 description: "It is a Display Name, Example:Azure"  
  #               entityType:         
  #                 type: string    
  #                 description: "It is a Entity Type, Example:Portal" 
  #               ein:         
  #                 type: string    
  #                 description: "It is a EIN, Example:Portal"    
  #               phone:         
  #                 type: string    
  #                 description: "It is a Phone, Example:9847632154"
  #               country:         
  #                 type: string    
  #                 description: "It is a Country, Example:USA"
  #               email:         
  #                 type: string    
  #                 description: "It is a Email, Example:abc@gmail.com"  
  #               street:         
  #                 type: string    
  #                 description: "It is a Street, Example:Main" 
  #               city:         
  #                 type: string    
  #                 description: "It is a City, Example:Phoenix" 
  #               postalCode:         
  #                 type: string    
  #                 description: "It is a PostalCode, Example:85001" 
  #               website:         
  #                 type: string    
  #                 description: "It is a Website, Example:" 
  #               vertical:         
  #                 type: string    
  #                 description: "It is a Vertical, Example:" 
  #               brandRelationship:         
  #                 type: string    
  #                 description: "It is a Brand Relationship, Example:"                     
  #             required:
  #               - companyName  
  #               - displayName
  #     responses:
  #       '201':
  #         description: Brand Create Successfully!.

  /brandSmsOtp:
    post:
      summary: Resend an OTP message to the brand's mobilePhone (SP entity type only)
      description: <h3>Resend an OTP message to the brand's mobilePhone (SP entity type only)</h3>
      tags:
        - Brands
      security:
        - Bearer: []
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:  
             schema:
              type: object
              properties:
                brandId:
                  type: string 
                  description: "Enter brandId {HGVHJG}"
              required:
                - brandId
      responses:
        '201':
          description: Brand Verification Text Sent Successfully. 

  /brandOtpStatus:
    get:
      summary: Get OTP Status By referenceId
      description: <h3>Use this API procedure to get smsOtp Status.</h3>
      tags:
        - Brands
      parameters:
        - name: referenceId
          in: query
          description: Enter referenceId With Prefix 'OTP'.
          required: true
          schema:
            referenceId: string
      security:
        - Bearer: []   
      responses:
        '201':
          description: Brand's smsOtp Status Get Successfully.         
  
  /deleteBrand:
    delete:
      summary: Delete Brand
      description: This operation deletes a brand. A brand can be deleted if it does not have active campaigns. Once a brand is deleted the brand is in a DELETED state, and the brand cannot be restored to an ACTIVE state. Deleted brands will remain in the system for a period of TBD time and it can be searched using the GET /brand endpoint with query filter 'status' = ACTIVE. While deleted brands are searchable, all other API endpoints involving a deleted brand will result in a '502' - "Brand not found" error.
      tags:
        - Brands
      parameters:
        - name: brandId
          in: query
          description: "Brand alphanumeric identifier (prefixed with letter 'B')"
          required: true
          schema:
            type: string
      security:
        - Bearer: []  
      responses:
        '200':
          description: Brand Successfully deleted.  
  
  /vettingStatus:
    get:
      summary: Get Vetting Status Type
      description: <h3>Use this API Procedure to Return Brand's Vetting Status Types.</h3>
      tags:
        - Brands
      security:
        - Bearer: []   
      responses:
        '200':
          description: Brands Vetting Status Get Successfully.  

  /vettingClass:
    get:
      summary: List All Vetting Classes
      description: <h3>Use this API Procedure to Return Brand Vetting Classes.</h3>
      tags:
        - Brands
      security:
        - Bearer: []   
      responses:
        '200':
          description: Brands Vetting Class Get Successfully.    

  /extVettingProvider:
    get:
      summary: Get External Vetting Provider
      description: <h3>Use this API Procedure to Return Brand Vetting Provider/Partner.</h3>
      tags:
        - Brands
      security:
        - Bearer: []   
      responses:
        '200':
          description: Brands Vetting Provider Get Successfully.    
          
  /importVetting:
    put:
      summary: Import external vetting record
      description: This operation can be used to import external vetting record from a TCR approved vetting provider. If vetting provider confirms validity of the vetting record, the vetting record will be saved with the brand in the TCR and the vetting record will be considered for future campaign qualification.<br>The JSON request body must contain valid 'evpId', the identity of the vetting provider and the 'vettingId', the unique ID of the vetting transaction. The 'vettingToken' field is required by some vetting provider.
      tags:
        - Brands
      security:
        - Bearer: []
      parameters:
        - name: brandId
          in: query
          description: Brand alphanumeric identifier (prefixed with letter 'B')
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:  
             schema:
              type: object
              properties:
                evpId:
                  type: string 
                  description: "Enter evpId {HGVHJG}"                
                vettingId:
                  type: string 
                  description: "Enter vettingId {HGVHJG}"
                vettingToken:
                  type: string 
                  description: "Enter vettingToken {HGVHJG}"
              required:
                - brandId
                - evpId
                - vettingId
                - vettingToken
      responses:
        '200':
          description:  Import Vetting Status Updated. 

  /applyVetting:
    post:
      summary: Order new external vetting for a brand.
      description: <h3>This Procedure for Apply Vetting.</h3>
      tags:
          - Brands
      security:
         - Bearer: []
      parameters:
        - name: brandId
          in: query
          description: Brand alphanumeric identifier (prefixed with letter 'B')
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                evpId:
                  type: string 
                  description: "Enter evpId {HGVHJG}"
                vettingClass:
                  type: string 
                  description: "Enter vettingClass"
                additionalRequestPayload:
                  type: string 
                  example: "{\"requestorFirstName\":\"John\",\"requestorLastName\":\"Doe\",\"locale\":\"Federal\",\"fecCommitteeTypeCode\":\"Y\",\"committeeId\":\"00000\",\"candidateType\":\"City Mayor\",\"stateLocalCommitteeType\":\"State\",\"localCommitteeState\":\"NC\",\"localCommitteeMunicipality\":\"Some Locality\",\"tribalLocation\":\"US\",\"filingUrl\":\"https://sample.com\",\"filingRecordUrlInstructions\":\"Sample Instructions\",\"filingEmail\":\"contact@example.com\",\"electionDate\":\"2022-12-26\",\"pinPreference\":\"Express\"}"
              required:
                - brandId
      responses:
        '200':
          description:  Vetting Apply Successfully.

  /externalVettingList:
    get:
      summary: Get list of external vetting record for a given brand.
      description: <h3>Option to query by vetting partner id, vetting class and status.</h3>
      tags:
        - Brands
      parameters:
        - name: brandId
          in: query
          description: Enter BrandID
          required: true
          schema:
            type: string
        - name: evpId
          in: query
          description: Enter evpID
          required: false
          schema:
            type: string  
        - name: vettingClass
          in: query
          description: Enter vettingClass
          required: false
          schema:
            type: string
        - name: vettingStatus
          in: query
          required: true
          schema:
            type: string
            enum: ["PENDING","UNSCORE","ACTIVE","FAILED","EXPIRED"]  
            description: "Available values : PENDING, UNSCORE, ACTIVE, FAILED, EXPIRED"   
      security:
        - Bearer: []  
      responses:
        '200':
          description: Data fetched Successfully!.
  
  /revet:
    put:
      summary: Revet the Brand
      description: "This function allows you to revet"
      tags:
      - Brands
      security:
        - Bearer: []
      parameters:
        - name: brandId
          in: query
          description: Brand alphanumeric identifier (prefixed with letter 'B')
          required: true
          schema:
            type: string
      # requestBody:
      #   required: true
      #   content:
      #     application/x-www-form-urlencoded:
      #       schema:
      #         type: object
      #         properties:
      #           nonBlocking:
      #             type: boolean
      #             description: "This field is set to true by default and cannot be changed"
      #             default: true  
      #             enum: [true]
      #         required:
      #           - nonBlocking
      responses:
        '200':
          description:  Brand Revet Successfully. 
  /2faEmail:
    post:
      summary: Resend 2FA Email
      description: "This function allows you to send 2fa email"
      tags:
      - Brands
      security:
        - Bearer: []
      parameters:
        - name: brandId
          in: query
          description: Brand alphanumeric identifier (prefixed with letter 'B')
          required: true
          schema:
            type: string
      responses:
        '204':
          description:  2FA Email Sent Successfully.

  /campaignCases:
    get:
      summary: List All Use-Cases
      description: <h3>Use this API Procedure to Return a Campaign Case.</h3>
      tags:
        - Campaigns
      security:
        - Bearer: []   
      responses:
        '200':
          description: Campaign Cases Get Successfully.  
 
  /getMnoList:
    get:
      summary: List all MNOs
      description: <h3>This list contains all MNOs or MNO representatives participating in the TCR ecosystem.</h3>
      tags:
        - Campaigns
      security:
        - Bearer: []   
      responses:
        '200':
          description: MNO Id's Get Successfully.         
  
  # /addcampaign:
  #   post:
  #     description: "<h3>Use this API Procedure to Add a Campaign.</h3>"
  #     tags:
  #       - Campaigns
  #     security:
  #       - Bearer: []
  #     requestBody:
  #       required: true
  #       content:
  #         application/x-www-form-urlencoded:
  #           schema:
  #             type: object
  #             properties:
  #               campaign_key:         
  #                 type: string    
  #                 description: "It is a Campaign Key, Example:#RCA12345" 
  #               campaign_name:         
  #                 type: string    
  #                 description: "It is a Campaign Name, Example:Apple"  
  #               vertical:         
  #                 type: string    
  #                 description: "It is a Vertical, Example:"    
  #               Sample1:         
  #                 type: string    
  #                 description: "It is a Sample1, Example:"
  #               Sample2:         
  #                 type: string    
  #                 description: "It is a Sample2, Example:"
  #               Sample3:         
  #                 type: string    
  #                 description: "It is a Sample3, Example:"  
  #               Sample4:         
  #                 type: string    
  #                 description: "It is a Sample4, Example:" 
  #               Sample5:         
  #                 type: string    
  #                 description: "It is a Sample5, Example:" 
  #               usecase:
  #                 type: string
  #                 description: "It is a Use Cases, Example:"  
  #               subUsecases:
  #                 type: string
  #                 description: "It is a Sub Use Cases, Example:" 
  #               brandId:
  #                 type: string
  #                 description: "It is a BrandId, Example:REF1245"
  #               subscriberOptin:
  #                 type: boolean
  #                 enum: [true,false]  
  #                 description: "It is a Subsciber Option, Example:false"
  #               subscriberOptout:
  #                 type: boolean
  #                 enum: [true,false]  
  #                 description: "It is a Subsciber Output, Example:false"
  #               subscriberHelp:
  #                 type: boolean
  #                 enum: [true,false]  
  #                 description: "It is a Subsciber Help, Example:false"          
  #               description:         
  #                 type: string    
  #                 description: "It is a Description, Example:It is a company"                   
  #             required: 
  #               - campaign_name
  #               - Sample1
  #               - Sample2
  #               - description 
  #               - usecase
  #               - subUsecases
  #               - brandId             
  #     responses:
  #       '201':
  #         description: Campaign Added Successfully!.           
  
  # /brandCampaign:
  #   get:
  #     summary: Get All Existing Campaign List By Brind Id
  #     description: <h3>Use this API Procedure to Return a Brand Campaign.</h3>
  #     tags:
  #       - Campaigns
  #     parameters:
  #       - name: brandId
  #         in: query
  #         description: Brand alphanumeric identifier (prefixed with letter 'B')
  #         required: true
  #         schema:
  #           type: string
  #     security:
  #       - Bearer: []   
  #     responses:
  #       '200':
  #         description: Brand Campaign Get Successfully.

  /campaigns:
    get:
      summary: Get All Existing Campaign List
      description: <h3>Use this API Procedure to Return Campaigns.</h3>
      tags:
        - Campaigns
      security:
        - Bearer: []   
      responses:
        '200':
          description: Campaigns Get Successfully. 
  
  /qualifyBrandByUsecas:
    get:
      summary: Campaign Builder Step 1 Qualify brand by usecase
      description: This operation determines if a brand is qualified to run a campaign of a desired usecase across participating MNOs. If the brand qualifies to run the campaign on one or more MNOs, this API call returns restrictions (i.e. no embedded link), process (i.e. manual review), pricing (e.g. surcharge) and MNO specific attributes (e.g. AT&T message class). If the brand is not qualified to run the desired usecase on any MNO, CSP may consider having brand vetted to achieve access to broader usecases.
      tags:
        - Campaigns
      parameters:
        - name: brandId
          in: query
          description: Brand alphanumeric identifier (prefixed with letter 'B')
          required: true
        - name: usecase
          in: query
          description: Campaign usecase. E.g. 2FA
          required: true
          schema:
            type: string
      security:
        - Bearer: []   
      responses:
        '200':
          description: Brand Campaign Get Successfully.

  /registercampaign:
    post:
      summary: Campaign Builder Step 2 Create New Campaign
      description: "<h3>Use this API Procedure To Create a Campaign.</h3>"
      tags:
        - Campaigns
      security:
        - Bearer: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                brandId:
                  type: string  
                  default: BHGRTHH  
                usecase:         
                  type: string
                subUsecases:
                  type: array
                  items:
                    type: string
                description:
                  type: string
                  default: stringstringstringstringstringstringstri
                embeddedLink:
                  type: boolean
                  default: false
                embeddedPhone:
                  type: boolean
                  default: false
                affiliateMarketing:
                  type: boolean  
                  default: false
                termsAndConditions:
                  type: boolean  
                  default: true
                numberPool:
                  type: boolean
                  default: false
                ageGated:
                  type: boolean
                  default: false
                directLending:
                  type: boolean 
                  default: false    
                subscriberOptin:
                  type: boolean  
                  default: true
                subscriberOptout:
                  type: boolean  
                  default: true
                subscriberHelp:
                  type: boolean  
                  default: true    
                sample1:         
                  type: string   
                  default: stringstringstringst 
                sample2:         
                  type: string  
                  default: stringstringstringst  
                sample3:         
                  type: string  
                  default: stringstringstringst    
                sample4:         
                  type: string     
                  default: stringstringstringst
                sample5:         
                  type: string    
                  default: stringstringstringst
                messageFlow:
                  type: string
                  default: stringstringstringstringstringstringstri
                helpMessage:
                  type: string
                  default: stringstringstringst
                mnoIds:
                  type: array
                  default: []
                referenceId:
                  type: string  
                autoRenewal:
                  type: boolean  
                  default: true      
                tag:         
                  type: array
                  items:
                    type: string
                optinKeywords:
                  type: string
                  default: START,YES
                optoutKeywords:
                  type: string
                  default: STOP
                helpKeywords:
                  type: string
                  default: HELP
                optinMessage:
                  type: string
                  default: stringstringstringst
                optoutMessage:
                  type: string      
                  default: stringstringstringst   
                privacyPolicyLink:
                  type: string   
                termsAndConditionsLink:
                  type: string
                embeddedLinkSample: 
                  type: string             
              required:
                - brandId
                - usecase
                - subUsecases
                - embeddedLink
                - embeddedPhone
                - numberPool
                - ageGated
                - directLending 
                - subscriberOptin
                - subscriberOptout
                - subscriberHelp       
                - messageFlow
                - helpMessage
                - referenceId
                - autoRenewal
                - optinMessage
                - optoutMessage
                - affiliateMarketing
                - sample1
                - sample2        
      responses:
        '201':
          description: Campaign Register Successfully!.  
  
  /updateCampaign:
    put:
      summary: Update My Campaign Properties by using Campaign Id/SM Reference No.
      description: This operation let's you update a campaign you registered. Not all fields are updateable.
      tags:
        - Campaigns
      security:
        - Bearer: []
      parameters:
        - name: campaignId
          in: query
          description: Campaign Id/SM Reference No. alphanumeric identifier (prefixed with letter 'C'/'SM')
          required: true
          schema:
            type: string
      requestBody:
        description: Campaign properties to be updated. Only subset of campaign properties can be updated.
        required: true        
        content:
          application/json:              
             schema:
              type: object
              properties:           
                description:
                  type: string
                  default: stringstringstringstringstringstringstri
                sample1:
                  type: string 
                  default: stringstringstringst
                sample2:
                  type: string 
                  default: stringstringstringst
                sample3:
                  type: string 
                  default: stringstringstringst
                sample4:
                  type: string
                  default: stringstringstringst 
                sample5:
                  type: string 
                  default: stringstringstringst
                messageFlow:
                  type: string 
                  default: stringstringstringstringstringstringstri
                helpMessage:
                  type: string 
                  default: stringstringstringst
                autoRenewal:
                  type: boolean 
                  default: true
                optinKeywords:
                  type: string 
                  default: START,YES
                optoutKeywords:
                  type: string 
                  default: STOP
                helpKeywords:
                  type: string
                  default: HELP 
                optinMessage:
                  type: string 
                  default: stringstringstringst
                optoutMessage:
                  type: string 
                  default: stringstringstringst
                privacyPolicyLink:
                  type: string   
                termsAndConditionsLink:
                  type: string
                embeddedLinkSample: 
                  type: string 
              required:
                - campaignId
                - description
                - sample1
                - sample2
                - messageFlow
                - helpMessage
      responses:
        '200':
          description:  Campaign Updated Successfully. 

  /autoRenewal:
    put:
      summary: Update autoRenewal Property For Campaign
      description: "This function allows you to update campaign autoRenewal"
      tags:
       - Campaigns
      security:
        - Bearer: []
      parameters:
        - name: campaignId
          in: query
          description: Campaign alphanumeric identifier (prefixed with letter 'C')
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                autoRenewal:
                  type: boolean
                  enum: [true,false]  
                  description: "Selete one option for perform"
              required:
                - autoRenewal        
      responses:
        '200':
          description: autoRenewal Update Successfully

  /campaignDetails:
    get:
      summary: Get my Campaign Details.
      description: <h3>Retrieve a campaign you registerd from TCR by a Campaign Id/SM Reference No..</h3>
      tags:
        - Campaigns
      parameters:
        - name: campaignId
          in: query
          description: Campaign Id/SM Reference No. alphanumeric identifier (prefixed with letter 'C'/'SM')
          required: true
          schema:
            type: string
      security:
        - Bearer: []   
      responses:
        '200':
          description: Campaign Details fetched Successfully.

  /mnoMetaData:
    get:
      summary: Get my Campaign MNO MetaData
      description: <h3>The JSON resonse is a MAP data structure holding campaign MNO metaData for each MNO network campaign is submitted. MAP key contains MNO ID and MAP value contains the campaign metadata for corresponding MNO.</h3>
      tags:
        - Campaigns
      parameters:
        - name: campaignId
          in: query
          description: Campaign alphanumeric identifier (prefixed with letter 'C')
          required: true
          schema:
            type: string
      security:
        - Bearer: []   
      responses:
        '200':
          description: MNO metadata fetched Successfully. 

  /deletecampaign:
    delete:
      summary: Deactivate my Campaign
      description: <h3>Use this API Procedure to Delete a Campaign by using Campaign Id/SM Reference No..</h3>
      tags:
        - Campaigns
      
      parameters:
        - name: campaignId
          in: query
          description: "Campaign Id/SM Reference No. alphanumeric identifier (prefixed with letter 'C'/'SM')"
          required: true
          schema:
            type: string
      security:
        - Bearer: []  
      responses:
        '200':
          description: Campaign Deleted Successfully. 
  
  /campaignMultimediaFileUpload:
    post:
      summary: Add MMS sample media file to a Campaign by using Campaign Id/SM Reference No.
      description: "<h3>Use this API Procedure to Add MMS sample media file.</h3>Add MMS Sample media file to a campaign. Existing MMS sample media files can be downloaded or deleted with API endpoints under the 'Attachment' group."
      tags:
        - Campaigns
      security:
        - Bearer: []
      requestBody:
        required: true
        content:  
          multipart/form-data:
            schema:
              type: object
              properties:
                campaignId:
                  type: string
                  description: "Campaign Id/SM Reference No. alphanumeric identifier (prefixed with letter 'C'/'SM')"
                ATTACHMENTS:
                  type: string
                  format: binary
                  description: "Supported file types: .bmp, .dib, .gif, .jpeg, .jpg, .m2a, .m4a, .m4b, .m4p, .m4r, .m4v, .mp2, .mp3, .mp4, .ogg, .ogx, .png, .txt, .wav, .webm"
              required:
                - campaignId
                - ATTACHMENTS
      responses:
        '201': 
          description: Add MMS sample media file Successfully  
  
  /campaignMultimediaFileGet:
    get:
      summary: List MMS sample media files on a campaign.
      description: <h3>Retrieve a campaign multimedia file by a Campaign Id/SM Reference No..</h3>
      tags:
        - Campaigns
      parameters:
        - name: campaignId
          in: query
          description: Campaign Id/SM Reference No. alphanumeric identifier (prefixed with letter 'C'/'SM')
          required: true
          schema:
            type: string
      security:
        - Bearer: []   
      responses:
        '200':
          description: Campaign Multimedia File Fetched Successfully.

  /campaignMultimediaFileDelete:
    delete:
      summary: Delete MMS sample media files on a campaign.
      description: <h3>Use this API endpoint to delete an attachment, including existing campaign MMS sample media file. When deleting an existing MMS sample media file, pass the system assigned 'uuid' value from the MMS sample media upload as the 'attachmentId' path parameter.</h3>
      tags:
        - Campaigns
      
      parameters:
        - name: attachmentId
          in: query
          description: "Attachment Key"
          required: true
          schema:
            type: string
      security:
        - Bearer: []  
      responses:
        '200':
          description: Campaign File Deleted Successfully.  
  

  /sms:
    post:
      summary: Send SMS
      description: "<h3>Use this API Procedure to send an SMS.</h3> The SMS API is a program that allows us to send SMS messages quickly and effortlessly. You may send alerts, reminders, and notifications, as well as a one-time passcode verification message"
      tags:
        - SMS/MMS
      security:
        - Bearer: []
      requestBody:
        required: true
        content:  
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                FROM:
                  type: string
                  description: "Sender of the SMS, Example:8463216998"
                TO:
                  type: string
                  description: "Receiver of the SMS, Example:8463216998"
                BODY:
                  type: string  
                  description: "The content of the message."
                Connection:
                  type: string
                OutboundSMS:
                  type: string    
              required:
                - FROM
                - TO
                - BODY 
      responses:
        '201': 
          description: SMS Send Successfully  

  /mms:
    post:
      summary: Send MMS
      description: "<h3>Use this API Procedure to send an MMS.</h3>Multimedia Messaging APIs combine all the advantages of MMS to deliver rich information such as images, video, and audio for increased impact. Your consumers can collaborate with you on rich content"
      tags:
        - SMS/MMS
      security:
        - Bearer: []
      requestBody:
        required: true
        content:  
          multipart/form-data:
            schema:
              type: object
              properties:
                FROM:
                  type: string
                  description: "Sender of the MMS, Example:8463216998"
                TO:
                  type: string
                  description: "Receiver of the MMS, Example:8463216998"
                BODY:
                  type: string  
                  description: "The content of the message."
                ATTACHMENT:
                  type: string
                  format: binary
                  description: "The is used for sending images,videos,documents,etc."
              required:
                - FROM
                - TO
                - ATTACHMENT
      responses:
        '201': 
          description: MMS Send Successfully  

  /messages:
    post:
      summary: Send Messages
      description: "<h3>Use this API Procedure to send a Message.</h3> The SMS API is a program that allows us to send messages quickly and effortlessly. You may send alerts, reminders, and notifications, as well as a one-time passcode verification message"
      tags:
        - SMS/MMS
      security:
        - Bearer: []
      requestBody:
        required: true
        content:  
          multipart/form-data:
            schema:
              type: object
              properties:
                FROM:
                  type: string
                  description: "Sender of the SMS, Example:8463216998"
                TO:
                  type: string
                  description: "Receiver of the SMS, Example:8463216998"
                BODY:
                  type: string  
                  description: "The content of the message."
                # Connection:
                #   type: string
                # OutboundSMS:
                #   type: string    
                ATTACHMENT:
                  type: string
                  format: binary
                  description: "This is used for sending images,videos,documents,etc."
              required:
                - FROM
                - TO
      responses:
        '201': 
          description: Message Successfully Sent.

  /getmdr:
    get:
      description: <h3>Use this API Procedure To find the MDR. The Message Detail Record contains the messaging details for a recent SMS event. A SessionID and the number of records to limit to are Required.</h3>
      tags:
        - SMS/MMS
      parameters:
        - name: Limit
          in: query
          description: Enter Integer Number. Maximum Limit (1 - 1000)
          required: true
          schema:
            format: int32
            type: number
            minimum: 1
            maximum: 1000
            default: 1
        - name: SessionId
          in: query
          description: Enter SessionId here. Example:A25HIDCVH
          required: true
          schema:
            type: string     
      security:
        - Bearer: []  
      responses:
        '200':
          description: MDR Find Successfully.        

  # /mdrsearch:
  #   post:
  #     security:
  #       - Bearer: []
  #     requestBody:
  #       required: true
  #       content:  
  #         application/x-www-form-urlencoded:
  #           schema:
  #             type: object
  #             properties:
  #               Batch_Id:
  #                 type: string
  #               Recipient_id:
  #                 type: string  
  #             required:
  #               - Batch_Id  
  #               - Recipient_id              
  #     responses:
  #       '201': 
  #         description: Message Details Find Succesfully          

  /originate:
    post:
      description: "<h3>Use this API Procedure to Originate Calls.</h3>You can make the calls on outbound numbers by using this API."
      tags:
        - Calling
      security:
        - Bearer: []
      requestBody:
        required: true
        content:  
          application/x-www-form-urlencoded:  
            schema:
              type: object
              properties:
                FROM:
                  type: string
                  description: "Callerid for reciever of the call."
                CALLER:
                  type: string
                  description: "Caller of the call."
                CALLEE:
                  type: string
                  description: "Callee of the call."
                AMD:
                  type: boolean
                  default: false
                Recording:
                  type: boolean
                  default: false
              required:
                - FROM
                - CALLER
                - CALLEE        
      responses:
        '201': 
          description: Call Originate Successfully.     

  /makecall:
    post:
      description: "<h3>Use this API Procedure to make an outbound call.</h3>You can make the calls on outbound numbers by using this API."
      tags:
        - Calling
      security:
        - Bearer: []
      requestBody:
        required: true
        content:  
          application/x-www-form-urlencoded:  
            schema:
              type: object
              properties:
                FROM:
                  type: string
                  description: "Sender of the call."
                TO:
                  type: string
                  description: "Receiver of the call."
                Extension:
                  type: string 
                  description: "" 
                AMD:
                  type: boolean
                  default: false
                Recording:
                  type: boolean   
                  default: false  
              required:
                - FROM
                - TO        
      responses:
        '201': 
          description: Call Connected Successfully.           

  /senddtmf:
    post:
      description: "<h3>Use this API Procedure to send DTMF.</h3> Starts sending the DTMF digits specified. You can send DTMF digits separately in many requests or a single request with multiple numbers."
      tags:
        - Calling
      security:
        - Bearer: []
      requestBody:
        required: true
        content:  
          application/x-www-form-urlencoded:  
            schema:
              type: object
              properties:
                UUID:
                  type: string
                  description: "A string containing the unique call UUID"
                TONE:
                  type: string
                  description: "It is a message that we sent for taking your information."
              required:
                - UUID   
                - TONE     
      responses:
        '201': 
          description: DTMF Send Successfully.   

  /receiveddtmf:
    post:
      description: "<h3>Use this API Procedure to Receive DTMF. A Unique Call UUID is Required, as well as the message played to receive DTMF digits.</h3>"
      tags:
        - Calling
      security:
        - Bearer: []
      requestBody:
        required: true
        content:  
          application/x-www-form-urlencoded:  
            schema:
              type: object
              properties:
                UUID:
                  type: string
                  description: "A string containing the unique call UUID"
                TONE:
                  type: string
                  description: "A message that we sent before taking your information."
              required:
                - UUID   
                - TONE     
      responses:
        '201': 
          description: DTMF Received Successfully.          

  /record:
    post:
      description: "<h3>Use this API Procedure to create the recording of the audio. A Unique Call UUID is Required as well as the options to start and stop the recording.</h3>"
      tags:
        - Calling
      security:
        - Bearer: []
      requestBody:
        required: true
        content:  
          application/x-www-form-urlencoded:  
            schema:
              type: object
              properties:
                UUID:
                  type: string
                  description: "A string containing the unique call UUID."
                Recording:
                  type: string
                  enum: [Start, Stop]
                  description: "You can stop and start the recording."
              required:
                - UUID   
                - Recording     
      responses:
        '201': 
          description: Recording Start Or Stop Successfully  

  /hangup:
    post:
      description: "<h3>Use this API Procedure to end the call. A Unique UID of the call is Required.</h3>"
      tags:
        - Calling
      security:
        - Bearer: []
      requestBody:
        required: true
        content:  
          application/x-www-form-urlencoded:  
            schema:
              type: object
              properties:
                UUID:
                  type: string
                  description: "A string containing the unique call UUID."
              required:
                - UUID       
      responses:
        '200': 
          description: Call Hangup Successfully.
    
  /barge:
    post:
      description: "<h3>Use this API Procedure to Barge into a Call.</h3> It is used to assist supervisors in monitoring an ongoing call. The Sender of the Call and the Extension are Required."
      tags:
        - Calling
      security:
        - Bearer: []
      requestBody:
        required: true
        content:  
          application/x-www-form-urlencoded:  
            schema:
              type: object
              properties:
                Number : 
                  type: string
                  description: "Sender of the call."
                Extension:
                  type: string
                  description: "Use Your 7 digit Extension."
              required:
                - Number  
                - Extension     
      responses:
        '200': 
          description: Call Barge Successfully 

  /transfer:
    post:
      description: "<h3>Use this API Procedure to transfer a call.</h3> This is used for transferring the calls."
      tags:
        - Calling
      security:
        - Bearer: []
      requestBody:
        required: true
        content:  
          application/x-www-form-urlencoded:  
            schema:
              type: object
              properties:
                UUID:
                  type: string
                  description: "A string containing the unique call UUID"
                Number:
                  type: string  
                  description: "Use Your 7 digit Extension or 10 digit Phone Number."
              required:
                - UUID  
                - Number     
      responses:
        '200': 
          description: Call Transfer Successfully.   
          
  /3waycall:
    post:
      description: "<h3>Use this API Procedure to add a third person to the call. The Call UUID and phone number to transfer to are Reqired.</h3>"
      tags:
        - Calling
      security:
        - Bearer: []
      requestBody:
        required: true
        content:  
          application/x-www-form-urlencoded:  
            schema:
              type: object
              properties:
                UUID:
                  type: string
                  description: "A string containing the unique call UUID."
                Number:
                  type: string  
                  description: "The phone number of the party you would like to add to the existing call."
              required:
                - UUID  
                - Number     
      responses:
        '200': 
          description: Call Connected Successfully.
          
  # /blindtansfer:
  #   post:
  #     description: "If you want to add a third person in your call, that API is used."
  #     security:
  #       - Bearer: []
  #     requestBody:
  #       required: true
  #       content:  
  #         application/x-www-form-urlencoded:  
  #           schema:
  #             type: object
  #             properties:
  #               UUID:
  #                 type: string
  #                 description: "A string containing the unique call UUID."
  #               NUMBER:
  #                 type: string  
  #                 description: "A phone number that you are using."
  #             required:
  #               - UUID  
  #               - NUMBER     
  #     responses:
  #       '200': 
  #         description: Call Hangup Succesfully
  #       '401':
  #         description: Failed         

  /hold:
    post:
      description: "<h3>Use this API Procedure to place the call on hold. UUID and Options to Start Hold or Stop Hold are Required.</h3>"
      tags:
        - Calling
      security:
        - Bearer: []
      requestBody:
        required: true
        content:  
          application/x-www-form-urlencoded:  
            schema:
              type: object
              properties:
                UUID:
                  type: string
                  description: "A string containing the unique call UUID."
                Type:
                  type: string
                  enum: [Start,Stop,Toggle]  
                  description: "We have options for stop,start and toggle."
              required:
                - UUID  
                - Type     
      responses:
        '200': 
          description:  hangup Successfully.       

  /getcdr:
    get:
      description: <h3>Use this API Procedure to find the CDR. Call Detail Records provide the details around a call. By specifying Limit, you can increase or decrease the amount of records returned.</h3>
      tags:
        - Calling
      parameters:
        - name: Limit
          in: query
          description: Enter Limit here. Example:1000
          required: true
          schema:
            type: string   
      security:
        - Bearer: []          
      responses:
        '200':
          description: CDR Find Successfully.          
          
  /getcall:
    get:
      description: <h3>Use this API Procedure to return a list of channels for the client. This procedure will show active calls.</h3>
      tags:
        - Calling
      security:
        - Bearer: []
      responses:
        '200':
          description: Channels List Find Successfully.          

  /addagent:
    post:
      description: <h3>Use this API Procedure for Adding Agents.</h3>
      tags:
        - Agents
      security:
        - Bearer: []
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:  
             schema:
              type: object
              properties:
                FullName:
                  type: string
                  description: "FullName of the agent."  
                UserName:
                  type: string 
                  description: "Username." 
                Password:
                  type: string 
                  description: "Password."  
                CallerId:
                  type: string
                  description: "Caller Id"   
              required:
                - FullName
                - UserName
                - Password  
      responses:
        '201': 
          description: Agent Added Succesfully.

  /updateagent:
    patch:
      description: <h3>Use this API Procedure for updating the Agent.</h3>
      tags:
        - Agents
      security:
        - Bearer: []
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:  
             schema:
              type: object
              properties:
                IdAgent:
                  type: string 
                  description: "A unique id that is assigned to the agent."
                FullName:
                  type: string
                  description: "Name of the agent."
                UserName:
                  type: string   
                  description: "Username."
                Password:
                  type: string
                  description: "Password."  
                CallerId:
                  type: string
                  description: "Caller Id."   
              required:
                - IdAgent    
      responses:
        '201': 
          description: Update Agent Successfully        

  /getagent:
    get:
      description: <h3>Use this API Procedure to return Agent Details.</h3>
      tags:
        - Agents
      parameters:
        - name: username
          in: query
          description: Enter Agent Name. Example:Peter
          required: true
          schema:
            type: string
      security:
        - Bearer: []
      responses:
        '200':
          description: Get Agent Successfully.    

  /getallagent:
    get:
      description: <h3>Use this API Procedure to return a list of agents for the client.</h3>
      tags:
        - Agents
      parameters:
        - name: GroupName
          in: query
          description: Enter Group Name. Example:Tom
          required: true
          schema:
            type: string
      security:
        - Bearer: []
      responses:
        '200':
          description: Get All Agent Successfully.   

  /deleteagent:
    delete:
      description: <h3>Use this API Procedure to remove agent groups from a particular account.<h3>
      tags:
        - Agents
      security:
        - Bearer: []
      parameters:
        - name: id
          in: query
          description: Enter the Id. Example:1
          required: true
          schema:
            type: string     
      responses:
        '200': 
          description: Delete Agent Successfully
          
  /getgroups:
    get:
      description: <h3>Use this API Procedure to return Groups.</h3>
      tags:
        - Groups
      security:
        - Bearer: []
      responses:
        '200':
          description: Get Groups Successfully.

  /getagents:
    get:
      description: <h3>Use this API procedure to return Agents.</h3>
      tags:
        - Agents
      security:
        - Bearer: []
      responses:
        '200':
          description: Get Agents Successfully.        
          

  /addmapping:        
    post:
          description: <h3>Use this API Procedure for Mapping Agents.</h3>
          tags:
            - Agents
          security:
            - Bearer: []
          requestBody:
            required: true
            content:  
              application/x-www-form-urlencoded:
                schema:
                  type: object
                  properties:
                    group_key:
                      type: string
                    name:
                      type: array  
                  required:
                    - name
                    - group_key 
          responses:
            '200': 
              description: Group Mapping Added Successfully!.            
          
  /agentlogin:
    post:
      description: <h3>Use this API Procedure for Agent Login.</h3>
      tags:
        - Agents
      security:
        - Bearer: []
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:  
             schema:
              type: object
              properties:
                Username:
                  type: string 
                  description: "Enter Username."
                Password:
                  type: string
                  description: "Enter Password."
              required:
                - Username   
                - Password
      responses:
        '200':
          description:  Agent Login Successfully.  

  /agentstatus:        
    post:
      description: <h3>Use this API Procedure to Set Agent Status.</h3>
      tags:
        - Agents
      security:
        - Bearer: []
      requestBody:
        required: true
        content:  
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                Session:
                  type: string
                AgentStatus:
                  type: string
                  enum: [Ready,Break]     
              required:
                - AgentStatus 
      responses:
        '200': 
          description: Agent Status Change Successfully.                
          
  /agentlogout:
    get:
      description: <h3>Use this API Procedure for Agent's Logout.</h3>
      tags:
        - Agents
      parameters:
        - name: Session
          in: query
          description: Enter the Group Name. Example:Tom
          required: true
          schema:
            type: string
      security:
        - Bearer: []
      responses:
        '200':
          description:  Agent Logout Successfully.            
  
  /addgroup:
    post:
      description: <h3>Use this API Procedure to add a Group.</h3>
      tags:
        - Groups
      security:
        - Bearer: []
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:  
             schema:
              type: object
              properties:
                GroupName:
                  type: string
                  description: "Name of the group."
                Strategy:
                  type: string
                  enum: [ring-all,longest-idle-agent,round-robin,top-down,agent-with-least-talk-time,agent-with-fewest-calls,sequentially-by-agent-order,random,ring-progressively]
                  description: "A plan to design a group."
                TierRulesApply:
                  type: boolean
                  enum: [true,false]  
                  description: "When the maximum wait time is reached, perform the action you specified."
                Description:  
                  type: string
                  description: "Description of the group."
              required:
                - GroupName
                - Strategy
                - TierRulesApply     
                - Description 
      responses:
        '201': 
          description: Group Added Successfully.
          
  /updategroup:
    patch:
      description: <h3>Use this API Procedure to update an existing group's description.</h3> A resource group's name cannot be changed.
      tags:
        - Groups
      security:
        - Bearer: []
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:  
             schema:
              type: object
              properties:
                idgroup:
                  type: string
                  description: "A specific id that a group uses."
                GroupName:
                  type: string
                  description: "Name of the group."
                Strategy:
                  type: string
                  description: "A plan to design a group."
                  enum: [ring-all,longest-idle-agent,round-robin,top-down,agent-with-least-talk-time,agent-with-fewest-calls,sequentially-by-agent-order,random,ring-progressively]
                TierRulesApply:
                  type: boolean 
                  enum: [true,false]
                  description: "When the maximum wait time is reached, perform the action you specified."
                Description:  
                  type: string
                  description: "Description of the group."
              required: 
                - idgroup
      responses:
        '201': 
          description: Group Updated Successfully.      
          
  /getgroup:
    get:
      description: <h3>Use this API Procedure to return information about a resource group that has been defined.</h3>
      tags:
        - Groups
      security:
        - Bearer: []
      responses:
        '200':
          description: Get Group Succesfully.         
          
  /deletegroup:
    delete:
      description: <h3>Use this API Procedure to delete a Group.</h3> When you remove a resource group, you don't remove any of the group's resources; you remove the group's structure.
      tags:
        - Groups
      security:
        - Bearer: []
      parameters:
        - name: id
          in: query
          description: Enter the Id. Example:1
          required: true
          schema:
            type: string     
      responses:
        '200': 
          description: Group deleted  Successfully.             

  /sendotpbysms:        
    post:
      description: <h3>Use this API Procedure to send OTP By SMS. One Time Passcodes can be used for authentication/verification. A One Time Passcode will be sent by SMS to the intended recipient. FROM Number and TO Number Fields are Required.</h3>
      tags:
        - SMS/MMS
      security:
        - Bearer: []
      requestBody:
        required: true
        content:  
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                FROM:
                  type: string
                TO:
                  type: string    
                TemplateKey:
                  type: string  
              required:
                - FROM
                - TO  
                - TemplateKey
      responses:
        '200': 
          description: OTP Send Successfully.       

  /sendotpbycall:        
    post:
      description: <h3>Use this API Procedure to send OTP by Call. One Time Passcodes can be used for authentication/verification. A One Time Passcode will be sent by phone to the intended recipient. FROM Number and TO Number Fields are Required.</h3>
      tags:
        - Calling
      security:
        - Bearer: []
      requestBody:
        required: true
        content:  
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                FROM:
                  type: string
                TO:
                  type: string  
                Template:
                  type: boolean
                  enum: [true,false]  
                  description: ""  
              required:
                - FROM
                - TO  
                - Template
      responses:
        '200': 
          description: OTP Send Successfully.   
          
  /verifyotp:        
    post:
      description: <h3>Use this API Procedure to Verify OTP. One Time Passcodes can be used for authentication/verification. This API call can verify the OTP of an SMS or Call that was sent. The OTP and Session ID parameters are required.</h3>
      tags:
        - SMS/MMS
      security:
        - Bearer: []
      requestBody:
        required: true
        content:  
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                OTP:
                  type: string
                SessionId:
                  type: string    
              required:
                - OTP
                - SessionId
      responses:
        '200': 
          description: OTP Verify  Successfully.

  /cnamadd:        
    post:
      description: <h3>Use this API Procedure to add a CNAM entry.</h3>
      tags:
        - CNAM
      security:
        - Bearer: []
      requestBody:
        required: true
        content:  
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                Name:
                  type: string
                DID:
                  type: string    
              required:
                - Name
                - DID
      responses:
        '200': 
          description: CNAM Add  Successfully.