{
 "openapi":"3.1.0",
 "info":{
  "title":"Infobip OpenAPI Specification",
  "description":"OpenAPI Specification that contains all public endpoints and webhooks.",
  "contact":{
   "name":"Infobip support",
   "email":"support@infobip.com"
  },
  "version":"3.210.0",
  "x-generatedAt":"2026-07-23T15:23:49.992118108Z"
 },
 "tags":[
  {
   "name":"platform",
   "description":"Modular tools to scale and automate your business.\n",
   "x-type":"category",
   "x-displayName":"Platform"
  },
  {
   "name":"numbers",
   "description":"Numbers are essential for two way communication and your branding. Buy and manage your numbers to send and receive messages and voice calls.\n",
   "x-type":"product",
   "x-displayName":"Numbers"
  },
  {
   "name":"phone-numbers",
   "description":"",
   "x-type":"module",
   "x-displayName":"Purchase Numbers"
  },
  {
   "name":"my-numbers",
   "description":"",
   "x-type":"module",
   "x-displayName":"My Numbers"
  },
  {
   "name":"number-configuration",
   "description":"",
   "x-type":"section",
   "x-displayName":"Number Configuration"
  },
  {
   "name":"number-mms-configuration",
   "description":"",
   "x-type":"section",
   "x-displayName":"Number MMS Configuration"
  },
  {
   "name":"voice-configuration",
   "description":"",
   "x-type":"section",
   "x-displayName":"Voice Setup"
  },
  {
   "name":"number-registration",
   "description":"Manage your number compliance for sending A2P messages in the US and US Territories.\n\nAn A2P 10-digit long code – otherwise known as 10DLC – is a phone number approved for automated business messaging to send high volumes of SMS and MMS messages.  For more details, visit our [Documentation Hub](https://www.infobip.com/docs/10dlc).\n\n## Who this API is for\n\nAny US business or organization wanting to send A2P messages via 10DLC must go through a process that includes registering a brand and submitting a campaign. These processes give the mobile network operators (MNO) a way to control message traffic on their networks.\n\nUse this API to register a brand, vet it, and provide required information about a messaging campaign before you can start using a 10DLC that you [have purchased](#platform-&-connectivity/numbers).\n\n## 10DLC concepts explained\n\n* **Brand Registration** - Once a brand is created, it needs to be registered with an organization called [The Campaign Registry (TCR)](https://www.campaignregistry.com/). When you register a brand successfully, TCR assigns a Verified status and you can then start submitting campaigns tied to the brand. If TCR is unable to verify your brand and assigns a status of Unverified, you will not be able to submit any campaigns until the brand is successfully verified.\n* **Vetting** - Each major MNO has created their own mechanism for determining the throughput you receive. If you aren't satisfied with the AT&T throughput or T-Mobile threshold you receive, you can request third-party vetting. Vetting a brand may only be performed once every 30 days and it is a paid service.\n* **Campaign** - Contains information about the messages you intend to send. Every campaign must be associated with a brand.\n\n## Quick Workflow Overview\n\n1. Create a [brand](#platform-connectivity/number-registration/create-brand).\n2. [Register the brand](#platform-connectivity/number-registration/register-brand) with The Campaign Registry.\n  - If the brand is successfully verified, start submitting campaigns tied to that brand.\n  - If the brand hasn't been successfully verified or you want a higher throughput or threshold, [vet a brand](#platform-connectivity/number-registration/vet-brand) with the third party.\n3. Create a [campaign](#platform-connectivity/number-registration/create-campaign).\n4. [Register the campaign](#platform-connectivity/number-registration/register-campaign) with a mobile network operator.\n",
   "x-type":"module",
   "x-displayName":"USA Number Registration"
  },
  {
   "name":"brands",
   "description":"",
   "x-type":"submodule",
   "x-displayName":"Brands"
  },
  {
   "name":"brand-management",
   "description":"",
   "x-type":"section",
   "x-displayName":"Brand Management"
  },
  {
   "name":"brand-vetting",
   "description":"",
   "x-type":"section",
   "x-displayName":"Brand Vetting"
  },
  {
   "name":"campaigns",
   "description":"",
   "x-type":"submodule",
   "x-displayName":"Campaigns"
  },
  {
   "name":"number-pools",
   "description":"",
   "x-type":"submodule",
   "x-displayName":"Number Pools"
  },
  {
   "name":"documents",
   "description":"",
   "x-type":"submodule",
   "x-displayName":"Documents"
  },
  {
   "name":"ai-assistant",
   "description":"",
   "x-type":"submodule",
   "x-displayName":"Compliance AI assistant"
  }
 ],
 "paths":{
  "/numbers/1/numbers/available":{
   "get":{
    "tags":[
     "platform",
     "numbers",
     "phone-numbers"
    ],
    "summary":"Get available numbers",
    "description":"Use this method to get all the numbers available to buy. Use the query parameters to filter the returned numbers for specific details.",
    "externalDocs":{
     "description":"Read more about number types",
     "url":"https://www.infobip.com/docs/numbers/types"
    },
    "operationId":"get-available-numbers",
    "parameters":[
     {
      "name":"capabilities",
      "in":"query",
      "description":"An array of communication channels the number is able to support.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"array",
       "items":{
        "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumberCapabilityType"
       }
      }
     },
     {
      "name":"country",
      "in":"query",
      "description":"The number's country code.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"string"
      }
     },
     {
      "name":"state",
      "in":"query",
      "description":"US Numbers only: US state",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"string"
      }
     },
     {
      "name":"npa",
      "in":"query",
      "description":"US numbers only: area code.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"integer",
       "format":"int32"
      }
     },
     {
      "name":"nxx",
      "in":"query",
      "description":"US numbers only: the 3 digits following the area code.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"integer",
       "format":"int32"
      }
     },
     {
      "name":"limit",
      "in":"query",
      "description":"Number of records returned per page.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"integer",
       "format":"int32",
       "default":10
      }
     },
     {
      "name":"number",
      "in":"query",
      "description":"Searched number.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"string"
      }
     },
     {
      "name":"page",
      "in":"query",
      "description":"Page number. Use it with `limit` for paging purposes.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"integer",
       "format":"int32",
       "default":0
      }
     }
    ],
    "responses":{
     "200":{
      "description":"OK",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumbersResponse"
        },
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "numbers":[
            {
             "numberKey":"78D8394AC3EG0460B4CF0E723FC31B49",
             "number":"79029555551",
             "country":"RU",
             "type":"VIRTUAL_LONG_NUMBER",
             "capabilities":[
              "SMS"
             ],
             "shared":false,
             "price":{
              "pricePerMonth":15,
              "setupPrice":0,
              "initialMonthPrice":9.193549,
              "currency":"EUR"
             }
            },
            {
             "numberKey":"3B9D1EACAB7FBDRN%EE03592BFCD6BE",
             "number":"79029555525",
             "country":"RU",
             "type":"VIRTUAL_LONG_NUMBER",
             "capabilities":[
              "SMS"
             ],
             "shared":false,
             "price":{
              "pricePerMonth":15,
              "setupPrice":0,
              "initialMonthPrice":9.193549,
              "currency":"EUR"
             }
            }
           ],
           "numberCount":2
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"Not Found"
     },
     "429":{
      "$ref":"#/components/responses/ApiException429"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-additionalInfo":{
     "markdown":"### Related\n- [Use case: Making an appointment using 2-way SMS communication](https://www.infobip.com/docs/use-cases/appointment-reminder-with-sms)\n"
    },
    "x-throttling-info":[
     {
      "type":"token",
      "replenishRate":1,
      "requestedTokens":1,
      "burstCapacity":2
     }
    ]
   }
  },
  "/numbers/1/numbers":{
   "get":{
    "tags":[
     "platform",
     "numbers",
     "phone-numbers"
    ],
    "summary":"List owned numbers",
    "description":"Use this method to get all the owned numbers for this account.",
    "operationId":"list-owned-numbers",
    "parameters":[
     {
      "name":"limit",
      "in":"query",
      "description":"Number of records returned per page.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"integer",
       "format":"int32",
       "default":50
      }
     },
     {
      "name":"number",
      "in":"query",
      "description":"Searched number.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"string"
      }
     },
     {
      "name":"page",
      "in":"query",
      "description":"Page number. Use with `limit` for paging purposes.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"integer",
       "format":"int32",
       "default":0
      }
     }
    ],
    "responses":{
     "200":{
      "description":"OK",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumbersResponse"
        },
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "numbers":[
            {
             "numberKey":"6FED0BC540BFADD9B05ED7D89AAC22FA",
             "number":"447860041117",
             "country":"GB",
             "countryName":"United Kingdom",
             "type":"VIRTUAL_LONG_NUMBER",
             "capabilities":[
              "SMS"
             ],
             "shared":false,
             "price":{
              "pricePerMonth":5,
              "setupPrice":0,
              "currency":"EUR"
             },
             "network":"02 (Telefonica UK Ltd)",
             "keywords":[
              "test",
              "stop"
             ],
             "additionalSetupRequired":false,
             "editPermissions":{
              "canEditNumber":true,
              "canEditConfiguration":true
             },
             "applicationId":"default"
            }
           ],
           "numberCount":1
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"Not Found"
     },
     "429":{
      "$ref":"#/components/responses/ApiException429"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-additionalInfo":{
     "markdown":"### Related\n- [Use case: Making an appointment using 2-way SMS communication](https://www.infobip.com/docs/use-cases/appointment-reminder-with-sms)\n"
    },
    "x-throttling-info":[
     {
      "type":"token",
      "replenishRate":1,
      "requestedTokens":1,
      "burstCapacity":2
     }
    ]
   },
   "post":{
    "tags":[
     "platform",
     "numbers",
     "phone-numbers"
    ],
    "summary":"Purchase number",
    "description":"Using the number ID or number, this method enables you to buy a new number. For buying a US number, only the number should be provided. For all other purchases, only the numberKey must be provided.",
    "externalDocs":{
     "description":"Read more about buying a number",
     "url":"https://www.infobip.com/docs/numbers/buy"
    },
    "operationId":"purchase-number",
    "requestBody":{
     "description":"Either numberKey of the number to be purchased or a number needs to be provided",
     "content":{
      "application/json":{
       "schema":{
        "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.PurchaseNumberRequest"
       },
       "examples":{
        "numberKey":{
         "summary":"numberKey",
         "description":"numberKey",
         "value":{
          "numberKey":"58B3840032C7774BAC840EEEA2C23A44"
         }
        },
        "number":{
         "summary":"number",
         "description":"number",
         "value":{
          "number":"12223850630"
         }
        }
       }
      }
     },
     "required":true
    },
    "responses":{
     "200":{
      "description":"OK",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumberResponse"
        },
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "numberKey":"58B3840032C7774BAC840EEEA2C23A44",
           "number":"447860041117",
           "country":"GB",
           "type":"VIRTUAL_LONG_NUMBER",
           "capabilities":[
            "SMS"
           ],
           "shared":false,
           "price":{
            "pricePerMonth":5,
            "setupPrice":0,
            "currency":"EUR"
           }
          }
         }
        }
       }
      }
     },
     "201":{
      "description":"Created"
     },
     "400":{
      "$ref":"#/components/responses/ApiException400"
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"Not Found"
     },
     "429":{
      "description":"Too many requests",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/fc7dd544c10bf8ba502ba371088d1382022decf6a1acc2d0fa20f0b7f272047d.ApiException"
        },
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"TOO_MANY_REQUESTS",
             "text":"Too many requests"
            }
           }
          }
         }
        }
       }
      }
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-additionalInfo":{
     "markdown":"### Related\n- [Use case: Making an appointment using 2-way SMS communication](https://www.infobip.com/docs/use-cases/appointment-reminder-with-sms)\n"
    },
    "x-throttling-info":[
     {
      "type":"time",
      "numberOfRequests":1,
      "numberOfTimeUnits":0,
      "timeUnit":"s"
     }
    ]
   }
  },
  "/numbers/1/numbers/{numberKey}":{
   "get":{
    "tags":[
     "platform",
     "numbers",
     "phone-numbers"
    ],
    "summary":"Get single owned number",
    "description":"Get information about an owned number using the unique ID of the number.",
    "operationId":"get-single-owned-number",
    "parameters":[
     {
      "name":"numberKey",
      "in":"path",
      "description":"The unique ID of the number for which information is requested.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string"
      }
     }
    ],
    "responses":{
     "200":{
      "description":"OK",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumberResponse"
        },
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "numberKey":"6FED0BC540BFADD9B05ED7D89AAC22FA",
           "number":"447860041117",
           "country":"GB",
           "type":"VIRTUAL_LONG_NUMBER",
           "capabilities":[
            "SMS"
           ],
           "shared":false,
           "price":{
            "pricePerMonth":5,
            "setupPrice":0,
            "currency":"EUR"
           }
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"Not Found"
     },
     "429":{
      "$ref":"#/components/responses/ApiException429"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-additionalInfo":{
     "markdown":"### Related\n- [Use case: Making an appointment using 2-way SMS communication](https://www.infobip.com/docs/use-cases/appointment-reminder-with-sms)\n"
    },
    "x-throttling-info":[
     {
      "type":"time",
      "numberOfRequests":10,
      "numberOfTimeUnits":0,
      "timeUnit":"s"
     }
    ]
   },
   "put":{
    "tags":[
     "platform",
     "numbers",
     "phone-numbers"
    ],
    "summary":"Update owned number",
    "description":"Use this method to update the application and the entity, if required, that is linked to a number.",
    "operationId":"update-owned-number",
    "parameters":[
     {
      "name":"numberKey",
      "in":"path",
      "description":"Unique ID of a number.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string"
      }
     }
    ],
    "requestBody":{
     "content":{
      "application/json":{
       "schema":{
        "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.UpdateOwnedNumberRequest"
       },
       "examples":{
        "Request example":{
         "summary":"Request example",
         "value":{
          "applicationId":"appId",
          "entityId":"entId"
         }
        }
       }
      }
     },
     "required":true
    },
    "responses":{
     "200":{
      "description":"OK",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumberResponse"
        },
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "numberKey":"58B3840032C7774BAC840EEEA2C23A44",
           "number":"447860041117",
           "country":"GB",
           "type":"VIRTUAL_LONG_NUMBER",
           "capabilities":[
            "SMS"
           ],
           "shared":false,
           "price":{
            "pricePerMonth":5,
            "setupPrice":0,
            "currency":"EUR"
           },
           "applicationId":"appId",
           "entityId":"entId"
          }
         }
        }
       }
      }
     },
     "400":{
      "$ref":"#/components/responses/ApiException400"
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"Not Found"
     },
     "429":{
      "description":"Too many requests",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/fc7dd544c10bf8ba502ba371088d1382022decf6a1acc2d0fa20f0b7f272047d.ApiException"
        },
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"TOO_MANY_REQUESTS",
             "text":"Too many requests"
            }
           }
          }
         }
        }
       }
      }
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-throttling-info":[
     {
      "type":"time",
      "numberOfRequests":1,
      "numberOfTimeUnits":0,
      "timeUnit":"s"
     }
    ]
   },
   "delete":{
    "tags":[
     "platform",
     "numbers",
     "phone-numbers"
    ],
    "summary":"Cancel number",
    "description":"This method will cancel your number. Any number purchased from Infobip Numbers inventory you cancel will become available in the numbers pool for anyone to buy.",
    "externalDocs":{
     "description":"Read more about canceling a number",
     "url":"https://www.infobip.com/docs/numbers/getting-started#cancelling-numbers-over-web-interface-numbers-over-web-interface"
    },
    "operationId":"cancel-number",
    "parameters":[
     {
      "name":"numberKey",
      "in":"path",
      "description":"Unique ID of a number.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string"
      }
     }
    ],
    "responses":{
     "204":{
      "description":"No Content"
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "$ref":"#/components/responses/ApiException404"
     },
     "429":{
      "$ref":"#/components/responses/ApiException429"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-additionalInfo":{
     "markdown":"### Related\n- [Use case: Making an appointment using 2-way SMS communication](https://www.infobip.com/docs/use-cases/appointment-reminder-with-sms)\n"
    },
    "x-throttling-info":[
     {
      "type":"time",
      "numberOfRequests":1,
      "numberOfTimeUnits":0,
      "timeUnit":"s"
     }
    ]
   }
  },
  "/numbers/2/numbers/{numberKey}/sms":{
   "get":{
    "tags":[
     "platform",
     "numbers",
     "my-numbers",
     "number-configuration"
    ],
    "summary":"Get all number configurations",
    "description":"List all configurations set up for a number.",
    "operationId":"list-configurations-for-number",
    "parameters":[
     {
      "name":"limit",
      "in":"query",
      "description":"Number of records returned per page.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"integer",
       "format":"int32",
       "default":50
      }
     },
     {
      "name":"numberKey",
      "in":"path",
      "description":"Unique ID of a number.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string"
      }
     },
     {
      "name":"page",
      "in":"query",
      "description":"Page number. Use with `limit` for paging purposes.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"integer",
       "format":"int32",
       "default":0
      }
     }
    ],
    "responses":{
     "200":{
      "description":"OK",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoConfigurations"
        },
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "configurations":[
            {
             "key":"6336C2CCF10E74B705340E70D8E06BD6",
             "keyword":"KEYWORD1",
             "action":{
              "type":"HTTP_FORWARD",
              "url":"http://something.com"
             },
             "otherActionsDetails":[
              {
               "message":"Auto response message text.",
               "editable":true,
               "type":"AUTORESPONSE"
              }
             ],
             "otherActions":[
              "AUTORESPONSE"
             ]
            },
            {
             "key":"8F0792F86035A9F4290821F1EE6BC06A",
             "keyword":"KEYWORD2",
             "action":{
              "type":"MAIL_FORWARD",
              "mail":"someone@something.com"
             },
             "otherActionsDetails":[
              {
               "blockType":"FROM_SENDER",
               "editable":true,
               "type":"BLOCK"
              }
             ],
             "otherActions":[
              "BLOCK"
             ]
            }
           ],
           "totalCount":2
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"Not Found"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "deprecated":true,
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-deprecationInformation":{
     "deprecation":"2024-03-13T12:00:00+0000",
     "successorOperationId":"get-inbound-configurations"
    }
   },
   "put":{
    "tags":[
     "platform",
     "numbers",
     "my-numbers",
     "number-configuration"
    ],
    "summary":"Update number configuration",
    "description":"Update configuration details. Parameters used vary depending on the action type, the same as with the Create a new configuration method.",
    "externalDocs":{
     "description":"Read more about keywords",
     "url":"https://www.infobip.com/docs/numbers/keywords-and-actions"
    },
    "operationId":"modify-sms-configurations",
    "parameters":[
     {
      "name":"numberKey",
      "in":"path",
      "description":"Unique ID of a number.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string"
      }
     }
    ],
    "requestBody":{
     "description":"Configuration with updated values.",
     "content":{
      "application/json":{
       "schema":{
        "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.StoredMoConfiguration"
       },
       "examples":{
        "MAIL_FORWARD":{
         "summary":"MAIL_FORWARD",
         "description":"Update setup to Mail Forward configuration, or update current Mail Forward configuration",
         "value":{
          "key":"E9FCDCA496035F08EEA5933702EDF745",
          "keyword":"NEWKW",
          "action":{
           "type":"MAIL_FORWARD",
           "mail":"someone@something.com"
          }
         }
        },
        "HTTP_Forward":{
         "summary":"HTTP_Forward",
         "description":"Update setup to HTTP Forward configuration, or update current HTTP Forward configuration",
         "value":{
          "key":"E9FCDCA496035F08EEA5933702EDF745",
          "keyword":"KEYWORD1",
          "action":{
           "type":"HTTP_FORWARD",
           "url":"http://something.com",
           "httpMethod":"POST",
           "contentType":"JSON"
          }
         }
        },
        "SMPP_Forward":{
         "summary":"SMPP_Forward",
         "description":"Update setup to Mail SMPP configuration, or update current SMPP Forward configuration",
         "value":{
          "key":"E9FCDCA496035F08EEA5933702EDF745",
          "keyword":"KEYWORD2",
          "action":{
           "type":"SMPP_FORWARD"
          }
         }
        },
        "PULL":{
         "summary":"PULL",
         "description":"Update setup to PULL configuration, or update current PULL configuration",
         "value":{
          "key":"E9FCDCA496035F08EEA5933702EDF745",
          "keyword":"KEYWORD2",
          "action":{
           "type":"PULL"
          }
         }
        }
       }
      }
     },
     "required":true
    },
    "responses":{
     "200":{
      "description":"OK",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.StoredMoConfiguration"
        },
        "examples":{
         "HTTP_FORWARD":{
          "summary":"HTTP_FORWARD",
          "description":"Response for HTTP_FORWARD forwarding type",
          "value":{
           "key":"E9FCDCA496035F08EEA5933702EDF745",
           "keyword":"KEYWORD1",
           "action":{
            "url":"http://something.com",
            "httpMethod":"POST",
            "contentType":"JSON",
            "type":"HTTP_FORWARD"
           },
           "useConversation":{
            "enabled":false
           },
           "otherActionsDetails":[],
           "otherActions":[]
          }
         },
         "MAIL_FORWARD":{
          "summary":"MAIL_FORWARD",
          "description":"Response for MAIL_FORWARD forwarding type",
          "value":{
           "key":"E9FCDCA496035F08EEA5933702EDF745",
           "keyword":"NEWKW",
           "action":{
            "mail":"someone@something.com",
            "type":"MAIL_FORWARD"
           },
           "useConversation":{
            "enabled":true
           },
           "otherActionsDetails":[],
           "otherActions":[]
          }
         },
         "SMPP_FORWARD":{
          "summary":"SMPP_FORWARD",
          "description":"Response for SMPP_FORWARD forwarding type",
          "value":{
           "key":"E9FCDCA496035F08EEA5933702EDF745",
           "keyword":"KEYWORD2",
           "action":{
            "type":"SMPP_FORWARD"
           },
           "useConversation":{
            "enabled":false
           },
           "otherActionsDetails":[],
           "otherActions":[]
          }
         },
         "PULL":{
          "summary":"PULL",
          "description":"Response for PULL type",
          "value":{
           "key":"E9FCDCA496035F08EEA5933702EDF745",
           "keyword":"KEYWORD2",
           "action":{
            "type":"PULL"
           },
           "useConversation":{
            "enabled":false
           },
           "otherActionsDetails":[],
           "otherActions":[]
          }
         }
        }
       }
      }
     },
     "400":{
      "$ref":"#/components/responses/ApiException400"
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"Not Found"
     },
     "429":{
      "$ref":"#/components/responses/ApiException429"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "deprecated":true,
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-deprecationInformation":{
     "deprecation":"2024-03-13T12:00:00+0000",
     "successorOperationId":"manage-inbound-configuration"
    },
    "x-throttling-info":[
     {
      "type":"token",
      "replenishRate":2,
      "requestedTokens":1,
      "burstCapacity":10
     }
    ]
   },
   "post":{
    "tags":[
     "platform",
     "numbers",
     "my-numbers",
     "number-configuration"
    ],
    "summary":"Create number configuration",
    "description":"Create a new configuration for the number. The parameters used for setting up a configuration depend on the action type. Check the examples for more details.",
    "externalDocs":{
     "description":"Read more about keywords",
     "url":"https://www.infobip.com/docs/numbers/keywords-and-actions"
    },
    "operationId":"create-new-configuration",
    "parameters":[
     {
      "name":"numberKey",
      "in":"path",
      "description":"Unique ID of a number.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string"
      }
     }
    ],
    "requestBody":{
     "description":"configuration",
     "content":{
      "application/json":{
       "schema":{
        "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoConfiguration"
       },
       "examples":{
        "MAIL_FORWARD":{
         "summary":"MAIL_FORWARD",
         "description":"Setup of MAIL_FORWARD forwarding type",
         "value":{
          "keyword":"NEWKW",
          "action":{
           "type":"MAIL_FORWARD",
           "mail":"someone@something.com"
          }
         }
        },
        "HTTP_Forward":{
         "summary":"HTTP_Forward",
         "description":"Setup of HTTP_FORWARD forwarding type",
         "value":{
          "keyword":"KEYWORD1",
          "action":{
           "type":"HTTP_FORWARD",
           "url":"http://something.com",
           "httpMethod":"POST",
           "contentType":"JSON"
          }
         }
        },
        "SMPP_Forward":{
         "summary":"SMPP_Forward",
         "description":"Setup of SMPP_FORWARD forwarding type",
         "value":{
          "keyword":"KEYWORD2",
          "action":{
           "type":"SMPP_FORWARD"
          }
         }
        },
        "PULL":{
         "summary":"PULL",
         "description":"Setup of PULL forwarding type",
         "value":{
          "keyword":"KEYWORD2",
          "action":{
           "type":"PULL"
          }
         }
        }
       }
      }
     },
     "required":true
    },
    "responses":{
     "200":{
      "description":"OK",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.StoredMoConfiguration"
        },
        "examples":{
         "HTTP_FORWARD":{
          "summary":"HTTP_FORWARD",
          "description":"Response for HTTP_FORWARD forwarding type",
          "value":{
           "key":"E9FCDCA496035F08EEA5933702EDF745",
           "keyword":"KEYWORD1",
           "action":{
            "url":"http://something.com",
            "httpMethod":"POST",
            "contentType":"JSON",
            "type":"HTTP_FORWARD"
           },
           "useConversation":{
            "enabled":false
           },
           "otherActionsDetails":[],
           "otherActions":[]
          }
         },
         "MAIL_FORWARD":{
          "summary":"MAIL_FORWARD",
          "description":"Response for MAIL_FORWARD forwarding type",
          "value":{
           "key":"E9FCDCA496035F08EEA5933702EDF745",
           "keyword":"NEWKW",
           "action":{
            "mail":"someone@something.com",
            "type":"MAIL_FORWARD"
           },
           "useConversation":{
            "enabled":true
           },
           "otherActionsDetails":[],
           "otherActions":[]
          }
         },
         "SMPP_FORWARD":{
          "summary":"SMPP_FORWARD",
          "description":"Response for SMPP_FORWARD forwarding type",
          "value":{
           "key":"E9FCDCA496035F08EEA5933702EDF745",
           "keyword":"KEYWORD2",
           "action":{
            "type":"SMPP_FORWARD"
           },
           "useConversation":{
            "enabled":false
           },
           "otherActionsDetails":[],
           "otherActions":[]
          }
         },
         "PULL":{
          "summary":"PULL",
          "description":"Response for PULL type",
          "value":{
           "key":"E9FCDCA496035F08EEA5933702EDF745",
           "keyword":"KEYWORD2",
           "action":{
            "type":"PULL"
           },
           "useConversation":{
            "enabled":false
           },
           "otherActionsDetails":[],
           "otherActions":[]
          }
         }
        }
       }
      }
     },
     "400":{
      "$ref":"#/components/responses/ApiException400"
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"Not Found"
     },
     "429":{
      "$ref":"#/components/responses/ApiException429"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "deprecated":true,
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-deprecationInformation":{
     "deprecation":"2024-03-13T12:00:00+0000",
     "successorOperationId":"manage-inbound-configuration"
    },
    "x-throttling-info":[
     {
      "type":"token",
      "replenishRate":2,
      "requestedTokens":1,
      "burstCapacity":10
     }
    ]
   }
  },
  "/numbers/2/numbers/{numberKey}/sms/{configurationKey}":{
   "get":{
    "tags":[
     "platform",
     "numbers",
     "my-numbers",
     "number-configuration"
    ],
    "summary":"Get single number configuration",
    "description":"This method fetches a single configuration details set up for the number.",
    "operationId":"get-single-configuration",
    "parameters":[
     {
      "name":"configurationKey",
      "in":"path",
      "description":"Unique ID of configuration.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string"
      }
     },
     {
      "name":"numberKey",
      "in":"path",
      "description":"Unique ID of a number.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string"
      }
     }
    ],
    "responses":{
     "200":{
      "description":"OK",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.StoredMoConfiguration"
        },
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "key":"E9FCDCA496035F08EEA5933702EDF745",
           "keyword":"KEYWORD",
           "action":{
            "url":"http://something.com",
            "httpMethod":"POST",
            "contentType":"JSON",
            "type":"HTTP_FORWARD"
           },
           "useConversation":{
            "enabled":true
           },
           "otherActionsDetails":[],
           "otherActions":[]
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"Not Found"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "deprecated":true,
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-deprecationInformation":{
     "deprecation":"2024-03-13T12:00:00+0000",
     "successorOperationId":"get-inbound-configurations"
    }
   },
   "delete":{
    "tags":[
     "platform",
     "numbers",
     "my-numbers",
     "number-configuration"
    ],
    "summary":"Delete number configuration",
    "description":"This method will delete the configuration. If there are no configurations, you can still retrieve any incoming message by using a Get received messages method.",
    "operationId":"delete-configuration",
    "parameters":[
     {
      "name":"configurationKey",
      "in":"path",
      "description":"Unique ID of configuration.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string"
      }
     },
     {
      "name":"numberKey",
      "in":"path",
      "description":"Unique ID of a number.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string"
      }
     }
    ],
    "responses":{
     "204":{
      "description":"No Content"
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "$ref":"#/components/responses/ApiException404"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "deprecated":true,
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-deprecationInformation":{
     "deprecation":"2024-03-13T12:00:00+0000",
     "successorOperationId":"delete-inbound-configuration"
    }
   }
  },
  "/numbers/2/numbers/{numberKey}/mms":{
   "get":{
    "tags":[
     "platform",
     "numbers",
     "my-numbers",
     "number-mms-configuration"
    ],
    "summary":"Get all number MMS configurations",
    "description":"List all MMS configurations set up for a number.",
    "operationId":"get-mms-configurations",
    "parameters":[
     {
      "name":"limit",
      "in":"query",
      "description":"Number of records returned per page.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"integer",
       "format":"int32",
       "default":50
      }
     },
     {
      "name":"numberKey",
      "in":"path",
      "description":"Unique ID of a number.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string"
      }
     },
     {
      "name":"page",
      "in":"query",
      "description":"Page number. Use with `limit` for paging purposes.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"integer",
       "format":"int32",
       "default":0,
       "minimum":0
      }
     }
    ],
    "responses":{
     "200":{
      "description":"OK",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MmsConfigurations"
        },
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "configurations":[
            {
             "keyword":"EXAMPLE",
             "action":{
              "url":"https://url-example.com",
              "description":"Description example",
              "contentFormat":"MMS_JSON",
              "type":"HTTP_FORWARD"
             },
             "otherActions":[],
             "applicationId":"application-identifier-example",
             "entityId":"entity-identifier-example",
             "key":"5A385D1A5ABBC5B3FCE4DBFE19D3C27D"
            },
            {
             "keyword":"EXAMPLE2",
             "action":{
              "description":"Description example",
              "type":"PULL"
             },
             "otherActions":[],
             "applicationId":"application-identifier-example",
             "entityId":"entity-identifier-example",
             "key":"092D77CC41E7C90B8742F536905C9FBD"
            },
            {
             "keyword":"EXAMPLE3",
             "action":{
              "type":"NO_ACTION"
             },
             "otherActions":[],
             "applicationId":"application-identifier-example",
             "entityId":"entity-identifier-example",
             "key":"BFCCCF0649CB8779962D2AC665103485"
            }
           ],
           "totalCount":3
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"Not Found"
     },
     "429":{
      "$ref":"#/components/responses/ApiException429"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "deprecated":true,
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-deprecationInformation":{
     "deprecation":"2024-03-13T12:00:00+0000",
     "successorOperationId":"get-inbound-configurations"
    },
    "x-throttling-info":[
     {
      "type":"time",
      "numberOfRequests":10,
      "numberOfTimeUnits":0,
      "timeUnit":"s"
     }
    ]
   },
   "post":{
    "tags":[
     "platform",
     "numbers",
     "my-numbers",
     "number-mms-configuration"
    ],
    "summary":"Create number MMS configuration",
    "description":"Create a new MMS configuration for the number. The parameters used for setting up a configuration depend on the action type. Check the examples for more details.",
    "externalDocs":{
     "description":"Read more about keywords",
     "url":"https://www.infobip.com/docs/numbers/keywords-and-actions"
    },
    "operationId":"create-mms-configuration",
    "parameters":[
     {
      "name":"numberKey",
      "in":"path",
      "description":"Unique ID of a number.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string"
      }
     }
    ],
    "requestBody":{
     "description":"configuration",
     "content":{
      "application/json":{
       "schema":{
        "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MmsConfiguration"
       },
       "examples":{
        "HTTP_Forward":{
         "summary":"HTTP_Forward",
         "description":"Setup of HTTP_FORWARD forwarding type",
         "value":{
          "keyword":"EXAMPLE",
          "action":{
           "url":"https://url-example.com",
           "description":"Description example",
           "contentFormat":"MMS_JSON",
           "type":"HTTP_FORWARD"
          },
          "applicationId":"application-identifier-example",
          "entityId":"entity-identifier-example"
         }
        },
        "PULL":{
         "summary":"PULL",
         "description":"Setup of PULL forwarding type",
         "value":{
          "keyword":"EXAMPLE2",
          "action":{
           "description":"Description example",
           "type":"PULL"
          },
          "applicationId":"application-identifier-example",
          "entityId":"entity-identifier-example"
         }
        },
        "NO_ACTION":{
         "summary":"NO_ACTION",
         "description":"No action example",
         "value":{
          "keyword":"EXAMPLE3",
          "action":{
           "type":"NO_ACTION"
          },
          "applicationId":"application-identifier-example",
          "entityId":"entity-identifier-example"
         }
        }
       }
      }
     },
     "required":true
    },
    "responses":{
     "200":{
      "description":"OK",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MmsConfiguration"
        },
        "examples":{
         "HTTP_FORWARD":{
          "summary":"HTTP_FORWARD",
          "description":"Response for HTTP_FORWARD forwarding type",
          "value":{
           "keyword":"EXAMPLE",
           "action":{
            "url":"https://url-example.com",
            "description":"Description example",
            "contentFormat":"MMS_JSON",
            "type":"HTTP_FORWARD"
           },
           "otherActions":[],
           "applicationId":"application-identifier-example",
           "entityId":"entity-identifier-example",
           "key":"5A385D1A5ABBC5B3FCE4DBFE19D3C27D"
          }
         },
         "PULL":{
          "summary":"PULL",
          "description":"Response for PULL type",
          "value":{
           "keyword":"EXAMPLE2",
           "action":{
            "description":"Description example",
            "type":"PULL"
           },
           "otherActions":[],
           "applicationId":"application-identifier-example",
           "entityId":"entity-identifier-example",
           "key":"092D77CC41E7C90B8742F536905C9FBD"
          }
         },
         "NO_ACTION":{
          "summary":"NO_ACTION",
          "description":"Response for NO_ACTION type",
          "value":{
           "keyword":"EXAMPLE3",
           "action":{
            "type":"NO_ACTION"
           },
           "otherActions":[],
           "applicationId":"application-identifier-example",
           "entityId":"entity-identifier-example",
           "key":"BFCCCF0649CB8779962D2AC665103485"
          }
         }
        }
       }
      }
     },
     "400":{
      "$ref":"#/components/responses/ApiException400"
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"Not Found"
     },
     "429":{
      "$ref":"#/components/responses/ApiException429"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "deprecated":true,
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-deprecationInformation":{
     "deprecation":"2024-03-13T12:00:00+0000",
     "successorOperationId":"manage-inbound-configuration"
    },
    "x-throttling-info":[
     {
      "type":"token",
      "replenishRate":2,
      "requestedTokens":1,
      "burstCapacity":10
     }
    ]
   }
  },
  "/numbers/2/numbers/{numberKey}/mms/{configurationKey}":{
   "get":{
    "tags":[
     "platform",
     "numbers",
     "my-numbers",
     "number-mms-configuration"
    ],
    "summary":"Get number MMS configuration",
    "description":"This method fetches a single MMS configuration details set up for the number.",
    "operationId":"get-mms-configuration",
    "parameters":[
     {
      "name":"configurationKey",
      "in":"path",
      "description":"Unique ID of configuration.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string"
      }
     },
     {
      "name":"numberKey",
      "in":"path",
      "description":"Unique ID of a number.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string"
      }
     }
    ],
    "responses":{
     "200":{
      "description":"OK",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MmsConfiguration"
        },
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "keyword":"EXAMPLE",
           "action":{
            "url":"https://url-example.com",
            "description":"Description example",
            "contentFormat":"MMS_JSON",
            "type":"HTTP_FORWARD"
           },
           "otherActions":[],
           "applicationId":"application-identifier-example",
           "entityId":"entity-identifier-example",
           "key":"5A385D1A5ABBC5B3FCE4DBFE19D3C27D"
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"Not Found"
     },
     "429":{
      "$ref":"#/components/responses/ApiException429"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "deprecated":true,
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-deprecationInformation":{
     "deprecation":"2024-03-13T12:00:00+0000",
     "successorOperationId":"get-inbound-configurations"
    },
    "x-throttling-info":[
     {
      "type":"time",
      "numberOfRequests":10,
      "numberOfTimeUnits":0,
      "timeUnit":"s"
     }
    ]
   },
   "put":{
    "tags":[
     "platform",
     "numbers",
     "my-numbers",
     "number-mms-configuration"
    ],
    "summary":"Update number MMS configuration",
    "description":"Update MMS configuration details. Parameters used vary depending on the action type, the same as with the Create a new MMS configuration method.",
    "externalDocs":{
     "description":"Read more about keywords",
     "url":"https://www.infobip.com/docs/numbers/keywords-and-actions"
    },
    "operationId":"update-mms-configuration",
    "parameters":[
     {
      "name":"numberKey",
      "in":"path",
      "description":"Unique ID of a number.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string"
      }
     },
     {
      "name":"configurationKey",
      "in":"path",
      "description":"Unique ID of configuration.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string"
      }
     }
    ],
    "requestBody":{
     "description":"Configuration with updated values.",
     "content":{
      "application/json":{
       "schema":{
        "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MmsConfiguration"
       },
       "examples":{
        "HTTP_Forward":{
         "summary":"HTTP_Forward",
         "description":"Update setup to HTTP Forward configuration, or update current HTTP Forward configuration",
         "value":{
          "keyword":"EXAMPLE-UPDATE",
          "action":{
           "url":"https://url-example-updated.com",
           "description":"Description example - updated",
           "contentFormat":"MMS_JSON",
           "type":"HTTP_FORWARD"
          },
          "applicationId":"application-identifier-example",
          "entityId":"entity-identifier-example"
         }
        },
        "PULL":{
         "summary":"PULL",
         "description":"Update setup to PULL configuration, or update current PULL configuration",
         "value":{
          "keyword":"EXAMPLE2",
          "action":{
           "description":"Description example - updated",
           "type":"PULL"
          },
          "applicationId":"application-identifier-example-update",
          "entityId":"entity-identifier-example-update"
         }
        },
        "NO_ACTION":{
         "summary":"NO_ACTION",
         "description":"Update NO ACTION configuration",
         "value":{
          "keyword":"EXAMPLE3 - update",
          "action":{
           "type":"NO_ACTION"
          },
          "applicationId":"application-identifier-example-update",
          "entityId":"entity-identifier-example"
         }
        }
       }
      }
     },
     "required":true
    },
    "responses":{
     "200":{
      "description":"OK",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MmsConfiguration"
        },
        "examples":{
         "HTTP_FORWARD":{
          "summary":"HTTP_FORWARD",
          "description":"Response for HTTP_FORWARD forwarding type",
          "value":{
           "keyword":"EXAMPLE-UPDATE",
           "action":{
            "url":"https://url-example-updated.com",
            "description":"Description example - updated",
            "contentFormat":"MMS_JSON",
            "type":"HTTP_FORWARD"
           },
           "otherActions":[],
           "applicationId":"application-identifier-example",
           "entityId":"entity-identifier-example",
           "key":"5A385D1A5ABBC5B3FCE4DBFE19D3C27D"
          }
         },
         "PULL":{
          "summary":"PULL",
          "description":"Response for PULL type",
          "value":{
           "keyword":"EXAMPLE2",
           "action":{
            "description":"Description example - updated",
            "type":"PULL"
           },
           "otherActions":[],
           "applicationId":"application-identifier-example-update",
           "entityId":"entity-identifier-example-update",
           "key":"092D77CC41E7C90B8742F536905C9FBD"
          }
         },
         "NO_ACTION":{
          "summary":"NO_ACTION",
          "description":"Response for NO_ACTION type",
          "value":{
           "keyword":"EXAMPLE3 - UPDATE",
           "action":{
            "type":"NO_ACTION"
           },
           "otherActions":[],
           "applicationId":"application-identifier-example-update",
           "entityId":"entity-identifier-example",
           "key":"BFCCCF0649CB8779962D2AC665103485"
          }
         }
        }
       }
      }
     },
     "400":{
      "$ref":"#/components/responses/ApiException400"
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"Not Found"
     },
     "429":{
      "$ref":"#/components/responses/ApiException429"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "deprecated":true,
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-deprecationInformation":{
     "deprecation":"2024-03-13T12:00:00+0000",
     "successorOperationId":"manage-inbound-configuration"
    },
    "x-throttling-info":[
     {
      "type":"token",
      "replenishRate":2,
      "requestedTokens":1,
      "burstCapacity":10
     }
    ]
   },
   "delete":{
    "tags":[
     "platform",
     "numbers",
     "my-numbers",
     "number-mms-configuration"
    ],
    "summary":"Delete number MMS configuration",
    "description":"This method will delete MMS configuration. If there are no configurations, you can still retrieve any incoming message by using a Get received messages method.",
    "operationId":"delete-mms-configuration",
    "parameters":[
     {
      "name":"configurationKey",
      "in":"path",
      "description":"Unique ID of configuration.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string"
      }
     },
     {
      "name":"numberKey",
      "in":"path",
      "description":"Unique ID of a number.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string"
      }
     }
    ],
    "responses":{
     "204":{
      "description":"No Content"
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "$ref":"#/components/responses/ApiException404"
     },
     "429":{
      "$ref":"#/components/responses/ApiException429"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "deprecated":true,
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-deprecationInformation":{
     "deprecation":"2024-03-13T12:00:00+0000",
     "successorOperationId":"delete-inbound-configuration"
    },
    "x-throttling-info":[
     {
      "type":"token",
      "replenishRate":2,
      "requestedTokens":1,
      "burstCapacity":10
     }
    ]
   }
  },
  "/numbers/2/numbers/{numberKey}/voice":{
   "get":{
    "tags":[
     "platform",
     "numbers",
     "my-numbers",
     "voice-configuration"
    ],
    "summary":"Get voice setup on number",
    "description":"This method fetches the voice setup on a number.",
    "operationId":"get-voice-setup-on-number",
    "parameters":[
     {
      "name":"numberKey",
      "in":"path",
      "description":"Unique ID of a number.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string"
      }
     }
    ],
    "responses":{
     "200":{
      "description":"OK",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.VoiceSetup"
        },
        "examples":{
         "VOICE_NUMBER_MASKING":{
          "summary":"Return Voice Number Masking configuration",
          "description":"VOICE_NUMBER_MASKING",
          "value":{
           "action":{
            "voiceNumberMaskingConfigKey":"C6A5995CBF4D2DF2ADE29963B3BB00E6",
            "type":"VOICE_NUMBER_MASKING"
           }
          }
         },
         "FORWARD_TO_IVR":{
          "summary":"Forward To IVR configuration",
          "description":"FORWARD_TO_IVR",
          "value":{
           "action":{
            "scenarioKey":"56FE9214E7A98F2D4CB44E647E3D3CED",
            "type":"FORWARD_TO_IVR"
           }
          }
         },
         "FORWARD_TO_CALL_ROUTING":{
          "summary":"Forward To Call Routing configuration",
          "description":"FORWARD_TO_CALL_ROUTING",
          "value":{
           "action":{
            "routeId":"71c1cd2e-fa30-450f-a6f7-56f2ae0adc6b",
            "type":"FORWARD_TO_CALL_ROUTING"
           }
          }
         },
         "FORWARD_TO_PSTN":{
          "summary":"Forward to PSTN configuration",
          "description":"FORWARD_TO_PSTN",
          "value":{
           "action":{
            "pstnNumber":"41793026731",
            "type":"FORWARD_TO_PSTN"
           }
          }
         },
         "FORWARD_TO_SUBSCRIPTION":{
          "summary":"Forward To Subscription configuration",
          "description":"FORWARD_TO_SUBSCRIPTION",
          "value":{
           "action":{
            "callsConfigurationId":"6b99b1ac-fe35-4be7-bb0e-93c00dbd2206",
            "type":"FORWARD_TO_SUBSCRIPTION"
           }
          }
         },
         "FORWARD_TO_MARKUP_LANGUAGE":{
          "summary":"Forward To Markup Language configuration",
          "description":"FORWARD_TO_MARKUP_LANGUAGE",
          "value":{
           "action":{
            "type":"FORWARD_TO_MARKUP_LANGUAGE",
            "markupLanguageConfigId":123456789
           }
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"Not Found"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ]
   },
   "put":{
    "tags":[
     "platform",
     "numbers",
     "my-numbers",
     "voice-configuration"
    ],
    "summary":"Update voice setup on number",
    "description":"This method updates voice setup previously created on a number.",
    "operationId":"update-voice-setup-on-number",
    "parameters":[
     {
      "name":"numberKey",
      "in":"path",
      "description":"Unique ID of a number.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string"
      }
     }
    ],
    "requestBody":{
     "description":"voiceSetup",
     "content":{
      "application/json":{
       "schema":{
        "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.VoiceSetup"
       },
       "examples":{
        "VOICE_NUMBER_MASKING":{
         "summary":"Update setup to Voice Number Masking, or update current Voice Number Masking setup",
         "description":"VOICE_NUMBER_MASKING",
         "value":{
          "action":{
           "voiceNumberMaskingConfigKey":"C6A5995CBF4D2DF2ADE29963B3BB00E6",
           "type":"VOICE_NUMBER_MASKING"
          }
         }
        },
        "FORWARD_TO_IVR":{
         "summary":"Update setup to Forward To IVR configuration, or update current Forward To IVR configuration",
         "description":"FORWARD_TO_IVR",
         "value":{
          "action":{
           "type":"FORWARD_TO_IVR",
           "scenarioKey":"56FE9214E7A98F2D4CB44E647E3D3CED"
          }
         }
        },
        "FORWARD_TO_CALL_ROUTING":{
         "summary":"Update setup to Forward To Call Routing configuration, or update current Forward To Call Routing configuration",
         "description":"FORWARD_TO_CALL_ROUTING",
         "value":{
          "action":{
           "type":"FORWARD_TO_CALL_ROUTING",
           "routeId":"71c1cd2e-fa30-450f-a6f7-56f2ae0adc6b"
          }
         }
        },
        "FORWARD_TO_PSTN":{
         "summary":"Update setup to Forward To PSTN configuration, or update current Forward To PSTN configuration",
         "description":"FORWARD_TO_PSTN",
         "value":{
          "action":{
           "type":"FORWARD_TO_PSTN",
           "pstnNumber":"41793026731"
          }
         }
        },
        "FORWARD_TO_SUBSCRIPTION":{
         "summary":"Update setup to Forward To Subscription configuration, or update current Forward To Subscription configuration",
         "description":"FORWARD_TO_SUBSCRIPTION",
         "value":{
          "action":{
           "type":"FORWARD_TO_SUBSCRIPTION",
           "callsConfigurationId":"6b99b1ac-fe35-4be7-bb0e-93c00dbd2206"
          }
         }
        },
        "FORWARD_TO_MARKUP_LANGUAGE":{
         "summary":"Update setup to Forward To Markup Language configuration, or update current Forward To Markup Language configuration",
         "description":"FORWARD_TO_MARKUP_LANGUAGE",
         "value":{
          "action":{
           "type":"FORWARD_TO_MARKUP_LANGUAGE",
           "markupLanguageConfigId":123456789
          }
         }
        }
       }
      }
     },
     "required":true
    },
    "responses":{
     "200":{
      "description":"OK",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.VoiceSetup"
        },
        "examples":{
         "VOICE_NUMBER_MASKING":{
          "summary":"Response for VOICE_NUMBER_MASKING type",
          "description":"VOICE_NUMBER_MASKING",
          "value":{
           "action":{
            "voiceNumberMaskingConfigKey":"C6A5995CBF4D2DF2ADE29963B3BB00E6",
            "type":"VOICE_NUMBER_MASKING"
           }
          }
         },
         "FORWARD_TO_IVR":{
          "summary":"Response for FORWARD_TO_IVR forwarding type",
          "description":"FORWARD_TO_IVR",
          "value":{
           "action":{
            "scenarioKey":"56FE9214E7A98F2D4CB44E647E3D3CED",
            "type":"FORWARD_TO_IVR"
           }
          }
         },
         "FORWARD_TO_CALL_ROUTING":{
          "summary":"Response for FORWARD_TO_CALL_ROUTING forwarding type",
          "description":"FORWARD_TO_CALL_ROUTING",
          "value":{
           "action":{
            "routeId":"71c1cd2e-fa30-450f-a6f7-56f2ae0adc6b",
            "type":"FORWARD_TO_CALL_ROUTING"
           }
          }
         },
         "FORWARD_TO_PSTN":{
          "summary":"Response for FORWARD_TO_PSTN forwarding type",
          "description":"FORWARD_TO_PSTN",
          "value":{
           "action":{
            "pstnNumber":"41793026731",
            "type":"FORWARD_TO_PSTN"
           }
          }
         },
         "FORWARD_TO_SUBSCRIPTION":{
          "summary":"Response for FORWARD_TO_SUBSCRIPTION forwarding type",
          "description":"FORWARD_TO_SUBSCRIPTION",
          "value":{
           "action":{
            "callsConfigurationId":"6b99b1ac-fe35-4be7-bb0e-93c00dbd2206",
            "type":"FORWARD_TO_SUBSCRIPTION"
           }
          }
         },
         "FORWARD_TO_MARKUP_LANGUAGE":{
          "summary":"Response for FORWARD_TO_MARKUP_LANGUAGE forwarding type",
          "description":"FORWARD_TO_MARKUP_LANGUAGE",
          "value":{
           "action":{
            "type":"FORWARD_TO_MARKUP_LANGUAGE",
            "markupLanguageConfigId":123456789
           }
          }
         }
        }
       }
      }
     },
     "400":{
      "$ref":"#/components/responses/ApiException400"
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"Not Found"
     },
     "429":{
      "$ref":"#/components/responses/ApiException429"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-throttling-info":[
     {
      "type":"time",
      "numberOfRequests":1,
      "numberOfTimeUnits":0,
      "timeUnit":"s"
     }
    ]
   },
   "post":{
    "tags":[
     "platform",
     "numbers",
     "my-numbers",
     "voice-configuration"
    ],
    "summary":"Create voice setup on number",
    "description":"This method will create a new voice setup on a number. There can be only one voice action set for the number.",
    "operationId":"create-voice-setup-on-number",
    "parameters":[
     {
      "name":"numberKey",
      "in":"path",
      "description":"Unique ID of a number.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string"
      }
     }
    ],
    "requestBody":{
     "description":"voiceSetupRequest",
     "content":{
      "application/json":{
       "schema":{
        "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.VoiceSetup"
       },
       "examples":{
        "VOICE_NUMBER_MASKING":{
         "summary":"Setup new Voice Number Masking configuration",
         "description":"VOICE_NUMBER_MASKING",
         "value":{
          "action":{
           "voiceNumberMaskingConfigKey":"C6A5995CBF4D2DF2ADE29963B3BB00E6",
           "type":"VOICE_NUMBER_MASKING"
          }
         }
        },
        "FORWARD_TO_IVR":{
         "summary":"Setup new Forward To IVR configuration",
         "description":"FORWARD_TO_IVR",
         "value":{
          "action":{
           "type":"FORWARD_TO_IVR",
           "scenarioKey":"56FE9214E7A98F2D4CB44E647E3D3CED"
          }
         }
        },
        "FORWARD_TO_CALL_ROUTING":{
         "summary":"Setup new Forward To Call Routing configuration",
         "description":"FORWARD_TO_CALL_ROUTING",
         "value":{
          "action":{
           "type":"FORWARD_TO_CALL_ROUTING",
           "routeId":"71c1cd2e-fa30-450f-a6f7-56f2ae0adc6b"
          }
         }
        },
        "FORWARD_TO_PSTN":{
         "summary":"Setup new Forward To PSTN configuration",
         "description":"FORWARD_TO_PSTN",
         "value":{
          "action":{
           "type":"FORWARD_TO_PSTN",
           "pstnNumber":"41793026731"
          }
         }
        },
        "FORWARD_TO_SUBSCRIPTION":{
         "summary":"Setup new Forward To Subscription configuration",
         "description":"FORWARD_TO_SUBSCRIPTION",
         "value":{
          "action":{
           "type":"FORWARD_TO_SUBSCRIPTION",
           "callsConfigurationId":"6b99b1ac-fe35-4be7-bb0e-93c00dbd2206"
          }
         }
        },
        "FORWARD_TO_MARKUP_LANGUAGE":{
         "summary":"Setup new Forward To Markup Language configuration",
         "description":"FORWARD_TO_MARKUP_LANGUAGE",
         "value":{
          "action":{
           "type":"FORWARD_TO_MARKUP_LANGUAGE",
           "markupLanguageConfigId":123456789
          }
         }
        }
       }
      }
     },
     "required":true
    },
    "responses":{
     "200":{
      "description":"OK",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.VoiceSetup"
        },
        "examples":{
         "VOICE_NUMBER_MASKING":{
          "summary":"Response for VOICE_NUMBER_MASKING type",
          "description":"VOICE_NUMBER_MASKING",
          "value":{
           "action":{
            "voiceNumberMaskingConfigKey":"C6A5995CBF4D2DF2ADE29963B3BB00E6",
            "type":"VOICE_NUMBER_MASKING"
           }
          }
         },
         "FORWARD_TO_IVR":{
          "summary":"Response for FORWARD_TO_IVR forwarding type",
          "description":"FORWARD_TO_IVR",
          "value":{
           "action":{
            "scenarioKey":"56FE9214E7A98F2D4CB44E647E3D3CED",
            "type":"FORWARD_TO_IVR"
           }
          }
         },
         "FORWARD_TO_CALL_ROUTING":{
          "summary":"Response for FORWARD_TO_CALL_ROUTING forwarding type",
          "description":"FORWARD_TO_CALL_ROUTING",
          "value":{
           "action":{
            "routeId":"71c1cd2e-fa30-450f-a6f7-56f2ae0adc6b",
            "type":"FORWARD_TO_CALL_ROUTING"
           }
          }
         },
         "FORWARD_TO_PSTN":{
          "summary":"Response for FORWARD_TO_PSTN forwarding type",
          "description":"FORWARD_TO_PSTN",
          "value":{
           "action":{
            "pstnNumber":"41793026731",
            "type":"FORWARD_TO_PSTN"
           }
          }
         },
         "FORWARD_TO_SUBSCRIPTION":{
          "summary":"Response for FORWARD_TO_SUBSCRIPTION forwarding type",
          "description":"FORWARD_TO_SUBSCRIPTION",
          "value":{
           "action":{
            "callsConfigurationId":"6b99b1ac-fe35-4be7-bb0e-93c00dbd2206",
            "type":"FORWARD_TO_SUBSCRIPTION"
           }
          }
         },
         "FORWARD_TO_MARKUP_LANGUAGE":{
          "summary":"Response for FORWARD_TO_MARKUP_LANGUAGE forwarding type",
          "description":"FORWARD_TO_MARKUP_LANGUAGE",
          "value":{
           "action":{
            "type":"FORWARD_TO_MARKUP_LANGUAGE",
            "markupLanguageConfigId":123456789
           }
          }
         }
        }
       }
      }
     },
     "201":{
      "description":"Created"
     },
     "400":{
      "$ref":"#/components/responses/ApiException400"
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"Not Found"
     },
     "429":{
      "$ref":"#/components/responses/ApiException429"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-throttling-info":[
     {
      "type":"time",
      "numberOfRequests":1,
      "numberOfTimeUnits":0,
      "timeUnit":"s"
     }
    ]
   },
   "delete":{
    "tags":[
     "platform",
     "numbers",
     "my-numbers",
     "voice-configuration"
    ],
    "summary":"Delete voice setup on number",
    "description":"This method removes voice setup from a number.",
    "operationId":"delete-voice-setup-on-number",
    "parameters":[
     {
      "name":"numberKey",
      "in":"path",
      "description":"Unique ID of a number.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string"
      }
     }
    ],
    "responses":{
     "204":{
      "description":"No Content"
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "$ref":"#/components/responses/ApiException404"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ]
   }
  },
  "/numbers/2/numbers/{numberKey}/voice/cnam":{
   "get":{
    "tags":[
     "platform",
     "numbers",
     "my-numbers",
     "voice-configuration"
    ],
    "summary":"Get CNAM",
    "description":"Get CNAM configuration.",
    "operationId":"get-cnam",
    "parameters":[
     {
      "name":"numberKey",
      "in":"path",
      "description":"Unique ID of a number.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string"
      },
      "example":"E9FCDCA496035F08EEA5933702EDF745"
     }
    ],
    "responses":{
     "200":{
      "description":"Success",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/c477cb65646267e3f350bce7b433e9b56e5c28aa9ef21a75500a1337942923ba.Cnam"
        }
       }
      }
     },
     "400":{
      "description":"Bad request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
        },
        "examples":{
         "Error responses":{
          "summary":"Error responses",
          "description":"Error responses",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Request is invalid."
            }
           }
          }
         },
         "Bad request":{
          "summary":"Bad request",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Bad request"
            }
           }
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"CNAM not found.",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
        },
        "examples":{
         "Error responses":{
          "summary":"Error responses",
          "description":"Error responses",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"NOT_FOUND",
             "text":"Resource was not found."
            }
           }
          }
         }
        }
       }
      }
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ]
   },
   "put":{
    "tags":[
     "platform",
     "numbers",
     "my-numbers",
     "voice-configuration"
    ],
    "summary":"Update CNAM",
    "description":"Update a CNAM configuration.",
    "operationId":"update-cnam",
    "parameters":[
     {
      "name":"numberKey",
      "in":"path",
      "description":"Unique ID of a number.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string"
      },
      "example":"E9FCDCA496035F08EEA5933702EDF745"
     }
    ],
    "requestBody":{
     "content":{
      "application/json":{
       "schema":{
        "$ref":"#/components/schemas/c477cb65646267e3f350bce7b433e9b56e5c28aa9ef21a75500a1337942923ba.Cnam"
       }
      }
     },
     "required":true
    },
    "responses":{
     "200":{
      "description":"Success",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/c477cb65646267e3f350bce7b433e9b56e5c28aa9ef21a75500a1337942923ba.Cnam"
        }
       }
      }
     },
     "400":{
      "description":"Bad request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
        },
        "examples":{
         "Error responses":{
          "summary":"Error responses",
          "description":"Error responses",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Request is invalid."
            }
           }
          }
         },
         "Bad request":{
          "summary":"Bad request",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Bad request"
            }
           }
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"CNAM not found.",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
        },
        "examples":{
         "Error responses":{
          "summary":"Error responses",
          "description":"Error responses",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"NOT_FOUND",
             "text":"Resource was not found."
            }
           }
          }
         }
        }
       }
      }
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ]
   },
   "post":{
    "tags":[
     "platform",
     "numbers",
     "my-numbers",
     "voice-configuration"
    ],
    "summary":"Create CNAM",
    "description":"Create CNAM configuration.\n\nThis is currently available only for United States and Canada numbers.\n",
    "operationId":"create-cnam",
    "parameters":[
     {
      "name":"numberKey",
      "in":"path",
      "description":"Unique ID of a number.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string"
      },
      "example":"E9FCDCA496035F08EEA5933702EDF745"
     }
    ],
    "requestBody":{
     "content":{
      "application/json":{
       "schema":{
        "$ref":"#/components/schemas/c477cb65646267e3f350bce7b433e9b56e5c28aa9ef21a75500a1337942923ba.Cnam"
       }
      }
     },
     "required":true
    },
    "responses":{
     "200":{
      "description":"Success",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/c477cb65646267e3f350bce7b433e9b56e5c28aa9ef21a75500a1337942923ba.Cnam"
        }
       }
      }
     },
     "400":{
      "description":"Bad request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
        },
        "examples":{
         "Error responses":{
          "summary":"Error responses",
          "description":"Error responses",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Request is invalid."
            }
           }
          }
         },
         "Bad request":{
          "summary":"Bad request",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Bad request"
            }
           }
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"CNAM not found.",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
        },
        "examples":{
         "Error responses":{
          "summary":"Error responses",
          "description":"Error responses",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"NOT_FOUND",
             "text":"Resource was not found."
            }
           }
          }
         }
        }
       }
      }
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ]
   },
   "delete":{
    "tags":[
     "platform",
     "numbers",
     "my-numbers",
     "voice-configuration"
    ],
    "summary":"Delete CNAM",
    "description":"Delete CNAM configuration.",
    "operationId":"delete-cnam",
    "parameters":[
     {
      "name":"numberKey",
      "in":"path",
      "description":"Unique ID of a number.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string"
      },
      "example":"E9FCDCA496035F08EEA5933702EDF745"
     }
    ],
    "responses":{
     "200":{
      "description":"Success",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/c477cb65646267e3f350bce7b433e9b56e5c28aa9ef21a75500a1337942923ba.Cnam"
        }
       }
      }
     },
     "400":{
      "description":"Bad request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
        },
        "examples":{
         "Error responses":{
          "summary":"Error responses",
          "description":"Error responses",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Request is invalid."
            }
           }
          }
         },
         "Bad request":{
          "summary":"Bad request",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Bad request"
            }
           }
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"CNAM not found.",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
        },
        "examples":{
         "Error responses":{
          "summary":"Error responses",
          "description":"Error responses",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"NOT_FOUND",
             "text":"Resource was not found."
            }
           }
          }
         }
        }
       }
      }
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ]
   }
  },
  "/numbers/2/numbers/{numberKey}/voice/cnam/status":{
   "get":{
    "tags":[
     "platform",
     "numbers",
     "my-numbers",
     "voice-configuration"
    ],
    "summary":"Get CNAM status",
    "description":"Get a CNAM configuration status.",
    "operationId":"get-cnam-status",
    "parameters":[
     {
      "name":"numberKey",
      "in":"path",
      "description":"Unique ID of a number.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string"
      },
      "example":"E9FCDCA496035F08EEA5933702EDF745"
     }
    ],
    "responses":{
     "200":{
      "description":"Success",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/bc185b494ef7059aff9d68589cd5338df2245f21add51cf1a96e9927af6e30d7.PublicCnamStatus"
        }
       }
      }
     },
     "400":{
      "description":"Bad request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
        },
        "examples":{
         "Error responses":{
          "summary":"Error responses",
          "description":"Error responses",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Request is invalid."
            }
           }
          }
         },
         "Bad request":{
          "summary":"Bad request",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Bad request"
            }
           }
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"CNAM not found.",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
        },
        "examples":{
         "Error responses":{
          "summary":"Error responses",
          "description":"Error responses",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"NOT_FOUND",
             "text":"Resource was not found."
            }
           }
          }
         }
        }
       }
      }
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ]
   }
  },
  "/numbers/2/numbers/{numberKey}/voice/emergency-service/validate-address":{
   "post":{
    "tags":[
     "platform",
     "numbers",
     "my-numbers",
     "voice-configuration"
    ],
    "summary":"Validate Emergency Service Address",
    "description":"Validate a Emergency Service Address",
    "operationId":"validate-emergency-service",
    "parameters":[
     {
      "name":"numberKey",
      "in":"path",
      "description":"Unique ID of a number.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string"
      },
      "example":"E9FCDCA496035F08EEA5933702EDF745"
     }
    ],
    "requestBody":{
     "content":{
      "application/json":{
       "schema":{
        "$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Address"
       }
      }
     },
     "required":true
    },
    "responses":{
     "200":{
      "description":"Success",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/7635fa9e013ed171bbe9743a6ca322c3b2b29e7574931e38f0de0bda9687aadf.ValidateAddressResponse"
        }
       }
      }
     },
     "400":{
      "description":"Bad request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
        },
        "examples":{
         "Error responses":{
          "summary":"Error responses",
          "description":"Error responses",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Request is invalid."
            }
           }
          }
         },
         "Bad request":{
          "summary":"Bad request",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Bad request"
            }
           }
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"Emergency Service Address not found.",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
        },
        "examples":{
         "Error responses":{
          "summary":"Error responses",
          "description":"Error responses",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"NOT_FOUND",
             "text":"Resource was not found."
            }
           }
          }
         }
        }
       }
      }
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ]
   }
  },
  "/numbers/2/numbers/{numberKey}/voice/emergency-service":{
   "get":{
    "tags":[
     "platform",
     "numbers",
     "my-numbers",
     "voice-configuration"
    ],
    "summary":"Get Emergency Service Address",
    "description":"Get a Emergency Service Address",
    "operationId":"get-emergency-service",
    "parameters":[
     {
      "name":"numberKey",
      "in":"path",
      "description":"Unique ID of a number.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string"
      },
      "example":"E9FCDCA496035F08EEA5933702EDF745"
     }
    ],
    "responses":{
     "200":{
      "description":"Success",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/7635fa9e013ed171bbe9743a6ca322c3b2b29e7574931e38f0de0bda9687aadf.EmergencyAddress"
        }
       }
      }
     },
     "400":{
      "description":"Bad request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
        },
        "examples":{
         "Error responses":{
          "summary":"Error responses",
          "description":"Error responses",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Request is invalid."
            }
           }
          }
         },
         "Bad request":{
          "summary":"Bad request",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Bad request"
            }
           }
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"Emergency Service Address not found.",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
        },
        "examples":{
         "Error responses":{
          "summary":"Error responses",
          "description":"Error responses",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"NOT_FOUND",
             "text":"Resource was not found."
            }
           }
          }
         }
        }
       }
      }
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ]
   },
   "put":{
    "tags":[
     "platform",
     "numbers",
     "my-numbers",
     "voice-configuration"
    ],
    "summary":"Update Emergency Service Address",
    "description":"Update a Emergency Service Address",
    "operationId":"update-emergency-service",
    "parameters":[
     {
      "name":"numberKey",
      "in":"path",
      "description":"Unique ID of a number.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string"
      },
      "example":"E9FCDCA496035F08EEA5933702EDF745"
     }
    ],
    "requestBody":{
     "content":{
      "application/json":{
       "schema":{
        "$ref":"#/components/schemas/7635fa9e013ed171bbe9743a6ca322c3b2b29e7574931e38f0de0bda9687aadf.EmergencyAddress"
       }
      }
     },
     "required":true
    },
    "responses":{
     "200":{
      "description":"Success",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/7635fa9e013ed171bbe9743a6ca322c3b2b29e7574931e38f0de0bda9687aadf.EmergencyAddress"
        }
       }
      }
     },
     "400":{
      "description":"Bad request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
        },
        "examples":{
         "Error responses":{
          "summary":"Error responses",
          "description":"Error responses",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Request is invalid."
            }
           }
          }
         },
         "Bad request":{
          "summary":"Bad request",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Bad request"
            }
           }
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"Emergency Service Address not found.",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
        },
        "examples":{
         "Error responses":{
          "summary":"Error responses",
          "description":"Error responses",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"NOT_FOUND",
             "text":"Resource was not found."
            }
           }
          }
         }
        }
       }
      }
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ]
   },
   "post":{
    "tags":[
     "platform",
     "numbers",
     "my-numbers",
     "voice-configuration"
    ],
    "summary":"Create Emergency Service Address",
    "description":"Create Emergency Service Address\n\nEmergency Service Address allows you to set any physical address in the United States as your address to be transmitted on emergency number calls.\nThis means your calls to the emergency number will route to the closest PSAP (Public Safety Answering Point) to your registered address on our system. \n\nThat address will also appear on the emergency services operator’s screen when you call.\n",
    "operationId":"create-emergency-service",
    "parameters":[
     {
      "name":"numberKey",
      "in":"path",
      "description":"Unique ID of a number.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string"
      },
      "example":"E9FCDCA496035F08EEA5933702EDF745"
     }
    ],
    "requestBody":{
     "content":{
      "application/json":{
       "schema":{
        "$ref":"#/components/schemas/7635fa9e013ed171bbe9743a6ca322c3b2b29e7574931e38f0de0bda9687aadf.EmergencyAddress"
       }
      }
     },
     "required":true
    },
    "responses":{
     "200":{
      "description":"Success",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/7635fa9e013ed171bbe9743a6ca322c3b2b29e7574931e38f0de0bda9687aadf.EmergencyAddress"
        }
       }
      }
     },
     "400":{
      "description":"Bad request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
        },
        "examples":{
         "Error responses":{
          "summary":"Error responses",
          "description":"Error responses",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Request is invalid."
            }
           }
          }
         },
         "Bad request":{
          "summary":"Bad request",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Bad request"
            }
           }
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"Emergency Service Address not found.",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
        },
        "examples":{
         "Error responses":{
          "summary":"Error responses",
          "description":"Error responses",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"NOT_FOUND",
             "text":"Resource was not found."
            }
           }
          }
         }
        }
       }
      }
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ]
   },
   "delete":{
    "tags":[
     "platform",
     "numbers",
     "my-numbers",
     "voice-configuration"
    ],
    "summary":"Delete Emergency Service Address",
    "description":"Delete a Emergency Service Address",
    "operationId":"delete-emergency-service",
    "parameters":[
     {
      "name":"numberKey",
      "in":"path",
      "description":"Unique ID of a number.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string"
      },
      "example":"E9FCDCA496035F08EEA5933702EDF745"
     }
    ],
    "responses":{
     "200":{
      "description":"Success",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/7635fa9e013ed171bbe9743a6ca322c3b2b29e7574931e38f0de0bda9687aadf.EmergencyAddress"
        }
       }
      }
     },
     "400":{
      "description":"Bad request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
        },
        "examples":{
         "Error responses":{
          "summary":"Error responses",
          "description":"Error responses",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Request is invalid."
            }
           }
          }
         },
         "Bad request":{
          "summary":"Bad request",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Bad request"
            }
           }
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"Emergency Service Address not found.",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
        },
        "examples":{
         "Error responses":{
          "summary":"Error responses",
          "description":"Error responses",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"NOT_FOUND",
             "text":"Resource was not found."
            }
           }
          }
         }
        }
       }
      }
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ]
   }
  },
  "/numbers/2/numbers/{numberKey}/voice/emergency-service/status":{
   "get":{
    "tags":[
     "platform",
     "numbers",
     "my-numbers",
     "voice-configuration"
    ],
    "summary":"Get Emergency Service Address status",
    "description":"Get a Emergency Service Address status.",
    "operationId":"get-emergency-service-status",
    "parameters":[
     {
      "name":"numberKey",
      "in":"path",
      "description":"Unique ID of a number.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string"
      },
      "example":"E9FCDCA496035F08EEA5933702EDF745"
     }
    ],
    "responses":{
     "200":{
      "description":"Success",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/7635fa9e013ed171bbe9743a6ca322c3b2b29e7574931e38f0de0bda9687aadf.EmergencyAddressStatus"
        }
       }
      }
     },
     "400":{
      "description":"Bad request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
        },
        "examples":{
         "Error responses":{
          "summary":"Error responses",
          "description":"Error responses",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Request is invalid."
            }
           }
          }
         },
         "Bad request":{
          "summary":"Bad request",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Bad request"
            }
           }
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"Emergency Service Address not found.",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
        },
        "examples":{
         "Error responses":{
          "summary":"Error responses",
          "description":"Error responses",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"NOT_FOUND",
             "text":"Resource was not found."
            }
           }
          }
         }
        }
       }
      }
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ]
   }
  },
  "/number-registration/1/brands":{
   "get":{
    "tags":[
     "platform",
     "numbers",
     "number-registration",
     "brands",
     "brand-management"
    ],
    "summary":"Get Brands",
    "description":"Get a page of brands, using query parameters to filter results.",
    "operationId":"get-brands",
    "parameters":[
     {
      "name":"id",
      "in":"query",
      "description":"Filters brands to those that match the supplied ID(s).",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"array",
       "items":{
        "type":"string",
        "format":"uuid"
       }
      }
     },
     {
      "name":"type",
      "in":"query",
      "description":"Filters brands to those that match the supplied brand types(s).",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"array",
       "items":{
        "type":"string"
       }
      }
     },
     {
      "name":"nameLike",
      "in":"query",
      "description":"Filters brands to those whose names contain the supplied name.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"string"
      }
     },
     {
      "name":"referenceId",
      "in":"query",
      "description":"Filters brands to those that match the supplied referenceId(s).",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"array",
       "items":{
        "type":"string"
       }
      }
     },
     {
      "name":"applicationId",
      "in":"query",
      "description":"Filters brands to those whose application ID contains the supplied value.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"string"
      }
     },
     {
      "name":"entityId",
      "in":"query",
      "description":"Filters brands to those whose entity ID contains the supplied value.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"string"
      }
     },
     {
      "name":"page",
      "in":"query",
      "description":"Results page you want to retrieve (0..N). The default value is 0.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"integer",
       "format":"int32"
      }
     },
     {
      "name":"size",
      "in":"query",
      "description":"Number of records per page (0..2000). The default value is 20. The maximum value is 2000.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"integer",
       "format":"int32"
      }
     },
     {
      "name":"sort",
      "in":"query",
      "description":"Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Sortable Properties: 'id', 'name', 'type', 'createdDate', 'lastModifiedDate'.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"array",
       "items":{
        "type":"string"
       }
      },
      "example":"createdDate,desc"
     }
    ],
    "responses":{
     "200":{
      "description":"OK",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PageResponseBrand"
        },
        "examples":{
         "Example page of brands":{
          "summary":"Example page of brands",
          "description":"Example page of brands",
          "value":{
           "results":[
            {
             "id":"79ff0424-7201-45ca-bcbe-9989535fa2ec",
             "applicationId":"app-id",
             "entityId":"entity-id",
             "name":"Examples Warehouse",
             "stage":"SUBMITTED",
             "website":"https://www.example.com",
             "createdDate":"2021-01-19T16:17:14Z",
             "lastModifiedDate":"2021-01-19T16:17:14Z",
             "referenceId":"customer-defined-identifier",
             "legalName":"Examples Warehouse LLC",
             "address":{
              "city":"Seattle",
              "state":"WA",
              "street":"56486 915th Street",
              "zipCode":"98061"
             },
             "countryCode":"US",
             "alternateBusinessId":{
              "id":"858020355",
              "type":"DUNS"
             },
             "supportEmail":"help@example.com",
             "supportPhone":"41785473249",
             "vertical":"RETAIL_AND_CONSUMER_PRODUCTS",
             "taxId":"62-4161762",
             "taxIdIssuingCountry":"US",
             "type":"TENDLC_PRIVATE_COMPANY"
            }
           ],
           "paging":{
            "page":0,
            "size":20,
            "totalPages":1,
            "totalResults":1
           }
          }
         }
        }
       }
      }
     },
     "400":{
      "description":"Bad Request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException"
        },
        "examples":{
         "Bad request":{
          "summary":"Bad request",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Bad request"
            }
           }
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "429":{
      "$ref":"#/components/responses/ApiException429"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-throttling-info":[
     {
      "type":"time",
      "numberOfRequests":10,
      "numberOfTimeUnits":0,
      "timeUnit":"s"
     }
    ]
   },
   "post":{
    "tags":[
     "platform",
     "numbers",
     "number-registration",
     "brands",
     "brand-management"
    ],
    "summary":"Create Brand",
    "description":"Creates a brand within the Infobip platform. This operation does not register the brand with any registrars. Registration can be done using created brand's ID with the 'Register Brand' endpoint.",
    "operationId":"create-brand",
    "requestBody":{
     "content":{
      "application/json":{
       "schema":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Brand"
       },
       "examples":{
        "10DLC Non Profit Brand":{
         "summary":"10DLC Non Profit Brand",
         "description":"10DLC Non Profit Brand",
         "value":{
          "name":"Example Non Profit Company",
          "applicationId":"app-id",
          "entityId":"entity-id",
          "website":"https://www.example.com",
          "type":"TENDLC_NON_PROFIT",
          "referenceId":"customer-defined-identifier",
          "legalName":"Examples Warehouse LLC",
          "address":{
           "city":"Seattle",
           "state":"WA",
           "street":"56486 915th Street",
           "zipCode":"98061"
          },
          "countryCode":"US",
          "alternateBusinessId":{
           "id":"590900O3Z29E78HVXT56",
           "type":"LEI"
          },
          "supportEmail":"help@example.com",
          "supportPhone":"41785473249",
          "vertical":"NON_PROFIT_ORGANIZATION",
          "taxId":"62-4161762",
          "taxIdIssuingCountry":"US"
         }
        },
        "10DLC Private Company Brand":{
         "summary":"10DLC Private Company Brand",
         "description":"10DLC Private Company Brand",
         "value":{
          "name":"Example Private Company",
          "applicationId":"app-id",
          "entityId":"entity-id",
          "website":"https://www.example.com",
          "type":"TENDLC_PRIVATE_COMPANY",
          "referenceId":"customer-defined-identifier",
          "legalName":"Examples Warehouse LLC",
          "address":{
           "city":"Seattle",
           "state":"WA",
           "street":"56486 915th Street",
           "zipCode":"98061"
          },
          "countryCode":"US",
          "alternateBusinessId":{
           "id":"858020355",
           "type":"DUNS"
          },
          "supportEmail":"help@example.com",
          "supportPhone":"41785473249",
          "vertical":"AGRICULTURE",
          "taxId":"62-4161762",
          "taxIdIssuingCountry":"US"
         }
        },
        "10DLC Public Company Brand":{
         "summary":"10DLC Public Company Brand",
         "description":"10DLC Public Company Brand",
         "value":{
          "name":"Example Public Company",
          "applicationId":"app-id",
          "entityId":"entity-id",
          "website":"https://www.example.com",
          "type":"TENDLC_PUBLIC_COMPANY",
          "referenceId":"customer-defined-identifier",
          "legalName":"Examples Construction LLC",
          "address":{
           "city":"Seattle",
           "state":"WA",
           "street":"56486 915th Street",
           "zipCode":"98061"
          },
          "countryCode":"US",
          "alternateBusinessId":{
           "id":"N9R4GC.STJGQ.ME.163",
           "type":"GIIN"
          },
          "supportEmail":"help@example.com",
          "supportPhone":"41785473249",
          "vertical":"CONSTRUCTION_AND_MATERIALS",
          "taxId":"62-4161762",
          "taxIdIssuingCountry":"US",
          "stockExchange":"EXWH",
          "stockSymbol":"nyse"
         }
        },
        "10DLC Government Brand":{
         "summary":"10DLC Government Brand",
         "description":"10DLC Government Brand",
         "value":{
          "name":"Example Government Company",
          "applicationId":"app-id",
          "entityId":"entity-id",
          "website":"https://www.example.com",
          "type":"TENDLC_GOVERNMENT",
          "referenceId":"customer-defined-identifier",
          "legalName":"Examples Education LLC",
          "address":{
           "city":"Seattle",
           "state":"WA",
           "street":"56486 915th Street",
           "zipCode":"98061"
          },
          "countryCode":"US",
          "alternateBusinessId":{
           "id":"858020355",
           "type":"DUNS"
          },
          "supportEmail":"help@example.com",
          "supportPhone":"41785473249",
          "vertical":"EDUCATION",
          "taxId":"62-4161762",
          "taxIdIssuingCountry":"US"
         }
        },
        "TFN Brand":{
         "summary":"TFN Brand",
         "description":"TFN Brand",
         "value":{
          "name":"Example toll free number brand",
          "applicationId":"app-id",
          "entityId":"entity-id",
          "website":"https://www.example.com",
          "type":"TOLL_FREE_NUMBER",
          "referenceId":"customer-defined-identifier",
          "address":{
           "city":"Seattle",
           "state":"WA",
           "street":"56486 915th Street",
           "zipCode":"98061"
          },
          "countryCode":"US",
          "supportEmail":"help@example.com",
          "supportPhone":"41785473249",
          "businessContactFirstName":"First Name",
          "businessContactLastName":"Last Name",
          "businessDBA":"Example DBA name",
          "taxId":"62-4161762",
          "taxIdIssuingCountry":"US",
          "legalEntityType":"PRIVATE_COMPANY",
          "businessRegistrationType":"EIN",
          "legalName":"Example legal name"
         }
        }
       }
      }
     },
     "required":true
    },
    "responses":{
     "201":{
      "description":"Created",
      "headers":{
       "Location":{
        "description":"The URI location of the created resource.",
        "style":"simple",
        "explode":false,
        "schema":{
         "type":"string"
        }
       }
      },
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Brand"
        },
        "examples":{
         "10DLC Non Profit Brand":{
          "summary":"10DLC Non Profit Brand",
          "description":"10DLC Non Profit Brand",
          "value":{
           "id":"79ff0424-7201-45ca-bcbe-9989535fa2ec",
           "applicationId":"app-id",
           "entityId":"entity-id",
           "name":"Example Non Profit Company",
           "stage":"SUBMITTED",
           "website":"https://www.example.com",
           "createdDate":"2021-01-19T16:17:14Z",
           "lastModifiedDate":"2021-01-19T16:17:14Z",
           "referenceId":"customer-defined-identifier",
           "legalName":"Examples Warehouse LLC",
           "address":{
            "city":"Seattle",
            "state":"WA",
            "street":"56486 915th Street",
            "zipCode":"98061"
           },
           "countryCode":"US",
           "alternateBusinessId":{
            "id":"590900O3Z29E78HVXT56",
            "type":"LEI"
           },
           "supportEmail":"help@example.com",
           "supportPhone":"41785473249",
           "vertical":"NON_PROFIT_ORGANIZATION",
           "taxId":"62-4161762",
           "taxIdIssuingCountry":"US",
           "type":"TENDLC_NON_PROFIT"
          }
         },
         "10DLC Private Company Brand":{
          "summary":"10DLC Private Company Brand",
          "description":"10DLC Private Company Brand",
          "value":{
           "id":"79ff0424-7201-45ca-bcbe-9989535fa2ec",
           "applicationId":"app-id",
           "entityId":"entity-id",
           "name":"Example Private Company",
           "stage":"SUBMITTED",
           "website":"https://www.example.com",
           "createdDate":"2021-01-19T16:17:14Z",
           "lastModifiedDate":"2021-01-19T16:17:14Z",
           "referenceId":"customer-defined-identifier",
           "legalName":"Examples Agroculture LLC",
           "address":{
            "city":"Seattle",
            "state":"WA",
            "street":"56486 915th Street",
            "zipCode":"98061"
           },
           "countryCode":"US",
           "alternateBusinessId":{
            "id":"858020355",
            "type":"DUNS"
           },
           "supportEmail":"help@example.com",
           "supportPhone":"41785473249",
           "vertical":"AGRICULTURE",
           "taxId":"62-4161762",
           "taxIdIssuingCountry":"US",
           "type":"TENDLC_PRIVATE_COMPANY"
          }
         },
         "10DLC Public Company Brand":{
          "summary":"10DLC Public Company Brand",
          "description":"10DLC Public Company Brand",
          "value":{
           "id":"79ff0424-7201-45ca-bcbe-9989535fa2ec",
           "applicationId":"app-id",
           "entityId":"entity-id",
           "name":"Example Public Company",
           "stage":"SUBMITTED",
           "website":"https://www.example.com",
           "createdDate":"2021-01-19T16:17:14Z",
           "lastModifiedDate":"2021-01-19T16:17:14Z",
           "referenceId":"customer-defined-identifier",
           "legalName":"Examples Construction LLC",
           "address":{
            "city":"Seattle",
            "state":"WA",
            "street":"56486 915th Street",
            "zipCode":"98061"
           },
           "countryCode":"US",
           "alternateBusinessId":{
            "id":"N9R4GC.STJGQ.ME.163",
            "type":"GIIN"
           },
           "supportEmail":"help@example.com",
           "supportPhone":"41785473249",
           "businessContactEmail":"employee.name@example.com",
           "vertical":"CONSTRUCTION_AND_MATERIALS",
           "taxId":"62-4161762",
           "taxIdIssuingCountry":"US",
           "stockExchange":"EXWH",
           "stockSymbol":"nyse",
           "type":"TENDLC_PUBLIC_COMPANY"
          }
         },
         "10DLC Government Brand":{
          "summary":"10DLC Government Brand",
          "description":"10DLC Government Brand",
          "value":{
           "id":"79ff0424-7201-45ca-bcbe-9989535fa2ec",
           "applicationId":"app-id",
           "entityId":"entity-id",
           "name":"Example Government Company",
           "stage":"SUBMITTED",
           "website":"https://www.example.com",
           "createdDate":"2021-01-19T16:17:14Z",
           "lastModifiedDate":"2021-01-19T16:17:14Z",
           "referenceId":"customer-defined-identifier",
           "legalName":"Examples Education",
           "address":{
            "city":"Seattle",
            "state":"WA",
            "street":"56486 915th Street",
            "zipCode":"98061"
           },
           "countryCode":"US",
           "alternateBusinessId":{
            "id":"858020355",
            "type":"DUNS"
           },
           "supportEmail":"help@example.com",
           "supportPhone":"41785473249",
           "vertical":"EDUCATION",
           "taxId":"62-4161762",
           "taxIdIssuingCountry":"US",
           "type":"TENDLC_GOVERNMENT"
          }
         },
         "TFN Brand":{
          "summary":"TFN Brand",
          "description":"TFN Brand",
          "value":{
           "id":"d9073f3f-3006-4dcb-9d05-41405aa96346",
           "applicationId":"app-id",
           "entityId":"entity-id",
           "name":"Example Toll Free Number Brand",
           "stage":"SUBMITTED",
           "website":"https://www.example.com",
           "createdDate":"2021-01-19T16:17:14Z",
           "lastModifiedDate":"2021-01-19T16:17:14Z",
           "referenceId":"customer-defined-identifier",
           "address":{
            "city":"Seattle",
            "state":"WA",
            "street":"56486 915th Street",
            "zipCode":"98061"
           },
           "countryCode":"US",
           "supportEmail":"help@example.com",
           "supportPhone":"41785473249",
           "businessContactFirstName":"First Name",
           "businessContactLastName":"Last Name",
           "businessDBA":"Example DBA name",
           "taxId":"62-4161762",
           "taxIdIssuingCountry":"US",
           "legalEntityType":"PRIVATE_COMPANY",
           "businessRegistrationType":"EIN",
           "legalName":"Example legal name",
           "type":"TOLL_FREE_NUMBER"
          }
         }
        }
       }
      }
     },
     "400":{
      "description":"Bad Request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException"
        },
        "examples":{
         "Bad request":{
          "summary":"Bad request",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Bad request"
            }
           }
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "429":{
      "$ref":"#/components/responses/ApiException429"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-throttling-info":[
     {
      "type":"time",
      "numberOfRequests":1,
      "numberOfTimeUnits":0,
      "timeUnit":"s"
     }
    ]
   }
  },
  "/number-registration/1/brands/{brandId}":{
   "get":{
    "tags":[
     "platform",
     "numbers",
     "number-registration",
     "brands",
     "brand-management"
    ],
    "summary":"Get Brand",
    "description":"Retrieves a previously created brand by its ID.",
    "operationId":"get-brand",
    "parameters":[
     {
      "name":"brandId",
      "in":"path",
      "description":"The ID of the desired brand.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string",
       "format":"uuid",
       "description":"The ID of the desired brand."
      }
     }
    ],
    "responses":{
     "200":{
      "description":"OK",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Brand"
        },
        "examples":{
         "10DLC Non Profit Brand":{
          "summary":"10DLC Non Profit Brand",
          "description":"10DLC Non Profit Brand",
          "value":{
           "id":"79ff0424-7201-45ca-bcbe-9989535fa2ec",
           "applicationId":"app-id",
           "entityId":"entity-id",
           "name":"Example Non Profit Company",
           "stage":"SUBMITTED",
           "website":"https://www.example.com",
           "createdDate":"2021-01-19T16:17:14Z",
           "lastModifiedDate":"2021-01-19T16:17:14Z",
           "referenceId":"customer-defined-identifier",
           "legalName":"Examples Warehouse LLC",
           "address":{
            "city":"Seattle",
            "state":"WA",
            "street":"56486 915th Street",
            "zipCode":"98061"
           },
           "countryCode":"US",
           "alternateBusinessId":{
            "id":"590900O3Z29E78HVXT56",
            "type":"LEI"
           },
           "supportEmail":"help@example.com",
           "supportPhone":"41785473249",
           "vertical":"NON_PROFIT_ORGANIZATION",
           "taxId":"62-4161762",
           "taxIdIssuingCountry":"US",
           "type":"TENDLC_NON_PROFIT"
          }
         },
         "10DLC Private Company Brand":{
          "summary":"10DLC Private Company Brand",
          "description":"10DLC Private Company Brand",
          "value":{
           "id":"79ff0424-7201-45ca-bcbe-9989535fa2ec",
           "applicationId":"app-id",
           "entityId":"entity-id",
           "name":"Example Private Company",
           "stage":"SUBMITTED",
           "website":"https://www.example.com",
           "createdDate":"2021-01-19T16:17:14Z",
           "lastModifiedDate":"2021-01-19T16:17:14Z",
           "referenceId":"customer-defined-identifier",
           "legalName":"Examples Agroculture LLC",
           "address":{
            "city":"Seattle",
            "state":"WA",
            "street":"56486 915th Street",
            "zipCode":"98061"
           },
           "countryCode":"US",
           "alternateBusinessId":{
            "id":"858020355",
            "type":"DUNS"
           },
           "supportEmail":"help@example.com",
           "supportPhone":"41785473249",
           "vertical":"AGRICULTURE",
           "taxId":"62-4161762",
           "taxIdIssuingCountry":"US",
           "type":"TENDLC_PRIVATE_COMPANY"
          }
         },
         "10DLC Public Company Brand":{
          "summary":"10DLC Public Company Brand",
          "description":"10DLC Public Company Brand",
          "value":{
           "id":"79ff0424-7201-45ca-bcbe-9989535fa2ec",
           "applicationId":"app-id",
           "entityId":"entity-id",
           "name":"Example Public Company",
           "stage":"SUBMITTED",
           "website":"https://www.example.com",
           "createdDate":"2021-01-19T16:17:14Z",
           "lastModifiedDate":"2021-01-19T16:17:14Z",
           "referenceId":"customer-defined-identifier",
           "legalName":"Examples Construction LLC",
           "address":{
            "city":"Seattle",
            "state":"WA",
            "street":"56486 915th Street",
            "zipCode":"98061"
           },
           "countryCode":"US",
           "alternateBusinessId":{
            "id":"N9R4GC.STJGQ.ME.163",
            "type":"GIIN"
           },
           "supportEmail":"help@example.com",
           "supportPhone":"41785473249",
           "businessContactEmail":"employee.name@example.com",
           "vertical":"CONSTRUCTION_AND_MATERIALS",
           "taxId":"62-4161762",
           "taxIdIssuingCountry":"US",
           "stockExchange":"EXWH",
           "stockSymbol":"nyse",
           "type":"TENDLC_PUBLIC_COMPANY"
          }
         },
         "10DLC Government Brand":{
          "summary":"10DLC Government Brand",
          "description":"10DLC Government Brand",
          "value":{
           "id":"79ff0424-7201-45ca-bcbe-9989535fa2ec",
           "applicationId":"app-id",
           "entityId":"entity-id",
           "name":"Example Government Company",
           "stage":"SUBMITTED",
           "website":"https://www.example.com",
           "createdDate":"2021-01-19T16:17:14Z",
           "lastModifiedDate":"2021-01-19T16:17:14Z",
           "referenceId":"customer-defined-identifier",
           "legalName":"Examples Education",
           "address":{
            "city":"Seattle",
            "state":"WA",
            "street":"56486 915th Street",
            "zipCode":"98061"
           },
           "countryCode":"US",
           "alternateBusinessId":{
            "id":"858020355",
            "type":"DUNS"
           },
           "supportEmail":"help@example.com",
           "supportPhone":"41785473249",
           "vertical":"EDUCATION",
           "taxId":"62-4161762",
           "taxIdIssuingCountry":"US",
           "type":"TENDLC_GOVERNMENT"
          }
         },
         "TFN Brand":{
          "summary":"TFN Brand",
          "description":"TFN Brand",
          "value":{
           "id":"d9073f3f-3006-4dcb-9d05-41405aa96346",
           "applicationId":"app-id",
           "entityId":"entity-id",
           "name":"Example Toll Free Number Brand",
           "stage":"SUBMITTED",
           "website":"https://www.example.com",
           "createdDate":"2021-01-19T16:17:14Z",
           "lastModifiedDate":"2021-01-19T16:17:14Z",
           "referenceId":"customer-defined-identifier",
           "address":{
            "city":"Seattle",
            "state":"WA",
            "street":"56486 915th Street",
            "zipCode":"98061"
           },
           "countryCode":"US",
           "supportEmail":"help@example.com",
           "supportPhone":"41785473249",
           "businessContactFirstName":"First Name",
           "businessContactLastName":"Last Name",
           "businessDBA":"Example DBA name",
           "taxId":"62-4161762",
           "taxIdIssuingCountry":"US",
           "legalEntityType":"PRIVATE_COMPANY",
           "businessRegistrationType":"EIN",
           "legalName":"Example legal name",
           "type":"TOLL_FREE_NUMBER"
          }
         }
        }
       }
      }
     },
     "400":{
      "description":"Bad Request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException"
        },
        "examples":{
         "Bad request":{
          "summary":"Bad request",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Bad request"
            }
           }
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"Not Found",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException"
        },
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"NOT_FOUND",
             "text":"Not found"
            }
           }
          }
         }
        }
       }
      }
     },
     "429":{
      "$ref":"#/components/responses/ApiException429"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-throttling-info":[
     {
      "type":"time",
      "numberOfRequests":10,
      "numberOfTimeUnits":0,
      "timeUnit":"s"
     }
    ]
   },
   "put":{
    "tags":[
     "platform",
     "numbers",
     "number-registration",
     "brands",
     "brand-management"
    ],
    "summary":"Update Brand",
    "description":"Updates a brand that has not yet been registered within the Infobip platform (response 200) or that has a successful or failed registration\n(response 202). This method will not support a brand update with pending registration status and will return a 400 Bad Request.\nAlso for successfully registered brands, updates to the legalName, type, taxId, and taxIdIssuingCountry are restricted\nand will also return a 400 Bad Request.",
    "operationId":"update-brand",
    "parameters":[
     {
      "name":"brandId",
      "in":"path",
      "description":"The ID of the desired brand.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string",
       "format":"uuid",
       "description":"The ID of the desired brand."
      }
     }
    ],
    "requestBody":{
     "content":{
      "application/json":{
       "schema":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Brand"
       },
       "examples":{
        "10DLC Non Profit Brand":{
         "summary":"10DLC Non Profit Brand",
         "description":"10DLC Non Profit Brand",
         "value":{
          "name":"Example Non Profit Company",
          "applicationId":"app-id",
          "entityId":"entity-id",
          "website":"https://www.example.com",
          "type":"TENDLC_NON_PROFIT",
          "referenceId":"customer-defined-identifier",
          "legalName":"Examples Warehouse LLC",
          "address":{
           "city":"Seattle",
           "state":"WA",
           "street":"56486 915th Street",
           "zipCode":"98061"
          },
          "countryCode":"US",
          "alternateBusinessId":{
           "id":"590900O3Z29E78HVXT56",
           "type":"LEI"
          },
          "supportEmail":"help@example.com",
          "supportPhone":"41785473249",
          "vertical":"NON_PROFIT_ORGANIZATION",
          "taxId":"62-4161762",
          "taxIdIssuingCountry":"US"
         }
        },
        "10DLC Private Company Brand":{
         "summary":"10DLC Private Company Brand",
         "description":"10DLC Private Company Brand",
         "value":{
          "name":"Example Private Company",
          "applicationId":"app-id",
          "entityId":"entity-id",
          "website":"https://www.example.com",
          "type":"TENDLC_PRIVATE_COMPANY",
          "referenceId":"customer-defined-identifier",
          "legalName":"Examples Warehouse LLC",
          "address":{
           "city":"Seattle",
           "state":"WA",
           "street":"56486 915th Street",
           "zipCode":"98061"
          },
          "countryCode":"US",
          "alternateBusinessId":{
           "id":"858020355",
           "type":"DUNS"
          },
          "supportEmail":"help@example.com",
          "supportPhone":"41785473249",
          "vertical":"AGRICULTURE",
          "taxId":"62-4161762",
          "taxIdIssuingCountry":"US"
         }
        },
        "10DLC Public Company Brand":{
         "summary":"10DLC Public Company Brand",
         "description":"10DLC Public Company Brand",
         "value":{
          "name":"Example Public Company",
          "applicationId":"app-id",
          "entityId":"entity-id",
          "website":"https://www.example.com",
          "type":"TENDLC_PUBLIC_COMPANY",
          "referenceId":"customer-defined-identifier",
          "legalName":"Examples Construction LLC",
          "address":{
           "city":"Seattle",
           "state":"WA",
           "street":"56486 915th Street",
           "zipCode":"98061"
          },
          "countryCode":"US",
          "alternateBusinessId":{
           "id":"N9R4GC.STJGQ.ME.163",
           "type":"GIIN"
          },
          "supportEmail":"help@example.com",
          "supportPhone":"41785473249",
          "vertical":"CONSTRUCTION_AND_MATERIALS",
          "taxId":"62-4161762",
          "taxIdIssuingCountry":"US",
          "stockExchange":"EXWH",
          "stockSymbol":"nyse"
         }
        },
        "10DLC Government Brand":{
         "summary":"10DLC Government Brand",
         "description":"10DLC Government Brand",
         "value":{
          "name":"Example Government Company",
          "applicationId":"app-id",
          "entityId":"entity-id",
          "website":"https://www.example.com",
          "type":"TENDLC_GOVERNMENT",
          "referenceId":"customer-defined-identifier",
          "legalName":"Examples Education LLC",
          "address":{
           "city":"Seattle",
           "state":"WA",
           "street":"56486 915th Street",
           "zipCode":"98061"
          },
          "countryCode":"US",
          "alternateBusinessId":{
           "id":"858020355",
           "type":"DUNS"
          },
          "supportEmail":"help@example.com",
          "supportPhone":"41785473249",
          "vertical":"EDUCATION",
          "taxId":"62-4161762",
          "taxIdIssuingCountry":"US"
         }
        },
        "TFN Brand":{
         "summary":"TFN Brand",
         "description":"TFN Brand",
         "value":{
          "name":"Example toll free number brand",
          "applicationId":"app-id",
          "entityId":"entity-id",
          "website":"https://www.example.com",
          "type":"TOLL_FREE_NUMBER",
          "referenceId":"customer-defined-identifier",
          "address":{
           "city":"Seattle",
           "state":"WA",
           "street":"56486 915th Street",
           "zipCode":"98061"
          },
          "countryCode":"US",
          "supportEmail":"help@example.com",
          "supportPhone":"41785473249",
          "businessContactFirstName":"First Name",
          "businessContactLastName":"Last Name",
          "businessDBA":"Example DBA name",
          "taxId":"62-4161762",
          "taxIdIssuingCountry":"US",
          "legalEntityType":"PRIVATE_COMPANY",
          "businessRegistrationType":"EIN",
          "legalName":"Example legal name"
         }
        }
       }
      }
     },
     "required":true
    },
    "responses":{
     "200":{
      "description":"OK",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Brand"
        },
        "examples":{
         "10DLC Non Profit Brand":{
          "summary":"10DLC Non Profit Brand",
          "description":"10DLC Non Profit Brand",
          "value":{
           "id":"79ff0424-7201-45ca-bcbe-9989535fa2ec",
           "applicationId":"app-id",
           "entityId":"entity-id",
           "name":"Example Non Profit Company",
           "stage":"SUBMITTED",
           "website":"https://www.example.com",
           "createdDate":"2021-01-19T16:17:14Z",
           "lastModifiedDate":"2021-01-19T16:17:14Z",
           "referenceId":"customer-defined-identifier",
           "legalName":"Examples Warehouse LLC",
           "address":{
            "city":"Seattle",
            "state":"WA",
            "street":"56486 915th Street",
            "zipCode":"98061"
           },
           "countryCode":"US",
           "alternateBusinessId":{
            "id":"590900O3Z29E78HVXT56",
            "type":"LEI"
           },
           "supportEmail":"help@example.com",
           "supportPhone":"41785473249",
           "vertical":"NON_PROFIT_ORGANIZATION",
           "taxId":"62-4161762",
           "taxIdIssuingCountry":"US",
           "type":"TENDLC_NON_PROFIT"
          }
         },
         "10DLC Private Company Brand":{
          "summary":"10DLC Private Company Brand",
          "description":"10DLC Private Company Brand",
          "value":{
           "id":"79ff0424-7201-45ca-bcbe-9989535fa2ec",
           "applicationId":"app-id",
           "entityId":"entity-id",
           "name":"Example Private Company",
           "stage":"SUBMITTED",
           "website":"https://www.example.com",
           "createdDate":"2021-01-19T16:17:14Z",
           "lastModifiedDate":"2021-01-19T16:17:14Z",
           "referenceId":"customer-defined-identifier",
           "legalName":"Examples Agroculture LLC",
           "address":{
            "city":"Seattle",
            "state":"WA",
            "street":"56486 915th Street",
            "zipCode":"98061"
           },
           "countryCode":"US",
           "alternateBusinessId":{
            "id":"858020355",
            "type":"DUNS"
           },
           "supportEmail":"help@example.com",
           "supportPhone":"41785473249",
           "vertical":"AGRICULTURE",
           "taxId":"62-4161762",
           "taxIdIssuingCountry":"US",
           "type":"TENDLC_PRIVATE_COMPANY"
          }
         },
         "10DLC Public Company Brand":{
          "summary":"10DLC Public Company Brand",
          "description":"10DLC Public Company Brand",
          "value":{
           "id":"79ff0424-7201-45ca-bcbe-9989535fa2ec",
           "applicationId":"app-id",
           "entityId":"entity-id",
           "name":"Example Public Company",
           "stage":"SUBMITTED",
           "website":"https://www.example.com",
           "createdDate":"2021-01-19T16:17:14Z",
           "lastModifiedDate":"2021-01-19T16:17:14Z",
           "referenceId":"customer-defined-identifier",
           "legalName":"Examples Construction LLC",
           "address":{
            "city":"Seattle",
            "state":"WA",
            "street":"56486 915th Street",
            "zipCode":"98061"
           },
           "countryCode":"US",
           "alternateBusinessId":{
            "id":"N9R4GC.STJGQ.ME.163",
            "type":"GIIN"
           },
           "supportEmail":"help@example.com",
           "supportPhone":"41785473249",
           "businessContactEmail":"employee.name@example.com",
           "vertical":"CONSTRUCTION_AND_MATERIALS",
           "taxId":"62-4161762",
           "taxIdIssuingCountry":"US",
           "stockExchange":"EXWH",
           "stockSymbol":"nyse",
           "type":"TENDLC_PUBLIC_COMPANY"
          }
         },
         "10DLC Government Brand":{
          "summary":"10DLC Government Brand",
          "description":"10DLC Government Brand",
          "value":{
           "id":"79ff0424-7201-45ca-bcbe-9989535fa2ec",
           "applicationId":"app-id",
           "entityId":"entity-id",
           "name":"Example Government Company",
           "stage":"SUBMITTED",
           "website":"https://www.example.com",
           "createdDate":"2021-01-19T16:17:14Z",
           "lastModifiedDate":"2021-01-19T16:17:14Z",
           "referenceId":"customer-defined-identifier",
           "legalName":"Examples Education",
           "address":{
            "city":"Seattle",
            "state":"WA",
            "street":"56486 915th Street",
            "zipCode":"98061"
           },
           "countryCode":"US",
           "alternateBusinessId":{
            "id":"858020355",
            "type":"DUNS"
           },
           "supportEmail":"help@example.com",
           "supportPhone":"41785473249",
           "vertical":"EDUCATION",
           "taxId":"62-4161762",
           "taxIdIssuingCountry":"US",
           "type":"TENDLC_GOVERNMENT"
          }
         },
         "TFN Brand":{
          "summary":"TFN Brand",
          "description":"TFN Brand",
          "value":{
           "id":"d9073f3f-3006-4dcb-9d05-41405aa96346",
           "applicationId":"app-id",
           "entityId":"entity-id",
           "name":"Example Toll Free Number Brand",
           "stage":"SUBMITTED",
           "website":"https://www.example.com",
           "createdDate":"2021-01-19T16:17:14Z",
           "lastModifiedDate":"2021-01-19T16:17:14Z",
           "referenceId":"customer-defined-identifier",
           "address":{
            "city":"Seattle",
            "state":"WA",
            "street":"56486 915th Street",
            "zipCode":"98061"
           },
           "countryCode":"US",
           "supportEmail":"help@example.com",
           "supportPhone":"41785473249",
           "businessContactFirstName":"First Name",
           "businessContactLastName":"Last Name",
           "businessDBA":"Example DBA name",
           "taxId":"62-4161762",
           "taxIdIssuingCountry":"US",
           "legalEntityType":"PRIVATE_COMPANY",
           "businessRegistrationType":"EIN",
           "legalName":"Example legal name",
           "type":"TOLL_FREE_NUMBER"
          }
         }
        }
       }
      }
     },
     "202":{
      "description":"Accepted",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Brand"
        }
       }
      }
     },
     "400":{
      "description":"Bad Request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException"
        },
        "examples":{
         "Bad request":{
          "summary":"Bad request",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Bad request"
            }
           }
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"Not Found",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException"
        },
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"NOT_FOUND",
             "text":"Not found"
            }
           }
          }
         }
        }
       }
      }
     },
     "429":{
      "$ref":"#/components/responses/ApiException429"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-throttling-info":[
     {
      "type":"time",
      "numberOfRequests":1,
      "numberOfTimeUnits":0,
      "timeUnit":"s"
     }
    ]
   },
   "delete":{
    "tags":[
     "platform",
     "numbers",
     "number-registration",
     "brands",
     "brand-management"
    ],
    "summary":"Delete Brand",
    "description":"Removes a previously created brand by its ID.\nThis operation is only supported if all associated campaigns are in a stage that allows deletion (applies to vetted and non-vetted brands).\n",
    "operationId":"delete-brand",
    "parameters":[
     {
      "name":"brandId",
      "in":"path",
      "description":"The ID of the brand to delete.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string",
       "format":"uuid",
       "description":"The ID of the brand to delete."
      }
     }
    ],
    "responses":{
     "204":{
      "description":"No Content"
     },
     "400":{
      "description":"Bad Request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException"
        },
        "examples":{
         "Bad request":{
          "summary":"Bad request",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Bad request"
            }
           }
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"Not Found",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException"
        },
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"NOT_FOUND",
             "text":"Not found"
            }
           }
          }
         }
        }
       }
      }
     },
     "429":{
      "$ref":"#/components/responses/ApiException429"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-throttling-info":[
     {
      "type":"time",
      "numberOfRequests":1,
      "numberOfTimeUnits":0,
      "timeUnit":"s"
     }
    ]
   }
  },
  "/number-registration/1/brands/{brandId}/register":{
   "post":{
    "tags":[
     "platform",
     "numbers",
     "number-registration",
     "brands",
     "brand-management"
    ],
    "summary":"Register Brand",
    "description":"Registers the brand with the given ID with all available registrars. Each registered brand incurs a cost, consult your contract for pricing details.\nWhen registering brands of type TENDLC_PUBLIC_COMPANY brands, brand authentication+ verification are automatically triggered.\nThis is only available for 10DLC Brands",
    "operationId":"register-brand",
    "parameters":[
     {
      "name":"brandId",
      "in":"path",
      "description":"The ID of the desired brand.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string",
       "format":"uuid",
       "description":"The ID of the desired brand."
      }
     }
    ],
    "responses":{
     "202":{
      "description":"Accepted"
     },
     "400":{
      "description":"Bad Request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException"
        },
        "examples":{
         "Bad request":{
          "summary":"Bad request",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Bad request"
            }
           }
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"Not Found",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException"
        },
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"NOT_FOUND",
             "text":"Not found"
            }
           }
          }
         }
        }
       }
      }
     },
     "429":{
      "$ref":"#/components/responses/ApiException429"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-throttling-info":[
     {
      "type":"time",
      "numberOfRequests":1,
      "numberOfTimeUnits":0,
      "timeUnit":"s"
     }
    ]
   }
  },
  "/number-registration/1/brands/{brandId}/registrar-statuses":{
   "get":{
    "tags":[
     "platform",
     "numbers",
     "number-registration",
     "brands",
     "brand-management"
    ],
    "summary":"Get Brand Registrar Statuses",
    "description":"Retrieves status of a registered brand for each registrar.",
    "operationId":"get-brand-registrar-statuses",
    "parameters":[
     {
      "name":"brandId",
      "in":"path",
      "description":"The ID of the desired brand.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string",
       "format":"uuid",
       "description":"The ID of the desired brand."
      }
     }
    ],
    "responses":{
     "200":{
      "description":"OK",
      "content":{
       "application/json":{
        "schema":{
         "type":"array",
         "items":{
          "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandStatus"
         }
        }
       }
      }
     },
     "400":{
      "description":"Bad Request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException"
        },
        "examples":{
         "Bad request":{
          "summary":"Bad request",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Bad request"
            }
           }
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"Not Found",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException"
        },
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"NOT_FOUND",
             "text":"Not found"
            }
           }
          }
         }
        }
       }
      }
     },
     "429":{
      "$ref":"#/components/responses/ApiException429"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-throttling-info":[
     {
      "type":"time",
      "numberOfRequests":10,
      "numberOfTimeUnits":0,
      "timeUnit":"s"
     }
    ]
   }
  },
  "/number-registration/1/brands/{brandId}/brand-auth-verification":{
   "post":{
    "tags":[
     "platform",
     "numbers",
     "number-registration",
     "brands",
     "brand-management"
    ],
    "summary":"Request Brand Authentication+ Verification",
    "description":"Request brand authentication+ verification to finalize brand registration process.\nThis operation can be executed for TENDLC_PUBLIC_COMPANY brand type only when Brand authentication is not in progress.",
    "operationId":"brand-auth-verification",
    "parameters":[
     {
      "name":"brandId",
      "in":"path",
      "description":"The ID of the desired brand.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string",
       "format":"uuid",
       "description":"The ID of the desired brand."
      }
     }
    ],
    "responses":{
     "204":{
      "description":"No Content"
     },
     "400":{
      "description":"Bad Request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException"
        },
        "examples":{
         "Bad request":{
          "summary":"Bad request",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Bad request"
            }
           }
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"Not Found",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException"
        },
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"NOT_FOUND",
             "text":"Not found"
            }
           }
          }
         }
        }
       }
      }
     },
     "429":{
      "$ref":"#/components/responses/ApiException429"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-throttling-info":[
     {
      "type":"time",
      "numberOfRequests":1,
      "numberOfTimeUnits":0,
      "timeUnit":"s"
     }
    ]
   }
  },
  "/number-registration/1/brands/{brandId}/resend2fa":{
   "post":{
    "tags":[
     "platform",
     "numbers",
     "number-registration",
     "brands",
     "brand-management"
    ],
    "summary":"Resend 2FA Email For Brand Authentication",
    "description":"Resend 2FA email to proceed with Brand authentication.\nThis operation can be executed for TENDLC_PUBLIC_COMPANY brand type only when Brand authentication is in progress.\nIn 2 hour time window can resend only one 2FA email.",
    "operationId":"resend-2fa-mail-brand-auth",
    "parameters":[
     {
      "name":"brandId",
      "in":"path",
      "description":"The ID of the desired brand.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string",
       "format":"uuid",
       "description":"The ID of the desired brand."
      }
     }
    ],
    "responses":{
     "204":{
      "description":"No Content"
     },
     "400":{
      "description":"Bad Request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException"
        },
        "examples":{
         "Bad request":{
          "summary":"Bad request",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Bad request"
            }
           }
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"Not Found",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException"
        },
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"NOT_FOUND",
             "text":"Not found"
            }
           }
          }
         }
        }
       }
      }
     },
     "429":{
      "$ref":"#/components/responses/ApiException429"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-throttling-info":[
     {
      "type":"time",
      "numberOfRequests":1,
      "numberOfTimeUnits":0,
      "timeUnit":"s"
     }
    ]
   }
  },
  "/number-registration/1/brands/{brandId}/appeal":{
   "post":{
    "tags":[
     "platform",
     "numbers",
     "number-registration",
     "brands",
     "brand-management"
    ],
    "summary":"Submit Brand Identity Appeal",
    "description":"Submit an appeal for a 10DLC brand with REJECTED registration status.\nAppeal can be submitted inside 45 calendar days after rejection happen.\nOnly one pending appeal per brand is allowed at a time.\nCharges apply only if the appeal is processed by TCR. Appeals rejected internally are not charged and can be resubmitted.",
    "operationId":"submit-brand-appeal",
    "parameters":[
     {
      "name":"brandId",
      "in":"path",
      "description":"The ID of the desired brand.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string",
       "format":"uuid",
       "description":"The ID of the desired brand."
      }
     }
    ],
    "requestBody":{
     "content":{
      "application/json":{
       "schema":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandAppealRequest"
       }
      }
     },
     "required":true
    },
    "responses":{
     "202":{
      "description":"Accepted",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandAppealResponse"
        }
       }
      }
     },
     "400":{
      "description":"Bad Request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException"
        },
        "examples":{
         "Bad request":{
          "summary":"Bad request",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Bad request"
            }
           }
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"Not Found",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException"
        },
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"NOT_FOUND",
             "text":"Not found"
            }
           }
          }
         }
        }
       }
      }
     },
     "429":{
      "$ref":"#/components/responses/ApiException429"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-throttling-info":[
     {
      "type":"time",
      "numberOfRequests":1,
      "numberOfTimeUnits":0,
      "timeUnit":"s"
     }
    ]
   }
  },
  "/number-registration/1/brands/{brandId}/appeals":{
   "get":{
    "tags":[
     "platform",
     "numbers",
     "number-registration",
     "brands",
     "brand-management"
    ],
    "summary":"Get Brand Appeals",
    "description":"Retrieves the list of all appeals submitted for the specified brand.",
    "operationId":"get-brand-appeals",
    "parameters":[
     {
      "name":"brandId",
      "in":"path",
      "description":"The ID of the desired brand.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string",
       "format":"uuid",
       "description":"The ID of the desired brand."
      }
     }
    ],
    "responses":{
     "200":{
      "description":"OK",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandAppealsResponse"
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"Not Found",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException"
        },
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"NOT_FOUND",
             "text":"Not found"
            }
           }
          }
         }
        }
       }
      }
     },
     "429":{
      "$ref":"#/components/responses/ApiException429"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-throttling-info":[
     {
      "type":"time",
      "numberOfRequests":10,
      "numberOfTimeUnits":0,
      "timeUnit":"s"
     }
    ]
   }
  },
  "/number-registration/1/brands/{brandId}/vets":{
   "get":{
    "tags":[
     "platform",
     "numbers",
     "number-registration",
     "brands",
     "brand-vetting"
    ],
    "summary":"Get Brand Vets",
    "description":"Retrieves all vets done for the brand with the given ID.",
    "operationId":"get-brand-vets",
    "parameters":[
     {
      "name":"brandId",
      "in":"path",
      "description":"The ID of the desired brand.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string",
       "format":"uuid",
       "description":"The ID of the desired brand."
      }
     },
     {
      "name":"page",
      "in":"query",
      "description":"Results page you want to retrieve (0..N). The default value is 0.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"integer",
       "format":"int32"
      }
     },
     {
      "name":"size",
      "in":"query",
      "description":"Number of records per page (0..2000). The default value is 20. The maximum value is 2000.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"integer",
       "format":"int32"
      }
     },
     {
      "name":"sort",
      "in":"query",
      "description":"Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Sortable Properties: 'vetId', 'type', 'vettedDate', 'enhancedVettedDate'.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"array",
       "items":{
        "type":"string"
       }
      },
      "example":"vettedDate,desc"
     }
    ],
    "responses":{
     "200":{
      "description":"OK",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PageResponseBrandVet"
        }
       }
      }
     },
     "400":{
      "description":"Bad Request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException"
        },
        "examples":{
         "Bad request":{
          "summary":"Bad request",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Bad request"
            }
           }
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"Not Found",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException"
        },
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"NOT_FOUND",
             "text":"Not found"
            }
           }
          }
         }
        }
       }
      }
     },
     "429":{
      "$ref":"#/components/responses/ApiException429"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-throttling-info":[
     {
      "type":"time",
      "numberOfRequests":10,
      "numberOfTimeUnits":0,
      "timeUnit":"s"
     }
    ]
   },
   "post":{
    "tags":[
     "platform",
     "numbers",
     "number-registration",
     "brands",
     "brand-vetting"
    ],
    "summary":"Vet Brand",
    "description":"Vets the brand with the given ID. Vetting a brand may only be performed once every 30 days.\nCan be created as vet type standard or enhanced.\nEach vet of a brand incurs a cost, consult your contract for pricing information.",
    "operationId":"vet-brand",
    "parameters":[
     {
      "name":"brandId",
      "in":"path",
      "description":"The ID of the desired brand.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string",
       "format":"uuid",
       "description":"The ID of the desired brand."
      }
     }
    ],
    "requestBody":{
     "content":{
      "application/json":{
       "schema":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandVet"
       }
      }
     },
     "required":true
    },
    "responses":{
     "202":{
      "description":"Accepted",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandVet"
        }
       }
      }
     },
     "400":{
      "description":"Bad Request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException"
        },
        "examples":{
         "Bad request":{
          "summary":"Bad request",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Bad request"
            }
           }
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"Not Found",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException"
        },
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"NOT_FOUND",
             "text":"Not found"
            }
           }
          }
         }
        }
       }
      }
     },
     "429":{
      "$ref":"#/components/responses/ApiException429"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-throttling-info":[
     {
      "type":"time",
      "numberOfRequests":1,
      "numberOfTimeUnits":0,
      "timeUnit":"s"
     }
    ]
   }
  },
  "/number-registration/1/brands/{brandId}/vets/{vetId}":{
   "get":{
    "tags":[
     "platform",
     "numbers",
     "number-registration",
     "brands",
     "brand-vetting"
    ],
    "summary":"Get Brand Vet",
    "description":"Retrieves brand vet done for the brand with the given ID.",
    "operationId":"get-brand-vet",
    "parameters":[
     {
      "name":"brandId",
      "in":"path",
      "description":"The ID of the desired brand.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string",
       "format":"uuid",
       "description":"The ID of the desired brand."
      }
     },
     {
      "name":"vetId",
      "in":"path",
      "description":"The ID of the desired vet.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string",
       "format":"uuid",
       "description":"The ID of the desired vet."
      }
     }
    ],
    "responses":{
     "200":{
      "description":"OK",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandVet"
        }
       }
      }
     },
     "400":{
      "description":"Bad Request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException"
        },
        "examples":{
         "Bad request":{
          "summary":"Bad request",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Bad request"
            }
           }
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"Not Found",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException"
        },
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"NOT_FOUND",
             "text":"Not found"
            }
           }
          }
         }
        }
       }
      }
     },
     "429":{
      "$ref":"#/components/responses/ApiException429"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-throttling-info":[
     {
      "type":"time",
      "numberOfRequests":10,
      "numberOfTimeUnits":0,
      "timeUnit":"s"
     }
    ]
   },
   "put":{
    "tags":[
     "platform",
     "numbers",
     "number-registration",
     "brands",
     "brand-vetting"
    ],
    "summary":"Update Brand Vet",
    "description":"Updates a brand vetting type.\nProvided vet must be current active standard vet and it may only be updated to an enhanced vet if it was performed within the last 30 days.\nAll other attempts to update a vet are considered an error.",
    "operationId":"update-brand-vet",
    "parameters":[
     {
      "name":"brandId",
      "in":"path",
      "description":"The ID of the desired brand.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string",
       "format":"uuid",
       "description":"The ID of the desired brand."
      }
     },
     {
      "name":"vetId",
      "in":"path",
      "description":"The ID of the brand active vet.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string",
       "format":"uuid",
       "description":"The ID of the brand active vet."
      }
     }
    ],
    "requestBody":{
     "content":{
      "application/json":{
       "schema":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandVet"
       }
      }
     },
     "required":true
    },
    "responses":{
     "200":{
      "description":"OK",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandVet"
        }
       }
      }
     },
     "400":{
      "description":"Bad Request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException"
        },
        "examples":{
         "Bad request":{
          "summary":"Bad request",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Bad request"
            }
           }
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"Not Found",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException"
        },
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"NOT_FOUND",
             "text":"Not found"
            }
           }
          }
         }
        }
       }
      }
     },
     "429":{
      "$ref":"#/components/responses/ApiException429"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-throttling-info":[
     {
      "type":"time",
      "numberOfRequests":1,
      "numberOfTimeUnits":0,
      "timeUnit":"s"
     }
    ]
   }
  },
  "/number-registration/1/brands/{brandId}/vets/import":{
   "put":{
    "tags":[
     "platform",
     "numbers",
     "number-registration",
     "brands",
     "brand-vetting"
    ],
    "summary":"Import Existing Brand Vet",
    "description":"Imports Existing Brand Vet provider",
    "operationId":"import-existing-brand-vet",
    "parameters":[
     {
      "name":"brandId",
      "in":"path",
      "description":"The ID of the desired brand.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string",
       "format":"uuid",
       "description":"The ID of the desired brand."
      }
     }
    ],
    "requestBody":{
     "content":{
      "application/json":{
       "schema":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.VetImportRequest"
       }
      }
     },
     "required":true
    },
    "responses":{
     "200":{
      "description":"OK",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandVet"
        }
       }
      }
     },
     "400":{
      "description":"Bad Request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException"
        },
        "examples":{
         "Bad request":{
          "summary":"Bad request",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Bad request"
            }
           }
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"Not Found",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException"
        },
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"NOT_FOUND",
             "text":"Not found"
            }
           }
          }
         }
        }
       }
      }
     },
     "429":{
      "$ref":"#/components/responses/ApiException429"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-throttling-info":[
     {
      "type":"time",
      "numberOfRequests":1,
      "numberOfTimeUnits":0,
      "timeUnit":"s"
     }
    ]
   }
  },
  "/number-registration/1/brands/{brandId}/vets/{vetId}/report":{
   "get":{
    "tags":[
     "platform",
     "numbers",
     "number-registration",
     "brands",
     "brand-vetting"
    ],
    "summary":"Get Brand Enhanced Vet Report",
    "description":"Retrieves brand enhanced vet report by given vetId.",
    "operationId":"get-brand-enhanced-vet-report",
    "parameters":[
     {
      "name":"brandId",
      "in":"path",
      "description":"The ID of the desired brand.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string",
       "format":"uuid",
       "description":"The ID of the desired brand."
      }
     },
     {
      "name":"vetId",
      "in":"path",
      "description":"The ID of the desired vet.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string",
       "format":"uuid",
       "description":"The ID of the desired vet."
      }
     }
    ],
    "responses":{
     "200":{
      "description":"OK",
      "headers":{
       "Content-Disposition":{
        "description":"PDF file name.",
        "style":"simple",
        "explode":false,
        "schema":{
         "type":"string"
        }
       },
       "Content-Length":{
        "description":"PDF file size.",
        "style":"simple",
        "explode":false,
        "schema":{
         "type":"integer"
        }
       }
      },
      "content":{
       "application/pdf":{
        "schema":{
         "type":"string",
         "format":"binary"
        }
       }
      }
     },
     "400":{
      "description":"Bad Request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException"
        },
        "examples":{
         "Bad request":{
          "summary":"Bad request",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Bad request"
            }
           }
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"Not Found",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException"
        },
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"NOT_FOUND",
             "text":"Not found"
            }
           }
          }
         }
        }
       }
      }
     },
     "429":{
      "$ref":"#/components/responses/ApiException429"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-throttling-info":[
     {
      "type":"time",
      "numberOfRequests":1,
      "numberOfTimeUnits":0,
      "timeUnit":"s"
     }
    ]
   }
  },
  "/number-registration/1/campaigns":{
   "get":{
    "tags":[
     "platform",
     "numbers",
     "number-registration",
     "campaigns"
    ],
    "summary":"Get Campaigns",
    "description":"Gets a page of campaigns, using query parameters to filter results.",
    "operationId":"get-campaigns",
    "parameters":[
     {
      "name":"id",
      "in":"query",
      "description":"Filters campaigns to those that match the supplied ID(s).",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"array",
       "items":{
        "type":"string",
        "format":"uuid"
       }
      }
     },
     {
      "name":"brandId",
      "in":"query",
      "description":"Filters campaigns to those that match the supplied brand ID(s).",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"array",
       "items":{
        "type":"string",
        "format":"uuid"
       }
      }
     },
     {
      "name":"type",
      "in":"query",
      "description":"Filters campaigns to those that match the supplied campaign type(s).",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"array",
       "items":{
        "type":"string"
       }
      }
     },
     {
      "name":"nameLike",
      "in":"query",
      "description":"Filters campaigns to those whose names contain the supplied name.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"string"
      }
     },
     {
      "name":"referenceId",
      "in":"query",
      "description":"Filters campaigns to those that match the supplied referenceId(s).",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"array",
       "items":{
        "type":"string"
       }
      }
     },
     {
      "name":"applicationId",
      "in":"query",
      "description":"Filters campaigns to those whose application ID contains the supplied value.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"string"
      }
     },
     {
      "name":"entityId",
      "in":"query",
      "description":"Filters campaigns to those whose entity ID contains the supplied value.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"string"
      }
     },
     {
      "name":"stage",
      "in":"query",
      "description":"Filters campaigns to those that match the campaign stage(s).",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"array",
       "items":{
        "type":"string"
       }
      }
     },
     {
      "name":"number",
      "in":"query",
      "description":"Filters campaigns to those that match the number(s).",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"array",
       "items":{
        "type":"string"
       }
      }
     },
     {
      "name":"page",
      "in":"query",
      "description":"Results page you want to retrieve (0..N). The default value is 0.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"integer",
       "format":"int32"
      }
     },
     {
      "name":"size",
      "in":"query",
      "description":"Number of records per page (0..2000). The default value is 20. The maximum value is 2000.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"integer",
       "format":"int32"
      }
     },
     {
      "name":"sort",
      "in":"query",
      "description":"Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Sortable Properties: 'id', 'name', 'type', 'createdDate', 'lastModifiedDate'.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"array",
       "items":{
        "type":"string"
       }
      },
      "example":"createdDate,desc"
     }
    ],
    "responses":{
     "200":{
      "description":"OK",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PageResponseCampaign"
        },
        "examples":{
         "10-digit long code Campaign":{
          "summary":"10-digit long code Campaign",
          "description":"10-digit long code Campaign",
          "value":{
           "results":[
            {
             "id":"4d3601ed-c632-4979-ae22-43854ef4ffaf",
             "referenceId":"customer-defined-identifier",
             "applicationId":"app-id",
             "entityId":"entity-id",
             "name":"Example Promo",
             "createdDate":"2019-08-24T14:15:22Z",
             "lastModifiedDate":"2019-08-24T14:15:22Z",
             "stage":"DRAFT",
             "priority":{
              "priorityId":"46de4f63-390c-4253-9869-da282096691b",
              "submittedDate":"2019-08-24T14:15:22Z"
             },
             "brandId":"a0c63335-f841-4d43-9ef8-e0765a233f29",
             "programSummary":"A mix of promotional and informational messaging.",
             "customerCareEmail":"examples@example.com",
             "confirmationMessage":"Example promotional-marketing. Msg&data rates may apply. Reply HELP for help, STOP to cancel.",
             "exampleMessages":[
              "Come in today and get 10% OFF today!"
             ],
             "helpMessage":"Example promotional-marketing: Help at textsupport@example.com or 18889997777. Msg&data rates may apply. Reply STOP to cancel.",
             "stopMessage":"Example promotional-marketing: You have been unsubscribed, no more messages will be sent.",
             "messageTypes":[
              "sms",
              "mms"
             ],
             "termsAndConditionsUrl":"https://www.example.com/terms-and-conditions",
             "optIns":{
              "keyword":{
               "callToAction":"Text MESSAGE to subscribe",
               "keywords":[
                "MESSAGE"
               ]
              }
             },
             "brandPreview":{
              "brandId":"a0c63335-f841-4d43-9ef8-e0765a233f29",
              "brandName":"Examples Warehouse"
             },
             "customerCarePhone":"41785473249",
             "lowVolume":false,
             "useCase":null,
             "useCases":[
              "PROMOTIONAL_MARKETING",
              "EDUCATION"
             ],
             "externalCampaignId":null,
             "numberKeys":[
              "2C958BA98F9EBACA4F9357D81BFBF47B"
             ],
             "numberPreviews":[
              {
               "numberKey":"2C958BA98F9EBACA4F9357D81BFBF47B",
               "number":"41793026727",
               "countryCode":"US"
              }
             ],
             "ageGated":true,
             "directLending":false,
             "embeddedLink":true,
             "embeddedPhone":false,
             "type":"TEN_DIGIT_LONG_CODE",
             "policy":"STANDARD",
             "campaignFeedback":{
              "rejectionReasons":[
               "Example rejection reason 1",
               "Example rejection reason 2"
              ],
              "rejectionDate":"2019-08-24T14:15:22Z"
             },
             "appealData":{
              "appealReason":"Example appeal reason",
              "appealDate":"2019-08-24T14:15:22Z"
             }
            }
           ],
           "paging":{
            "page":0,
            "size":20,
            "totalPages":1,
            "totalResults":1
           }
          }
         },
         "External 10-digit long code Campaign":{
          "summary":"External 10-digit long code Campaign",
          "description":"External 10-digit long code Campaign",
          "value":{
           "results":[
            {
             "id":"4d3601ed-c632-4979-ae22-43854ef4ffaf",
             "referenceId":"customer-defined-identifier",
             "applicationId":"default",
             "name":"Example Promo",
             "createdDate":"2019-08-24T14:15:22Z",
             "lastModifiedDate":"2019-08-24T14:15:22Z",
             "stage":"REGISTERED",
             "priority":{
              "priorityId":"46de4f63-390c-4253-9869-da282096691b",
              "submittedDate":"2019-08-24T14:15:22Z"
             },
             "externalCampaignId":"CAM1234",
             "numberKeys":[
              "D79C1785A82A2BC6FC0B867DCD055215"
             ],
             "numberPreviews":[
              {
               "numberKey":"D79C1785A82A2BC6FC0B867DCD055215",
               "number":"41793026727",
               "countryCode":"US"
              }
             ],
             "type":"EXTERNAL_TEN_DIGIT_LONG_CODE",
             "policy":"STANDARD"
            }
           ],
           "paging":{
            "page":0,
            "size":20,
            "totalPages":1,
            "totalResults":1
           }
          }
         },
         "TFN Campaign":{
          "summary":"TFN Campaign",
          "description":"TFN Campaign",
          "value":{
           "results":[
            {
             "id":"4d3601ed-c632-4979-ae22-43854ef4ffaf",
             "referenceId":"customer-defined-identifier",
             "applicationId":"app-id",
             "entityId":"entity-id",
             "name":"Example Promo",
             "createdDate":"2019-08-24T14:15:22Z",
             "lastModifiedDate":"2019-08-24T14:15:22Z",
             "stage":"REGISTERED",
             "priority":{
              "priorityId":"46de4f63-390c-4253-9869-da282096691b",
              "submittedDate":"2019-08-24T14:15:22Z"
             },
             "campaignFeedback":null,
             "brandId":"a0c63335-f841-4d43-9ef8-e0765a233f29",
             "brandPreview":{
              "brandId":"a0c63335-f841-4d43-9ef8-e0765a233f29",
              "brandName":"Example brand"
             },
             "appealData":null,
             "privacyPolicyUrl":"https://www.example.com/privacy-policy",
             "termsAndConditionsUrl":"https://www.example.com/terms-and-conditions",
             "messageVolume":"HUNDRED",
             "numberKeys":[
              "8CE2738191F7F06F84E5417579D41D74"
             ],
             "numberPreviews":[
              {
               "numberKey":"8CE2738191F7F06F84E5417579D41D74",
               "number":"18007321000",
               "countryCode":"UF"
              }
             ],
             "useCase":"APP_NOTIFICATIONS",
             "programSummary":"A mix of promotional and informational messaging.",
             "exampleMessage":"Come in today and get 10% OFF today!",
             "optIns":{
              "keyword":{
               "callToAction":"Text MESSAGE to subscribe",
               "keywords":[
                "MESSAGE"
               ]
              }
             },
             "optInImageURLs":[
              "https://www.example.com"
             ],
             "additionalInformation":"Example additional info",
             "customerCareEmail":"examples@example.com",
             "type":"TOLL_FREE_NUMBER"
            }
           ],
           "paging":{
            "page":0,
            "size":20,
            "totalPages":1,
            "totalResults":1
           }
          }
         }
        }
       }
      }
     },
     "400":{
      "description":"Bad Request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException"
        },
        "examples":{
         "Bad request":{
          "summary":"Bad request",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Bad request"
            }
           }
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "429":{
      "$ref":"#/components/responses/ApiException429"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-throttling-info":[
     {
      "type":"time",
      "numberOfRequests":10,
      "numberOfTimeUnits":0,
      "timeUnit":"s"
     }
    ]
   },
   "post":{
    "tags":[
     "platform",
     "numbers",
     "number-registration",
     "campaigns"
    ],
    "summary":"Create Campaign",
    "description":"Creates a campaign within the Infobip platform. This operation does not register the campaign with any networks. Registration can be done using created campaign's ID with the 'Register Campaign' endpoint.",
    "operationId":"create-campaign",
    "requestBody":{
     "content":{
      "application/json":{
       "schema":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Campaign"
       },
       "examples":{
        "10-digit long code Campaign":{
         "summary":"10-digit long code Campaign",
         "description":"10-digit long code Campaign",
         "value":{
          "referenceId":"customer-defined-identifier",
          "type":"TEN_DIGIT_LONG_CODE",
          "applicationId":"app-id",
          "entityId":"entity-id",
          "name":"Example Promo",
          "numbers":[
           "41785473249"
          ],
          "brandId":"a0c63335-f841-4d43-9ef8-e0765a233f29",
          "confirmationMessage":"Example promotional-marketing. Msg&data rates may apply. Reply HELP for help, STOP to cancel.",
          "customerCarePhone":"41785473249",
          "customerCareEmail":"examples@example.com",
          "exampleMessages":[
           "Come in today and get 10% OFF today!"
          ],
          "helpMessage":"Example promotional-marketing: Help at textsupport@example.com or 18889997777. Msg&data rates may apply. Reply STOP to cancel.",
          "lowVolume":false,
          "messageTypes":[
           "SMS",
           "MMS"
          ],
          "programSummary":"A mix of promotional and informational messaging.",
          "stopMessage":"Example promotional-marketing: You have been unsubscribed, no more messages will be sent.",
          "termsAndConditionsUrl":"https://www.example.com/terms-and-conditions",
          "useCases":[
           "PROMOTIONAL_MARKETING",
           "EDUCATION"
          ],
          "optIns":{
           "keyword":{
            "callToAction":"Text MESSAGE to subscribe to recurring promotional marketing alerts. Msg&DataRates may apply. Text HELP for help, STOP to opt out. Terms and PP https://www.example.om/terms-of-service/",
            "keywords":[
             "MESSAGE"
            ]
           }
          },
          "ageGated":true,
          "directLending":false,
          "embeddedLink":true,
          "embeddedPhone":false
         }
        },
        "External 10-digit long code Campaign":{
         "summary":"External 10-digit long code Campaign",
         "description":"External 10-digit long code Campaign",
         "value":{
          "referenceId":"customer-defined-identifier",
          "type":"EXTERNAL_TEN_DIGIT_LONG_CODE",
          "name":"Example Promo",
          "numbers":[
           "41785473249"
          ],
          "externalCampaignId":"CAM1234"
         }
        },
        "TFN Campaign":{
         "summary":"TFN Campaign",
         "description":"TFN Campaign",
         "value":{
          "referenceId":"customer-defined-identifier",
          "type":"TOLL_FREE_NUMBER",
          "applicationId":"app-id",
          "entityId":"entity-id",
          "name":"Example Promo",
          "numbers":[
           "18007321000"
          ],
          "brandId":"a0c63335-f841-4d43-9ef8-e0765a233f29",
          "programSummary":"A mix of promotional and informational messaging.",
          "customerCareEmail":"examples@example.com",
          "exampleMessage":"Come in today and get 10% OFF today!",
          "privacyPolicyUrl":"https://www.example.com/privacy-policy",
          "termsAndConditionsUrl":"https://www.example.com/terms-and-conditions",
          "messageVolume":"HUNDRED",
          "useCase":"APP_NOTIFICATIONS",
          "optIns":{
           "keyword":{
            "callToAction":"Text MESSAGE to subscribe",
            "keywords":[
             "MESSAGE"
            ]
           }
          },
          "optInImageURLs":[
           "https://www.example.com"
          ],
          "additionalInformation":"Example additional info",
          "customerCarePhone":"41785473249"
         }
        }
       }
      }
     },
     "required":true
    },
    "responses":{
     "201":{
      "description":"Created",
      "headers":{
       "Location":{
        "description":"The URI location of the created resource.",
        "style":"simple",
        "explode":false,
        "schema":{
         "type":"string"
        }
       }
      },
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Campaign"
        },
        "examples":{
         "10-digit long code Campaign":{
          "summary":"10-digit long code Campaign",
          "description":"10-digit long code Campaign",
          "value":{
           "id":"4d3601ed-c632-4979-ae22-43854ef4ffaf",
           "referenceId":"customer-defined-identifier",
           "applicationId":"app-id",
           "entityId":"entity-id",
           "name":"Example Promo",
           "createdDate":"2019-08-24T14:15:22Z",
           "lastModifiedDate":"2019-08-24T14:15:22Z",
           "stage":"DRAFT",
           "priority":{
            "priorityId":"46de4f63-390c-4253-9869-da282096691b",
            "submittedDate":"2019-08-24T14:15:22Z"
           },
           "brandId":"a0c63335-f841-4d43-9ef8-e0765a233f29",
           "programSummary":"A mix of promotional and informational messaging.",
           "customerCareEmail":"examples@example.com",
           "confirmationMessage":"Example promotional-marketing. Msg&data rates may apply. Reply HELP for help, STOP to cancel.",
           "exampleMessages":[
            "Come in today and get 10% OFF today!"
           ],
           "helpMessage":"Example promotional-marketing: Help at textsupport@example.com or 18889997777. Msg&data rates may apply. Reply STOP to cancel.",
           "stopMessage":"Example promotional-marketing: You have been unsubscribed, no more messages will be sent.",
           "messageTypes":[
            "sms",
            "mms"
           ],
           "termsAndConditionsUrl":"https://www.example.com/terms-and-conditions",
           "optIns":{
            "keyword":{
             "callToAction":"Text MESSAGE to subscribe",
             "keywords":[
              "MESSAGE"
             ]
            }
           },
           "brandPreview":{
            "brandId":"a0c63335-f841-4d43-9ef8-e0765a233f29",
            "brandName":"Examples Warehouse"
           },
           "customerCarePhone":"41785473249",
           "lowVolume":false,
           "useCase":null,
           "useCases":[
            "PROMOTIONAL_MARKETING",
            "EDUCATION"
           ],
           "externalCampaignId":null,
           "numberKeys":[
            "2C958BA98F9EBACA4F9357D81BFBF47B"
           ],
           "numberPreviews":[
            {
             "numberKey":"2C958BA98F9EBACA4F9357D81BFBF47B",
             "number":"41793026727",
             "countryCode":"US"
            }
           ],
           "ageGated":true,
           "directLending":false,
           "embeddedLink":true,
           "embeddedPhone":false,
           "type":"TEN_DIGIT_LONG_CODE",
           "policy":"STANDARD",
           "campaignFeedback":{
            "rejectionReasons":[
             "Campaign appears to be for an age-gated content type but age gate attribute is not selected.",
             "This is a custom rejection reason provided by a reviewer."
            ],
            "rejectionDetails":[
             {
              "errorCode":"1001",
              "description":"Campaign appears to be for an age-gated content type but age gate attribute is not selected.",
              "recommendedAction":"Verify if the Age Gate attribute is selected for the campaign registration. If the campaign is not related to age-gated content, update the campaign description."
             },
             {
              "errorCode":"9999",
              "description":"This is a custom rejection reason provided by a reviewer.",
              "recommendedAction":null
             }
            ],
            "rejectionDate":"2019-08-23T14:15:22Z"
           },
           "appealData":{
            "appealReason":"Example appeal reason",
            "appealDate":"2019-08-24T14:15:22Z"
           }
          }
         },
         "External 10-digit long code Campaign":{
          "summary":"External 10-digit long code Campaign",
          "description":"External 10-digit long code Campaign",
          "value":{
           "id":"4d3601ed-c632-4979-ae22-43854ef4ffaf",
           "referenceId":"customer-defined-identifier",
           "applicationId":"default",
           "entityId":"",
           "name":"Example Promo",
           "createdDate":"2019-08-24T14:15:22Z",
           "lastModifiedDate":"2019-08-24T14:15:22Z",
           "stage":"REGISTERED",
           "priority":{
            "priorityId":"46de4f63-390c-4253-9869-da282096691b",
            "submittedDate":"2019-08-24T14:15:22Z"
           },
           "externalCampaignId":"CAM1234",
           "numberKeys":[
            "D79C1785A82A2BC6FC0B867DCD055215"
           ],
           "numberPreviews":[
            {
             "numberKey":"D79C1785A82A2BC6FC0B867DCD055215",
             "number":"41793026727",
             "countryCode":"US"
            }
           ],
           "campaignFeedback":{
            "rejectionReasons":[
             "Campaign appears to be for an age-gated content type but age gate attribute is not selected.",
             "This is a custom rejection reason provided by a reviewer."
            ],
            "rejectionDetails":[
             {
              "errorCode":"1001",
              "description":"Campaign appears to be for an age-gated content type but age gate attribute is not selected.",
              "recommendedAction":"Verify if the Age Gate attribute is selected for the campaign registration. If the campaign is not related to age-gated content, update the campaign description."
             },
             {
              "errorCode":"9999",
              "description":"This is a custom rejection reason provided by a reviewer.",
              "recommendedAction":null
             }
            ],
            "rejectionDate":"2019-08-23T14:15:22Z"
           },
           "type":"EXTERNAL_TEN_DIGIT_LONG_CODE",
           "policy":"STANDARD"
          }
         },
         "TFN Campaign":{
          "summary":"TFN Campaign",
          "description":"TFN Campaign",
          "value":{
           "id":"4d3601ed-c632-4979-ae22-43854ef4ffaf",
           "referenceId":"customer-defined-identifier",
           "applicationId":"app-id",
           "entityId":"entity-id",
           "name":"Example Promo",
           "createdDate":"2019-08-24T14:15:22Z",
           "lastModifiedDate":"2019-08-24T14:15:22Z",
           "stage":"DRAFT",
           "priority":{
            "priorityId":"46de4f63-390c-4253-9869-da282096691b",
            "submittedDate":"2019-08-24T14:15:22Z"
           },
           "brandId":"a0c63335-f841-4d43-9ef8-e0765a233f29",
           "brandPreview":{
            "brandId":"a0c63335-f841-4d43-9ef8-e0765a233f29",
            "brandName":"Examples Warehouse"
           },
           "programSummary":"A mix of promotional and informational messaging.",
           "customerCareEmail":"examples@example.com",
           "exampleMessage":"Come in today and get 10% OFF today!",
           "privacyPolicyUrl":"https://www.example.com/privacy-policy",
           "termsAndConditionsUrl":"https://www.example.com/terms-and-conditions",
           "messageVolume":"HUNDRED",
           "optIns":{
            "keyword":{
             "callToAction":"Text MESSAGE to subscribe",
             "keywords":[
              "MESSAGE"
             ]
            }
           },
           "optInImageURLs":[
            "https://www.example.com"
           ],
           "additionalInformation":"Example additional info",
           "customerCarePhone":"41785473249",
           "useCase":"APP_NOTIFICATIONS",
           "numberKeys":[
            "8CE2738191F7F06F84E5417579D41D74"
           ],
           "numberPreviews":[
            {
             "numberKey":"8CE2738191F7F06F84E5417579D41D74",
             "number":"18007321000",
             "countryCode":"UF"
            }
           ],
           "type":"TOLL_FREE_NUMBER",
           "campaignFeedback":{
            "rejectionReasons":[
             "Campaign appears to be for an age-gated content type but age gate attribute is not selected.",
             "This is a custom rejection reason provided by a reviewer."
            ],
            "rejectionDetails":[
             {
              "errorCode":"1001",
              "description":"Campaign appears to be for an age-gated content type but age gate attribute is not selected.",
              "recommendedAction":"Verify if the Age Gate attribute is selected for the campaign registration. If the campaign is not related to age-gated content, update the campaign description."
             },
             {
              "errorCode":"9999",
              "description":"This is a custom rejection reason provided by a reviewer.",
              "recommendedAction":null
             }
            ],
            "rejectionDate":"2019-08-23T14:15:22Z"
           },
           "appealData":{
            "appealReason":"Example appeal reason",
            "appealDate":"2019-08-24T14:15:22Z"
           }
          }
         }
        }
       }
      }
     },
     "400":{
      "description":"Bad Request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException"
        },
        "examples":{
         "Bad request":{
          "summary":"Bad request",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Bad request"
            }
           }
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "429":{
      "$ref":"#/components/responses/ApiException429"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-throttling-info":[
     {
      "type":"time",
      "numberOfRequests":5,
      "numberOfTimeUnits":0,
      "timeUnit":"s"
     }
    ]
   }
  },
  "/number-registration/1/campaigns/toll-free":{
   "post":{
    "tags":[
     "platform",
     "numbers",
     "number-registration",
     "campaigns"
    ],
    "summary":"Create Toll Free Campaign",
    "description":"Creates a toll free campaign within the Infobip platform.",
    "operationId":"create-toll-free-campaign",
    "requestBody":{
     "content":{
      "application/json":{
       "schema":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TollFreeUnifiedNumberCampaignApiModel"
       },
       "examples":{
        "TFN Campaign":{
         "summary":"TFN Campaign",
         "description":"TFN Campaign",
         "value":{
          "referenceId":"customer-defined-identifier",
          "type":"TOLL_FREE_UNIFIED_NUMBER",
          "applicationId":"app-id",
          "entityId":"entity-id",
          "name":"Example Promo",
          "numbers":[
           "18007321000"
          ],
          "exampleMessage":"Come in today and get 10% OFF today!",
          "programSummary":"A mix of promotional and informational messaging.",
          "termsAndConditionsUrl":"https://www.example.com/terms-and-conditions",
          "privacyPolicyUrl":"https://www.example.com/privacy-policy",
          "useCase":"APP_NOTIFICATIONS",
          "optIns":{
           "keyword":{
            "callToAction":"Text MESSAGE to subscribe",
            "keywords":[
             "MESSAGE"
            ]
           }
          },
          "messageVolume":"HUNDRED",
          "optInImageURLs":[
           "https://www.example.com/terms-and-conditions"
          ],
          "additionalInformation":"Example additional information",
          "customerCareEmail":"examples@example.com",
          "countryCode":"US",
          "address":{
           "city":"Seattle",
           "state":"WA",
           "street":"56486 915th Street",
           "zipCode":"98061"
          },
          "supportPhone":"1234567890",
          "supportEmail":"example@example.com",
          "businessContactFirstName":"First Name",
          "businessContactLastName":"Last Name",
          "businessDBA":"Example DBA name",
          "businessName":"Example business name",
          "legalName":"Example legal name",
          "businessWebsite":"https://www.example.com",
          "taxId":"62-4161762",
          "taxIdIssuingCountry":"US",
          "legalEntityType":"PRIVATE_COMPANY",
          "businessRegistrationType":"EIN"
         }
        }
       }
      }
     },
     "required":true
    },
    "responses":{
     "201":{
      "description":"Created",
      "headers":{
       "Location":{
        "description":"The URI location of the created resource.",
        "style":"simple",
        "explode":false,
        "schema":{
         "type":"string"
        }
       }
      },
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TollFreeUnifiedNumberCampaignApiModel"
        },
        "examples":{
         "TFN Campaign":{
          "summary":"TFN Campaign",
          "description":"TFN Campaign",
          "value":{
           "id":"2e13b58f-e8d1-45a1-bc67-efc834e2b146",
           "referenceId":"customer-defined-identifier",
           "applicationId":"app-id",
           "entityId":"entity-id",
           "name":"Example toll free unified number campaign",
           "createdDate":"2025-06-30T15:38:40Z",
           "lastModifiedDate":"2025-06-30T15:38:41Z",
           "stage":"SUBMITTED_FOR_REVIEW",
           "priority":{
            "priorityId":null,
            "submittedDate":"2025-06-30T15:38:41Z"
           },
           "campaignFeedback":null,
           "privacyPolicyUrl":"https://www.example.com/privacy-policy",
           "termsAndConditionsUrl":"https://www.example.com/terms-and-conditions",
           "messageVolume":"HUNDRED",
           "numberKeys":[
            "8CE2738191F7F06F84E5417579D41D74"
           ],
           "numberPreviews":[
            {
             "numberKey":"8CE2738191F7F06F84E5417579D41D74",
             "number":"18007321000",
             "countryCode":"UF"
            }
           ],
           "useCase":"APP_NOTIFICATIONS",
           "programSummary":"A mix of promotional and informational messaging.",
           "exampleMessage":"Come in today and get 10% OFF today!",
           "optIns":{
            "keyword":{
             "callToAction":"Text MESSAGE to subscribe",
             "keywords":[
              "MESSAGE"
             ]
            }
           },
           "optInImageURLs":[
            "https://www.example.com"
           ],
           "additionalInformation":"Example additional information",
           "countryCode":"US",
           "address":{
            "city":"Seattle",
            "state":"WA",
            "street":"56486 915th Street",
            "zipCode":"98061"
           },
           "supportPhone":"1234567890",
           "supportEmail":"email@example.com",
           "businessContactFirstName":"First Name",
           "businessContactLastName":"Last Name",
           "businessDBA":"Example Business DBA",
           "businessName":"Example Business Name",
           "legalName":"Example legal name",
           "businessWebsite":"https://www.example.com",
           "customerCareEmail":"customercare@example.com",
           "taxId":"62-4161762",
           "taxIdIssuingCountry":"US",
           "legalEntityType":"PRIVATE_COMPANY",
           "businessRegistrationType":"EIN",
           "type":"TOLL_FREE_UNIFIED_NUMBER"
          }
         }
        }
       }
      }
     },
     "400":{
      "description":"Bad Request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException"
        },
        "examples":{
         "Bad request":{
          "summary":"Bad request",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Bad request"
            }
           }
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "429":{
      "$ref":"#/components/responses/ApiException429"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-throttling-info":[
     {
      "type":"time",
      "numberOfRequests":5,
      "numberOfTimeUnits":0,
      "timeUnit":"s"
     }
    ]
   }
  },
  "/number-registration/1/campaigns/{campaignId}":{
   "get":{
    "tags":[
     "platform",
     "numbers",
     "number-registration",
     "campaigns"
    ],
    "summary":"Get Campaign",
    "description":"Retrieves a previously created campaign by its ID.",
    "operationId":"get-campaign",
    "parameters":[
     {
      "name":"campaignId",
      "in":"path",
      "description":"The ID of the desired campaign.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string",
       "format":"uuid",
       "description":"The ID of the desired campaign."
      }
     }
    ],
    "responses":{
     "200":{
      "description":"OK",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Campaign"
        },
        "examples":{
         "10-digit long code Campaign":{
          "summary":"10-digit long code Campaign",
          "description":"10-digit long code Campaign",
          "value":{
           "id":"4d3601ed-c632-4979-ae22-43854ef4ffaf",
           "referenceId":"customer-defined-identifier",
           "applicationId":"app-id",
           "entityId":"entity-id",
           "name":"Example Promo",
           "createdDate":"2019-08-24T14:15:22Z",
           "lastModifiedDate":"2019-08-24T14:15:22Z",
           "stage":"DRAFT",
           "priority":{
            "priorityId":"46de4f63-390c-4253-9869-da282096691b",
            "submittedDate":"2019-08-24T14:15:22Z"
           },
           "brandId":"a0c63335-f841-4d43-9ef8-e0765a233f29",
           "programSummary":"A mix of promotional and informational messaging.",
           "customerCareEmail":"examples@example.com",
           "confirmationMessage":"Example promotional-marketing. Msg&data rates may apply. Reply HELP for help, STOP to cancel.",
           "exampleMessages":[
            "Come in today and get 10% OFF today!"
           ],
           "helpMessage":"Example promotional-marketing: Help at textsupport@example.com or 18889997777. Msg&data rates may apply. Reply STOP to cancel.",
           "stopMessage":"Example promotional-marketing: You have been unsubscribed, no more messages will be sent.",
           "messageTypes":[
            "sms",
            "mms"
           ],
           "termsAndConditionsUrl":"https://www.example.com/terms-and-conditions",
           "optIns":{
            "keyword":{
             "callToAction":"Text MESSAGE to subscribe",
             "keywords":[
              "MESSAGE"
             ]
            }
           },
           "brandPreview":{
            "brandId":"a0c63335-f841-4d43-9ef8-e0765a233f29",
            "brandName":"Examples Warehouse"
           },
           "customerCarePhone":"41785473249",
           "lowVolume":false,
           "useCase":null,
           "useCases":[
            "PROMOTIONAL_MARKETING",
            "EDUCATION"
           ],
           "externalCampaignId":null,
           "numberKeys":[
            "2C958BA98F9EBACA4F9357D81BFBF47B"
           ],
           "numberPreviews":[
            {
             "numberKey":"2C958BA98F9EBACA4F9357D81BFBF47B",
             "number":"41793026727",
             "countryCode":"US"
            }
           ],
           "ageGated":true,
           "directLending":false,
           "embeddedLink":true,
           "embeddedPhone":false,
           "type":"TEN_DIGIT_LONG_CODE",
           "policy":"STANDARD",
           "campaignFeedback":{
            "rejectionReasons":[
             "Campaign appears to be for an age-gated content type but age gate attribute is not selected.",
             "This is a custom rejection reason provided by a reviewer."
            ],
            "rejectionDetails":[
             {
              "errorCode":"1001",
              "description":"Campaign appears to be for an age-gated content type but age gate attribute is not selected.",
              "recommendedAction":"Verify if the Age Gate attribute is selected for the campaign registration. If the campaign is not related to age-gated content, update the campaign description."
             },
             {
              "errorCode":"9999",
              "description":"This is a custom rejection reason provided by a reviewer.",
              "recommendedAction":null
             }
            ],
            "rejectionDate":"2019-08-23T14:15:22Z"
           },
           "appealData":{
            "appealReason":"Example appeal reason",
            "appealDate":"2019-08-24T14:15:22Z"
           }
          }
         },
         "External 10-digit long code Campaign":{
          "summary":"External 10-digit long code Campaign",
          "description":"External 10-digit long code Campaign",
          "value":{
           "id":"4d3601ed-c632-4979-ae22-43854ef4ffaf",
           "referenceId":"customer-defined-identifier",
           "applicationId":"default",
           "entityId":"",
           "name":"Example Promo",
           "createdDate":"2019-08-24T14:15:22Z",
           "lastModifiedDate":"2019-08-24T14:15:22Z",
           "stage":"REGISTERED",
           "priority":{
            "priorityId":"46de4f63-390c-4253-9869-da282096691b",
            "submittedDate":"2019-08-24T14:15:22Z"
           },
           "externalCampaignId":"CAM1234",
           "numberKeys":[
            "D79C1785A82A2BC6FC0B867DCD055215"
           ],
           "numberPreviews":[
            {
             "numberKey":"D79C1785A82A2BC6FC0B867DCD055215",
             "number":"41793026727",
             "countryCode":"US"
            }
           ],
           "campaignFeedback":{
            "rejectionReasons":[
             "Campaign appears to be for an age-gated content type but age gate attribute is not selected.",
             "This is a custom rejection reason provided by a reviewer."
            ],
            "rejectionDetails":[
             {
              "errorCode":"1001",
              "description":"Campaign appears to be for an age-gated content type but age gate attribute is not selected.",
              "recommendedAction":"Verify if the Age Gate attribute is selected for the campaign registration. If the campaign is not related to age-gated content, update the campaign description."
             },
             {
              "errorCode":"9999",
              "description":"This is a custom rejection reason provided by a reviewer.",
              "recommendedAction":null
             }
            ],
            "rejectionDate":"2019-08-23T14:15:22Z"
           },
           "type":"EXTERNAL_TEN_DIGIT_LONG_CODE",
           "policy":"STANDARD"
          }
         },
         "TFN Campaign":{
          "summary":"TFN Campaign",
          "description":"TFN Campaign",
          "value":{
           "id":"4d3601ed-c632-4979-ae22-43854ef4ffaf",
           "referenceId":"customer-defined-identifier",
           "applicationId":"app-id",
           "entityId":"entity-id",
           "name":"Example Promo",
           "createdDate":"2019-08-24T14:15:22Z",
           "lastModifiedDate":"2019-08-24T14:15:22Z",
           "stage":"DRAFT",
           "priority":{
            "priorityId":"46de4f63-390c-4253-9869-da282096691b",
            "submittedDate":"2019-08-24T14:15:22Z"
           },
           "brandId":"a0c63335-f841-4d43-9ef8-e0765a233f29",
           "brandPreview":{
            "brandId":"a0c63335-f841-4d43-9ef8-e0765a233f29",
            "brandName":"Examples Warehouse"
           },
           "programSummary":"A mix of promotional and informational messaging.",
           "customerCareEmail":"examples@example.com",
           "exampleMessage":"Come in today and get 10% OFF today!",
           "privacyPolicyUrl":"https://www.example.com/privacy-policy",
           "termsAndConditionsUrl":"https://www.example.com/terms-and-conditions",
           "messageVolume":"HUNDRED",
           "optIns":{
            "keyword":{
             "callToAction":"Text MESSAGE to subscribe",
             "keywords":[
              "MESSAGE"
             ]
            }
           },
           "optInImageURLs":[
            "https://www.example.com"
           ],
           "additionalInformation":"Example additional info",
           "customerCarePhone":"41785473249",
           "useCase":"APP_NOTIFICATIONS",
           "numberKeys":[
            "8CE2738191F7F06F84E5417579D41D74"
           ],
           "numberPreviews":[
            {
             "numberKey":"8CE2738191F7F06F84E5417579D41D74",
             "number":"18007321000",
             "countryCode":"UF"
            }
           ],
           "type":"TOLL_FREE_NUMBER",
           "campaignFeedback":{
            "rejectionReasons":[
             "Campaign appears to be for an age-gated content type but age gate attribute is not selected.",
             "This is a custom rejection reason provided by a reviewer."
            ],
            "rejectionDetails":[
             {
              "errorCode":"1001",
              "description":"Campaign appears to be for an age-gated content type but age gate attribute is not selected.",
              "recommendedAction":"Verify if the Age Gate attribute is selected for the campaign registration. If the campaign is not related to age-gated content, update the campaign description."
             },
             {
              "errorCode":"9999",
              "description":"This is a custom rejection reason provided by a reviewer.",
              "recommendedAction":null
             }
            ],
            "rejectionDate":"2019-08-23T14:15:22Z"
           },
           "appealData":{
            "appealReason":"Example appeal reason",
            "appealDate":"2019-08-24T14:15:22Z"
           }
          }
         }
        }
       }
      }
     },
     "400":{
      "description":"Bad Request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException"
        },
        "examples":{
         "Bad request":{
          "summary":"Bad request",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Bad request"
            }
           }
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"Not Found",
      "content":{
       "application/json":{
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"NOT_FOUND",
             "text":"Not found"
            }
           }
          }
         }
        }
       }
      }
     },
     "429":{
      "$ref":"#/components/responses/ApiException429"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-throttling-info":[
     {
      "type":"time",
      "numberOfRequests":10,
      "numberOfTimeUnits":0,
      "timeUnit":"s"
     }
    ]
   },
   "put":{
    "tags":[
     "platform",
     "numbers",
     "number-registration",
     "campaigns"
    ],
    "summary":"Update Campaign",
    "description":"Updates a campaign that has not yet been registered within the Infobip platform or has been rejected by Infobip. This operation is only supported for campaigns that are in DRAFT or REJECTED stage.",
    "operationId":"update-campaign",
    "parameters":[
     {
      "name":"campaignId",
      "in":"path",
      "description":"The ID of the desired campaign.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string",
       "format":"uuid",
       "description":"The ID of the desired campaign."
      }
     }
    ],
    "requestBody":{
     "content":{
      "application/json":{
       "schema":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Campaign"
       },
       "examples":{
        "10-digit long code Campaign":{
         "summary":"10-digit long code Campaign",
         "description":"10-digit long code Campaign",
         "value":{
          "referenceId":"customer-defined-identifier",
          "type":"TEN_DIGIT_LONG_CODE",
          "applicationId":"app-id",
          "entityId":"entity-id",
          "name":"Example Promo",
          "numbers":[
           "41785473249"
          ],
          "brandId":"a0c63335-f841-4d43-9ef8-e0765a233f29",
          "confirmationMessage":"Example promotional-marketing. Msg&data rates may apply. Reply HELP for help, STOP to cancel.",
          "customerCarePhone":"41785473249",
          "customerCareEmail":"examples@example.com",
          "exampleMessages":[
           "Come in today and get 10% OFF today!"
          ],
          "helpMessage":"Example promotional-marketing: Help at textsupport@example.com or 18889997777. Msg&data rates may apply. Reply STOP to cancel.",
          "lowVolume":false,
          "messageTypes":[
           "SMS",
           "MMS"
          ],
          "programSummary":"A mix of promotional and informational messaging.",
          "stopMessage":"Example promotional-marketing: You have been unsubscribed, no more messages will be sent.",
          "termsAndConditionsUrl":"https://www.example.com/terms-and-conditions",
          "useCases":[
           "PROMOTIONAL_MARKETING",
           "EDUCATION"
          ],
          "optIns":{
           "keyword":{
            "callToAction":"Text MESSAGE to subscribe to recurring promotional marketing alerts. Msg&DataRates may apply. Text HELP for help, STOP to opt out. Terms and PP https://www.example.om/terms-of-service/",
            "keywords":[
             "MESSAGE"
            ]
           }
          },
          "ageGated":true,
          "directLending":false,
          "embeddedLink":true,
          "embeddedPhone":false
         }
        },
        "External 10-digit long code Campaign":{
         "summary":"External 10-digit long code Campaign",
         "description":"External 10-digit long code Campaign",
         "value":{
          "referenceId":"customer-defined-identifier",
          "type":"EXTERNAL_TEN_DIGIT_LONG_CODE",
          "name":"Example Promo",
          "numbers":[
           "41785473249"
          ],
          "externalCampaignId":"CAM1234"
         }
        },
        "TFN Campaign":{
         "summary":"TFN Campaign",
         "description":"TFN Campaign",
         "value":{
          "referenceId":"customer-defined-identifier",
          "type":"TOLL_FREE_NUMBER",
          "applicationId":"app-id",
          "entityId":"entity-id",
          "name":"Example Promo",
          "numbers":[
           "18007321000"
          ],
          "brandId":"a0c63335-f841-4d43-9ef8-e0765a233f29",
          "programSummary":"A mix of promotional and informational messaging.",
          "customerCareEmail":"examples@example.com",
          "exampleMessage":"Come in today and get 10% OFF today!",
          "privacyPolicyUrl":"https://www.example.com/privacy-policy",
          "termsAndConditionsUrl":"https://www.example.com/terms-and-conditions",
          "messageVolume":"HUNDRED",
          "useCase":"APP_NOTIFICATIONS",
          "optIns":{
           "keyword":{
            "callToAction":"Text MESSAGE to subscribe",
            "keywords":[
             "MESSAGE"
            ]
           }
          },
          "optInImageURLs":[
           "https://www.example.com"
          ],
          "additionalInformation":"Example additional info",
          "customerCarePhone":"41785473249"
         }
        }
       }
      }
     },
     "required":true
    },
    "responses":{
     "200":{
      "description":"OK",
      "headers":{
       "Location":{
        "description":"The URI location of the created resource.",
        "style":"simple",
        "explode":false,
        "schema":{
         "type":"string"
        }
       }
      },
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Campaign"
        },
        "examples":{
         "10-digit long code Campaign":{
          "summary":"10-digit long code Campaign",
          "description":"10-digit long code Campaign",
          "value":{
           "id":"4d3601ed-c632-4979-ae22-43854ef4ffaf",
           "referenceId":"customer-defined-identifier",
           "applicationId":"app-id",
           "entityId":"entity-id",
           "name":"Example Promo",
           "createdDate":"2019-08-24T14:15:22Z",
           "lastModifiedDate":"2019-08-24T14:15:22Z",
           "stage":"DRAFT",
           "priority":{
            "priorityId":"46de4f63-390c-4253-9869-da282096691b",
            "submittedDate":"2019-08-24T14:15:22Z"
           },
           "brandId":"a0c63335-f841-4d43-9ef8-e0765a233f29",
           "programSummary":"A mix of promotional and informational messaging.",
           "customerCareEmail":"examples@example.com",
           "confirmationMessage":"Example promotional-marketing. Msg&data rates may apply. Reply HELP for help, STOP to cancel.",
           "exampleMessages":[
            "Come in today and get 10% OFF today!"
           ],
           "helpMessage":"Example promotional-marketing: Help at textsupport@example.com or 18889997777. Msg&data rates may apply. Reply STOP to cancel.",
           "stopMessage":"Example promotional-marketing: You have been unsubscribed, no more messages will be sent.",
           "messageTypes":[
            "sms",
            "mms"
           ],
           "termsAndConditionsUrl":"https://www.example.com/terms-and-conditions",
           "optIns":{
            "keyword":{
             "callToAction":"Text MESSAGE to subscribe",
             "keywords":[
              "MESSAGE"
             ]
            }
           },
           "brandPreview":{
            "brandId":"a0c63335-f841-4d43-9ef8-e0765a233f29",
            "brandName":"Examples Warehouse"
           },
           "customerCarePhone":"41785473249",
           "lowVolume":false,
           "useCase":null,
           "useCases":[
            "PROMOTIONAL_MARKETING",
            "EDUCATION"
           ],
           "externalCampaignId":null,
           "numberKeys":[
            "2C958BA98F9EBACA4F9357D81BFBF47B"
           ],
           "numberPreviews":[
            {
             "numberKey":"2C958BA98F9EBACA4F9357D81BFBF47B",
             "number":"41793026727",
             "countryCode":"US"
            }
           ],
           "ageGated":true,
           "directLending":false,
           "embeddedLink":true,
           "embeddedPhone":false,
           "type":"TEN_DIGIT_LONG_CODE",
           "policy":"STANDARD",
           "campaignFeedback":{
            "rejectionReasons":[
             "Campaign appears to be for an age-gated content type but age gate attribute is not selected.",
             "This is a custom rejection reason provided by a reviewer."
            ],
            "rejectionDetails":[
             {
              "errorCode":"1001",
              "description":"Campaign appears to be for an age-gated content type but age gate attribute is not selected.",
              "recommendedAction":"Verify if the Age Gate attribute is selected for the campaign registration. If the campaign is not related to age-gated content, update the campaign description."
             },
             {
              "errorCode":"9999",
              "description":"This is a custom rejection reason provided by a reviewer.",
              "recommendedAction":null
             }
            ],
            "rejectionDate":"2019-08-23T14:15:22Z"
           },
           "appealData":{
            "appealReason":"Example appeal reason",
            "appealDate":"2019-08-24T14:15:22Z"
           }
          }
         },
         "External 10-digit long code Campaign":{
          "summary":"External 10-digit long code Campaign",
          "description":"External 10-digit long code Campaign",
          "value":{
           "id":"4d3601ed-c632-4979-ae22-43854ef4ffaf",
           "referenceId":"customer-defined-identifier",
           "applicationId":"default",
           "entityId":"",
           "name":"Example Promo",
           "createdDate":"2019-08-24T14:15:22Z",
           "lastModifiedDate":"2019-08-24T14:15:22Z",
           "stage":"REGISTERED",
           "priority":{
            "priorityId":"46de4f63-390c-4253-9869-da282096691b",
            "submittedDate":"2019-08-24T14:15:22Z"
           },
           "externalCampaignId":"CAM1234",
           "numberKeys":[
            "D79C1785A82A2BC6FC0B867DCD055215"
           ],
           "numberPreviews":[
            {
             "numberKey":"D79C1785A82A2BC6FC0B867DCD055215",
             "number":"41793026727",
             "countryCode":"US"
            }
           ],
           "campaignFeedback":{
            "rejectionReasons":[
             "Campaign appears to be for an age-gated content type but age gate attribute is not selected.",
             "This is a custom rejection reason provided by a reviewer."
            ],
            "rejectionDetails":[
             {
              "errorCode":"1001",
              "description":"Campaign appears to be for an age-gated content type but age gate attribute is not selected.",
              "recommendedAction":"Verify if the Age Gate attribute is selected for the campaign registration. If the campaign is not related to age-gated content, update the campaign description."
             },
             {
              "errorCode":"9999",
              "description":"This is a custom rejection reason provided by a reviewer.",
              "recommendedAction":null
             }
            ],
            "rejectionDate":"2019-08-23T14:15:22Z"
           },
           "type":"EXTERNAL_TEN_DIGIT_LONG_CODE",
           "policy":"STANDARD"
          }
         },
         "TFN Campaign":{
          "summary":"TFN Campaign",
          "description":"TFN Campaign",
          "value":{
           "id":"4d3601ed-c632-4979-ae22-43854ef4ffaf",
           "referenceId":"customer-defined-identifier",
           "applicationId":"app-id",
           "entityId":"entity-id",
           "name":"Example Promo",
           "createdDate":"2019-08-24T14:15:22Z",
           "lastModifiedDate":"2019-08-24T14:15:22Z",
           "stage":"DRAFT",
           "priority":{
            "priorityId":"46de4f63-390c-4253-9869-da282096691b",
            "submittedDate":"2019-08-24T14:15:22Z"
           },
           "brandId":"a0c63335-f841-4d43-9ef8-e0765a233f29",
           "brandPreview":{
            "brandId":"a0c63335-f841-4d43-9ef8-e0765a233f29",
            "brandName":"Examples Warehouse"
           },
           "programSummary":"A mix of promotional and informational messaging.",
           "customerCareEmail":"examples@example.com",
           "exampleMessage":"Come in today and get 10% OFF today!",
           "privacyPolicyUrl":"https://www.example.com/privacy-policy",
           "termsAndConditionsUrl":"https://www.example.com/terms-and-conditions",
           "messageVolume":"HUNDRED",
           "optIns":{
            "keyword":{
             "callToAction":"Text MESSAGE to subscribe",
             "keywords":[
              "MESSAGE"
             ]
            }
           },
           "optInImageURLs":[
            "https://www.example.com"
           ],
           "additionalInformation":"Example additional info",
           "customerCarePhone":"41785473249",
           "useCase":"APP_NOTIFICATIONS",
           "numberKeys":[
            "8CE2738191F7F06F84E5417579D41D74"
           ],
           "numberPreviews":[
            {
             "numberKey":"8CE2738191F7F06F84E5417579D41D74",
             "number":"18007321000",
             "countryCode":"UF"
            }
           ],
           "type":"TOLL_FREE_NUMBER",
           "campaignFeedback":{
            "rejectionReasons":[
             "Campaign appears to be for an age-gated content type but age gate attribute is not selected.",
             "This is a custom rejection reason provided by a reviewer."
            ],
            "rejectionDetails":[
             {
              "errorCode":"1001",
              "description":"Campaign appears to be for an age-gated content type but age gate attribute is not selected.",
              "recommendedAction":"Verify if the Age Gate attribute is selected for the campaign registration. If the campaign is not related to age-gated content, update the campaign description."
             },
             {
              "errorCode":"9999",
              "description":"This is a custom rejection reason provided by a reviewer.",
              "recommendedAction":null
             }
            ],
            "rejectionDate":"2019-08-23T14:15:22Z"
           },
           "appealData":{
            "appealReason":"Example appeal reason",
            "appealDate":"2019-08-24T14:15:22Z"
           }
          }
         }
        }
       }
      }
     },
     "400":{
      "description":"Bad Request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException"
        },
        "examples":{
         "Bad request":{
          "summary":"Bad request",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Bad request"
            }
           }
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"Not Found",
      "content":{
       "application/json":{
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"NOT_FOUND",
             "text":"Not found"
            }
           }
          }
         }
        }
       }
      }
     },
     "429":{
      "$ref":"#/components/responses/ApiException429"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-throttling-info":[
     {
      "type":"time",
      "numberOfRequests":1,
      "numberOfTimeUnits":0,
      "timeUnit":"s"
     }
    ]
   },
   "delete":{
    "tags":[
     "platform",
     "numbers",
     "number-registration",
     "campaigns"
    ],
    "summary":"Delete Campaign",
    "description":"Removes a previously created campaign by its ID.\nThis operation is only supported for campaigns that are in DRAFT, DEREGISTERED or REJECTED stage.\n",
    "operationId":"delete-campaign",
    "parameters":[
     {
      "name":"campaignId",
      "in":"path",
      "description":"The ID of the campaign to delete.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string",
       "format":"uuid",
       "description":"The ID of the campaign to delete."
      }
     }
    ],
    "responses":{
     "204":{
      "description":"No Content"
     },
     "400":{
      "description":"Bad Request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException"
        },
        "examples":{
         "Bad request":{
          "summary":"Bad request",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Bad request"
            }
           }
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"Not Found",
      "content":{
       "application/json":{
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"NOT_FOUND",
             "text":"Not found"
            }
           }
          }
         }
        }
       }
      }
     },
     "429":{
      "$ref":"#/components/responses/ApiException429"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-throttling-info":[
     {
      "type":"time",
      "numberOfRequests":1,
      "numberOfTimeUnits":0,
      "timeUnit":"s"
     }
    ]
   }
  },
  "/number-registration/1/campaigns/{campaignId}/register":{
   "post":{
    "tags":[
     "platform",
     "numbers",
     "number-registration",
     "campaigns"
    ],
    "summary":"Submit Campaign",
    "description":"Submits the campaign with the given ID for Infobip review. If a campaign gets approved by Infobip, it will get registered with carriers, and submitted for underlying connectivity provider's review. Each registered campaign incurs a cost, consult your contract for pricing information.",
    "externalDocs":{
     "description":"Find out more",
     "url":"https://www.infobip.com/docs/10dlc/10dlc-registration"
    },
    "operationId":"register-campaign",
    "parameters":[
     {
      "name":"campaignId",
      "in":"path",
      "description":"The ID of the desired campaign.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string",
       "format":"uuid",
       "description":"The ID of the desired campaign."
      }
     }
    ],
    "requestBody":{
     "content":{
      "application/json":{
       "schema":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.RegisterCampaignRequest"
       },
       "examples":{
        "Request example":{
         "summary":"Request example",
         "value":{
          "priorityId":"3fa85f64-5717-4562-b3fc-2c963f66afa6"
         }
        }
       }
      }
     }
    },
    "responses":{
     "202":{
      "description":"Accepted"
     },
     "400":{
      "description":"Bad Request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException"
        },
        "examples":{
         "Bad request":{
          "summary":"Bad request",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Bad request"
            }
           }
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"Not Found",
      "content":{
       "application/json":{
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"NOT_FOUND",
             "text":"Not found"
            }
           }
          }
         }
        }
       }
      }
     },
     "429":{
      "$ref":"#/components/responses/ApiException429"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-throttling-info":[
     {
      "type":"time",
      "numberOfRequests":1,
      "numberOfTimeUnits":0,
      "timeUnit":"s"
     }
    ]
   }
  },
  "/number-registration/1/campaigns/{campaignId}/network-statuses":{
   "get":{
    "tags":[
     "platform",
     "numbers",
     "number-registration",
     "campaigns"
    ],
    "summary":"Get Campaign Network Statuses",
    "description":"Retrieves status of a registered campaign for each network.",
    "operationId":"get-campaign-network-statuses",
    "parameters":[
     {
      "name":"campaignId",
      "in":"path",
      "description":"The ID of the desired campaign.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string",
       "format":"uuid",
       "description":"The ID of the desired campaign."
      }
     }
    ],
    "responses":{
     "200":{
      "description":"OK",
      "content":{
       "application/json":{
        "schema":{
         "type":"array",
         "items":{
          "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.NetworkStatus"
         }
        },
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":[
           {
            "network":"ATT",
            "state":"ACTIVE",
            "messageClass":"A",
            "throughput":4500,
            "brandTier":null
           },
           {
            "network":"T_MOBILE",
            "state":"ACTIVE",
            "messageClass":"20",
            "throughput":2000,
            "brandTier":"LOW"
           }
          ]
         }
        }
       }
      }
     },
     "400":{
      "description":"Bad Request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException"
        },
        "examples":{
         "Bad request":{
          "summary":"Bad request",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Bad request"
            }
           }
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"Not Found",
      "content":{
       "application/json":{
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"NOT_FOUND",
             "text":"Not found"
            }
           }
          }
         }
        }
       }
      }
     },
     "429":{
      "$ref":"#/components/responses/ApiException429"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-throttling-info":[
     {
      "type":"time",
      "numberOfRequests":10,
      "numberOfTimeUnits":0,
      "timeUnit":"s"
     }
    ]
   }
  },
  "/number-registration/1/campaigns/{campaignId}/deregister":{
   "post":{
    "tags":[
     "platform",
     "numbers",
     "number-registration",
     "campaigns"
    ],
    "summary":"Deregister Campaign",
    "description":"Deregisters the campaign with the given ID with all available networks.",
    "operationId":"deregister-campaign",
    "parameters":[
     {
      "name":"campaignId",
      "in":"path",
      "description":"The ID of the desired campaign.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string",
       "format":"uuid",
       "description":"The ID of the desired campaign."
      }
     }
    ],
    "responses":{
     "202":{
      "description":"Accepted"
     },
     "204":{
      "description":"Returned if campaign is already in DEREGISTERED or REGISTERED_PENDING_DEREGISTRATION stage."
     },
     "400":{
      "description":"Bad Request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException"
        },
        "examples":{
         "Bad request":{
          "summary":"Bad request",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Bad request"
            }
           }
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"Not Found",
      "content":{
       "application/json":{
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"NOT_FOUND",
             "text":"Not found"
            }
           }
          }
         }
        }
       }
      }
     },
     "429":{
      "$ref":"#/components/responses/ApiException429"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-throttling-info":[
     {
      "type":"time",
      "numberOfRequests":1,
      "numberOfTimeUnits":0,
      "timeUnit":"s"
     }
    ]
   }
  },
  "/number-registration/1/campaigns/{campaignId}/update-registration":{
   "post":{
    "tags":[
     "platform",
     "numbers",
     "number-registration",
     "campaigns"
    ],
    "summary":"Update Registered Campaign",
    "description":"Updates a campaign that has already been registered. If the campaign registration has not been completed, attempting to update via this api will result in a 400 Bad Request. Numbers which require OSR to be updated in advance could be identified by using Numbers API's \"List owned number\" GET endpoint.",
    "operationId":"update-registered-campaign",
    "parameters":[
     {
      "name":"campaignId",
      "in":"path",
      "description":"The ID of the desired campaign.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string",
       "format":"uuid",
       "description":"The ID of the desired campaign."
      }
     }
    ],
    "requestBody":{
     "content":{
      "application/json":{
       "schema":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.UpdateCampaignRegistrationRequest"
       },
       "examples":{
        "Request example":{
         "summary":"Request example",
         "value":{
          "numberKeys":[
           "8F665E5F6582E586BA9DF4D227035298",
           "D79C1785A82A2BC6FC0B867DCD055215"
          ]
         }
        }
       }
      }
     },
     "required":true
    },
    "responses":{
     "202":{
      "description":"Accepted"
     },
     "400":{
      "description":"Bad Request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException"
        },
        "examples":{
         "Bad request":{
          "summary":"Bad request",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Bad request"
            }
           }
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"Not Found",
      "content":{
       "application/json":{
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"NOT_FOUND",
             "text":"Not found"
            }
           }
          }
         }
        }
       }
      }
     },
     "429":{
      "$ref":"#/components/responses/ApiException429"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-throttling-info":[
     {
      "type":"time",
      "numberOfRequests":1,
      "numberOfTimeUnits":0,
      "timeUnit":"s"
     }
    ]
   }
  },
  "/number-registration/1/campaigns/{campaignId}/add-numbers":{
   "post":{
    "tags":[
     "platform",
     "numbers",
     "number-registration",
     "campaigns"
    ],
    "summary":"Add Numbers to Registered Campaign",
    "description":"Adds numbers to campaign that has already been registered. If the campaign registration has not been completed or numbers size exceeds the limit, attempting to update via this api will result in a 400 Bad Request. Numbers which require OSR to be updated in advance could be identified by using Numbers API's \"List owned number\" GET endpoint.",
    "operationId":"add-numbers",
    "parameters":[
     {
      "name":"campaignId",
      "in":"path",
      "description":"The ID of the desired campaign.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string",
       "format":"uuid",
       "description":"The ID of the desired campaign."
      }
     }
    ],
    "requestBody":{
     "content":{
      "application/json":{
       "schema":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.UpdateCampaignRegistrationRequest"
       },
       "examples":{
        "Request example":{
         "summary":"Request example",
         "value":{
          "numberKeys":[
           "8F665E5F6582E586BA9DF4D227035298",
           "D79C1785A82A2BC6FC0B867DCD055215"
          ]
         }
        }
       }
      }
     },
     "required":true
    },
    "responses":{
     "202":{
      "description":"Accepted"
     },
     "400":{
      "description":"Bad Request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException"
        },
        "examples":{
         "Bad request":{
          "summary":"Bad request",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Bad request"
            }
           }
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"Not Found",
      "content":{
       "application/json":{
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"NOT_FOUND",
             "text":"Not found"
            }
           }
          }
         }
        }
       }
      }
     },
     "429":{
      "description":"Too Many Requests",
      "content":{
       "application/json":{
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"TOO_MANY_REQUESTS",
             "text":"Too many requests"
            }
           }
          }
         }
        }
       }
      }
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-throttling-info":[
     {
      "type":"time",
      "numberOfRequests":1,
      "numberOfTimeUnits":0,
      "timeUnit":"s"
     }
    ]
   }
  },
  "/number-registration/1/campaigns/{campaignId}/remove-numbers":{
   "post":{
    "tags":[
     "platform",
     "numbers",
     "number-registration",
     "campaigns"
    ],
    "summary":"Remove Numbers from Registered Campaign",
    "description":"Removes numbers from campaign that has already been registered. If the campaign registration has not been completed or numbers size exceeds the limit, attempting to update via this api will result in a 400 Bad Request.",
    "operationId":"remove-numbers",
    "parameters":[
     {
      "name":"campaignId",
      "in":"path",
      "description":"The ID of the desired campaign.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string",
       "format":"uuid",
       "description":"The ID of the desired campaign."
      }
     }
    ],
    "requestBody":{
     "content":{
      "application/json":{
       "schema":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.UpdateCampaignRegistrationRequest"
       },
       "examples":{
        "Request example":{
         "summary":"Request example",
         "value":{
          "numberKeys":[
           "8F665E5F6582E586BA9DF4D227035298",
           "D79C1785A82A2BC6FC0B867DCD055215"
          ]
         }
        }
       }
      }
     },
     "required":true
    },
    "responses":{
     "202":{
      "description":"Accepted"
     },
     "400":{
      "description":"Bad Request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException"
        },
        "examples":{
         "Bad request":{
          "summary":"Bad request",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Bad request"
            }
           }
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"Not Found",
      "content":{
       "application/json":{
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"NOT_FOUND",
             "text":"Not found"
            }
           }
          }
         }
        }
       }
      }
     },
     "429":{
      "description":"Too Many Requests",
      "content":{
       "application/json":{
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"TOO_MANY_REQUESTS",
             "text":"Too many requests"
            }
           }
          }
         }
        }
       }
      }
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-throttling-info":[
     {
      "type":"time",
      "numberOfRequests":1,
      "numberOfTimeUnits":0,
      "timeUnit":"s"
     }
    ]
   }
  },
  "/number-registration/1/campaigns/{campaignId}/numbers":{
   "get":{
    "tags":[
     "platform",
     "numbers",
     "number-registration",
     "campaigns"
    ],
    "summary":"Get Campaign numbers",
    "description":"Retrieves all the numbers associated with a campaign, regardless of the stage, by its ID.",
    "operationId":"get-campaign-numbers",
    "parameters":[
     {
      "name":"campaignId",
      "in":"path",
      "description":"The ID of the campaign for which the numbers should be fetched.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string",
       "format":"uuid",
       "description":"The ID of the campaign for which the numbers should be fetched."
      }
     }
    ],
    "responses":{
     "200":{
      "description":"OK",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.NumberPreviews"
        },
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "numberPreviews":[
            {
             "numberKey":"2C958BA98F9EBACA4F9357D81BFBF47B",
             "number":"41793026727",
             "countryCode":"US"
            },
            {
             "numberKey":"D79C1785A82A2BC6FC0B867DCD055215",
             "number":"42893024539",
             "countryCode":"US"
            }
           ]
          }
         }
        }
       }
      }
     },
     "400":{
      "description":"Bad Request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException"
        },
        "examples":{
         "Bad request":{
          "summary":"Bad request",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Bad request"
            }
           }
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"Not Found",
      "content":{
       "application/json":{
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"NOT_FOUND",
             "text":"Not found"
            }
           }
          }
         }
        }
       }
      }
     },
     "429":{
      "$ref":"#/components/responses/ApiException429"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-throttling-info":[
     {
      "type":"time",
      "numberOfRequests":10,
      "numberOfTimeUnits":0,
      "timeUnit":"s"
     }
    ]
   }
  },
  "/number-registration/1/campaigns/{campaignId}/appeal":{
   "post":{
    "tags":[
     "platform",
     "numbers",
     "number-registration",
     "campaigns"
    ],
    "summary":"Appeal Campaign",
    "description":"Appeals a rejected 10DLC campaign within the Infobip platform. Campaigns are eligible for appeal if they were rejected within the past 3 months and can be appealed up to five times.",
    "operationId":"appeal-campaign",
    "parameters":[
     {
      "name":"campaignId",
      "in":"path",
      "description":"The ID of the desired campaign.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string",
       "format":"uuid",
       "description":"The ID of the desired campaign."
      }
     }
    ],
    "requestBody":{
     "content":{
      "application/json":{
       "schema":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.AppealRequest"
       },
       "examples":{
        "Request example":{
         "summary":"Request example",
         "value":{
          "reason":"Example appeal reason"
         }
        }
       }
      }
     },
     "required":true
    },
    "responses":{
     "204":{
      "description":"No Content"
     },
     "400":{
      "description":"Bad Request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException"
        },
        "examples":{
         "Bad request":{
          "summary":"Bad request",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Bad request"
            }
           }
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"Not Found",
      "content":{
       "application/json":{
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"NOT_FOUND",
             "text":"Not found"
            }
           }
          }
         }
        }
       }
      }
     },
     "429":{
      "$ref":"#/components/responses/ApiException429"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-throttling-info":[
     {
      "type":"time",
      "numberOfRequests":1,
      "numberOfTimeUnits":0,
      "timeUnit":"s"
     }
    ]
   }
  },
  "/number-registration/1/campaigns/priorities":{
   "get":{
    "tags":[
     "platform",
     "numbers",
     "number-registration",
     "campaigns"
    ],
    "summary":"Get Campaign Priorities",
    "description":"Retrieves campaign priority levels for your account(if applicable). Please contact your account manager to learn more about priorities.",
    "operationId":"get-campaign-priorities",
    "responses":{
     "200":{
      "description":"OK",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Priority"
        },
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":[
           {
            "priorityId":"4d3601ed-c632-4979-ae22-43854ef4ffaf",
            "dailySubmitLimit":10,
            "reviewTime":{
             "timeUnit":"HOURS",
             "amount":2
            }
           },
           {
            "priorityId":"4d3601ed-c632-4979-ae22-43854ef4ffad",
            "dailySubmitLimit":100,
            "reviewTime":{
             "timeUnit":"DAYS",
             "amount":2
            }
           }
          ]
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "429":{
      "$ref":"#/components/responses/ApiException429"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-throttling-info":[
     {
      "type":"time",
      "numberOfRequests":10,
      "numberOfTimeUnits":0,
      "timeUnit":"s"
     }
    ]
   }
  },
  "/number-registration/1/campaigns/{campaignId}/number-pool/attach":{
   "post":{
    "tags":[
     "platform",
     "numbers",
     "number-registration",
     "campaigns"
    ],
    "summary":"Attach Number Pool to Campaign",
    "description":"Associates an existing number pool with a campaign. Number pooling is required when a campaign utilizes more than 49 numbers. This is common in high-throughput environments such as call centers. Attaching a number pool ensures proper provisioning and compliance with carrier requirements.",
    "operationId":"attach-number-pool",
    "parameters":[
     {
      "name":"campaignId",
      "in":"path",
      "description":"The ID of the desired campaign.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string",
       "format":"uuid",
       "description":"The ID of the desired campaign."
      }
     }
    ],
    "requestBody":{
     "content":{
      "application/json":{
       "schema":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.AttachNumberPoolRequest"
       },
       "examples":{
        "Request example":{
         "summary":"Request example",
         "value":{
          "numberPoolId":"number-pool-identifier",
          "reason":"Example attach reason"
         }
        }
       }
      }
     },
     "required":true
    },
    "responses":{
     "204":{
      "description":"No Content"
     },
     "400":{
      "description":"Bad Request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException"
        },
        "examples":{
         "Bad request":{
          "summary":"Bad request",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Bad request"
            }
           }
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"Not Found",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException"
        },
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"NOT_FOUND",
             "text":"Not found"
            }
           }
          }
         }
        }
       }
      }
     },
     "429":{
      "$ref":"#/components/responses/ApiException429"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-throttling-info":[
     {
      "type":"time",
      "numberOfRequests":1,
      "numberOfTimeUnits":0,
      "timeUnit":"s"
     }
    ]
   }
  },
  "/number-registration/1/campaigns/{campaignId}/number-pool/detach":{
   "post":{
    "tags":[
     "platform",
     "numbers",
     "number-registration",
     "campaigns"
    ],
    "summary":"Detach Number Pool from Campaign",
    "description":"Detaches an existing number pool from the specified campaign. This operation is subject to validation: the campaign must have fewer than 50 assigned numbers at the time of detachment.",
    "operationId":"detach-number-pool",
    "parameters":[
     {
      "name":"campaignId",
      "in":"path",
      "description":"The ID of the desired campaign.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string",
       "format":"uuid",
       "description":"The ID of the desired campaign."
      }
     }
    ],
    "responses":{
     "204":{
      "description":"No Content"
     },
     "400":{
      "description":"Bad Request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException"
        },
        "examples":{
         "Bad request":{
          "summary":"Bad request",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Bad request"
            }
           }
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"Not Found",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException"
        },
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"NOT_FOUND",
             "text":"Not found"
            }
           }
          }
         }
        }
       }
      }
     },
     "429":{
      "$ref":"#/components/responses/ApiException429"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-throttling-info":[
     {
      "type":"time",
      "numberOfRequests":1,
      "numberOfTimeUnits":0,
      "timeUnit":"s"
     }
    ]
   }
  },
  "/number-registration/1/number-pools":{
   "get":{
    "tags":[
     "platform",
     "numbers",
     "number-registration",
     "number-pools"
    ],
    "summary":"Get Owned Number Pools",
    "description":"Returns a paginated list of number pools owned by the authenticated account.",
    "operationId":"get-owned-number-pools",
    "parameters":[
     {
      "name":"availability",
      "in":"query",
      "description":"Filters number pools to those that match the supplied availability.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.NumberPoolAvailability"
      }
     },
     {
      "name":"registrarRecordId",
      "in":"query",
      "description":"Filters number pools to those that match the supplied referenceId.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"string"
      }
     },
     {
      "name":"page",
      "in":"query",
      "description":"Results page you want to retrieve (0..N). The default value is 0.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"integer",
       "format":"int32"
      }
     },
     {
      "name":"size",
      "in":"query",
      "description":"Number of records per page (0..2000). The default value is 10. The maximum value is 1000.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"integer",
       "format":"int32"
      }
     }
    ],
    "responses":{
     "200":{
      "description":"OK",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.NumberPoolUsageApiPageResponse"
        },
        "examples":{
         "Example page of owned number pools":{
          "summary":"Example page of owned number pools",
          "description":"Example page of owned number pools",
          "value":{
           "results":[
            {
             "numberPoolId":"number-pool-identifier-1",
             "campaignId":"4d3601ed-c632-4979-ae22-43854ef4ffaf",
             "campaignName":"Example name"
            },
            {
             "numberPoolId":"number-pool-identifier-2"
            }
           ],
           "paging":{
            "page":0,
            "size":20,
            "totalPages":1,
            "totalResults":2
           }
          }
         }
        }
       }
      }
     },
     "400":{
      "description":"Bad Request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException"
        },
        "examples":{
         "Bad request":{
          "summary":"Bad request",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Bad request"
            }
           }
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "429":{
      "$ref":"#/components/responses/ApiException429"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-throttling-info":[
     {
      "type":"time",
      "numberOfRequests":10,
      "numberOfTimeUnits":0,
      "timeUnit":"s"
     }
    ]
   }
  },
  "/number-registration/1/documents":{
   "post":{
    "tags":[
     "platform",
     "numbers",
     "number-registration",
     "documents"
    ],
    "summary":"Upload Document",
    "description":"Uploads a document file to the system and returns the document metadata. The uploaded document can be used for 10DLC campaign registration purposes. Documents not attached to a campaign within 7 days will be automatically deleted. Supported file types: .bmp, .dib, .docx, .gif, .htm, .html, .jpeg, .jpg, .m2a, .m4a, .m4b, .m4p, .m4r, .m4v, .mp1, .mp2, .mp3, .mp4, .mpa, .oga, .ogg, .ogm, .ogv, .ogx, .odt, .pdf, .png, .raw, .rtf, .spx, .tif, .tiff, .txt, .wav, .webm, .xml, Maximum file size: 10MB.",
    "operationId":"upload-document-metadata",
    "requestBody":{
     "content":{
      "multipart/form-data":{
       "schema":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.UploadDocumentApiDoc"
       }
      }
     }
    },
    "responses":{
     "201":{
      "description":"Created",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.DocumentMetadata"
        },
        "examples":{
         "Document metadata":{
          "summary":"Document metadata",
          "description":"Document metadata",
          "value":{
           "documentId":"9904751a-9436-4bda-b98a-37b1f7179483",
           "documentName":"Example document.pdf",
           "contentType":"application/pdf",
           "contentLength":14956
          }
         }
        }
       }
      }
     },
     "400":{
      "description":"Bad Request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException"
        },
        "examples":{
         "Bad request":{
          "summary":"Bad request",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Bad request"
            }
           }
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ]
   }
  },
  "/number-registration/1/documents/{documentId}":{
   "get":{
    "tags":[
     "platform",
     "numbers",
     "number-registration",
     "documents"
    ],
    "summary":"Download Document",
    "description":"Downloads a document file by its unique identifier. Access to the document is restricted based on account ownership.",
    "operationId":"download-document-content",
    "parameters":[
     {
      "name":"documentId",
      "in":"path",
      "description":"Unique identifier for the document.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string",
       "format":"uuid",
       "description":"Unique identifier for the document."
      }
     }
    ],
    "responses":{
     "200":{
      "description":"OK",
      "headers":{
       "Content-Disposition":{
        "description":"File name.",
        "style":"simple",
        "explode":false,
        "schema":{
         "type":"string"
        }
       },
       "Content-Length":{
        "description":"File size.",
        "style":"simple",
        "explode":false,
        "schema":{
         "type":"integer"
        }
       },
       "Content-Type":{
        "description":"File type.",
        "style":"simple",
        "explode":false,
        "schema":{
         "type":"string"
        }
       }
      },
      "content":{
       "application/octet-stream":{
        "schema":{
         "type":"string",
         "format":"binary"
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"Not Found",
      "content":{
       "*/*":{
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"NOT_FOUND",
             "text":"Not found"
            }
           }
          }
         }
        }
       }
      }
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ]
   }
  },
  "/number-registration/1/automatic-review/campaigns/{campaignUuid}":{
   "post":{
    "tags":[
     "platform",
     "numbers",
     "number-registration",
     "ai-assistant"
    ],
    "summary":"Submit Existing Campaign for AI Review",
    "description":"Submits an existing campaign for automatic AI compliance review. Returns a request UUID that can be used to fetch the review results. Contact your account manager to learn more.",
    "operationId":"submit-existing-campaign-for-ai-review",
    "parameters":[
     {
      "name":"campaignUuid",
      "in":"path",
      "description":"The UUID assigned to the campaign when it was created or imported into the infobip platform. This identifier is returned during campaign creation.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string",
       "format":"uuid",
       "description":"The UUID assigned to the campaign when it was created or imported into the infobip platform. This identifier is returned during campaign creation.",
       "example":"4d3601ed-c632-4979-ae22-43854ef4ffaf"
      },
      "example":"4d3601ed-c632-4979-ae22-43854ef4ffaf"
     }
    ],
    "responses":{
     "202":{
      "description":"Accepted",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.ReviewSubmissionResponse"
        },
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "requestUuid":"3fa85f64-5717-4562-b3fc-2c963f66afa6"
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiError401"
     },
     "403":{
      "$ref":"#/components/responses/ApiError403"
     },
     "404":{
      "$ref":"#/components/responses/ApiError404"
     },
     "429":{
      "$ref":"#/components/responses/ApiError429"
     },
     "500":{
      "$ref":"#/components/responses/ApiError500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-throttling-info":[
     {
      "type":"time",
      "numberOfRequests":1,
      "numberOfTimeUnits":0,
      "timeUnit":"s"
     }
    ]
   }
  },
  "/number-registration/1/automatic-review":{
   "post":{
    "tags":[
     "platform",
     "numbers",
     "number-registration",
     "ai-assistant"
    ],
    "summary":"Submit Campaign Info for AI Review",
    "description":"Submits new campaign information for automatic AI compliance review. Returns a request UUID that can be used to fetch the review results. Contact your account manager to learn more.",
    "operationId":"submit-campaign-info-for-ai-review",
    "requestBody":{
     "content":{
      "application/json":{
       "schema":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignInfoReviewRequest"
       },
       "examples":{
        "10DLC AI Review Request":{
         "summary":"10DLC AI Review Request",
         "description":"10DLC AI Review Request",
         "value":{
          "reviewType":"TEN_DIGIT_LONG_CODE",
          "brandName":"Example Corp",
          "brandWebsite":"https://www.example.com",
          "brandSupportEmail":"support@example.com",
          "programDescription":"Send marketing messages and promotional offers to opted-in users who want to hear about new products and sales.",
          "messageExamples":[
           "Example Corp: Flash sale! 50% off all items today only. Shop now at https://example.com/sale Reply STOP to opt out"
          ],
          "customerCareEmail":"care@example.com",
          "termsAndConditionsUrl":"https://www.example.com/terms",
          "privacyPolicyUrl":"https://www.example.com/privacy",
          "optInMessage":"Welcome to Example Corp alerts! Msg&data rates may apply. Reply HELP for help, STOP to cancel.",
          "helpMessage":"Example Corp Help: contact support@example.com or call 1-800-555-0100. Msg&data rates may apply.",
          "optOutMessage":"You have been unsubscribed from Example Corp alerts. Text START to resubscribe.",
          "ctaWebsite":"https://www.example.com/opt-in",
          "ctas":[
           "Text JOIN to 12345 to subscribe",
           "Visit https://example.com/opt-in to sign up"
          ],
          "useCases":[
           "PROMOTIONAL_MARKETING"
          ],
          "ageGated":false,
          "directLending":false,
          "messageFlow":"Users opt-in via website, receive confirmation messages"
         }
        }
       }
      }
     },
     "required":true
    },
    "responses":{
     "202":{
      "description":"Accepted",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.ReviewSubmissionResponse"
        },
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "requestUuid":"3fa85f64-5717-4562-b3fc-2c963f66afa6"
          }
         }
        }
       }
      }
     },
     "400":{
      "$ref":"#/components/responses/ApiError400"
     },
     "401":{
      "$ref":"#/components/responses/ApiError401"
     },
     "403":{
      "$ref":"#/components/responses/ApiError403"
     },
     "429":{
      "$ref":"#/components/responses/ApiError429"
     },
     "500":{
      "$ref":"#/components/responses/ApiError500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-throttling-info":[
     {
      "type":"time",
      "numberOfRequests":1,
      "numberOfTimeUnits":0,
      "timeUnit":"s"
     }
    ]
   }
  },
  "/number-registration/1/automatic-review/{requestUuid}":{
   "get":{
    "tags":[
     "platform",
     "numbers",
     "number-registration",
     "ai-assistant"
    ],
    "summary":"Get AI Review Results",
    "description":"Retrieves the results of a campaign AI compliance review by its request UUID. Contact your account manager to learn more.",
    "operationId":"get-ai-review-results",
    "parameters":[
     {
      "name":"requestUuid",
      "in":"path",
      "description":"The UUID of the AI review request.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string",
       "format":"uuid",
       "description":"The UUID of the AI review request."
      }
     }
    ],
    "responses":{
     "200":{
      "description":"OK",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.ExternalAutomaticReviewResults"
        },
        "examples":{
         "Compliant":{
          "summary":"Compliant",
          "description":"Compliant",
          "value":{
           "reviewStatus":"COMPLIANT",
           "campaignErrors":[]
          }
         },
         "Non-Compliant":{
          "summary":"Non-Compliant",
          "description":"Non-Compliant",
          "value":{
           "reviewStatus":"NON_COMPLIANT",
           "campaignErrors":[
            {
             "code":"1001",
             "justification":"Brand name not found on website.",
             "description":"The brand name could not be verified on the provided website URL.",
             "recommendation":"Ensure the brand name is clearly displayed on the website."
            }
           ]
          }
         },
         "Processing":{
          "summary":"Processing",
          "description":"Processing",
          "value":{
           "reviewStatus":"PROCESSING",
           "campaignErrors":[]
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiError401"
     },
     "403":{
      "$ref":"#/components/responses/ApiError403"
     },
     "404":{
      "$ref":"#/components/responses/ApiError404"
     },
     "429":{
      "$ref":"#/components/responses/ApiError429"
     },
     "500":{
      "$ref":"#/components/responses/ApiError500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-throttling-info":[
     {
      "type":"time",
      "numberOfRequests":1,
      "numberOfTimeUnits":0,
      "timeUnit":"s"
     }
    ]
   }
  },
  "/number-registration/1/campaign-builder":{
   "post":{
    "tags":[
     "platform",
     "numbers",
     "number-registration",
     "ai-assistant"
    ],
    "summary":"Start Campaign Builder",
    "description":"Submits a request to build a campaign based on the provided brand and campaign information.\nReturns a request UUID that can be used to track the job status.",
    "operationId":"start-campaign-builder",
    "requestBody":{
     "content":{
      "application/json":{
       "schema":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderRequest"
       },
       "examples":{
        "Campaign Builder Request - 10DLC":{
         "summary":"Campaign Builder Request - 10DLC",
         "description":"Campaign Builder Request - 10DLC",
         "value":{
          "brandId":"3da2f37c-fe0f-441e-ba7e-c2b4d4990069",
          "campaignType":"TEN_DIGIT_LONG_CODE",
          "campaignIntent":"Campaign should send promotion messages on seasonal discounts for loyalty club members",
          "contactEmail":"support@example.com",
          "optInMethods":[
           "VERBAL"
          ],
          "campaignAttributes":[
           "DIRECT_LENDING"
          ]
         }
        },
        "Campaign Builder Request - Short code":{
         "summary":"Campaign Builder Request - Short code",
         "description":"Campaign Builder Request - Short code",
         "value":"{\n    \"brandId\": \"dce0dd3e-829f-4ebe-a747-c93757140a50\",\n    \"campaignType\": \"SHORT_CODE\",\n    \"campaignIntent\": \"Campaign should send promotion messages on seasonal discounts for loyalty club members\",\n    \"contactEmail\": \"support@example.com\",\n    \"contactPhone\": \"1234567890\"\n    \"optInMethods\": [\"VERBAL\", \"ONLINE\"]\n}"
        },
        "Campaign Builder Request - Toll free":{
         "summary":"Campaign Builder Request - Toll free",
         "description":"Campaign Builder Request - Toll free",
         "value":{
          "brandId":"c37008bc-2ebc-488b-ac64-aa7cc09f551b",
          "campaignType":"TOLL_FREE_NUMBER",
          "campaignIntent":"Campaign should send promotion messages on seasonal discounts for loyalty club members",
          "contactEmail":"support@example.com",
          "optInMethods":[
           "KEYWORD",
           "IVR"
          ]
         }
        }
       }
      }
     },
     "required":true
    },
    "responses":{
     "202":{
      "description":"Accepted",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderResponse"
        },
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "requestUuid":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"
          }
         }
        }
       }
      }
     },
     "400":{
      "$ref":"#/components/responses/ApiError400"
     },
     "401":{
      "$ref":"#/components/responses/ApiError401"
     },
     "403":{
      "$ref":"#/components/responses/ApiError403"
     },
     "429":{
      "$ref":"#/components/responses/ApiError429"
     },
     "500":{
      "$ref":"#/components/responses/ApiError500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-is-early-access":true,
    "x-throttling-info":[
     {
      "type":"time",
      "numberOfRequests":1,
      "numberOfTimeUnits":0,
      "timeUnit":"s"
     }
    ]
   }
  },
  "/number-registration/1/campaign-builder/{requestUuid}":{
   "get":{
    "tags":[
     "platform",
     "numbers",
     "number-registration",
     "ai-assistant"
    ],
    "summary":"Get Campaign Builder Results",
    "description":"Retrieves the results of a campaign builder by its request UUID.\nThe result structure varies based on the campaign type used when starting the builder.",
    "operationId":"get-campaign-builder-results",
    "parameters":[
     {
      "name":"requestUuid",
      "in":"path",
      "description":"The UUID of the campaign builder request.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string",
       "format":"uuid",
       "description":"The UUID of the campaign builder request."
      }
     }
    ],
    "responses":{
     "200":{
      "description":"OK",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderResult"
        },
        "examples":{
         "Processing":{
          "summary":"Processing",
          "description":"Processing",
          "value":{
           "status":"PROCESSING"
          }
         },
         "Completed - 10DLC":{
          "summary":"Completed - 10DLC",
          "description":"Completed - 10DLC",
          "value":{
           "status":"COMPLETED",
           "result":{
            "campaignType":"TEN_DIGIT_LONG_CODE",
            "useCase":"PROMOTIONAL_MARKETING",
            "messageFlow":{
             "optInMessage":"Welcome to ExampleCorp Loyalty Club! Msg & data rates may apply. Get 2-4 msgs/month. Reply HELP for help, STOP to cancel. Enjoy exclusive seasonal discounts!",
             "exampleMessage1":"ExampleCorp: Winter Sale is here! Enjoy up to 50% off for loyalty members. Shop now at https://www.example.com. Reply HELP for help, STOP to cancel.",
             "exampleMessage2":"ExampleCorp: Exclusive Spring Offer! Save 30% on your next purchase. Visit https://www.example.com to shop. Reply HELP for help, STOP to cancel.",
             "helpMessage":"ExampleCorp: For assistance, email support@example.com. We're here to help!",
             "optOutMessage":"You have now unsubscribed from ExampleCorp promotional messages and will receive no further messages."
            },
            "optInMethods":[
             {
              "optInMethod":"VERBAL",
              "description":"By providing your mobile number verbally during a phone call or in person, you agree to receive promotional messages from ExampleCorp about seasonal discounts for loyalty club members. Message and data rates may apply. Message frequency may vary. For terms and conditions, visit <TERMS_AND_CONDITIONS_URL>. For privacy policy, visit <PRIVACY_POLICY_URL>. Reply STOP to cancel.",
              "disclaimer":"This is an informational example only. You must update it to match your actual opt-in flow.",
              "rules":[
               "Clear verbal agreement must be obtained before sending messages.",
               "Users must be informed about what messages will be sent.",
               "Users must be informed about message frequency and potential charges.",
               "Users must be informed how to access the Terms and Privacy Policy.",
               "Consent must be documented (timestamp, agent name, and user acknowledgment).",
               "A confirmation SMS must be sent shortly after consent is obtained."
              ],
              "restrictions":[
               "Verbal consent is not allowed for promotional or marketing campaigns."
              ]
             }
            ],
            "termsConditionsSample":"TERMS & CONDITIONS sample content for PROMOTIONAL_MARKETING 10DLC program",
            "privacyPolicySample":"PRIVACY POLICY sample content for PROMOTIONAL_MARKETING 10DLC program"
           }
          }
         },
         "Completed - Short Code":{
          "summary":"Completed - Short Code",
          "description":"Completed - Short Code",
          "value":{
           "status":"COMPLETED",
           "result":{
            "campaignType":"SHORT_CODE",
            "useCase":"PROMOTIONAL_MARKETING",
            "messageFlow":{
             "optInMessage":"Welcome to ExampleCorp! Msg & data rates may apply. Receive 2-4 msgs/month on seasonal discounts for loyalty club members. Reply HELP for help, STOP to cancel.",
             "exampleMessage1":"ExampleCorp Loyalty Club: Enjoy 20% off on all winter items! Shop now at https://www.example.com. Reply HELP for help, STOP to cancel.",
             "exampleMessage2":"ExampleCorp Exclusive: Spring Sale is here! Get up to 30% off on selected items. Visit https://www.example.com to shop. Reply HELP for help, STOP to cancel.",
             "helpMessage":"ExampleCorp Support: For assistance, email support@example.com. Reply STOP to cancel.",
             "optOutMessage":"You have now unsubscribed from ExampleCorp promotional messages and will receive no further messages."
            },
            "cta":[
             {
              "promotionMethod":"PRINT",
              "description":"Text <KEYWORD> to <SHORT_CODE> to get seasonal discount promotions for loyalty club members from ExampleCorp. You'll receive promotional offers and marketing messages. Msg & Data rates may apply. Frequency varies. Reply STOP to unsubscribe. Reply HELP or email us at support@example.com for help. Terms & Conditions: <TERMS_AND_CONDITIONS_URL> Privacy Policy: <PRIVACY_POLICY_URL>"
             }
            ],
            "optInMethods":[
             {
              "optInMethod":"VERBAL",
              "description":"By providing your mobile number verbally during a phone call or in person, you agree to receive promotional messages from ExampleCorp about seasonal discounts for loyalty club members. Message and data rates may apply. Message frequency may vary. Terms and Conditions: <TERMS_AND_CONDITIONS_URL>. Privacy Policy: <PRIVACY_POLICY_URL>. Reply STOP to cancel.",
              "disclaimer":"This is an informational example only. You must update it to match your actual opt-in flow.",
              "rules":[
               "Clear verbal agreement must be obtained before sending messages.",
               "Users must be informed about what messages will be sent.",
               "Users must be informed about message frequency and potential charges.",
               "Users must be informed how to access the Terms and Privacy Policy.",
               "Consent must be documented (timestamp, agent name, and user acknowledgment).",
               "A confirmation SMS must be sent shortly after consent is obtained."
              ],
              "restrictions":[
               "Verbal consent is not allowed for promotional or marketing campaigns."
              ]
             }
            ],
            "termsConditionsSample":"TERMS & CONDITIONS sample content for PROMOTIONAL_MARKETING short code program",
            "privacyPolicySample":"PRIVACY POLICY sample content for PROMOTIONAL_MARKETING short code program"
           }
          }
         },
         "Completed - Toll Free":{
          "summary":"Completed - Toll Free",
          "description":"Completed - Toll Free",
          "value":{
           "status":"COMPLETED",
           "result":{
            "campaignType":"TOLL_FREE_NUMBER",
            "useCase":"GENERAL_MARKETING",
            "messageFlow":{
             "exampleMessage":"ExampleCorp Loyalty Club: Seasonal discounts are now available for members. Visit <URL_PROVIDED_BY_CLIENT> for details. Reply HELP for assistance or STOP to opt out."
            },
            "optInMethods":[
             {
              "optInMethod":"IVR",
              "description":"Users opt in by calling a designated phone number and following the voice prompts to confirm their subscription to promotional messages. Reply STOP to cancel.",
              "disclaimer":"This is an informational example only. You must update it to match your actual opt-in flow.",
              "rules":[
               "The IVR flow must clearly state what the user is consenting to and what messages will be sent.",
               "Message frequency and potential charges must be disclosed during the IVR interaction.",
               "Consent must be captured via an explicit action (e.g., 'Press 1 to confirm').",
               "A confirmation SMS must be sent immediately after IVR consent."
              ]
             },
             {
              "optInMethod":"KEYWORD",
              "description":"Users opt in by sending a specific keyword via SMS to a designated number, agreeing to receive promotional messages. Reply STOP to cancel.",
              "disclaimer":"This is an informational example only. You must update it to match your actual opt-in flow.",
              "rules":[
               "Users must be clearly shown the keyword and messaging number before opting in.(e.g., shown to users as “Text JOIN to 12345” on a website, poster, or advertisement)",
               "An immediate confirmation message must be sent after opt-in.",
               "The confirmation message must include message frequency (or 'may vary').",
               "The confirmation message must include STOP and HELP instructions.",
               "The confirmation message must provide access to the Terms and Privacy Policy.",
               "The confirmation message should be under 160 characters when possible."
              ]
             }
            ],
            "channelNote":"TFN campaigns are reviewed based on how accurately the opt-in description reflects the real user experience. Not all disclosures apply to every TFN opt‑in method (e.g., verbal or IVR consent). Include disclosures only where applicable and do not invent or assume details that do not exist in your actual flow.",
            "termsConditionsSample":"TERMS & CONDITIONS sample content for GENERAL_MARKETING toll free program",
            "privacyPolicySample":"PRIVACY POLICY sample content for GENERAL_MARKETING toll free program"
           }
          }
         },
         "Failed":{
          "summary":"Failed",
          "description":"Failed",
          "value":{
           "status":"FAILED",
           "error":"Campaign builder processing failed. Please try again."
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiError401"
     },
     "403":{
      "$ref":"#/components/responses/ApiError403"
     },
     "404":{
      "$ref":"#/components/responses/ApiError404"
     },
     "429":{
      "$ref":"#/components/responses/ApiError429"
     },
     "500":{
      "$ref":"#/components/responses/ApiError500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "numbers:manage"
    ],
    "x-is-early-access":true,
    "x-throttling-info":[
     {
      "type":"time",
      "numberOfRequests":1,
      "numberOfTimeUnits":0,
      "timeUnit":"s"
     }
    ]
   }
  }
 },
 "components":{
  "schemas":{
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Address":{
    "type":"object",
    "description":"The address of the brand.",
    "properties":{
     "city":{
      "type":"string",
      "description":"The city in which the brand is located.",
      "maxLength":50,
      "minLength":1
     },
     "state":{
      "type":"string",
      "description":"State or province. For the United States, please use 2 character codes. E.g. 'CA' for California.",
      "maxLength":20,
      "minLength":1
     },
     "street":{
      "type":"string",
      "description":"The street address for the brand.",
      "maxLength":100,
      "minLength":1
     },
     "zipCode":{
      "type":"string",
      "description":"The zipcode in which the brand is located.",
      "maxLength":10,
      "minLength":1
     }
    },
    "required":[
     "city",
     "street",
     "zipCode"
    ],
    "title":"Address"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.AegisVetImportRequest":{
    "type":"object",
    "allOf":[
     {
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.VetImportRequest"
     },
     {
      "type":"object",
      "properties":{
       "externalVetId":{
        "type":"string",
        "description":"Aegis external vetting ID"
       },
       "vettingToken":{
        "type":"string",
        "description":"Aegis vetting token"
       }
      }
     }
    ],
    "required":[
     "externalVetId",
     "type",
     "vettingToken"
    ],
    "title":"AegisVetImportRequest"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.AppealData":{
    "type":"object",
    "properties":{
     "appealReason":{
      "type":"string",
      "description":"The reason for the appeal."
     },
     "appealDate":{
      "type":"string",
      "format":"date-time",
      "description":"The time of the appeal."
     }
    },
    "title":"AppealData"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.AppealDocument":{
    "type":"object",
    "description":"A document attached to a brand identity appeal.",
    "properties":{
     "documentId":{
      "type":"string",
      "format":"uuid",
      "description":"ID of the previously uploaded document."
     },
     "documentType":{
      "type":"string",
      "description":"Classification of the document type. Defaults to OTHER if not specified.",
      "enum":[
       "IRS_CP575",
       "OTHER"
      ]
     }
    },
    "required":[
     "documentId"
    ],
    "title":"AppealDocument"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.AppealRequest":{
    "type":"object",
    "properties":{
     "reason":{
      "type":"string",
      "description":"The reason for the appeal.",
      "maxLength":2048,
      "minLength":10
     }
    },
    "required":[
     "reason"
    ],
    "title":"AppealRequest"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.AttachNumberPoolRequest":{
    "type":"object",
    "properties":{
     "numberPoolId":{
      "type":"string",
      "description":"Unique identifier of the number pool to be used for this campaign. If not provided, a default number pool will be automatically assigned. ",
      "maxLength":100,
      "minLength":1
     },
     "reason":{
      "type":"string",
      "description":"A concise explanation of why this campaign requires a dedicated number pool. Include operational or regulatory justifications, such as high-volume messaging, the use of multiple sender identities, or throughput guarantees.",
      "maxLength":1000,
      "minLength":1
     }
    },
    "title":"AttachNumberPoolRequest"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Brand":{
    "type":"object",
    "discriminator":{
     "propertyName":"type",
     "mapping":{
      "TENDLC_NON_PROFIT":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.NonProfitBrand",
      "TENDLC_PRIVATE_COMPANY":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PrivateCompanyBrand",
      "TENDLC_PUBLIC_COMPANY":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PublicCompanyBrand",
      "TENDLC_GOVERNMENT":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.GovernmentBrand",
      "TOLL_FREE_NUMBER":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TollFreeBrand"
     }
    },
    "properties":{
     "id":{
      "type":"string",
      "format":"uuid",
      "description":"The identifier for the brand.",
      "readOnly":true
     },
     "applicationId":{
      "type":"string",
      "description":"CPaaS X property identifying an application, a use case or an environment on your system. It should only be set if you are using CPaaS X Applications with your traffic."
     },
     "entityId":{
      "type":"string",
      "description":"CPaaS X property identifying an unique actor on your system. Should only be set if you are using CPaaS X Applications with your traffic."
     },
     "name":{
      "type":"string",
      "description":"The customer defined name of brand.",
      "maxLength":100,
      "minLength":1
     },
     "stage":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandStage"
     },
     "website":{
      "type":"string",
      "description":"The website for the brand.",
      "maxLength":100,
      "minLength":11
     },
     "createdDate":{
      "type":"string",
      "format":"date-time",
      "description":"The date and time when the brand was created.",
      "readOnly":true
     },
     "lastModifiedDate":{
      "type":"string",
      "format":"date-time",
      "description":"The date and time when the brand was last modified.",
      "readOnly":true
     },
     "type":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandType"
     }
    },
    "required":[
     "name",
     "type",
     "website"
    ],
    "title":"Brand"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandAppealPreview":{
    "type":"object",
    "description":"Summary information about a single brand appeal.",
    "properties":{
     "appealId":{
      "type":"string",
      "format":"uuid",
      "description":"Unique identifier of the appeal."
     },
     "status":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandAppealStatus"
     },
     "submittedAt":{
      "type":"string",
      "format":"date-time",
      "description":"Timestamp when the appeal was submitted."
     },
     "rejectionReason":{
      "type":"string",
      "description":"Reason for rejection. Present only when the appeal status is REJECTED."
     }
    },
    "title":"BrandAppealPreview"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandAppealRequest":{
    "type":"object",
    "description":"Request body for submitting a brand appeal.",
    "properties":{
     "explanation":{
      "type":"string",
      "description":"Optional explanation supporting the appeal. Maximum 1024 characters.",
      "maxLength":1024,
      "minLength":0
     },
     "documents":{
      "type":"array",
      "description":"List of supporting documents attached to the appeal.",
      "items":{
       "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.AppealDocument"
      },
      "maxItems":10,
      "minItems":1
     }
    },
    "required":[
     "documents"
    ],
    "title":"BrandAppealRequest"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandAppealResponse":{
    "type":"object",
    "description":"Response returned after successfully submitting a brand identity appeal.",
    "properties":{
     "appealId":{
      "type":"string",
      "format":"uuid",
      "description":"Unique identifier assigned to the submitted appeal."
     }
    },
    "title":"BrandAppealResponse"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandAppealStatus":{
    "type":"string",
    "description":"Current status of the appeal.",
    "enum":[
     "PENDING",
     "COMPLETED",
     "REJECTED"
    ],
    "title":"BrandAppealStatus"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandAppealsResponse":{
    "type":"object",
    "description":"Response containing the list of all appeals submitted for a brand.",
    "properties":{
     "appeals":{
      "type":"array",
      "description":"List of appeals submitted for the brand, ordered from most recent to oldest.",
      "items":{
       "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandAppealPreview"
      }
     }
    },
    "title":"BrandAppealsResponse"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandAuthUpdateWebhookContent":{
    "type":"object",
    "description":"Event content.",
    "properties":{
     "brandId":{
      "type":"string",
      "format":"uuid",
      "description":"The ID of the brand.",
      "example":"0579c038-55f2-11ee-9458-325096b39f47"
     },
     "brandAuthUpdate":{
      "type":"string",
      "description":"The new brand auth 2FA update.",
      "enum":[
       "BRAND_EMAIL_2FA_SEND",
       "BRAND_EMAIL_2FA_COMPLETE"
      ],
      "example":"BRAND_EMAIL_2FA_SEND"
     }
    },
    "title":"BrandAuthUpdateWebhookContent"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandAuthUpdateWebhookMessage":{
    "type":"object",
    "description":"Incoming events",
    "properties":{
     "event":{
      "type":"string",
      "description":"The name of the event.",
      "enum":[
       "BRAND_AUTH_UPDATE"
      ],
      "example":"BRAND_AUTH_UPDATE"
     },
     "receivedAt":{
      "type":"string",
      "format":"date-time",
      "description":"Date and time when Infobip received the event."
     },
     "content":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandAuthUpdateWebhookContent"
     },
     "platform":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandWebhookPlatform"
     }
    },
    "title":"BrandAuthUpdateWebhookMessage"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandAuthUpdateWebhookResponse":{
    "type":"object",
    "properties":{
     "results":{
      "type":"array",
      "description":"Incoming events",
      "items":{
       "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandAuthUpdateWebhookMessage"
      }
     }
    },
    "title":"BrandAuthUpdateWebhookResponse"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandPreview":{
    "type":"object",
    "description":"The preview of brand details to use with the campaign. This property is read-only and ignored in POST/PUT calls.",
    "properties":{
     "brandId":{
      "type":"string",
      "description":"The ID of the brand."
     },
     "brandName":{
      "type":"string",
      "description":"The name of the brand."
     },
     "website":{
      "type":"string",
      "description":"The website for the brand."
     }
    },
    "readOnly":true,
    "title":"BrandPreview"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandRegistrar":{
    "type":"string",
    "description":"The name of the registrar with which the brand has been registered.",
    "enum":[
     "CAMPAIGN_REGISTRY"
    ],
    "title":"BrandRegistrar"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandRegistrationStatusPublic":{
    "type":"string",
    "description":"The state of the registration for this brand.",
    "enum":[
     "ACTIVE",
     "PENDING",
     "PENDING_2FA",
     "PENDING_APPEAL",
     "REJECTED"
    ],
    "example":"REJECTED",
    "title":"BrandRegistrationStatusPublic"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandRegistrationWebhookContent":{
    "type":"object",
    "description":"Event content.",
    "properties":{
     "brandId":{
      "type":"string",
      "format":"uuid",
      "description":"The ID of the brand.",
      "example":"0579c038-55f2-11ee-9458-325096b39f47"
     },
     "brandStatus":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.WebhookBrandRegistrationStatus"
     },
     "rejectionReasons":{
      "type":"array",
      "description":"The rejection reasons. This field is present only when brand registration status is 'FAILURE'.",
      "example":[
       "Tax id does not match with the company name or business type."
      ],
      "items":{
       "type":"string",
       "description":"The rejection reasons. This field is present only when brand registration status is 'FAILURE'.",
       "example":"[\"Tax id does not match with the company name or business type.\"]"
      }
     }
    },
    "title":"BrandRegistrationWebhookContent"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandRegistrationWebhookMessage":{
    "type":"object",
    "description":"Incoming events",
    "properties":{
     "event":{
      "type":"string",
      "description":"The name of the event.",
      "enum":[
       "BRAND_STATUS_UPDATE"
      ],
      "example":"BRAND_STATUS_UPDATE"
     },
     "receivedAt":{
      "type":"string",
      "format":"date-time",
      "description":"Date and time when Infobip received the event."
     },
     "content":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandRegistrationWebhookContent"
     },
     "platform":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandWebhookPlatform"
     }
    },
    "title":"BrandRegistrationWebhookMessage"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandRegistrationWebhookResponse":{
    "type":"object",
    "properties":{
     "results":{
      "type":"array",
      "description":"Incoming events",
      "items":{
       "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandRegistrationWebhookMessage"
      }
     }
    },
    "title":"BrandRegistrationWebhookResponse"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandStage":{
    "type":"string",
    "enum":[
     "DRAFT",
     "SUBMITTED"
    ],
    "title":"BrandStage"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandStatus":{
    "type":"object",
    "properties":{
     "registrar":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandRegistrar"
     },
     "state":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandRegistrationStatusPublic"
     },
     "brandIdentityStatus":{
      "type":"string",
      "description":"The status of the brand as determined by the registrar.",
      "enum":[
       "SELF_DECLARED",
       "UNVERIFIED",
       "VERIFIED",
       "VETTED_VERIFIED"
      ],
      "example":"UNVERIFIED"
     },
     "brandAuthenticationStatus":{
      "type":"string",
      "description":"The status of brand authentication applicable for TENDLC_PUBLIC_COMPANY brand type.",
      "enum":[
       "PENDING",
       "ACTIVE",
       "FAILED",
       "EXPIRED"
      ],
      "example":"PENDING"
     },
     "rejectionReason":{
      "type":"string",
      "description":"The reason for brand registration rejection.",
      "example":"Invalid country code."
     }
    },
    "title":"BrandStatus"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandType":{
    "type":"string",
    "description":"The type of brand.",
    "enum":[
     "TENDLC_NON_PROFIT",
     "TENDLC_PRIVATE_COMPANY",
     "TENDLC_PUBLIC_COMPANY",
     "TENDLC_GOVERNMENT"
    ],
    "title":"BrandType"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandVet":{
    "type":"object",
    "description":"The list of the results for this page.",
    "properties":{
     "vetId":{
      "type":"string",
      "format":"uuid",
      "description":"The ID of the vet record.",
      "readOnly":true
     },
     "brandId":{
      "type":"string",
      "format":"uuid",
      "description":"The ID of the brand the vet belongs to.",
      "readOnly":true
     },
     "score":{
      "type":"integer",
      "format":"int32",
      "description":"The score the brand received after being vetted.",
      "readOnly":true
     },
     "vettedDate":{
      "type":"string",
      "format":"date-time",
      "description":"The date the vet was completed.",
      "readOnly":true
     },
     "enhancedVettedDate":{
      "type":"string",
      "format":"date-time",
      "description":"The date the vet was completed if it was an enhanced vet or if it was converted to enhanced from a standard vet.",
      "readOnly":true
     },
     "status":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandVetStatus"
     },
     "type":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.VettingType"
     },
     "imported":{
      "type":"boolean",
      "description":"Showing is brand vet imported.",
      "readOnly":true
     },
     "importedVetProvider":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.VettingProvider"
     }
    },
    "required":[
     "type"
    ],
    "title":"BrandVet"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandVetStatus":{
    "type":"string",
    "description":"The status of vet.",
    "enum":[
     "PENDING",
     "SUCCESS",
     "FAILURE"
    ],
    "title":"BrandVetStatus"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandVetStatusWebhookContent":{
    "type":"object",
    "description":"Event content.",
    "properties":{
     "vetId":{
      "type":"string",
      "format":"uuid",
      "description":"The ID of the brand vet.",
      "example":"20ef4b12-55f2-11ee-bfc2-325096b39f47"
     },
     "brandId":{
      "type":"string",
      "format":"uuid",
      "description":"The ID of the brand.",
      "example":"0579c038-55f2-11ee-9458-325096b39f47"
     },
     "vettingScore":{
      "type":"integer",
      "format":"int32",
      "description":"The vetting score of a brand vet. This can be empty if score isn't present.",
      "example":80
     },
     "brandVettingStatus":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.WebhookBrandVetStatus"
     },
     "vetType":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.WebhookBrandVettingType"
     }
    },
    "title":"BrandVetStatusWebhookContent"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandVetStatusWebhookMessage":{
    "type":"object",
    "description":"Incoming events",
    "properties":{
     "event":{
      "type":"string",
      "description":"The name of the event.",
      "enum":[
       "BRAND_VET_UPDATE"
      ],
      "example":"BRAND_VET_UPDATE"
     },
     "receivedAt":{
      "type":"string",
      "format":"date-time",
      "description":"Date and time when Infobip received the event."
     },
     "content":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandVetStatusWebhookContent"
     },
     "platform":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandWebhookPlatform"
     }
    },
    "title":"BrandVetStatusWebhookMessage"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandVetStatusWebhookResponse":{
    "type":"object",
    "properties":{
     "results":{
      "type":"array",
      "description":"Incoming events",
      "items":{
       "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandVetStatusWebhookMessage"
      }
     }
    },
    "title":"BrandVetStatusWebhookResponse"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandWebhookPlatform":{
    "type":"object",
    "description":"Platform properties.",
    "properties":{
     "applicationId":{
      "type":"string",
      "description":"Brand application id.",
      "example":"application-id"
     },
     "entityId":{
      "type":"string",
      "description":"Brand entity id.",
      "example":"entity-id"
     }
    },
    "title":"BrandWebhookPlatform"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BusinessIdentifier":{
    "type":"object",
    "description":"An alternative business identifier for the brand.",
    "discriminator":{
     "propertyName":"type",
     "mapping":{
      "DUNS":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.DataUniversalNumberingSystemNumber",
      "GIIN":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.GlobalIntermediaryIdentificationNumber",
      "LEI":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.LegalEntityIdentifier"
     }
    },
    "properties":{
     "id":{
      "type":"string"
     },
     "type":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BusinessIdentifierType"
     }
    },
    "title":"BusinessIdentifier"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BusinessIdentifierType":{
    "type":"string",
    "enum":[
     "DUNS",
     "GIIN",
     "LEI"
    ],
    "title":"BusinessIdentifierType"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BusinessRegistrationType":{
    "type":"string",
    "description":"Type of tax identification number provided. Value depend on selected taxId issuing country. For US it can be only EIN.\nNot required for sole proprietor brands.",
    "enum":[
     "EIN",
     "CBN",
     "NEQ",
     "PROVINCIAL_NUMBER",
     "CRN",
     "VAT",
     "ACN",
     "ABN",
     "BRN",
     "SIREN",
     "SIRET",
     "NZBN",
     "UST_IDNR",
     "CIF",
     "NIF",
     "CNPJ",
     "UID",
     "OTHER"
    ],
    "title":"BusinessRegistrationType"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Campaign":{
    "type":"object",
    "discriminator":{
     "propertyName":"type",
     "mapping":{
      "TEN_DIGIT_LONG_CODE":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TenDlcCampaign",
      "EXTERNAL_TEN_DIGIT_LONG_CODE":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.ExternalTenDlcCampaign",
      "TOLL_FREE_NUMBER":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TollFreeCampaign"
     }
    },
    "properties":{
     "id":{
      "type":"string",
      "format":"uuid",
      "description":"The identifier for the campaign.",
      "readOnly":true
     },
     "referenceId":{
      "type":"string",
      "description":"Unique user defined ID for the campaign. While not required, it is recommended to supply a referenceId as the uniqueness constraint will help ensure a campaign is not accidentally created multiple times. Subsequent create requests with the same referenceId will be rejected with an error.",
      "maxLength":50,
      "minLength":0
     },
     "applicationId":{
      "type":"string",
      "description":"CPaaS X property identifying an application, a use case or an environment on your system. It should only be set if you are using CPaaS X Applications with your traffic."
     },
     "entityId":{
      "type":"string",
      "description":"CPaaS X property identifying an unique actor on your system. Should only be set if you are using CPaaS X Applications with your traffic."
     },
     "name":{
      "type":"string",
      "description":"The name of the campaign.",
      "maxLength":30,
      "minLength":1,
      "pattern":"[A-Za-z0-9_ ]*"
     },
     "createdDate":{
      "type":"string",
      "format":"date-time",
      "description":"The date and time when the campaign was created.",
      "readOnly":true
     },
     "lastModifiedDate":{
      "type":"string",
      "format":"date-time",
      "description":"The date and time when the campaign was last modified.",
      "readOnly":true
     },
     "stage":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignStage"
     },
     "priority":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PriorityInfo"
     },
     "campaignFeedback":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignFeedback"
     },
     "type":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignType"
     }
    },
    "required":[
     "name"
    ],
    "title":"Campaign"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignAiBuilderWebhookContent":{
    "type":"object",
    "description":"Event content.",
    "properties":{
     "aiCampaignBuilderRequestUuid":{
      "type":"string",
      "format":"uuid",
      "description":"Unique identifier of the AI campaign builder request, matching the requestUuid returned when the campaign builder was started."
     }
    },
    "title":"CampaignAiBuilderWebhookContent"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignAiBuilderWebhookMessage":{
    "type":"object",
    "description":"Incoming events",
    "properties":{
     "event":{
      "type":"string",
      "description":"The name of the event.",
      "enum":[
       "AI_CAMPAIGN_BUILDER"
      ],
      "example":"AI_CAMPAIGN_BUILDER"
     },
     "receivedAt":{
      "type":"string",
      "format":"date-time",
      "description":"Date and time when Infobip received the event."
     },
     "content":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignAiBuilderWebhookContent"
     },
     "platform":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignWebhookPlatform"
     }
    },
    "title":"CampaignAiBuilderWebhookMessage"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignAiBuilderWebhookResponse":{
    "type":"object",
    "properties":{
     "results":{
      "type":"array",
      "description":"Incoming events",
      "items":{
       "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignAiBuilderWebhookMessage"
      }
     }
    },
    "title":"CampaignAiBuilderWebhookResponse"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignAiFeedbackWebhookContent":{
    "type":"object",
    "description":"Event content.",
    "properties":{
     "aiCampaignFeedbackRequestUuid":{
      "type":"string",
      "format":"uuid",
      "description":"Unique identifier of the AI review request, matching the requestUuid returned when the campaign was submitted for AI review."
     }
    },
    "title":"CampaignAiFeedbackWebhookContent"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignAiFeedbackWebhookMessage":{
    "type":"object",
    "description":"Incoming events",
    "properties":{
     "event":{
      "type":"string",
      "description":"The name of the event.",
      "enum":[
       "AI_CAMPAIGN_FEEDBACK"
      ],
      "example":"AI_CAMPAIGN_FEEDBACK"
     },
     "receivedAt":{
      "type":"string",
      "format":"date-time",
      "description":"Date and time when Infobip received the event."
     },
     "content":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignAiFeedbackWebhookContent"
     },
     "platform":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignWebhookPlatform"
     }
    },
    "title":"CampaignAiFeedbackWebhookMessage"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignAiFeedbackWebhookResponse":{
    "type":"object",
    "properties":{
     "results":{
      "type":"array",
      "description":"Incoming events",
      "items":{
       "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignAiFeedbackWebhookMessage"
      }
     }
    },
    "title":"CampaignAiFeedbackWebhookResponse"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderCampaignAttributes":{
    "type":"string",
    "description":"Campaign attributes that indicate special content characteristics",
    "enum":[
     "AGE_GATED",
     "DIRECT_LENDING"
    ],
    "title":"CampaignBuilderCampaignAttributes"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderOptInMethod":{
    "type":"string",
    "description":"Method used to obtain consumer opt-in consent for messaging",
    "enum":[
     "VERBAL",
     "ONLINE",
     "KEYWORD",
     "IVR"
    ],
    "title":"CampaignBuilderOptInMethod"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderRequest":{
    "type":"object",
    "description":"Request to start building campaign using AI assistant.",
    "discriminator":{
     "propertyName":"campaignType",
     "mapping":{
      "TEN_DIGIT_LONG_CODE":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TenDlcCampaignBuilderRequest",
      "SHORT_CODE":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.ShortCodeCampaignBuilderRequest",
      "TOLL_FREE_NUMBER":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TollFreeCampaignBuilderRequest"
     }
    },
    "oneOf":[
     {
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TenDlcCampaignBuilderRequest"
     },
     {
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.ShortCodeCampaignBuilderRequest"
     },
     {
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TollFreeCampaignBuilderRequest"
     }
    ],
    "properties":{
     "brandId":{
      "type":"string",
      "format":"uuid",
      "description":"Brand ID."
     },
     "campaignType":{
      "type":"string",
      "description":"Campaign type.",
      "enum":[
       "TEN_DIGIT_LONG_CODE",
       "SHORT_CODE",
       "TOLL_FREE_NUMBER"
      ]
     },
     "campaignIntent":{
      "type":"string",
      "description":"Description of the campaign's purpose and messaging use case. This is the primary input that drives the generated campaign configuration, so it should be specific enough to convey the type of messages being sent and target audience, but concise (1-2 sentences)."
     },
     "contactEmail":{
      "type":"string",
      "format":"email",
      "description":"Campaign contact email."
     },
     "optInMethods":{
      "type":"array",
      "description":"Campaign opt-in methods.",
      "items":{
       "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderOptInMethod"
      },
      "uniqueItems":true
     }
    },
    "required":[
     "brandId",
     "campaignIntent",
     "campaignType",
     "contactEmail",
     "optInMethods"
    ],
    "title":"CampaignBuilderRequest"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderResponse":{
    "type":"object",
    "description":"Response containing the request UUID for tracking the started campaign builder",
    "properties":{
     "requestUuid":{
      "type":"string",
      "format":"uuid",
      "description":"Unique identifier for this campaign builder."
     }
    },
    "title":"CampaignBuilderResponse"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderResult":{
    "type":"object",
    "description":"Response containing the campaign builder job status and result.",
    "properties":{
     "status":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderResultStatus"
     },
     "result":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderResultData"
     },
     "error":{
      "type":"string",
      "description":"Error message. Present only when status is FAILED."
     }
    },
    "title":"CampaignBuilderResult"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderResultCta":{
    "type":"object",
    "description":"Call-to-action suggestion generated by the campaign builder",
    "properties":{
     "promotionMethod":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PromotionMethodType"
     },
     "description":{
      "type":"string",
      "description":"Description of the call-to-action"
     }
    },
    "title":"CampaignBuilderResultCta"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderResultData":{
    "type":"object",
    "description":"Campaign builder result data. The structure varies based on the campaign type.",
    "discriminator":{
     "propertyName":"campaignType",
     "mapping":{
      "TEN_DIGIT_LONG_CODE":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TenDlcCampaignBuilderResultData",
      "SHORT_CODE":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.ShortCodeCampaignBuilderResultData",
      "TOLL_FREE_NUMBER":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TollFreeCampaignBuilderResultData"
     }
    },
    "oneOf":[
     {
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TenDlcCampaignBuilderResultData"
     },
     {
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.ShortCodeCampaignBuilderResultData"
     },
     {
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TollFreeCampaignBuilderResultData"
     }
    ],
    "properties":{
     "campaignType":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignType"
     },
     "optInMethods":{
      "type":"array",
      "description":"Opt-in configuration.",
      "items":{
       "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderResultOptIn"
      }
     },
     "termsConditionsSample":{
      "type":"string",
      "description":"Terms and conditions content sample."
     },
     "privacyPolicySample":{
      "type":"string",
      "description":"Privacy policy content sample."
     }
    },
    "title":"CampaignBuilderResultData"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderResultOptIn":{
    "type":"object",
    "description":"Opt-in suggestion generated by the campaign builder.",
    "properties":{
     "optInMethod":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderOptInMethod"
     },
     "description":{
      "type":"string",
      "description":"Description of the opt-in suggestion."
     },
     "disclaimer":{
      "type":"string",
      "description":"Disclaimer text for the opt-in method."
     },
     "rules":{
      "type":"array",
      "description":"Opt-in rules for the opt-in method.",
      "items":{
       "type":"string",
       "description":"Opt-in rules for the opt-in method."
      }
     },
     "restrictions":{
      "type":"array",
      "description":"Opt-in restrictions for the opt-in method. Only present for VERBAL opt-in method.",
      "items":{
       "type":"string",
       "description":"Opt-in restrictions for the opt-in method. Only present for VERBAL opt-in method."
      }
     }
    },
    "title":"CampaignBuilderResultOptIn"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderResultStatus":{
    "type":"string",
    "description":"Current status of the campaign builder job.",
    "enum":[
     "PROCESSING",
     "COMPLETED",
     "FAILED"
    ],
    "title":"CampaignBuilderResultStatus"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignFeedback":{
    "type":"object",
    "description":"Offers additional information regarding the campaign, includes rejection reason and time.",
    "properties":{
     "rejectionReasons":{
      "type":"array",
      "description":"The reasons for the rejection.",
      "items":{
       "type":"string",
       "description":"The reasons for the rejection."
      }
     },
     "rejectionDetails":{
      "type":"array",
      "description":"Rejection reasons details.",
      "items":{
       "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.RejectionReason"
      }
     },
     "rejectionDate":{
      "type":"string",
      "format":"date-time",
      "description":"The time of the rejection."
     }
    },
    "readOnly":true,
    "title":"CampaignFeedback"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignInfoReviewRequest":{
    "type":"object",
    "description":"Request to submit a new campaign for AI compliance review",
    "discriminator":{
     "propertyName":"reviewType",
     "mapping":{
      "TEN_DIGIT_LONG_CODE":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TenDlcAiReviewRequest"
     }
    },
    "oneOf":[
     {
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TenDlcAiReviewRequest"
     }
    ],
    "properties":{
     "reviewType":{
      "type":"string",
      "description":"Type of review submission",
      "enum":[
       "TEN_DIGIT_LONG_CODE"
      ]
     },
     "brandName":{
      "type":"string",
      "description":"Brand name"
     },
     "brandWebsite":{
      "type":"string",
      "description":"Brand website URL"
     },
     "brandSupportEmail":{
      "type":"string",
      "description":"Brand support email"
     },
     "programDescription":{
      "type":"string",
      "description":"A brief description of the purpose of the campaign."
     },
     "messageExamples":{
      "type":"array",
      "description":"The example message(s) a user may receive from this campaign. Each example message must be at least 20 characters long.",
      "items":{
       "type":"string",
       "description":"The example message(s) a user may receive from this campaign. Each example message must be at least 20 characters long."
      }
     },
     "customerCareEmail":{
      "type":"string",
      "description":"The email address the user may contact to get customer care."
     },
     "termsAndConditionsUrl":{
      "type":"string",
      "description":"URL where the terms and conditions of the campaign are located."
     },
     "privacyPolicyUrl":{
      "type":"string",
      "description":"Privacy policy URL"
     }
    },
    "required":[
     "brandName",
     "brandSupportEmail",
     "brandWebsite",
     "customerCareEmail",
     "messageExamples",
     "programDescription",
     "reviewType"
    ],
    "title":"CampaignInfoReviewRequest"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignNetworkStatusWebhookContent":{
    "type":"object",
    "description":"Event content.",
    "properties":{
     "campaignId":{
      "type":"string",
      "format":"uuid",
      "description":"The ID of campaign.",
      "example":"38a1c2c6-55f2-11ee-a061-325096b39f47"
     },
     "campaignNetwork":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignRegistrar"
     },
     "campaignNetworkStatus":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.WebhookCampaignNetworkStatus"
     }
    },
    "title":"CampaignNetworkStatusWebhookContent"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignNetworkStatusWebhookMessage":{
    "type":"object",
    "description":"Incoming events",
    "properties":{
     "event":{
      "type":"string",
      "description":"The name of the event.",
      "enum":[
       "CAMPAIGN_NETWORK_STATUS_UPDATE"
      ],
      "example":"CAMPAIGN_NETWORK_STATUS_UPDATE"
     },
     "receivedAt":{
      "type":"string",
      "format":"date-time",
      "description":"Date and time when Infobip received the event."
     },
     "content":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignNetworkStatusWebhookContent"
     },
     "platform":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignWebhookPlatform"
     }
    },
    "title":"CampaignNetworkStatusWebhookMessage"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignNetworkStatusWebhookResponse":{
    "type":"object",
    "properties":{
     "results":{
      "type":"array",
      "description":"Incoming events",
      "items":{
       "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignNetworkStatusWebhookMessage"
      }
     }
    },
    "title":"CampaignNetworkStatusWebhookResponse"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignRegistrar":{
    "type":"string",
    "description":"The network a campaign is submitted to.",
    "enum":[
     "CAMPAIGN_REGISTRY",
     "T_MOBILE",
     "ATT",
     "VERIZON",
     "CLEARSKY",
     "US_CELLULAR_SMS",
     "INTEROP",
     "GOOGLE_VOICE",
     "US_CELLULAR_MMS",
     "ZIPWHIP",
     "LIBERTY",
     "DISH",
     "CHARTER_SPECTRUM",
     "C_SPIRE",
     "GOOGLE_FI",
     "TRACFONE"
    ],
    "example":"VERIZON",
    "title":"CampaignRegistrar"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignStage":{
    "type":"string",
    "enum":[
     "DRAFT",
     "SUBMITTED_FOR_REVIEW",
     "IN_REVIEW",
     "UPDATE_REQUESTED_BY_INTERNAL_REVIEWER",
     "APPROVED_BY_INTERNAL_REVIEWER",
     "SUBMITTED",
     "REJECTED_EXTERNALLY",
     "REGISTERED",
     "REJECTED",
     "ON_HOLD",
     "DEREGISTERED",
     "REGISTERED_PENDING_UPDATE",
     "REGISTERED_PENDING_DEREGISTRATION",
     "ARCHIVED",
     "BLOCKED",
     "SUSPENDED",
     "APPEALED",
     "IN_MIGRATION",
     "PAUSED"
    ],
    "readOnly":true,
    "title":"CampaignStage"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignStatusWebhookContent":{
    "type":"object",
    "description":"Event content.",
    "properties":{
     "campaignId":{
      "type":"string",
      "format":"uuid",
      "description":"The ID of campaign.",
      "example":"38a1c2c6-55f2-11ee-a061-325096b39f47"
     },
     "tcrId":{
      "type":"string",
      "description":"The ID of the campaign as defined by The Campaign Registry. This field is present only for 10DLC campaigns.",
      "example":"C0O3XVU"
     },
     "campaignStatus":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.WebhookCampaignStage"
     },
     "rejectionReasons":{
      "type":"string",
      "description":"The rejection reasons. This field is present only when new campaign registration status is 'REJECTED'.",
      "example":"Unable to verify, need website."
     },
     "rejectionDetails":{
      "type":"array",
      "description":"The rejection reasons details. This field is present only when new campaign registration status is 'REJECTED'.",
      "items":{
       "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.RejectionReasonPayload"
      }
     },
     "rejectionDate":{
      "type":"string",
      "format":"date-time",
      "description":"The rejection date. This field is present only when new campaign registration status is 'REJECTED'."
     }
    },
    "title":"CampaignStatusWebhookContent"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignStatusWebhookMessage":{
    "type":"object",
    "description":"Incoming events",
    "properties":{
     "event":{
      "type":"string",
      "description":"The name of the event.",
      "enum":[
       "CAMPAIGN_STATUS_UPDATE"
      ],
      "example":"CAMPAIGN_STATUS_UPDATE"
     },
     "receivedAt":{
      "type":"string",
      "format":"date-time",
      "description":"Date and time when Infobip received the event."
     },
     "content":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignStatusWebhookContent"
     },
     "platform":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignWebhookPlatform"
     }
    },
    "title":"CampaignStatusWebhookMessage"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignStatusWebhookResponse":{
    "type":"object",
    "properties":{
     "results":{
      "type":"array",
      "description":"Incoming events",
      "items":{
       "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignStatusWebhookMessage"
      }
     }
    },
    "title":"CampaignStatusWebhookResponse"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignType":{
    "type":"string",
    "description":"Campaign type.",
    "enum":[
     "TEN_DIGIT_LONG_CODE",
     "EXTERNAL_TEN_DIGIT_LONG_CODE",
     "SHORT_CODE",
     "DCA2_TEN_DIGIT_LONG_CODE",
     "TOLL_FREE_NUMBER",
     "TOLL_FREE_UNIFIED_NUMBER",
     "TOLL_FREE_EXTERNALLY_VERIFIED",
     "RCS_SENDER_LAUNCH"
    ],
    "title":"CampaignType"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignWebhookPlatform":{
    "type":"object",
    "description":"Platform properties.",
    "properties":{
     "applicationId":{
      "type":"string",
      "description":"Campaign application id.",
      "example":"application-id"
     },
     "entityId":{
      "type":"string",
      "description":"Campaign entity id.",
      "example":"entity-id"
     }
    },
    "title":"CampaignWebhookPlatform"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CvVetImportRequest":{
    "type":"object",
    "allOf":[
     {
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.VetImportRequest"
     },
     {
      "type":"object",
      "properties":{
       "authorizationToken":{
        "type":"string",
        "description":"Campaign Verify authorization token",
        "pattern":"^cv(\\|[^|]+){5}$"
       }
      }
     }
    ],
    "required":[
     "authorizationToken",
     "type"
    ],
    "title":"CvVetImportRequest"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.DataUniversalNumberingSystemNumber":{
    "type":"object",
    "allOf":[
     {
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BusinessIdentifier"
     },
     {
      "type":"object",
      "properties":{
       "id":{
        "type":"string",
        "description":"The DUNS identifier.",
        "maxLength":9,
        "minLength":9,
        "pattern":"\\d{9}"
       }
      }
     }
    ],
    "required":[
     "id"
    ],
    "title":"DataUniversalNumberingSystemNumber"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.DocumentMetadata":{
    "type":"object",
    "description":"Preview of the screenshot document. This property is read-only and ignored in POST/PUT calls.",
    "properties":{
     "documentId":{
      "type":"string",
      "format":"uuid",
      "description":"Unique identifier for the document."
     },
     "documentName":{
      "type":"string",
      "description":"Name of the document file."
     },
     "contentType":{
      "type":"string",
      "description":"MIME type of the document content (e.g., application/pdf, image/png)."
     },
     "contentLength":{
      "type":"integer",
      "format":"int32",
      "description":"Size of the document content in bytes."
     }
    },
    "title":"DocumentMetadata"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.ExternalAutomaticReviewError":{
    "type":"object",
    "description":"List of compliance errors found during the AI campaign review. Empty when the review is still processing or the campaign is compliant.",
    "properties":{
     "code":{
      "type":"string",
      "description":"The error code identifying the type of compliance issue."
     },
     "justification":{
      "type":"string",
      "description":"The justification for why this was flagged as a compliance issue."
     },
     "description":{
      "type":"string",
      "description":"Description of the compliance issue."
     },
     "recommendation":{
      "type":"string",
      "description":"The recommended action to resolve the compliance issue."
     }
    },
    "title":"ExternalAutomaticReviewError"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.ExternalAutomaticReviewResults":{
    "type":"object",
    "properties":{
     "reviewStatus":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.ExternalAutomaticReviewStatus"
     },
     "campaignErrors":{
      "type":"array",
      "description":"List of compliance errors found during the AI campaign review. Empty when the review is still processing or the campaign is compliant.",
      "items":{
       "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.ExternalAutomaticReviewError"
      }
     }
    },
    "title":"ExternalAutomaticReviewResults"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.ExternalAutomaticReviewStatus":{
    "type":"string",
    "description":"The current status of the AI campaign review.",
    "enum":[
     "PROCESSING",
     "COMPLIANT",
     "NON_COMPLIANT"
    ],
    "title":"ExternalAutomaticReviewStatus"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.ExternalTenDlcCampaign":{
    "type":"object",
    "allOf":[
     {
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Campaign"
     },
     {
      "type":"object",
      "properties":{
       "externalCampaignId":{
        "type":"string",
        "description":"The ID of the campaign as defined by The Campaign Registry.",
        "maxLength":100,
        "minLength":0
       },
       "numbers":{
        "type":"array",
        "description":"US 10DLC Numbers to be used with the campaign.",
        "items":{
         "type":"string",
         "description":"US 10DLC Numbers to be used with the campaign.",
         "pattern":"1\\d{10}"
        },
        "maxItems":49,
        "minItems":0,
        "uniqueItems":true
       },
       "policy":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PolicyType"
       },
       "numberKeys":{
        "type":"array",
        "description":"The numberKey(s) of the numbers to use with the campaign. Alternatively, you can use the 'numbers' property to specify the numbers directly, but note that 'numberKeys' property takes precedence if both are specified. ",
        "externalDocs":{
         "description":"Find out more about numbers.",
         "url":"#platform-&-connectivity/numbers"
        },
        "items":{
         "type":"string"
        },
        "maxItems":49,
        "minItems":0,
        "uniqueItems":true
       },
       "numberPreviews":{
        "type":"array",
        "description":"The number(s) to use with the campaign. This property is read-only and ignored in POST/PUT calls.",
        "items":{
         "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.NumberPreview"
        },
        "readOnly":true,
        "uniqueItems":true
       },
       "numberPool":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.NumberPool"
       }
      }
     }
    ],
    "required":[
     "externalCampaignId",
     "name"
    ],
    "title":"ExternalTenDlcCampaign"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.GlobalIntermediaryIdentificationNumber":{
    "type":"object",
    "allOf":[
     {
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BusinessIdentifier"
     },
     {
      "type":"object",
      "properties":{
       "id":{
        "type":"string",
        "description":"The GIIN identifier.",
        "maxLength":19,
        "minLength":19,
        "pattern":"([A-NP-Z0-9]{6})\\.([A-NP-Z0-9]{5})\\.(LE|SL|ME|BR|SP)\\.(\\d{3})"
       }
      }
     }
    ],
    "required":[
     "id"
    ],
    "title":"GlobalIntermediaryIdentificationNumber"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.GovernmentBrand":{
    "type":"object",
    "allOf":[
     {
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Brand"
     },
     {
      "type":"object",
      "properties":{
       "referenceId":{
        "type":"string",
        "description":"Unique user defined ID for the brand. While not required, it is recommended to supply a referenceId as the uniqueness constraint will help ensure a brand is not accidentally created multiple times. Subsequent create requests with the same referenceId will be rejected with an error.",
        "maxLength":50,
        "minLength":0
       },
       "taxId":{
        "type":"string",
        "description":"The tax identifier for the brand. Not required for sole proprietor brands.",
        "maxLength":50,
        "minLength":0
       },
       "taxIdIssuingCountry":{
        "type":"string",
        "description":"The country where tax identifier is issued. If not specified, the value from countryCode will be used.",
        "maxLength":2,
        "minLength":1
       },
       "address":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Address"
       },
       "countryCode":{
        "type":"string",
        "description":"The country where the brand is located.",
        "maxLength":2,
        "minLength":1
       },
       "supportPhone":{
        "type":"string",
        "description":"The business phone number to contact about brand compliance issues.",
        "maxLength":16,
        "minLength":3,
        "pattern":"\\+?[1-9]\\d{1,14}"
       },
       "supportEmail":{
        "type":"string",
        "description":"The business email address to contact about brand compliance issues. Must be a well formed email address that does not include a '=' character."
       },
       "businessContactFirstName":{
        "type":"string",
        "description":"First name of the primary contact person for the brand or business entity. Used for verification or compliance outreach.",
        "maxLength":100,
        "minLength":1
       },
       "businessContactLastName":{
        "type":"string",
        "description":"Last name of the primary contact person for the brand or business entity.",
        "maxLength":100,
        "minLength":1
       },
       "businessDBA":{
        "type":"string",
        "description":"'Doing Business As' name if different from the legal business name.",
        "maxLength":500,
        "minLength":0
       },
       "legalName":{
        "type":"string",
        "description":"The legal name of the brand.",
        "maxLength":255,
        "minLength":1
       },
       "alternateBusinessId":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BusinessIdentifier"
       },
       "vertical":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Vertical"
       }
      }
     }
    ],
    "required":[
     "address",
     "countryCode",
     "legalName",
     "name",
     "supportEmail",
     "supportPhone",
     "taxId",
     "type",
     "vertical",
     "website"
    ],
    "title":"GovernmentBrand"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.InteractiveVoiceResponseOptIn":{
    "type":"object",
    "description":"The type of opt in that requires a user to record a confirmation.",
    "properties":{
     "callToAction":{
      "type":"string",
      "description":"    The message sent to the user to tell them how to subscribe. Must include:\n    • Product description\n    • Message frequency disclosure\n    • Complete terms and conditions OR link to complete terms and conditions\n    • Privacy policy OR link to privacy policy\n    • STOP keyword\n    • The \"Message and data rates may apply\" disclosure\n",
      "maxLength":1024,
      "minLength":20
     }
    },
    "required":[
     "callToAction"
    ],
    "title":"InteractiveVoiceResponseOptIn"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.KeywordOptIn":{
    "type":"object",
    "description":"The type of opt in that requires a user to type in a keyword.",
    "properties":{
     "callToAction":{
      "type":"string",
      "description":"    The message sent to the user to tell them how to subscribe. Must include:\n    • Product description\n    • Message frequency disclosure\n    • Complete terms and conditions OR link to complete terms and conditions\n    • Privacy policy OR link to privacy policy\n    • STOP keyword\n    • The \"Message and data rates may apply\" disclosure\n",
      "maxLength":1024,
      "minLength":20
     },
     "keywords":{
      "type":"array",
      "description":"The keyword(s) the user will text to subscribe. Keyword(s) must include only uppercase letters and numbers.",
      "items":{
       "type":"string",
       "description":"The keyword(s) the user will text to subscribe. Keyword(s) must include only uppercase letters and numbers.",
       "pattern":"[A-Z0-9]+"
      }
     }
    },
    "required":[
     "callToAction",
     "keywords"
    ],
    "title":"KeywordOptIn"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.LegalEntityIdentifier":{
    "type":"object",
    "allOf":[
     {
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BusinessIdentifier"
     },
     {
      "type":"object",
      "properties":{
       "id":{
        "type":"string",
        "description":"The LEI identifier.",
        "maxLength":20,
        "minLength":20,
        "pattern":"(\\d{4})(00)([A-Z0-9]{12})(\\d{2})"
       }
      }
     }
    ],
    "required":[
     "id"
    ],
    "title":"LegalEntityIdentifier"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.MessageType":{
    "type":"string",
    "description":"The message type(s) this campaign will use to send messages.",
    "enum":[
     "SMS",
     "MMS"
    ],
    "title":"MessageType"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Network":{
    "type":"string",
    "description":"The network with which the campaign has been registered.",
    "enum":[
     "ATT",
     "T_MOBILE",
     "VERIZON",
     "US_CELLULAR",
     "INTEROP",
     "CLEARSKY",
     "GOOGLE_VOICE",
     "LIBERTY",
     "DISH",
     "CHARTER_SPECTRUM",
     "C_SPIRE",
     "GOOGLE_FI",
     "TRACFONE"
    ],
    "title":"Network"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.NetworkState":{
    "type":"string",
    "description":"The state of the campaign's registration with this network.",
    "enum":[
     "ACTIVE",
     "PENDING",
     "NOT_REGISTERED",
     "CERTIFICATION"
    ],
    "title":"NetworkState"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.NetworkStatus":{
    "type":"object",
    "properties":{
     "network":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Network"
     },
     "state":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.NetworkState"
     },
     "messageClass":{
      "type":"string",
      "description":"This value is provided by some carriers to help determine throughput and daily limits.\nRefer to the [current documentation](https://www.infobip.com/docs/10dlc/throughput) for how to interpret these values as they may change over time."
     },
     "throughput":{
      "type":"integer",
      "format":"int32",
      "description":"This value represents the throughput limit, which is calculated based on the message class and brand tier.\nIts meaning varies depending on the carrier: for AT&T, it denotes messages per minute, while for T-Mobile, it denotes messages per day.\nIf the throughput value is null, the throughput is considered unlimited."
     },
     "brandTier":{
      "type":"string",
      "description":"This value indicates the brand tier for T-Mobile, which determines the corresponding throughput limit."
     }
    },
    "title":"NetworkStatus"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.NonProfitBrand":{
    "type":"object",
    "allOf":[
     {
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Brand"
     },
     {
      "type":"object",
      "properties":{
       "referenceId":{
        "type":"string",
        "description":"Unique user defined ID for the brand. While not required, it is recommended to supply a referenceId as the uniqueness constraint will help ensure a brand is not accidentally created multiple times. Subsequent create requests with the same referenceId will be rejected with an error.",
        "maxLength":50,
        "minLength":0
       },
       "taxId":{
        "type":"string",
        "description":"The tax identifier for the brand. Not required for sole proprietor brands.",
        "maxLength":50,
        "minLength":0
       },
       "taxIdIssuingCountry":{
        "type":"string",
        "description":"The country where tax identifier is issued. If not specified, the value from countryCode will be used.",
        "maxLength":2,
        "minLength":1
       },
       "address":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Address"
       },
       "countryCode":{
        "type":"string",
        "description":"The country where the brand is located.",
        "maxLength":2,
        "minLength":1
       },
       "supportPhone":{
        "type":"string",
        "description":"The business phone number to contact about brand compliance issues.",
        "maxLength":16,
        "minLength":3,
        "pattern":"\\+?[1-9]\\d{1,14}"
       },
       "supportEmail":{
        "type":"string",
        "description":"The business email address to contact about brand compliance issues. Must be a well formed email address that does not include a '=' character."
       },
       "businessContactFirstName":{
        "type":"string",
        "description":"First name of the primary contact person for the brand or business entity. Used for verification or compliance outreach.",
        "maxLength":100,
        "minLength":1
       },
       "businessContactLastName":{
        "type":"string",
        "description":"Last name of the primary contact person for the brand or business entity.",
        "maxLength":100,
        "minLength":1
       },
       "businessDBA":{
        "type":"string",
        "description":"'Doing Business As' name if different from the legal business name.",
        "maxLength":500,
        "minLength":0
       },
       "legalName":{
        "type":"string",
        "description":"The legal name of the brand.",
        "maxLength":255,
        "minLength":1
       },
       "alternateBusinessId":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BusinessIdentifier"
       },
       "vertical":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Vertical"
       },
       "taxExemptStatus":{
        "type":"string",
        "description":"The tax exempt status per section 501 of the US tax code for non profit brands.",
        "readOnly":true
       }
      }
     }
    ],
    "required":[
     "address",
     "countryCode",
     "legalName",
     "name",
     "supportEmail",
     "supportPhone",
     "taxId",
     "type",
     "vertical",
     "website"
    ],
    "title":"NonProfitBrand"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.NumberPool":{
    "type":"object",
    "description":"The number pool to be used with the campaign.",
    "properties":{
     "numberPoolId":{
      "type":"string",
      "description":"Registrar ID of number pool"
     },
     "numberPoolType":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.NumberPoolType"
     },
     "numberPoolStatus":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.NumberPoolStatus"
     },
     "nnid":{
      "type":"string",
      "description":"NNID of number pool"
     },
     "policy":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PolicyType"
     }
    },
    "title":"NumberPool"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.NumberPoolAvailability":{
    "type":"string",
    "enum":[
     "AVAILABLE",
     "IN_USE"
    ],
    "title":"NumberPoolAvailability"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.NumberPoolStatus":{
    "type":"string",
    "enum":[
     "PENDING_VERIFICATION",
     "SUBMITTED_FOR_VERIFICATION",
     "VALID",
     "INVALID"
    ],
    "title":"NumberPoolStatus"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.NumberPoolType":{
    "type":"string",
    "enum":[
     "SUB_ID",
     "CAMPAIGN_ID"
    ],
    "title":"NumberPoolType"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.NumberPoolUsageApiPageResponse":{
    "type":"object",
    "properties":{
     "results":{
      "type":"array",
      "description":"The list of the results for this page.",
      "items":{
       "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.NumberPoolUsageApiResponse"
      }
     },
     "paging":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PageInfo"
     }
    },
    "title":"NumberPoolUsageApiPageResponse"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.NumberPoolUsageApiResponse":{
    "type":"object",
    "description":"The list of the results for this page.",
    "properties":{
     "numberPoolId":{
      "type":"string",
      "description":"Unique identifier of the number pool."
     },
     "campaignId":{
      "type":"string",
      "description":"Unique identifier of the campaign currently associated with this number pool. If the number pool is unassigned, this field will be empty."
     },
     "campaignName":{
      "type":"string",
      "description":"Name of the associated campaign. Will be empty if no campaign is associated."
     }
    },
    "title":"NumberPoolUsageApiResponse"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.NumberPreview":{
    "type":"object",
    "properties":{
     "numberKey":{
      "type":"string",
      "description":"Unique ID of the number."
     },
     "number":{
      "type":"string",
      "description":"Number."
     },
     "countryCode":{
      "type":"string",
      "description":"Number's country code."
     }
    },
    "title":"NumberPreview"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.NumberPreviews":{
    "type":"object",
    "properties":{
     "numberPreviews":{
      "type":"array",
      "items":{
       "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.NumberPreview"
      },
      "uniqueItems":true
     }
    },
    "title":"NumberPreviews"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.OptIns":{
    "type":"object",
    "properties":{
     "keyword":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.KeywordOptIn"
     },
     "web":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.WebOptIn"
     },
     "verbal":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.VerbalOptIn"
     },
     "interactiveVoiceResponse":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.InteractiveVoiceResponseOptIn"
     }
    },
    "title":"OptIns"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PageInfo":{
    "type":"object",
    "description":"Contains information about the page.",
    "properties":{
     "page":{
      "type":"integer",
      "format":"int32",
      "description":"Requested page number.",
      "minimum":0
     },
     "size":{
      "type":"integer",
      "format":"int32",
      "description":"Requested page size.",
      "minimum":1
     },
     "totalPages":{
      "type":"integer",
      "format":"int32",
      "description":"The total number of pages of the results matching the requested parameters.",
      "minimum":0
     },
     "totalResults":{
      "type":"integer",
      "format":"int64",
      "description":"The total number of the results matching the requested parameters.",
      "minimum":0
     }
    },
    "required":[
     "page",
     "size",
     "totalPages",
     "totalResults"
    ],
    "title":"PageInfo"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PageResponseBrand":{
    "type":"object",
    "properties":{
     "results":{
      "type":"array",
      "description":"The list of the results for this page.",
      "items":{
       "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Brand"
      }
     },
     "paging":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PageInfo"
     }
    },
    "title":"PageResponseBrand"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PageResponseBrandVet":{
    "type":"object",
    "properties":{
     "results":{
      "type":"array",
      "description":"The list of the results for this page.",
      "items":{
       "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandVet"
      }
     },
     "paging":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PageInfo"
     }
    },
    "title":"PageResponseBrandVet"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PageResponseCampaign":{
    "type":"object",
    "properties":{
     "results":{
      "type":"array",
      "description":"The list of the results for this page.",
      "items":{
       "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Campaign"
      }
     },
     "paging":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PageInfo"
     }
    },
    "title":"PageResponseCampaign"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PolicyType":{
    "type":"string",
    "description":"Policy type to indicate either standard, reduced or M2M policy",
    "enum":[
     "STANDARD",
     "REDUCED",
     "M2M"
    ],
    "title":"PolicyType"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Priority":{
    "type":"object",
    "properties":{
     "priorityId":{
      "type":"string",
      "format":"uuid",
      "description":"The ID for the campaign priority."
     },
     "dailySubmitLimit":{
      "type":"integer",
      "format":"int32",
      "description":"The limit on how many campaigns you can submit a day with this priority."
     },
     "reviewTime":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PriorityTimeData"
     },
     "priorityType":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PriorityType"
     }
    },
    "title":"Priority"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PriorityInfo":{
    "type":"object",
    "description":"Priority information used in latest campaign review.",
    "properties":{
     "priorityId":{
      "type":"string",
      "format":"uuid",
      "description":"Id of a priority"
     },
     "submittedDate":{
      "type":"string",
      "format":"date-time",
      "description":"Date submitted for review"
     }
    },
    "title":"PriorityInfo"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PriorityTimeData":{
    "type":"object",
    "properties":{
     "timeUnit":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PriorityTimeUnit"
     },
     "amount":{
      "type":"integer",
      "format":"int32",
      "description":"The amount of time unit."
     }
    },
    "title":"PriorityTimeData"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PriorityTimeUnit":{
    "type":"string",
    "description":"The  unit of time for the priority request.",
    "enum":[
     "HOURS",
     "DAYS"
    ],
    "title":"PriorityTimeUnit"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PriorityType":{
    "type":"string",
    "description":"Type of a priority",
    "enum":[
     "TEN_DLC",
     "SHORT_CODE",
     "TFN"
    ],
    "title":"PriorityType"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PrivateCompanyBrand":{
    "type":"object",
    "allOf":[
     {
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Brand"
     },
     {
      "type":"object",
      "properties":{
       "referenceId":{
        "type":"string",
        "description":"Unique user defined ID for the brand. While not required, it is recommended to supply a referenceId as the uniqueness constraint will help ensure a brand is not accidentally created multiple times. Subsequent create requests with the same referenceId will be rejected with an error.",
        "maxLength":50,
        "minLength":0
       },
       "taxId":{
        "type":"string",
        "description":"The tax identifier for the brand. Not required for sole proprietor brands.",
        "maxLength":50,
        "minLength":0
       },
       "taxIdIssuingCountry":{
        "type":"string",
        "description":"The country where tax identifier is issued. If not specified, the value from countryCode will be used.",
        "maxLength":2,
        "minLength":1
       },
       "address":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Address"
       },
       "countryCode":{
        "type":"string",
        "description":"The country where the brand is located.",
        "maxLength":2,
        "minLength":1
       },
       "supportPhone":{
        "type":"string",
        "description":"The business phone number to contact about brand compliance issues.",
        "maxLength":16,
        "minLength":3,
        "pattern":"\\+?[1-9]\\d{1,14}"
       },
       "supportEmail":{
        "type":"string",
        "description":"The business email address to contact about brand compliance issues. Must be a well formed email address that does not include a '=' character."
       },
       "businessContactFirstName":{
        "type":"string",
        "description":"First name of the primary contact person for the brand or business entity. Used for verification or compliance outreach.",
        "maxLength":100,
        "minLength":1
       },
       "businessContactLastName":{
        "type":"string",
        "description":"Last name of the primary contact person for the brand or business entity.",
        "maxLength":100,
        "minLength":1
       },
       "businessDBA":{
        "type":"string",
        "description":"'Doing Business As' name if different from the legal business name.",
        "maxLength":500,
        "minLength":0
       },
       "legalName":{
        "type":"string",
        "description":"The legal name of the brand.",
        "maxLength":255,
        "minLength":1
       },
       "alternateBusinessId":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BusinessIdentifier"
       },
       "vertical":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Vertical"
       }
      }
     }
    ],
    "required":[
     "address",
     "countryCode",
     "legalName",
     "name",
     "supportEmail",
     "supportPhone",
     "taxId",
     "type",
     "vertical",
     "website"
    ],
    "title":"PrivateCompanyBrand"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PromotionMethodType":{
    "type":"string",
    "description":"Call-to-action promotion method type",
    "enum":[
     "OUTDOOR",
     "POS",
     "PRINT",
     "RADIO",
     "TV",
     "WEB"
    ],
    "title":"PromotionMethodType"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PublicCompanyBrand":{
    "type":"object",
    "allOf":[
     {
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Brand"
     },
     {
      "type":"object",
      "properties":{
       "referenceId":{
        "type":"string",
        "description":"Unique user defined ID for the brand. While not required, it is recommended to supply a referenceId as the uniqueness constraint will help ensure a brand is not accidentally created multiple times. Subsequent create requests with the same referenceId will be rejected with an error.",
        "maxLength":50,
        "minLength":0
       },
       "taxId":{
        "type":"string",
        "description":"The tax identifier for the brand. Not required for sole proprietor brands.",
        "maxLength":50,
        "minLength":0
       },
       "taxIdIssuingCountry":{
        "type":"string",
        "description":"The country where tax identifier is issued. If not specified, the value from countryCode will be used.",
        "maxLength":2,
        "minLength":1
       },
       "address":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Address"
       },
       "countryCode":{
        "type":"string",
        "description":"The country where the brand is located.",
        "maxLength":2,
        "minLength":1
       },
       "supportPhone":{
        "type":"string",
        "description":"The business phone number to contact about brand compliance issues.",
        "maxLength":16,
        "minLength":3,
        "pattern":"\\+?[1-9]\\d{1,14}"
       },
       "supportEmail":{
        "type":"string",
        "description":"The business email address to contact about brand compliance issues. Must be a well formed email address that does not include a '=' character."
       },
       "businessContactFirstName":{
        "type":"string",
        "description":"First name of the primary contact person for the brand or business entity. Used for verification or compliance outreach.",
        "maxLength":100,
        "minLength":1
       },
       "businessContactLastName":{
        "type":"string",
        "description":"Last name of the primary contact person for the brand or business entity.",
        "maxLength":100,
        "minLength":1
       },
       "businessDBA":{
        "type":"string",
        "description":"'Doing Business As' name if different from the legal business name.",
        "maxLength":500,
        "minLength":0
       },
       "legalName":{
        "type":"string",
        "description":"The legal name of the brand.",
        "maxLength":255,
        "minLength":1
       },
       "alternateBusinessId":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BusinessIdentifier"
       },
       "vertical":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Vertical"
       },
       "stockExchange":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.StockExchange"
       },
       "stockSymbol":{
        "type":"string",
        "description":"The ticker symbol for the brand on the exchange where it is listed.",
        "maxLength":10,
        "minLength":1
       },
       "businessContactEmail":{
        "type":"string",
        "description":"The email address of the individual responsible for processing the 2FA request via email.\nThis must be a personal email address associated with the brand and not a distribution list or support email.",
        "maxLength":100,
        "minLength":5
       }
      }
     }
    ],
    "required":[
     "address",
     "businessContactEmail",
     "countryCode",
     "legalName",
     "name",
     "stockExchange",
     "stockSymbol",
     "supportEmail",
     "supportPhone",
     "taxId",
     "type",
     "vertical",
     "website"
    ],
    "title":"PublicCompanyBrand"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.RegisterCampaignRequest":{
    "type":"object",
    "properties":{
     "priorityId":{
      "type":"string",
      "format":"uuid",
      "description":"The ID of the campaign priority you would like to use.",
      "externalDocs":{
       "description":"Find out more about Campaign Priority.",
       "url":"https://www.infobip.com/docs/api/platform/numbers/number-registration/campaigns/get-campaign-priorities"
      }
     }
    },
    "title":"RegisterCampaignRequest"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.RejectionReason":{
    "type":"object",
    "description":"Rejection reasons details.",
    "properties":{
     "errorCode":{
      "type":"string",
      "description":"Predefined code."
     },
     "description":{
      "type":"string",
      "description":"Rejection reason."
     },
     "recommendedAction":{
      "type":"string",
      "description":"Recommended action."
     }
    },
    "title":"RejectionReason"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.RejectionReasonPayload":{
    "type":"object",
    "description":"The rejection reasons details. This field is present only when new campaign registration status is 'REJECTED'.",
    "properties":{
     "errorCode":{
      "type":"string",
      "description":"Predefined code.",
      "example":"1001"
     },
     "description":{
      "type":"string",
      "description":"Rejection reason.",
      "example":"Campaign appears to be for an age gated content type but age gate attribute is not selected."
     }
    },
    "title":"RejectionReasonPayload"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.ReviewSubmissionResponse":{
    "type":"object",
    "description":"Response containing the request UUID for tracking the AI review submission",
    "properties":{
     "requestUuid":{
      "type":"string",
      "format":"uuid",
      "description":"Unique identifier for this AI review request."
     }
    },
    "title":"ReviewSubmissionResponse"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.ShortCodeCampaignBuilderRequest":{
    "type":"object",
    "allOf":[
     {
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderRequest"
     },
     {
      "type":"object",
      "properties":{
       "contactPhone":{
        "type":"string",
        "description":"Campaign contact phone for use in call-to-action method"
       },
       "ctaMethods":{
        "type":"array",
        "description":"Call-to-action (CTA) methods indicating how the short code will be promoted to consumers (e.g. web, TV, radio, print).",
        "items":{
         "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PromotionMethodType"
        },
        "uniqueItems":true
       },
       "campaignAttributes":{
        "type":"array",
        "description":"Campaign attributes indicating special content characteristics.",
        "items":{
         "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderCampaignAttributes"
        },
        "uniqueItems":true
       }
      }
     }
    ],
    "description":"Request to start building Short code campaign using AI assistant.",
    "required":[
     "brandId",
     "campaignIntent",
     "campaignType",
     "contactEmail",
     "ctaMethods",
     "optInMethods"
    ],
    "title":"ShortCodeCampaignBuilderRequest"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.ShortCodeCampaignBuilderResultData":{
    "type":"object",
    "allOf":[
     {
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderResultData"
     },
     {
      "type":"object",
      "properties":{
       "useCase":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.ShortCodeUseCase"
       },
       "messageFlow":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.ShortCodeCampaignBuilderResultMessageFlow"
       },
       "cta":{
        "type":"array",
        "description":"Call-to-action suggestions.",
        "items":{
         "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderResultCta"
        }
       },
       "termsConditions":{
        "type":"string",
        "writeOnly":true
       },
       "privacyPolicy":{
        "type":"string",
        "writeOnly":true
       }
      }
     }
    ],
    "description":"Campaign builder result for Short Code campaigns.",
    "title":"ShortCodeCampaignBuilderResultData"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.ShortCodeCampaignBuilderResultMessageFlow":{
    "type":"object",
    "description":"Campaign message flow for Short Code campaigns",
    "properties":{
     "optInMessage":{
      "type":"string",
      "description":"Opt-in confirmation message"
     },
     "exampleMessage1":{
      "type":"string",
      "description":"First example message"
     },
     "exampleMessage2":{
      "type":"string",
      "description":"Second example message"
     },
     "helpMessage":{
      "type":"string",
      "description":"Help response message"
     },
     "optOutMessage":{
      "type":"string",
      "description":"Opt-out response message"
     }
    },
    "title":"ShortCodeCampaignBuilderResultMessageFlow"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.ShortCodeUseCase":{
    "type":"string",
    "description":"Campaign use case.",
    "enum":[
     "ALERTS",
     "CHAT",
     "DONATION",
     "EDUCATION",
     "FRAUD_ALERTS",
     "PROMOTIONAL_MARKETING",
     "PUBLIC_SERVICE_ANNOUNCEMENT",
     "SWEEPSTAKES_CONTEST",
     "TWO_FACTOR_AUTH",
     "VOTING_POLLING",
     "POLITICAL",
     "EMERGENCY_NOTIFICATIONS",
     "DELIVERY_NOTIFICATIONS",
     "SECURITY_ALERT"
    ],
    "title":"ShortCodeUseCase"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.StockExchange":{
    "type":"string",
    "description":"The stock exchange where brand is listed. Only for publicly traded companies.",
    "enum":[
     "AMEX",
     "AMX",
     "ASX",
     "B3",
     "BME",
     "BSE",
     "FRA",
     "ICEX",
     "JPX",
     "JSE",
     "KRX",
     "LON",
     "NASDAQ",
     "NSE",
     "NYSE",
     "OMX",
     "SEHK",
     "SGX",
     "SSE",
     "STO",
     "SWX",
     "SZSE",
     "TSX",
     "TWSE",
     "VSE",
     "OTHER"
    ],
    "title":"StockExchange"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TenDlcAiReviewRequest":{
    "type":"object",
    "allOf":[
     {
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignInfoReviewRequest"
     },
     {
      "type":"object",
      "properties":{
       "optInMessage":{
        "type":"string",
        "description":"The message sent to the user after they have subscribed."
       },
       "helpMessage":{
        "type":"string",
        "description":"The message sent to a user after they have asked for help."
       },
       "optOutMessage":{
        "type":"string",
        "description":"The message sent to a user after they have asked to stop receiving messages."
       },
       "ctaWebsite":{
        "type":"string",
        "description":"CTA website URL"
       },
       "ctas":{
        "type":"array",
        "description":"List of call-to-action texts",
        "items":{
         "type":"string",
         "description":"List of call-to-action texts"
        }
       },
       "useCases":{
        "type":"array",
        "description":"The use cases for this campaign.",
        "items":{
         "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TenDlcUseCase"
        }
       },
       "ageGated":{
        "type":"boolean",
        "description":"Whether the campaign is age-gated (18+)"
       },
       "directLending":{
        "type":"boolean",
        "description":"Whether the campaign involves direct lending"
       },
       "messageFlow":{
        "type":"string",
        "description":"Message flow description"
       }
      }
     }
    ],
    "description":"Request to submit 10DLC campaign info for AI compliance review with full details",
    "required":[
     "ageGated",
     "brandName",
     "brandSupportEmail",
     "brandWebsite",
     "ctaWebsite",
     "ctas",
     "customerCareEmail",
     "directLending",
     "helpMessage",
     "messageExamples",
     "messageFlow",
     "optInMessage",
     "optOutMessage",
     "programDescription",
     "reviewType",
     "useCases"
    ],
    "title":"TenDlcAiReviewRequest"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TenDlcCampaign":{
    "type":"object",
    "allOf":[
     {
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Campaign"
     },
     {
      "type":"object",
      "properties":{
       "brandId":{
        "type":"string",
        "format":"uuid",
        "description":"The ID of the brand to use with the campaign.",
        "externalDocs":{
         "description":"Find out more about Brands.",
         "url":"#platform-connectivity/number-registration/create-brand"
        }
       },
       "brandPreview":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandPreview"
       },
       "appealData":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.AppealData"
       },
       "programSummary":{
        "type":"string",
        "description":"A brief description of the purpose of the campaign.",
        "maxLength":500,
        "minLength":40
       },
       "confirmationMessage":{
        "type":"string",
        "description":"The message sent to the user after they have subscribed.",
        "maxLength":320,
        "minLength":20
       },
       "exampleMessages":{
        "type":"array",
        "description":"The example message(s) a user may receive from this campaign. Each example message must be at least 20 characters long.",
        "items":{
         "type":"string",
         "description":"The example message(s) a user may receive from this campaign. Each example message must be at least 20 characters long.",
         "maxLength":320,
         "minLength":20
        },
        "maxItems":5,
        "minItems":0
       },
       "helpMessage":{
        "type":"string",
        "description":"The message sent to a user after they have asked for help.",
        "maxLength":320,
        "minLength":20
       },
       "stopMessage":{
        "type":"string",
        "description":"The message sent to a user after they have asked to stop receiving messages.",
        "maxLength":320,
        "minLength":20
       },
       "messageTypes":{
        "type":"array",
        "description":"The message type(s) this campaign will use to send messages.",
        "items":{
         "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.MessageType"
        },
        "uniqueItems":true
       },
       "termsAndConditionsUrl":{
        "type":"string",
        "description":"URL where the terms and conditions of the campaign are located.",
        "maxLength":255,
        "minLength":11
       },
       "optIns":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.OptIns"
       },
       "ageGated":{
        "type":"boolean",
        "default":false,
        "description":"Shows whether the campaign will include any age-gated content, as defined by Carrier and CTIA guidelines."
       },
       "customerCarePhone":{
        "type":"string",
        "description":"The phone number the user may call to get customer care.",
        "maxLength":16,
        "minLength":3,
        "pattern":"\\+?[1-9]\\d{1,14}"
       },
       "lowVolume":{
        "type":"boolean",
        "default":false,
        "description":"Low volume campaigns are a lower cost campaign designed for low daily volume and non-time-sensitive messages. They are limited to 6 messages per minute on most carriers and no more than 5,000 messages per month on all carriers."
       },
       "useCases":{
        "type":"array",
        "description":"The use cases for this campaign.",
        "items":{
         "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TenDlcUseCase"
        },
        "maxItems":5,
        "minItems":1,
        "uniqueItems":true
       },
       "directLending":{
        "type":"boolean",
        "default":false,
        "description":"Shows whether the campaign will include content related to direct lending or other loan arrangements."
       },
       "embeddedLink":{
        "type":"boolean",
        "default":false,
        "description":"Shows whether the campaign will send embedded links of any kind. Public URL shorteners (bitly, tinyurl) are not accepted."
       },
       "embeddedPhone":{
        "type":"boolean",
        "default":false,
        "description":"Shows whether any embedded phone numbers would be used in the campaign, except the required HELP information contact phone number."
       },
       "customerCareEmail":{
        "type":"string",
        "description":"The email address the user may contact to get customer care.  Must be a well formed email address that does not include a '=' character.",
        "maxLength":255,
        "minLength":1
       },
       "mmsSampleFiles":{
        "type":"array",
        "description":"List of MMS sample files for the campaign. Each entry can be either a URL to an external file or a UUID of a previously uploaded document. Maximum 5 files allowed. Supported file types: .bmp, .dib, .gif, .jpeg, .jpg, .m2a, .m4a, .m4b, .m4p, .m4r, .m4v, .mp1, .mp2, .mp3, .mp4, .mpa, .oga, .ogg, .ogm, .ogv, .ogx, .png, .spx, .txt, .wav, .webm.",
        "items":{
         "type":"string",
         "description":"List of MMS sample files for the campaign. Each entry can be either a URL to an external file or a UUID of a previously uploaded document. Maximum 5 files allowed. Supported file types: .bmp, .dib, .gif, .jpeg, .jpg, .m2a, .m4a, .m4b, .m4p, .m4r, .m4v, .mp1, .mp2, .mp3, .mp4, .mpa, .oga, .ogg, .ogm, .ogv, .ogx, .png, .spx, .txt, .wav, .webm."
        },
        "maxItems":5,
        "minItems":0
       },
       "supportingDocuments":{
        "type":"array",
        "description":"List of supporting documents for the campaign. Each entry can be either a URL to an external document or a UUID of a previously uploaded document. Maximum 5 documents allowed. Supported file types: .bmp, .dib, .docx, .htm, .html, .jpeg, .jpg, .odt, .pdf, .png, .raw, .rtf, .tif, .tiff, .txt, .xml.",
        "items":{
         "type":"string",
         "description":"List of supporting documents for the campaign. Each entry can be either a URL to an external document or a UUID of a previously uploaded document. Maximum 5 documents allowed. Supported file types: .bmp, .dib, .docx, .htm, .html, .jpeg, .jpg, .odt, .pdf, .png, .raw, .rtf, .tif, .tiff, .txt, .xml."
        },
        "maxItems":5,
        "minItems":0
       },
       "policy":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PolicyType"
       },
       "externalCampaignId":{
        "type":"string",
        "description":"The ID of the campaign as defined by The Campaign Registry.",
        "readOnly":true
       },
       "numberKeys":{
        "type":"array",
        "description":"The numberKey(s) of the numbers to use with the campaign. Alternatively, you can use the 'numbers' property to specify the numbers directly, but note that 'numberKeys' property takes precedence if both are specified. ",
        "externalDocs":{
         "description":"Find out more about numbers.",
         "url":"#platform-&-connectivity/numbers"
        },
        "items":{
         "type":"string"
        },
        "maxItems":49,
        "minItems":0,
        "uniqueItems":true
       },
       "numbers":{
        "type":"array",
        "description":"US 10DLC numbers to use with the campaign. You may only use numbers that are associated with your account inside the Infobip platform. Numbers must be provided in international format including the country prefix, e.g. 14232180111. This property can be used instead of 'numberKeys' to specify the campaign numbers; it is not returned in the API response. ",
        "externalDocs":{
         "description":"Find out more about numbers.",
         "url":"#platform-&-connectivity/numbers"
        },
        "items":{
         "type":"string",
         "description":"US 10DLC numbers to use with the campaign. You may only use numbers that are associated with your account inside the Infobip platform. Numbers must be provided in international format including the country prefix, e.g. 14232180111. This property can be used instead of 'numberKeys' to specify the campaign numbers; it is not returned in the API response. ",
         "externalDocs":{
          "description":"Find out more about numbers.",
          "url":"#platform-&-connectivity/numbers"
         },
         "writeOnly":true
        },
        "maxItems":49,
        "minItems":0,
        "uniqueItems":true,
        "writeOnly":true
       },
       "numberPreviews":{
        "type":"array",
        "description":"The number(s) to use with the campaign. This property is read-only and ignored in POST/PUT calls.",
        "items":{
         "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.NumberPreview"
        },
        "readOnly":true,
        "uniqueItems":true
       },
       "numberPool":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.NumberPool"
       }
      }
     }
    ],
    "required":[
     "brandId",
     "confirmationMessage",
     "customerCareEmail",
     "customerCarePhone",
     "exampleMessages",
     "helpMessage",
     "lowVolume",
     "messageTypes",
     "name",
     "optIns",
     "programSummary",
     "stopMessage",
     "termsAndConditionsUrl",
     "useCases"
    ],
    "title":"TenDlcCampaign"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TenDlcCampaignBuilderRequest":{
    "type":"object",
    "allOf":[
     {
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderRequest"
     },
     {
      "type":"object",
      "properties":{
       "campaignAttributes":{
        "type":"array",
        "description":"Campaign attributes indicating special content characteristics.",
        "items":{
         "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderCampaignAttributes"
        },
        "uniqueItems":true
       }
      }
     }
    ],
    "description":"Request to start building 10DLC campaign using AI assistant.",
    "required":[
     "brandId",
     "campaignIntent",
     "campaignType",
     "contactEmail",
     "optInMethods"
    ],
    "title":"TenDlcCampaignBuilderRequest"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TenDlcCampaignBuilderResultData":{
    "type":"object",
    "allOf":[
     {
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderResultData"
     },
     {
      "type":"object",
      "properties":{
       "useCase":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TenDlcUseCase"
       },
       "messageFlow":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TenDlcCampaignBuilderResultMessageFlow"
       },
       "termsConditions":{
        "type":"string",
        "writeOnly":true
       },
       "privacyPolicy":{
        "type":"string",
        "writeOnly":true
       }
      }
     }
    ],
    "description":"Campaign builder result for 10DLC campaigns.",
    "title":"TenDlcCampaignBuilderResultData"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TenDlcCampaignBuilderResultMessageFlow":{
    "type":"object",
    "description":"Campaign message flow for 10DLC campaigns",
    "properties":{
     "optInMessage":{
      "type":"string",
      "description":"Opt-in confirmation message"
     },
     "exampleMessage1":{
      "type":"string",
      "description":"First example message"
     },
     "exampleMessage2":{
      "type":"string",
      "description":"Second example message"
     },
     "helpMessage":{
      "type":"string",
      "description":"Help response message"
     },
     "optOutMessage":{
      "type":"string",
      "description":"Opt-out response message"
     }
    },
    "title":"TenDlcCampaignBuilderResultMessageFlow"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TenDlcUseCase":{
    "type":"string",
    "description":"Campaign use case.",
    "enum":[
     "ALERTS",
     "CHAT",
     "DONATION",
     "EDUCATION",
     "FRAUD_ALERTS",
     "PROMOTIONAL_MARKETING",
     "PUBLIC_SERVICE_ANNOUNCEMENT",
     "TWO_FACTOR_AUTH",
     "VOTING_POLLING",
     "POLITICAL",
     "M2M",
     "SWEEPSTAKE"
    ],
    "title":"TenDlcUseCase"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TollFreeBrand":{
    "type":"object",
    "allOf":[
     {
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Brand"
     },
     {
      "type":"object",
      "properties":{
       "referenceId":{
        "type":"string",
        "description":"Unique user defined ID for the brand. While not required, it is recommended to supply a referenceId as the uniqueness constraint will help ensure a brand is not accidentally created multiple times. Subsequent create requests with the same referenceId will be rejected with an error.",
        "maxLength":50,
        "minLength":0
       },
       "taxId":{
        "type":"string",
        "description":"The tax identifier for the brand. Not required for sole proprietor brands.",
        "maxLength":50,
        "minLength":0
       },
       "taxIdIssuingCountry":{
        "type":"string",
        "description":"The country where tax identifier is issued. If not specified, the value from countryCode will be used.",
        "maxLength":2,
        "minLength":1
       },
       "address":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Address"
       },
       "countryCode":{
        "type":"string",
        "description":"The country where the brand is located.",
        "maxLength":2,
        "minLength":1
       },
       "supportPhone":{
        "type":"string",
        "description":"The business phone number to contact about brand compliance issues.",
        "maxLength":16,
        "minLength":3,
        "pattern":"\\+?[1-9]\\d{1,14}"
       },
       "supportEmail":{
        "type":"string",
        "description":"The business email address to contact about brand compliance issues. Must be a well formed email address that does not include a '=' character."
       },
       "businessContactFirstName":{
        "type":"string",
        "description":"First name of the primary contact person for the brand or business entity. Used for verification or compliance outreach.",
        "maxLength":100,
        "minLength":1
       },
       "businessContactLastName":{
        "type":"string",
        "description":"Last name of the primary contact person for the brand or business entity.",
        "maxLength":100,
        "minLength":1
       },
       "businessDBA":{
        "type":"string",
        "description":"'Doing Business As' name if different from the legal business name.",
        "maxLength":500,
        "minLength":0
       },
       "legalName":{
        "type":"string",
        "description":"The legal name of the brand.",
        "maxLength":255,
        "minLength":1
       },
       "legalEntityType":{
        "type":"string",
        "description":"Legal entity type of the business.",
        "enum":[
         "PRIVATE_COMPANY",
         "PUBLIC_COMPANY",
         "NON_PROFIT",
         "GOVERNMENT",
         "SOLE_PROPRIETOR"
        ]
       },
       "businessRegistrationType":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BusinessRegistrationType"
       }
      }
     }
    ],
    "required":[
     "address",
     "businessContactFirstName",
     "businessContactLastName",
     "businessRegistrationType",
     "countryCode",
     "legalEntityType",
     "legalName",
     "name",
     "supportEmail",
     "supportPhone",
     "taxId",
     "type",
     "website"
    ],
    "title":"TollFreeBrand"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TollFreeCampaign":{
    "type":"object",
    "allOf":[
     {
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Campaign"
     },
     {
      "type":"object",
      "properties":{
       "brandId":{
        "type":"string",
        "format":"uuid",
        "description":"The ID of the brand to use with the campaign.",
        "externalDocs":{
         "description":"Find out more about Brands.",
         "url":"#platform-connectivity/number-registration/create-brand"
        }
       },
       "brandPreview":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandPreview"
       },
       "appealData":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.AppealData"
       },
       "privacyPolicyUrl":{
        "type":"string",
        "description":"Public URL to the privacy policy that outlines how user data is collected, stored, and used."
       },
       "termsAndConditionsUrl":{
        "type":"string",
        "description":"URL where the terms and conditions of the campaign are located."
       },
       "messageVolume":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TollFreeMessageVolume"
       },
       "numbers":{
        "type":"array",
        "description":"US TFN numbers to use with the campaign. Campaign must have at least one TFN number associated before it can be submitted for review. You may only use numbers that are associated with your account inside the Infobip platform. Numbers must be provided in international format including the country prefix, e.g. 18881234567. This property can be used instead of 'numberKeys' to specify the campaign numbers; it is not returned in the API response.",
        "items":{
         "type":"string",
         "description":"US TFN numbers to use with the campaign. Campaign must have at least one TFN number associated before it can be submitted for review. You may only use numbers that are associated with your account inside the Infobip platform. Numbers must be provided in international format including the country prefix, e.g. 18881234567. This property can be used instead of 'numberKeys' to specify the campaign numbers; it is not returned in the API response."
        },
        "uniqueItems":true,
        "writeOnly":true
       },
       "numberKeys":{
        "type":"array",
        "description":"The numberKey(s) of the numbers to use with the campaign. Campaign must have at least one TFN number associated before it can be submitted for review. Alternatively, you can use the 'numbers' property to specify the numbers directly, but note that 'numberKeys' property takes precedence if both are specified.",
        "items":{
         "type":"string"
        },
        "maxItems":25,
        "minItems":1,
        "uniqueItems":true
       },
       "numberPreviews":{
        "type":"array",
        "description":"The number(s) to use with the campaign. This property is read-only and ignored in POST/PUT calls.",
        "items":{
         "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.NumberPreview"
        },
        "readOnly":true,
        "uniqueItems":true
       },
       "useCase":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TollFreeUseCase"
       },
       "programSummary":{
        "type":"string",
        "description":"A brief description of the purpose of the campaign.",
        "maxLength":500,
        "minLength":0
       },
       "exampleMessage":{
        "type":"string",
        "description":"The example message(s) a user may receive from this campaign. Each example message must be at least 20 characters long.",
        "maxLength":1000,
        "minLength":0
       },
       "optIns":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.OptIns"
       },
       "optInImageURLs":{
        "type":"array",
        "description":"List of URLs linking to screenshots that show how end-users opt in to receive messages.",
        "items":{
         "type":"string",
         "description":"List of URLs linking to screenshots that show how end-users opt in to receive messages.",
         "pattern":"(?i)https?:\\/\\/\\S+"
        },
        "uniqueItems":true
       },
       "additionalInformation":{
        "type":"string",
        "description":"Free-form field for any extra details relevant to the campaign—such as custom use cases or compliance clarification.",
        "maxLength":500,
        "minLength":0
       },
       "customerCareEmail":{
        "type":"string",
        "description":"The email address the user may contact to get customer care.  Must be a well formed email address that does not include a '=' character.",
        "maxLength":255,
        "minLength":1
       },
       "campaignVerifyToken":{
        "type":"string",
        "description":"Campaign Verify token for POLITICAL campaigns."
       }
      }
     }
    ],
    "required":[
     "brandId",
     "customerCareEmail",
     "exampleMessage",
     "messageVolume",
     "name",
     "optInImageURLs",
     "optIns",
     "programSummary",
     "useCase"
    ],
    "title":"TollFreeCampaign"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TollFreeCampaignBuilderRequest":{
    "type":"object",
    "allOf":[
     {
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderRequest"
     }
    ],
    "description":"Request to start building Toll free campaign using AI assistant.",
    "required":[
     "brandId",
     "campaignIntent",
     "campaignType",
     "contactEmail",
     "optInMethods"
    ],
    "title":"TollFreeCampaignBuilderRequest"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TollFreeCampaignBuilderResultData":{
    "type":"object",
    "allOf":[
     {
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderResultData"
     },
     {
      "type":"object",
      "properties":{
       "useCase":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TollFreeUseCase"
       },
       "messageFlow":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TollFreeCampaignBuilderResultMessageFlow"
       },
       "channelNote":{
        "type":"string",
        "description":"Channel-specific note."
       },
       "termsConditions":{
        "type":"string",
        "writeOnly":true
       },
       "privacyPolicy":{
        "type":"string",
        "writeOnly":true
       }
      }
     }
    ],
    "description":"Campaign builder result for Toll Free Number campaigns.",
    "title":"TollFreeCampaignBuilderResultData"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TollFreeCampaignBuilderResultMessageFlow":{
    "type":"object",
    "description":"Campaign message flow for Toll Free Number campaigns",
    "properties":{
     "exampleMessage":{
      "type":"string",
      "description":"Example message"
     }
    },
    "title":"TollFreeCampaignBuilderResultMessageFlow"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TollFreeMessageVolume":{
    "type":"string",
    "enum":[
     "TEN",
     "HUNDRED",
     "THOUSAND",
     "TEN_THOUSAND",
     "HUNDRED_THOUSAND",
     "TWO_HUNDRED_FIFTY_THOUSAND",
     "FIVE_HUNDRED_THOUSAND",
     "SEVEN_HUNDRED_FIFTY_THOUSAND",
     "ONE_MILLION",
     "FIVE_MILLION",
     "TEN_MILLION_PLUS"
    ],
    "title":"TollFreeMessageVolume"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TollFreeUnifiedNumberCampaignApiModel":{
    "type":"object",
    "properties":{
     "id":{
      "type":"string",
      "format":"uuid",
      "description":"The identifier for the campaign.",
      "readOnly":true
     },
     "referenceId":{
      "type":"string",
      "description":"Unique user defined ID for the campaign. While not required, it is recommended to supply a referenceId as the uniqueness constraint will help ensure a campaign is not accidentally created multiple times. Subsequent create requests with the same referenceId will be rejected with an error.",
      "maxLength":50,
      "minLength":0
     },
     "applicationId":{
      "type":"string",
      "description":"CPaaS X property identifying an application, a use case or an environment on your system. It should only be set if you are using CPaaS X Applications with your traffic."
     },
     "entityId":{
      "type":"string",
      "description":"CPaaS X property identifying an unique actor on your system. Should only be set if you are using CPaaS X Applications with your traffic."
     },
     "name":{
      "type":"string",
      "description":"The name of the campaign.",
      "maxLength":30,
      "minLength":1,
      "pattern":"[A-Za-z0-9_ ]*"
     },
     "createdDate":{
      "type":"string",
      "format":"date-time",
      "description":"The date and time when the campaign was created.",
      "readOnly":true
     },
     "lastModifiedDate":{
      "type":"string",
      "format":"date-time",
      "description":"The date and time when the campaign was last modified.",
      "readOnly":true
     },
     "stage":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignStage"
     },
     "priority":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PriorityInfo"
     },
     "type":{
      "type":"string",
      "enum":[
       "TOLL_FREE_UNIFIED_NUMBER"
      ]
     },
     "campaignFeedback":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignFeedback"
     },
     "privacyPolicyUrl":{
      "type":"string",
      "description":"Public URL to the privacy policy that outlines how user data is collected, stored, and used."
     },
     "termsAndConditionsUrl":{
      "type":"string",
      "description":"URL where the terms and conditions of the campaign are located."
     },
     "messageVolume":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TollFreeMessageVolume"
     },
     "numbers":{
      "type":"array",
      "description":"US TFN numbers to use with the campaign. Campaign must have at least one TFN number associated before it can be submitted for review. You may only use numbers that are associated with your account inside the Infobip platform. Numbers must be provided in international format including the country prefix, e.g. 18881234567. This property can be used instead of 'numberKeys' to specify the campaign numbers; it is not returned in the API response.",
      "items":{
       "type":"string",
       "description":"US TFN numbers to use with the campaign. Campaign must have at least one TFN number associated before it can be submitted for review. You may only use numbers that are associated with your account inside the Infobip platform. Numbers must be provided in international format including the country prefix, e.g. 18881234567. This property can be used instead of 'numberKeys' to specify the campaign numbers; it is not returned in the API response."
      },
      "uniqueItems":true,
      "writeOnly":true
     },
     "numberKeys":{
      "type":"array",
      "description":"The numberKey(s) of the numbers to use with the campaign. Campaign must have at least one TFN number associated before it can be submitted for review. Alternatively, you can use the 'numbers' property to specify the numbers directly, but note that 'numberKeys' property takes precedence if both are specified.",
      "items":{
       "type":"string"
      },
      "maxItems":25,
      "minItems":1,
      "uniqueItems":true,
      "writeOnly":true
     },
     "numberPreviews":{
      "type":"array",
      "description":"The number(s) to use with the campaign. This property is read-only and ignored in POST/PUT calls.",
      "items":{
       "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.NumberPreview"
      },
      "readOnly":true,
      "uniqueItems":true
     },
     "useCase":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TollFreeUseCase"
     },
     "programSummary":{
      "type":"string",
      "description":"A brief description of the purpose of the campaign.",
      "maxLength":500,
      "minLength":0
     },
     "exampleMessage":{
      "type":"string",
      "description":"The example message(s) a user may receive from this campaign. Each example message must be at least 20 characters long.",
      "maxLength":1000,
      "minLength":0
     },
     "optIns":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.OptIns"
     },
     "optInImageURLs":{
      "type":"array",
      "description":"List of URLs linking to screenshots that show how end-users opt in to receive messages.",
      "items":{
       "type":"string",
       "description":"List of URLs linking to screenshots that show how end-users opt in to receive messages.",
       "pattern":"(?i)https?:\\/\\/\\S+"
      },
      "uniqueItems":true
     },
     "additionalInformation":{
      "type":"string",
      "description":"Free-form field for any extra details relevant to the campaign—such as custom use cases or compliance clarification.",
      "maxLength":500,
      "minLength":0
     },
     "countryCode":{
      "type":"string",
      "description":"The country where the brand is located.",
      "maxLength":2,
      "minLength":1
     },
     "address":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Address"
     },
     "supportPhone":{
      "type":"string",
      "description":"The business phone number to contact about brand compliance issues.",
      "maxLength":16,
      "minLength":3,
      "pattern":"\\+?[1-9]\\d{1,14}"
     },
     "supportEmail":{
      "type":"string",
      "description":"The business email address to contact about brand compliance issues. Must be a well formed email address that does not include a '=' character."
     },
     "businessContactFirstName":{
      "type":"string",
      "description":"First name of the primary contact person for the brand or business entity. Used for verification or compliance outreach.",
      "maxLength":100,
      "minLength":1
     },
     "businessContactLastName":{
      "type":"string",
      "description":"Last name of the primary contact person for the brand or business entity.",
      "maxLength":100,
      "minLength":1
     },
     "legalName":{
      "type":"string",
      "description":"The legal name of the brand.",
      "maxLength":255,
      "minLength":1
     },
     "businessDBA":{
      "type":"string",
      "description":"'Doing Business As' name if different from the legal business name.",
      "maxLength":500,
      "minLength":0
     },
     "businessName":{
      "type":"string",
      "description":"The customer defined name of brand or business entity.",
      "maxLength":500,
      "minLength":0
     },
     "businessWebsite":{
      "type":"string",
      "description":"The website for the brand or business entity.",
      "maxLength":500,
      "minLength":0
     },
     "customerCareEmail":{
      "type":"string",
      "description":"The email address the user may contact to get customer care.  Must be a well formed email address that does not include a '=' character.",
      "maxLength":255,
      "minLength":1
     },
     "taxId":{
      "type":"string",
      "description":"The tax identifier for the brand. Not required for sole proprietor brands.",
      "maxLength":50,
      "minLength":0
     },
     "taxIdIssuingCountry":{
      "type":"string",
      "description":"The country where tax identifier is issued. If not specified, the value from countryCode will be used.",
      "maxLength":2,
      "minLength":1
     },
     "legalEntityType":{
      "type":"string",
      "description":"Legal entity type of the business.",
      "enum":[
       "PRIVATE_COMPANY",
       "PUBLIC_COMPANY",
       "NON_PROFIT",
       "GOVERNMENT",
       "SOLE_PROPRIETOR"
      ]
     },
     "businessRegistrationType":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BusinessRegistrationType"
     },
     "campaignVerifyToken":{
      "type":"string",
      "description":"Campaign Verify token for POLITICAL campaigns."
     },
     "priorityId":{
      "type":"string",
      "format":"uuid",
      "description":"Priority information used in latest campaign review.",
      "writeOnly":true
     }
    },
    "required":[
     "businessContactFirstName",
     "businessContactLastName",
     "businessWebsite",
     "customerCareEmail",
     "exampleMessage",
     "legalEntityType",
     "legalName",
     "messageVolume",
     "name",
     "numberKeys",
     "optInImageURLs",
     "optIns",
     "programSummary",
     "supportEmail",
     "supportPhone",
     "useCase"
    ],
    "title":"TollFreeUnifiedNumberCampaignApiModel"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TollFreeUseCase":{
    "type":"string",
    "description":"Campaign use case.",
    "enum":[
     "TWO_FA",
     "APP_NOTIFICATIONS",
     "APPOINTMENTS",
     "AUCTIONS",
     "AUTO_DEALERSHIP_SERVICES",
     "BANKING",
     "BILLING",
     "BOOKING_CONFIRMATIONS",
     "BUSINESS_UPDATES",
     "COVID_19_ALERTS",
     "CAREER_TRAINING",
     "CHATBOT",
     "CONVERSATIONAL_ALERTS",
     "COURIER_SERVICES_DELIVERIES",
     "EDUCATIONAL",
     "EMERGENCY_ALERTS",
     "EMPLOYEE_ALERTS_NOTIFICATIONS",
     "EVENTS_PLANNING",
     "FINANCIAL_SERVICES",
     "FRAUD_ALERTS",
     "FUNDRAISING",
     "GENERAL_MARKETING",
     "HR_STAFFING",
     "HEALTHCARE",
     "HOUSING_COMMUNITY_UPDATES",
     "INSURANCE_SERVICES",
     "JOB_ALERTS",
     "LEGAL_SERVICES",
     "MIXED",
     "MOTIVATIONAL_REMINDERS",
     "NOTARY_NOTIFICATIONS",
     "NOTIFICATIONS",
     "ORDER_NOTIFICATIONS",
     "POLITICAL",
     "PUBLIC_WORKS",
     "REAL_ESTATE_SERVICES",
     "RECEIPT_NOTIFICATIONS",
     "RELIGIOUS_SERVICES",
     "REPAIR_DIAGNOSTICS_ALERTS",
     "REWARDS_PROGRAM",
     "SURVEYS",
     "SYSTEM_ALERTS",
     "WAITLIST_ALERTS",
     "WEBINAR_REMINDERS",
     "WORKSHOP_ALERTS"
    ],
    "title":"TollFreeUseCase"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.UpdateCampaignRegistrationRequest":{
    "type":"object",
    "properties":{
     "numberKeys":{
      "type":"array",
      "description":"The numberKey(s) of the numbers to use with the campaign. Alternatively, you can use the 'numbers' property to specify the numbers directly, but note that 'numberKeys' property takes precedence if both are specified.  Total limit for Number pooling campaigns is 35000 instead of 49. You can add or remove up to 5000 numbers at a time for Number pooling campaigns.",
      "externalDocs":{
       "description":"Find out more about numbers.",
       "url":"#platform-&-connectivity/numbers"
      },
      "items":{
       "type":"string",
       "description":"The numberKey(s) of the numbers to use with the campaign. Alternatively, you can use the 'numbers' property to specify the numbers directly, but note that 'numberKeys' property takes precedence if both are specified.  Total limit for Number pooling campaigns is 35000 instead of 49. You can add or remove up to 5000 numbers at a time for Number pooling campaigns.",
       "externalDocs":{
        "description":"Find out more about numbers.",
        "url":"#platform-&-connectivity/numbers"
       }
      },
      "maxItems":5000,
      "minItems":0,
      "uniqueItems":true
     },
     "numbers":{
      "type":"array",
      "description":"US 10DLC numbers to use with the campaign. You may only use numbers that are associated with your account inside the Infobip platform. Numbers must be provided in international format including the country prefix, e.g. 14232180111. This property can be used instead of 'numberKeys' to specify the campaign numbers; it is not returned in the API response.  Total limit for Number pooling campaigns is 35000 instead of 49. You can add or remove up to 5000 numbers at a time for Number pooling campaigns. ",
      "externalDocs":{
       "description":"Find out more about numbers.",
       "url":"#platform-&-connectivity/numbers"
      },
      "items":{
       "type":"string",
       "description":"US 10DLC numbers to use with the campaign. You may only use numbers that are associated with your account inside the Infobip platform. Numbers must be provided in international format including the country prefix, e.g. 14232180111. This property can be used instead of 'numberKeys' to specify the campaign numbers; it is not returned in the API response.  Total limit for Number pooling campaigns is 35000 instead of 49. You can add or remove up to 5000 numbers at a time for Number pooling campaigns. ",
       "externalDocs":{
        "description":"Find out more about numbers.",
        "url":"#platform-&-connectivity/numbers"
       }
      },
      "maxItems":5000,
      "minItems":0,
      "uniqueItems":true,
      "writeOnly":true
     }
    },
    "title":"UpdateCampaignRegistrationRequest"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.UploadDocumentApiDoc":{
    "type":"object",
    "properties":{
     "document":{
      "type":"string",
      "format":"binary",
      "description":"The document file to be uploaded."
     }
    },
    "required":[
     "document"
    ],
    "title":"UploadDocumentApiDoc"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.VerbalOptIn":{
    "type":"object",
    "description":"The type of opt in that requires a user to verbally confirm.",
    "properties":{
     "callToAction":{
      "type":"string",
      "description":"    The message sent to the user to tell them how to subscribe. Must include:\n    • Product description\n    • Message frequency disclosure\n    • Complete terms and conditions OR link to complete terms and conditions\n    • Privacy policy OR link to privacy policy\n    • STOP keyword\n    • The \"Message and data rates may apply\" disclosure\n",
      "maxLength":1024,
      "minLength":20
     }
    },
    "required":[
     "callToAction"
    ],
    "title":"VerbalOptIn"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Vertical":{
    "type":"string",
    "description":"The vertical in which the brand operates.",
    "enum":[
     "AGRICULTURE",
     "CONSTRUCTION_AND_MATERIALS",
     "EDUCATION",
     "ENERGY_AND_UTILITIES",
     "ENTERTAINMENT",
     "FINANCIAL_SERVICES",
     "GAMBLING_AND_LOTTERY",
     "HEALTHCARE_AND_LIFESCIENCES",
     "HOSPITALITY",
     "INFORMATION_TECHNOLOGY_SERVICES",
     "INSURANCE",
     "MANUFACTURING",
     "MASS_MEDIA_AND_COMMUNICATION",
     "NON_PROFIT_ORGANIZATION",
     "PUBLIC_SECTOR",
     "REAL_ESTATE",
     "RETAIL_AND_CONSUMER_PRODUCTS",
     "PROFESSIONAL_SERVICES",
     "HUMAN_RESOURCES_STAFFING_RECRUITMENT",
     "TRANSPORTATION_LOGISTICS",
     "POSTAL_DELIVERY",
     "LEGAL",
     "POLITICAL"
    ],
    "title":"Vertical"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.VetImportRequest":{
    "type":"object",
    "discriminator":{
     "propertyName":"type",
     "mapping":{
      "AEGIS_MOBILE":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.AegisVetImportRequest",
      "CAMPAIGN_VERIFY":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CvVetImportRequest",
      "WMC_GLOBAL":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.WmcVetImportRequest"
     }
    },
    "properties":{
     "type":{
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.VettingProvider"
     }
    },
    "required":[
     "type"
    ],
    "title":"VetImportRequest"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.VettingProvider":{
    "type":"string",
    "description":"Provider for imported brand vet.",
    "enum":[
     "AEGIS_MOBILE",
     "CAMPAIGN_VERIFY",
     "WMC_GLOBAL"
    ],
    "title":"VettingProvider"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.VettingType":{
    "type":"string",
    "description":"The type of vet.",
    "enum":[
     "STANDARD",
     "ENHANCED",
     "POLITICAL"
    ],
    "title":"VettingType"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.WebOptIn":{
    "type":"object",
    "description":"The type of opt in that requires a user to follow a URL.",
    "properties":{
     "callToAction":{
      "type":"string",
      "description":"    The message sent to the user to tell them how to subscribe. Must include:\n    • Product description\n    • Message frequency disclosure\n    • Complete terms and conditions OR link to complete terms and conditions\n    • Privacy policy OR link to privacy policy\n    • STOP keyword\n    • The \"Message and data rates may apply\" disclosure\n",
      "maxLength":1024,
      "minLength":20
     },
     "url":{
      "type":"string",
      "maxLength":255,
      "minLength":11
     }
    },
    "required":[
     "callToAction"
    ],
    "title":"WebOptIn"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.WebhookBrandRegistrationStatus":{
    "type":"string",
    "description":"The new brand registration status.",
    "enum":[
     "SUCCESS",
     "FAILURE",
     "PENDING",
     "PENDING_2FA"
    ],
    "example":"FAILURE",
    "title":"WebhookBrandRegistrationStatus"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.WebhookBrandVetStatus":{
    "type":"string",
    "description":"The new brand vet status.",
    "enum":[
     "SUCCESS",
     "FAILURE"
    ],
    "example":"SUCCESS",
    "title":"WebhookBrandVetStatus"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.WebhookBrandVettingType":{
    "type":"string",
    "description":"The type of brand vet.",
    "enum":[
     "STANDARD",
     "ENHANCED"
    ],
    "example":"STANDARD",
    "title":"WebhookBrandVettingType"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.WebhookCampaignNetworkStatus":{
    "type":"string",
    "description":"The new campaign registration status for a given network.",
    "enum":[
     "ACTIVE"
    ],
    "example":"ACTIVE",
    "title":"WebhookCampaignNetworkStatus"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.WebhookCampaignStage":{
    "type":"string",
    "description":"The new campaign registration.",
    "enum":[
     "REGISTERED",
     "REJECTED",
     "DEREGISTERED",
     "SUBMITTED",
     "APPROVED_BY_INTERNAL_REVIEWER"
    ],
    "example":"REJECTED",
    "title":"WebhookCampaignStage"
   },
   "2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.WmcVetImportRequest":{
    "type":"object",
    "allOf":[
     {
      "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.VetImportRequest"
     },
     {
      "type":"object",
      "properties":{
       "transactionId":{
        "type":"string",
        "description":"WMC Global transaction ID"
       }
      }
     }
    ],
    "required":[
     "transactionId",
     "type"
    ],
    "title":"WmcVetImportRequest"
   },
   "4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Address":{
    "type":"object",
    "description":"Address of an Emergency Service.",
    "properties":{
     "name":{
      "type":"string",
      "description":"Emergency Service address name.",
      "maxLength":100,
      "minLength":0
     },
     "streetName":{
      "type":"string",
      "description":"Emergency Service address street.",
      "maxLength":100,
      "minLength":0
     },
     "streetNumber":{
      "type":"string",
      "description":"Emergency Service address street number.",
      "maxLength":20,
      "minLength":0
     },
     "city":{
      "type":"string",
      "description":"Emergency Service address city.",
      "maxLength":50,
      "minLength":0
     },
     "countryCode":{
      "type":"string",
      "description":"Emergency Service address country code.",
      "maxLength":2,
      "minLength":2
     },
     "stateCode":{
      "type":"string",
      "description":"Emergency Service address state code.",
      "maxLength":2,
      "minLength":2
     },
     "zipCode":{
      "type":"string",
      "description":"Emergency Service address zip code.",
      "maxLength":10,
      "minLength":5
     },
     "direction":{
      "$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Direction"
     },
     "suite":{
      "type":"string",
      "description":"Emergency Service address suite."
     }
    },
    "required":[
     "city",
     "countryCode",
     "name",
     "stateCode",
     "streetName",
     "streetNumber",
     "zipCode"
    ],
    "title":"Address"
   },
   "4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CnamDelivery":{
    "type":"object",
    "description":"CNAM Delivery is enabled on your DID at an additional charge that allows you to see the caller identification of the person calling you.",
    "properties":{
     "enabled":{
      "type":"boolean",
      "default":false,
      "description":"Indicates whether configuration is enabled or not."
     }
    },
    "title":"CnamDelivery"
   },
   "4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CnamStorage":{
    "type":"object",
    "description":"CNAM Storage is an up to 15-character name that will identify you to the person that you are calling if they subscribe to caller ID.",
    "properties":{
     "enabled":{
      "type":"boolean",
      "default":false,
      "description":"Indicates whether configuration is enabled or not."
     },
     "name":{
      "type":"string",
      "description":"Name that will identify you to the person that you are calling.",
      "maxLength":15,
      "minLength":0
     }
    },
    "required":[
     "name"
    ],
    "title":"CnamStorage"
   },
   "4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Direction":{
    "type":"string",
    "description":"Emergency Service address direction.",
    "enum":[
     "NORTH",
     "EAST",
     "SOUTH",
     "WEST"
    ],
    "title":"Direction"
   },
   "4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicCnamDeliveryStatus":{
    "type":"object",
    "description":"Current status of CNAM Delivery configuration.",
    "properties":{
     "status":{
      "$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Status"
     },
     "reason":{
      "type":"string",
      "description":"Description of the status."
     }
    },
    "title":"PublicCnamDeliveryStatus"
   },
   "4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicCnamStorageStatus":{
    "type":"object",
    "description":"Current status of CNAM Storage configuration.",
    "properties":{
     "status":{
      "$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Status"
     },
     "reason":{
      "type":"string",
      "description":"Description of the status."
     }
    },
    "title":"PublicCnamStorageStatus"
   },
   "4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Status":{
    "type":"string",
    "description":"Current bulk status.",
    "enum":[
     "PENDING",
     "PAUSED",
     "PROCESSING",
     "CANCELED",
     "FINISHED",
     "FAILED"
    ],
    "example":"PENDING",
    "title":"Status"
   },
   "4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.StatusResponse":{
    "type":"object",
    "description":"Current status of Emergency Service configuration.",
    "properties":{
     "status":{
      "$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Status"
     },
     "reason":{
      "type":"string",
      "description":"Description of the status."
     }
    },
    "title":"StatusResponse"
   },
   "7635fa9e013ed171bbe9743a6ca322c3b2b29e7574931e38f0de0bda9687aadf.EmergencyAddress":{
    "type":"object",
    "properties":{
     "enabled":{
      "type":"boolean",
      "default":false,
      "description":"Indicates whether configuration is enabled or not."
     },
     "address":{
      "$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Address"
     }
    },
    "required":[
     "address",
     "enabled"
    ],
    "title":"EmergencyAddress"
   },
   "7635fa9e013ed171bbe9743a6ca322c3b2b29e7574931e38f0de0bda9687aadf.EmergencyAddressStatus":{
    "type":"object",
    "properties":{
     "emergencyService":{
      "$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.StatusResponse"
     }
    },
    "title":"EmergencyAddressStatus"
   },
   "7635fa9e013ed171bbe9743a6ca322c3b2b29e7574931e38f0de0bda9687aadf.ValidateAddressResponse":{
    "type":"object",
    "properties":{
     "validAddresses":{
      "type":"array",
      "description":"List of physical valid addresses that matches your input.",
      "items":{
       "$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Address"
      }
     }
    },
    "title":"ValidateAddressResponse"
   },
   "7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.AutoResponseAction":{
    "type":"object",
    "allOf":[
     {
      "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoNonForwardAction"
     },
     {
      "type":"object",
      "properties":{
       "message":{
        "type":"string",
        "description":"Text that will be sent as response message.",
        "maxLength":1080,
        "minLength":0
       },
       "sender":{
        "type":"string",
        "default":"null",
        "description":"If set, response message will be sent from this sender, not from MO receiver."
       },
       "deliveryTimeWindow":{
        "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.DeliveryTimeWindow"
       }
      }
     }
    ],
    "description":"Used for sending message as automatic response for received message.",
    "required":[
     "message",
     "type"
    ],
    "title":"AutoResponseAction"
   },
   "7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.BlockAction":{
    "type":"object",
    "allOf":[
     {
      "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoNonForwardAction"
     },
     {
      "type":"object",
      "properties":{
       "blockType":{
        "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.BlockActionType"
       }
      }
     }
    ],
    "description":"Used for blocking MT messages.",
    "required":[
     "blockType",
     "type"
    ],
    "title":"BlockAction"
   },
   "7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.BlockActionType":{
    "type":"string",
    "description":"Block type.",
    "enum":[
     "FROM_ANY_SENDER",
     "FROM_SENDER"
    ],
    "title":"BlockActionType"
   },
   "7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ContentType":{
    "type":"string",
    "description":"Specifies content type.",
    "enum":[
     "JSON",
     "XML"
    ],
    "title":"ContentType"
   },
   "7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.DayOfWeek":{
    "type":"string",
    "description":"Days which are included in the delivery time window.",
    "enum":[
     "MONDAY",
     "TUESDAY",
     "WEDNESDAY",
     "THURSDAY",
     "FRIDAY",
     "SATURDAY",
     "SUNDAY"
    ],
    "title":"DayOfWeek"
   },
   "7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.DeliveryTimeWindow":{
    "type":"object",
    "description":"Used to specify a time-window in which a response message is allowed to be sent. If not defined there is no limitation when message will be sent.",
    "properties":{
     "from":{
      "type":"string",
      "description":"Exact time of day in which the sending can start. Consists of hour and minute properties, both mandatory. Time is expressed in the UTC time zone. Formatted as <code>HH:mm</code>.",
      "example":"08:35"
     },
     "to":{
      "type":"string",
      "description":"Exact time of day in which the sending will end. Consists of an hour and minute properties, both mandatory. Time is expressed in the UTC time zone. Formatted as <code>HH:mm</code>.",
      "example":"16:35"
     },
     "days":{
      "type":"array",
      "description":"Days which are included in the delivery time window.",
      "items":{
       "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.DayOfWeek"
      },
      "maxItems":7,
      "minItems":1,
      "uniqueItems":true
     },
     "deliveryTimeZone":{
      "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.DeliveryTimeZone"
     }
    },
    "required":[
     "days",
     "from",
     "to"
    ],
    "title":"DeliveryTimeWindow"
   },
   "7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.DeliveryTimeZone":{
    "type":"string",
    "description":"Sending time zone. If <code>null</code> is sent, <code>User time zone</code> will be set.",
    "enum":[
     "USER_TIME_ZONE",
     "DESTINATION_TIME_ZONE"
    ],
    "title":"DeliveryTimeZone"
   },
   "7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.EditPermissions":{
    "type":"object",
    "description":"The editPermissions object to indicate editing permissions for the number.",
    "properties":{
     "canEditNumber":{
      "type":"boolean",
      "description":"Indicates whether the permissions allow for editing a number."
     },
     "canEditConfiguration":{
      "type":"boolean",
      "description":"Indicates whether the  the permissions allow for editing number configuration."
     }
    },
    "title":"EditPermissions"
   },
   "7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ExternalIntegrationType":{
    "type":"string",
    "enum":[
     "MICROSOFT_ACS"
    ],
    "title":"ExternalIntegrationType"
   },
   "7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ForwardToCallRoutingDetails":{
    "type":"object",
    "allOf":[
     {
      "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.VoiceActionDetails"
     },
     {
      "type":"object",
      "properties":{
       "routeId":{
        "type":"string",
        "description":"Unique identifier of a route."
       }
      }
     }
    ],
    "title":"ForwardToCallRoutingDetails"
   },
   "7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ForwardToExternalIntegrationAction":{
    "type":"object",
    "allOf":[
     {
      "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoAction"
     },
     {
      "type":"object",
      "properties":{
       "integrationType":{
        "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ExternalIntegrationType"
       }
      }
     }
    ],
    "required":[
     "integrationType"
    ],
    "title":"ForwardToExternalIntegrationAction"
   },
   "7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ForwardToIvrActionDetails":{
    "type":"object",
    "allOf":[
     {
      "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.VoiceActionDetails"
     },
     {
      "type":"object",
      "properties":{
       "scenarioKey":{
        "type":"string",
        "description":"Unique ID of the IVR scenario."
       }
      }
     }
    ],
    "required":[
     "scenarioKey"
    ],
    "title":"ForwardToIvrActionDetails"
   },
   "7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ForwardToMarkupLanguageDetails":{
    "type":"object",
    "allOf":[
     {
      "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.VoiceActionDetails"
     },
     {
      "type":"object",
      "properties":{
       "markupLanguageConfigId":{
        "type":"integer",
        "format":"int64",
        "description":"Unique ID of the Markup Language."
       }
      }
     }
    ],
    "required":[
     "markupLanguageConfigId"
    ],
    "title":"ForwardToMarkupLanguageDetails"
   },
   "7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ForwardToPstnActionDetails":{
    "type":"object",
    "allOf":[
     {
      "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.VoiceActionDetails"
     },
     {
      "type":"object",
      "properties":{
       "pstnNumber":{
        "type":"string",
        "minLength":1
       }
      }
     }
    ],
    "required":[
     "pstnNumber"
    ],
    "title":"ForwardToPstnActionDetails"
   },
   "7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ForwardToSubscriptionDetails":{
    "type":"object",
    "allOf":[
     {
      "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.VoiceActionDetails"
     },
     {
      "type":"object",
      "properties":{
       "callsConfigurationId":{
        "type":"string",
        "description":"Unique identifier of a Calls Configuration."
       }
      }
     }
    ],
    "title":"ForwardToSubscriptionDetails"
   },
   "7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.HttpForwardAction":{
    "type":"object",
    "allOf":[
     {
      "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoAction"
     },
     {
      "type":"object",
      "properties":{
       "url":{
        "type":"string",
        "description":"Specifies URL where message will be pushed.",
        "minLength":1
       },
       "httpMethod":{
        "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.HttpMethod"
       },
       "contentType":{
        "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ContentType"
       }
      }
     }
    ],
    "description":"Used for HTTP push. MO message parameters can be pushed to specified URL in defined format.",
    "required":[
     "url"
    ],
    "title":"HttpForwardAction"
   },
   "7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.HttpMethod":{
    "type":"string",
    "description":"Specifies push format.",
    "enum":[
     "GET",
     "POST"
    ],
    "title":"HttpMethod"
   },
   "7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MailForwardAction":{
    "type":"object",
    "allOf":[
     {
      "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoAction"
     },
     {
      "type":"object",
      "properties":{
       "mail":{
        "type":"string",
        "description":"Specifies e-mail destination.",
        "minLength":1
       }
      }
     }
    ],
    "description":"Used for sending e-mail to specified destination.",
    "required":[
     "mail"
    ],
    "title":"MailForwardAction"
   },
   "7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MmsAction":{
    "type":"object",
    "description":"Forward action configuration.",
    "discriminator":{
     "propertyName":"type",
     "mapping":{
      "HTTP_FORWARD":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MmsHttpForwardAction",
      "PULL":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MmsPullAction",
      "NO_ACTION":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MmsNoAction"
     }
    },
    "properties":{
     "type":{
      "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoActionType"
     },
     "description":{
      "type":"string",
      "description":"Additional action description."
     }
    },
    "title":"MmsAction"
   },
   "7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MmsConfiguration":{
    "type":"object",
    "properties":{
     "keyword":{
      "type":"string",
      "description":"Configuration keyword.",
      "maxLength":50,
      "minLength":0
     },
     "action":{
      "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MmsAction"
     },
     "otherActions":{
      "type":"array",
      "description":"List of other configured action types/names on this keyword. Ignored in POST/PUT calls.",
      "items":{
       "type":"string",
       "description":"List of other configured action types/names on this keyword. Ignored in POST/PUT calls.",
       "readOnly":true
      },
      "readOnly":true
     },
     "applicationId":{
      "type":"string",
      "description":"ID of the Application that would be associated with the configuration.",
      "externalDocs":{
       "description":"Find out more about Application and Application Management",
       "url":"https://www.infobip.com/docs/api/platform/application-entity"
      },
      "maxLength":255,
      "minLength":0
     },
     "entityId":{
      "type":"string",
      "description":"ID of the Entity that would be associated with the configuration.",
      "externalDocs":{
       "description":"Find out more about Entity and Entity Management",
       "url":"https://www.infobip.com/docs/api/platform/application-entity"
      },
      "maxLength":255,
      "minLength":0
     },
     "key":{
      "type":"string",
      "description":"Unique ID of configuration.",
      "readOnly":true
     }
    },
    "required":[
     "action"
    ],
    "title":"MmsConfiguration"
   },
   "7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MmsConfigurations":{
    "type":"object",
    "properties":{
     "configurations":{
      "type":"array",
      "items":{
       "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MmsConfiguration"
      }
     },
     "totalCount":{
      "type":"integer",
      "format":"int32"
     }
    },
    "title":"MmsConfigurations"
   },
   "7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MmsHttpForwardAction":{
    "type":"object",
    "allOf":[
     {
      "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MmsAction"
     },
     {
      "type":"object",
      "properties":{
       "url":{
        "type":"string",
        "description":"Specifies URL where message will be pushed.",
        "minLength":1
       },
       "contentFormat":{
        "type":"string",
        "default":"MMS_JSON",
        "description":"Specifies pushed content format."
       }
      }
     }
    ],
    "description":"Used for HTTP push. MO message parameters can be pushed to specified URL in defined format.",
    "required":[
     "url"
    ],
    "title":"MmsHttpForwardAction"
   },
   "7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MmsNoAction":{
    "type":"object",
    "allOf":[
     {
      "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MmsAction"
     }
    ],
    "title":"MmsNoAction"
   },
   "7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MmsPullAction":{
    "type":"object",
    "allOf":[
     {
      "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MmsAction"
     }
    ],
    "description":"This action is used to pull all paired messages on specific resource.",
    "title":"MmsPullAction"
   },
   "7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoAction":{
    "type":"object",
    "description":"Forward action configuration.",
    "discriminator":{
     "propertyName":"type",
     "mapping":{
      "HTTP_FORWARD":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.HttpForwardAction",
      "MAIL_FORWARD":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MailForwardAction",
      "SMPP_FORWARD":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.SmppForwardAction",
      "PULL":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.PullAction",
      "FORWARD_TO_EXTERNAL_INTEGRATION":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ForwardToExternalIntegrationAction",
      "NO_ACTION":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NoAction"
     }
    },
    "properties":{
     "type":{
      "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoActionType"
     },
     "description":{
      "type":"string",
      "description":"Additional action description.",
      "example":"My description."
     }
    },
    "title":"MoAction"
   },
   "7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoActionType":{
    "type":"string",
    "description":"Defines action type. It is not possible to create new action type.",
    "enum":[
     "PULL",
     "HTTP_FORWARD",
     "SMPP_FORWARD",
     "MAIL_FORWARD",
     "NO_ACTION",
     "BLOCK",
     "AUTORESPONSE",
     "USSD",
     "SEND_BULK_MT",
     "EMAIL_TO_SMS_FORWARD",
     "CNS_FWD",
     "USE_CONVERSATIONS",
     "FORWARD_TO_PSTN",
     "FORWARD_TO_IP",
     "FORWARD_TO_IVR",
     "VOICE_NUMBER_MASKING",
     "VOICE_CALL_DROP",
     "FORWARD_TO_WEBRTC",
     "VOICE_FORWARD_TO_CONVERSATIONS",
     "VOICE_FORWARD_TO_CONVERSATIONS_WITH_FLOW",
     "CALL_FORWARD_TO_APPLICATION",
     "FORWARD_TO_SUBSCRIPTION",
     "FORWARD_TO_CALL_ROUTING",
     "USE_ANSWERS",
     "VOICE_FORWARD_TO_ANSWERS",
     "VOICE_FORWARD_TO_FLOW",
     "VOICE_FORWARD_TO_FLOW_WITH_CONVERSATIONS",
     "FORWARD_TO_OPERATOR_CONNECT",
     "FORWARD_TO_EXTERNAL_INTEGRATION",
     "FORWARD_TO_AI_AGENT",
     "FORWARD_TO_MARKUP_LANGUAGE",
     "OTHER"
    ],
    "title":"MoActionType"
   },
   "7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoConfiguration":{
    "type":"object",
    "properties":{
     "keyword":{
      "type":"string",
      "description":"Configuration keyword.",
      "maxLength":50,
      "minLength":0
     },
     "action":{
      "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoAction"
     },
     "useConversation":{
      "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.UseConversation"
     },
     "otherActionsDetails":{
      "type":"array",
      "description":"List of other configured actions on this keyword. Ignored in POST/PUT calls.",
      "items":{
       "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoNonForwardAction"
      },
      "readOnly":true
     },
     "otherActions":{
      "type":"array",
      "description":"List of other configured action types/names on this keyword. Ignored in POST/PUT calls.",
      "items":{
       "type":"string",
       "description":"List of other configured action types/names on this keyword. Ignored in POST/PUT calls.",
       "readOnly":true
      },
      "readOnly":true
     },
     "applicationId":{
      "type":"string",
      "description":"ID of the Application that would be associated with the configuration.",
      "externalDocs":{
       "description":"Find out more about Application and Application Management",
       "url":"https://www.infobip.com/docs/api/platform/application-entity"
      },
      "maxLength":255,
      "minLength":0
     },
     "entityId":{
      "type":"string",
      "description":"ID of the Entity that would be associated with the configuration.",
      "externalDocs":{
       "description":"Find out more about Entity and Entity Management",
       "url":"https://www.infobip.com/docs/api/platform/application-entity"
      },
      "maxLength":255,
      "minLength":0
     }
    },
    "required":[
     "action"
    ],
    "title":"MoConfiguration"
   },
   "7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoConfigurations":{
    "type":"object",
    "properties":{
     "configurations":{
      "type":"array",
      "items":{
       "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.StoredMoConfiguration"
      }
     },
     "totalCount":{
      "type":"integer",
      "format":"int32"
     }
    },
    "title":"MoConfigurations"
   },
   "7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoNonForwardAction":{
    "type":"object",
    "description":"List of other configured actions on this keyword. Ignored in POST/PUT calls.",
    "discriminator":{
     "propertyName":"type",
     "mapping":{
      "AUTORESPONSE":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.AutoResponseAction",
      "BLOCK":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.BlockAction"
     }
    },
    "properties":{
     "type":{
      "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoActionType"
     },
     "editable":{
      "type":"boolean",
      "description":"Flag which indicates if given action is editable. Ignored on POST/PUT requests.",
      "readOnly":true
     }
    },
    "readOnly":true,
    "required":[
     "type"
    ],
    "title":"MoNonForwardAction"
   },
   "7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NoAction":{
    "type":"object",
    "allOf":[
     {
      "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoAction"
     }
    ],
    "title":"NoAction"
   },
   "7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumberCapabilityType":{
    "type":"string",
    "description":"An array of communication channels the number can support.",
    "enum":[
     "SMS",
     "VOICE",
     "MMS",
     "WHATSAPP",
     "WHATSAPP_VOICE"
    ],
    "title":"NumberCapabilityType"
   },
   "7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumberPrice":{
    "type":"object",
    "description":"The price object indicating pricing details for the number.",
    "properties":{
     "pricePerMonth":{
      "type":"number",
      "description":"Price of the monthly fee."
     },
     "setupPrice":{
      "type":"number",
      "description":"Price of the setup fee."
     },
     "initialMonthPrice":{
      "type":"number",
      "description":"Price for the initial month."
     },
     "currency":{
      "type":"string",
      "description":"Currency of the number's fees."
     }
    },
    "title":"NumberPrice"
   },
   "7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumberResponse":{
    "type":"object",
    "properties":{
     "numberKey":{
      "type":"string",
      "description":"Unique ID of a number."
     },
     "number":{
      "type":"string",
      "description":"The number."
     },
     "country":{
      "type":"string",
      "description":"Number's country code."
     },
     "countryName":{
      "type":"string",
      "description":"Number's country."
     },
     "type":{
      "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumberType"
     },
     "capabilities":{
      "type":"array",
      "description":"An array of communication channels the number can support.",
      "items":{
       "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumberCapabilityType"
      }
     },
     "shared":{
      "type":"boolean",
      "description":"Indicates whether a number is shared."
     },
     "price":{
      "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumberPrice"
     },
     "network":{
      "type":"string",
      "description":"Indicates the network that owns the number."
     },
     "keywords":{
      "type":"array",
      "description":"Keywords defined for the number.",
      "items":{
       "type":"string",
       "description":"Keywords defined for the number."
      }
     },
     "voiceSetup":{
      "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.VoiceSetup"
     },
     "reservationStatus":{
      "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ReservationStatus"
     },
     "additionalSetupRequired":{
      "type":"boolean",
      "description":"Indicates whether the number requires additional setup before being used."
     },
     "editPermissions":{
      "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.EditPermissions"
     },
     "note":{
      "type":"string",
      "description":"Additional information attached to the number. Available only for SHORT_CODE and VIRTUAL_LONG_NUMBER number types."
     },
     "applicationId":{
      "type":"string",
      "description":"ID of the Application that would be associated with the number.",
      "externalDocs":{
       "description":"Find out more about Application and Application Management",
       "url":"https://www.infobip.com/docs/api/platform/application-entity"
      },
      "maxLength":255,
      "minLength":0
     },
     "entityId":{
      "type":"string",
      "description":"ID of the Entity that would be associated with the number.",
      "externalDocs":{
       "description":"Find out more about Entity and Entity Management",
       "url":"https://www.infobip.com/docs/api/platform/application-entity"
      },
      "maxLength":255,
      "minLength":0
     }
    },
    "title":"NumberResponse"
   },
   "7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumberType":{
    "type":"string",
    "description":"The type of number.",
    "enum":[
     "VIRTUAL_LONG_NUMBER",
     "SHORT_CODE",
     "SIM_HOSTING",
     "VIRTUAL_SIM_HOSTING",
     "VIRTUAL_LONG_NUMBER_CALL_TRIGGER",
     "SHORT_CODE_USSD",
     "WHATSAPP",
     "VIBER",
     "VIBER_VOICE",
     "FACEBOOK",
     "RCS",
     "TELEGRAM",
     "KAKAO_SANGDAM",
     "OPEN_CHANNEL"
    ],
    "title":"NumberType"
   },
   "7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumbersResponse":{
    "type":"object",
    "properties":{
     "numbers":{
      "type":"array",
      "items":{
       "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumberResponse"
      }
     },
     "numberCount":{
      "type":"integer",
      "format":"int64"
     }
    },
    "title":"NumbersResponse"
   },
   "7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.PullAction":{
    "type":"object",
    "allOf":[
     {
      "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoAction"
     }
    ],
    "description":"This action is used to pull all paired messages on specific resource.",
    "title":"PullAction"
   },
   "7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.PurchaseNumberRequest":{
    "type":"object",
    "properties":{
     "numberKey":{
      "type":"string"
     },
     "number":{
      "type":"string"
     },
     "applicationId":{
      "type":"string",
      "description":"ID of the Application that would be associated with the number.",
      "externalDocs":{
       "description":"Find out more about Application and Application Management",
       "url":"https://www.infobip.com/docs/api/platform/application-entity"
      },
      "maxLength":255,
      "minLength":0
     },
     "entityId":{
      "type":"string",
      "description":"ID of the Entity that would be associated with the number.",
      "externalDocs":{
       "description":"Find out more about Entity and Entity Management",
       "url":"https://www.infobip.com/docs/api/platform/application-entity"
      },
      "maxLength":255,
      "minLength":0
     }
    },
    "title":"PurchaseNumberRequest"
   },
   "7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ReservationStatus":{
    "type":"string",
    "description":"Status of the number reservation.",
    "enum":[
     "PENDING",
     "BILLING_FAILED",
     "ERROR",
     "RESERVATION_FAILED"
    ],
    "title":"ReservationStatus"
   },
   "7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.SmppForwardAction":{
    "type":"object",
    "allOf":[
     {
      "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoAction"
     }
    ],
    "description":"Used for SMPP push.",
    "title":"SmppForwardAction"
   },
   "7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.StoredMoConfiguration":{
    "type":"object",
    "properties":{
     "keyword":{
      "type":"string",
      "description":"Configuration keyword.",
      "maxLength":50,
      "minLength":0
     },
     "action":{
      "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoAction"
     },
     "useConversation":{
      "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.UseConversation"
     },
     "otherActionsDetails":{
      "type":"array",
      "description":"List of other configured actions on this keyword. Ignored in POST/PUT calls.",
      "items":{
       "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoNonForwardAction"
      },
      "readOnly":true
     },
     "otherActions":{
      "type":"array",
      "description":"List of other configured action types/names on this keyword. Ignored in POST/PUT calls.",
      "items":{
       "type":"string",
       "description":"List of other configured action types/names on this keyword. Ignored in POST/PUT calls.",
       "readOnly":true
      },
      "readOnly":true
     },
     "applicationId":{
      "type":"string",
      "description":"ID of the Application that would be associated with the configuration.",
      "externalDocs":{
       "description":"Find out more about Application and Application Management",
       "url":"https://www.infobip.com/docs/api/platform/application-entity"
      },
      "maxLength":255,
      "minLength":0
     },
     "entityId":{
      "type":"string",
      "description":"ID of the Entity that would be associated with the configuration.",
      "externalDocs":{
       "description":"Find out more about Entity and Entity Management",
       "url":"https://www.infobip.com/docs/api/platform/application-entity"
      },
      "maxLength":255,
      "minLength":0
     },
     "key":{
      "type":"string",
      "description":"Unique ID of configuration.",
      "minLength":1
     }
    },
    "required":[
     "action",
     "key"
    ],
    "title":"StoredMoConfiguration"
   },
   "7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.UpdateOwnedNumberRequest":{
    "type":"object",
    "properties":{
     "applicationId":{
      "type":"string",
      "description":"ID of the Application that would be associated with the number.",
      "externalDocs":{
       "description":"Find out more about Application and Application Management",
       "url":"https://www.infobip.com/docs/api/platform/application-entity"
      },
      "minLength":1
     },
     "entityId":{
      "type":"string",
      "description":"ID of the Entity that would be associated with the number.",
      "externalDocs":{
       "description":"Find out more about Entity and Entity Management",
       "url":"https://www.infobip.com/docs/api/platform/application-entity"
      }
     }
    },
    "required":[
     "applicationId"
    ],
    "title":"UpdateOwnedNumberRequest"
   },
   "7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.UseConversation":{
    "type":"object",
    "description":"Used for forwarding messages to Conversations service.",
    "properties":{
     "enabled":{
      "type":"boolean",
      "description":"Flag which indicates if action is enabled."
     }
    },
    "title":"UseConversation"
   },
   "7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.VoiceActionDetails":{
    "type":"object",
    "description":"Voice action configuration.",
    "discriminator":{
     "propertyName":"type",
     "mapping":{
      "VOICE_NUMBER_MASKING":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.VoiceNumberMaskingActionDetails",
      "FORWARD_TO_IVR":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ForwardToIvrActionDetails",
      "VOICE_FORWARD_TO_CONVERSATIONS":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.VoiceForwardToConversationsDetails",
      "FORWARD_TO_SUBSCRIPTION":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ForwardToSubscriptionDetails",
      "FORWARD_TO_CALL_ROUTING":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ForwardToCallRoutingDetails",
      "FORWARD_TO_PSTN":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ForwardToPstnActionDetails",
      "VOICE_FORWARD_TO_ANSWERS":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.VoiceForwardToAnswersDetails",
      "FORWARD_TO_MARKUP_LANGUAGE":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ForwardToMarkupLanguageDetails"
     }
    },
    "properties":{
     "type":{
      "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoActionType"
     },
     "description":{
      "type":"string",
      "description":"Additional action description."
     }
    },
    "title":"VoiceActionDetails"
   },
   "7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.VoiceForwardToAnswersDetails":{
    "type":"object",
    "allOf":[
     {
      "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.VoiceActionDetails"
     }
    ],
    "title":"VoiceForwardToAnswersDetails"
   },
   "7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.VoiceForwardToConversationsDetails":{
    "type":"object",
    "allOf":[
     {
      "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.VoiceActionDetails"
     }
    ],
    "title":"VoiceForwardToConversationsDetails"
   },
   "7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.VoiceNumberMaskingActionDetails":{
    "type":"object",
    "allOf":[
     {
      "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.VoiceActionDetails"
     },
     {
      "type":"object",
      "properties":{
       "voiceNumberMaskingConfigKey":{
        "type":"string",
        "description":"Unique ID of number masking configuration."
       }
      }
     }
    ],
    "required":[
     "voiceNumberMaskingConfigKey"
    ],
    "title":"VoiceNumberMaskingActionDetails"
   },
   "7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.VoiceSetup":{
    "type":"object",
    "description":"Voice setup configuration.",
    "properties":{
     "applicationId":{
      "type":"string",
      "description":"ID of the Application that would be associated with the voice setup.",
      "externalDocs":{
       "description":"Find out more about Application and Application Management",
       "url":"https://www.infobip.com/docs/api/platform/application-entity"
      },
      "maxLength":255,
      "minLength":0
     },
     "entityId":{
      "type":"string",
      "description":"ID of the Entity that would be associated with the voice setup.",
      "externalDocs":{
       "description":"Find out more about Entity and Entity Management",
       "url":"https://www.infobip.com/docs/api/platform/application-entity"
      },
      "maxLength":255,
      "minLength":0
     },
     "action":{
      "$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.VoiceActionDetails"
     }
    },
    "required":[
     "action"
    ],
    "title":"VoiceSetup"
   },
   "8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException":{
    "type":"object",
    "properties":{
     "requestError":{
      "$ref":"#/components/schemas/ApiRequestError"
     }
    },
    "title":"ApiException"
   },
   "ApiError":{
    "type":"object",
    "properties":{
     "errorCode":{
      "type":"string",
      "description":"An error code uniquely identifying the error case."
     },
     "description":{
      "type":"string",
      "description":"A detailed description of an error."
     },
     "action":{
      "type":"string",
      "description":"An action that should be taken to recover from the error."
     },
     "violations":{
      "type":"array",
      "description":"List of violations that caused the error.",
      "items":{
       "$ref":"#/components/schemas/ApiErrorViolation"
      }
     },
     "resources":{
      "type":"array",
      "description":"List of available resources to recover from the error.",
      "items":{
       "$ref":"#/components/schemas/ApiErrorResource"
      }
     }
    },
    "required":[
     "action",
     "description",
     "errorCode",
     "resources",
     "violations"
    ],
    "title":"ApiError"
   },
   "ApiErrorResource":{
    "type":"object",
    "description":"List of available resources to recover from the error.",
    "properties":{
     "name":{
      "type":"string",
      "description":"Resource name."
     },
     "url":{
      "type":"string",
      "description":"Resource URL."
     }
    },
    "title":"ApiErrorResource"
   },
   "ApiErrorViolation":{
    "type":"object",
    "description":"List of violations that caused the error.",
    "properties":{
     "property":{
      "type":"string",
      "description":"Request property that caused the error."
     },
     "violation":{
      "type":"string",
      "description":"Detailed violation description."
     }
    },
    "title":"ApiErrorViolation"
   },
   "ApiException":{
    "type":"object",
    "properties":{
     "requestError":{
      "$ref":"#/components/schemas/ApiRequestError"
     }
    },
    "title":"ApiException"
   },
   "ApiRequestError":{
    "type":"object",
    "properties":{
     "serviceException":{
      "$ref":"#/components/schemas/ApiRequestErrorDetails"
     }
    },
    "title":"ApiRequestError"
   },
   "ApiRequestErrorDetails":{
    "type":"object",
    "properties":{
     "messageId":{
      "type":"string",
      "description":"Identifier of the error."
     },
     "text":{
      "type":"string",
      "description":"Detailed error description."
     },
     "validationErrors":{
      "type":"object",
      "additionalProperties":{
       "type":"array",
       "items":{
        "type":"string",
        "description":"Validation errors."
       }
      },
      "description":"Validation errors."
     }
    },
    "title":"ApiRequestErrorDetails"
   },
   "bc185b494ef7059aff9d68589cd5338df2245f21add51cf1a96e9927af6e30d7.PublicCnamStatus":{
    "type":"object",
    "properties":{
     "storage":{
      "$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicCnamStorageStatus"
     },
     "delivery":{
      "$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicCnamDeliveryStatus"
     }
    },
    "title":"PublicCnamStatus"
   },
   "c477cb65646267e3f350bce7b433e9b56e5c28aa9ef21a75500a1337942923ba.Cnam":{
    "type":"object",
    "properties":{
     "storage":{
      "$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CnamStorage"
     },
     "delivery":{
      "$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CnamDelivery"
     }
    },
    "title":"Cnam"
   },
   "e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException":{
    "type":"object",
    "properties":{
     "requestError":{
      "$ref":"#/components/schemas/ApiRequestError"
     }
    },
    "title":"ApiException"
   },
   "fc7dd544c10bf8ba502ba371088d1382022decf6a1acc2d0fa20f0b7f272047d.ApiException":{
    "type":"object",
    "properties":{
     "requestError":{
      "$ref":"#/components/schemas/ApiRequestError"
     }
    },
    "title":"ApiException"
   }
  },
  "responses":{
   "ApiError400":{
    "description":"Bad Request",
    "content":{
     "application/json":{
      "schema":{
       "$ref":"#/components/schemas/ApiError"
      },
      "example":{
       "errorCode":"E400",
       "description":"Request cannot be processed.",
       "action":"Check the syntax, violations and adjust the request.",
       "violations":[],
       "resources":[]
      }
     },
     "application/xml":{
      "schema":{
       "$ref":"#/components/schemas/ApiError"
      },
      "example":"<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiError>\n  <errorCode>E400</errorCode>\n  <description>Request cannot be processed.</description>\n  <action>Check the syntax, violations and adjust the request.</action>\n  <violations/>\n  <resources/>\n</ApiError>\n"
     }
    }
   },
   "ApiError401":{
    "description":"Unauthorized",
    "content":{
     "application/json":{
      "schema":{
       "$ref":"#/components/schemas/ApiError"
      },
      "example":{
       "errorCode":"E401",
       "description":"The request lacks valid authentication credentials for the requested resource.",
       "action":"Check the resources and adjust authentication credentials.",
       "violations":[],
       "resources":[
        {
         "name":"API Authentication",
         "url":"https://www.infobip.com/docs/essentials/api-authentication"
        }
       ]
      }
     },
     "application/xml":{
      "schema":{
       "$ref":"#/components/schemas/ApiError"
      },
      "example":"<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiError>\n  <errorCode>E401</errorCode>\n  <description>The request lacks valid authentication credentials for the requested resource.</description>\n  <action>Check the resources and adjust authentication credentials.</action>\n  <violations/>\n  <resources>\n    <resource>\n      <name>API Authentication</name>\n      <url>https://www.infobip.com/docs/essentials/api-authentication</url>\n    </resource>\n  </resources>\n</ApiError>\n"
     }
    }
   },
   "ApiError403":{
    "description":"Forbidden",
    "content":{
     "application/json":{
      "schema":{
       "$ref":"#/components/schemas/ApiError"
      },
      "example":{
       "errorCode":"E403",
       "description":"Insufficient permissions to access the requested resource.",
       "action":"Repeat the request with new or different credentials.",
       "violations":[],
       "resources":[
        {
         "name":"API Scopes",
         "url":"https://www.infobip.com/docs/essentials/api-essentials/api-authorization#api-scopes"
        }
       ]
      }
     },
     "application/xml":{
      "schema":{
       "$ref":"#/components/schemas/ApiError"
      },
      "example":"<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiError>\n  <errorCode>E403</errorCode>\n  <description>Insufficient permissions to access the requested resource.</description>\n  <action>Repeat the request with new or different credentials.</action>\n  <violations/>\n  <resources>\n    <resource>\n      <name>API Scopes</name>\n      <url>https://www.infobip.com/docs/essentials/api-essentials/api-authorization#api-scopes</url>\n    </resource>\n  </resources>\n</ApiError>\n"
     }
    }
   },
   "ApiError404":{
    "description":"Not Found",
    "content":{
     "application/json":{
      "schema":{
       "$ref":"#/components/schemas/ApiError"
      },
      "example":{
       "errorCode":"E404",
       "description":"Not found - request URL doesn't exist on the API server or resource is not found.",
       "action":"Check the resources and adjust your request.",
       "violations":[],
       "resources":[]
      }
     },
     "application/xml":{
      "schema":{
       "$ref":"#/components/schemas/ApiError"
      },
      "example":"<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiError>\n  <errorCode>E404</errorCode>\n  <description>Not found - request URL doesn't exist on the API server or resource is not found.</description>\n  <action>Check the resources and adjust your request.</action>\n  <violations/>\n  <resources/>\n</ApiError>\n"
     }
    }
   },
   "ApiError429":{
    "description":"Too Many Requests",
    "content":{
     "application/json":{
      "schema":{
       "$ref":"#/components/schemas/ApiError"
      },
      "example":{
       "errorCode":"E429",
       "description":"Too many requests sent.",
       "action":"Check request rate limit specified in the API endpoint documentation resource.",
       "violations":[],
       "resources":[
        {
         "name":"Throttling handling errors",
         "url":"https://www.infobip.com/docs/essentials/integration-best-practices#throttling-handling-errors"
        }
       ]
      }
     },
     "application/xml":{
      "schema":{
       "$ref":"#/components/schemas/ApiError"
      },
      "example":"<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiError>\n  <errorCode>E429</errorCode>\n  <description>Too many requests sent.</description>\n  <action>Check request rate limit specified in the API endpoint documentation resource.</action>\n  <violations/>\n  <resources>\n    <resource>\n      <name>Throttling handling errors</name>\n      <url>https://www.infobip.com/docs/essentials/integration-best-practices#throttling-handling-errors</url>\n    </resource>\n  </resources>\n</ApiError>\n"
     }
    }
   },
   "ApiError500":{
    "description":"Internal Server Error",
    "content":{
     "application/json":{
      "schema":{
       "$ref":"#/components/schemas/ApiError"
      },
      "example":{
       "errorCode":"E500",
       "description":"Something went wrong.",
       "action":"Contact the support.",
       "violations":[],
       "resources":[]
      }
     },
     "application/xml":{
      "schema":{
       "$ref":"#/components/schemas/ApiError"
      },
      "example":"<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiError>\n  <errorCode>E500</errorCode>\n  <description>Something went wrong.</description>\n  <action>Contact the support.</action>\n  <violations/>\n  <resources/>\n</ApiError>\n"
     }
    }
   },
   "ApiException400":{
    "description":"Bad Request",
    "content":{
     "application/json":{
      "schema":{
       "$ref":"#/components/schemas/ApiException"
      },
      "example":{
       "requestError":{
        "serviceException":{
         "messageId":"BAD_REQUEST",
         "text":"Bad request"
        }
       }
      }
     },
     "application/xml":{
      "schema":{
       "$ref":"#/components/schemas/ApiException"
      },
      "example":"<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n  <requestError>\n    <serviceException>\n      <messageId>BAD_REQUEST</messageId>\n      <text>Bad request</text>\n    </serviceException>\n  </requestError>\n</ApiException>\n"
     }
    }
   },
   "ApiException401":{
    "description":"Unauthorized",
    "content":{
     "application/json":{
      "schema":{
       "$ref":"#/components/schemas/ApiException"
      },
      "example":{
       "requestError":{
        "serviceException":{
         "messageId":"UNAUTHORIZED",
         "text":"Unauthorized"
        }
       }
      }
     },
     "application/xml":{
      "schema":{
       "$ref":"#/components/schemas/ApiException"
      },
      "example":"<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n  <requestError>\n    <serviceException>\n      <messageId>UNAUTHORIZED</messageId>\n      <text>Unauthorized</text>\n    </serviceException>\n  </requestError>\n</ApiException>\n"
     }
    }
   },
   "ApiException403":{
    "description":"Forbidden",
    "content":{
     "application/json":{
      "schema":{
       "$ref":"#/components/schemas/ApiException"
      },
      "example":{
       "requestError":{
        "serviceException":{
         "messageId":"FORBIDDEN",
         "text":"Forbidden"
        }
       }
      }
     },
     "application/xml":{
      "schema":{
       "$ref":"#/components/schemas/ApiException"
      },
      "example":"<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n  <requestError>\n    <serviceException>\n      <messageId>FORBIDDEN</messageId>\n      <text>Forbidden</text>\n    </serviceException>\n  </requestError>\n</ApiException>\n"
     }
    }
   },
   "ApiException404":{
    "description":"Not Found",
    "content":{
     "application/json":{
      "schema":{
       "$ref":"#/components/schemas/ApiException"
      },
      "example":{
       "requestError":{
        "serviceException":{
         "messageId":"NOT_FOUND",
         "text":"Not found"
        }
       }
      }
     },
     "application/xml":{
      "schema":{
       "$ref":"#/components/schemas/ApiException"
      },
      "example":"<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n  <requestError>\n    <serviceException>\n      <messageId>NOT_FOUND</messageId>\n      <text>Not found</text>\n    </serviceException>\n  </requestError>\n</ApiException>\n"
     }
    }
   },
   "ApiException429":{
    "description":"Too Many Requests",
    "content":{
     "application/json":{
      "schema":{
       "$ref":"#/components/schemas/ApiException"
      },
      "example":{
       "requestError":{
        "serviceException":{
         "messageId":"TOO_MANY_REQUESTS",
         "text":"Too many requests"
        }
       }
      }
     },
     "application/xml":{
      "schema":{
       "$ref":"#/components/schemas/ApiException"
      },
      "example":"<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n  <requestError>\n    <serviceException>\n      <messageId>TOO_MANY_REQUESTS</messageId>\n      <text>Too many requests</text>\n    </serviceException>\n  </requestError>\n</ApiException>\n"
     }
    }
   },
   "ApiException500":{
    "description":"Internal Server Error",
    "content":{
     "application/json":{
      "schema":{
       "$ref":"#/components/schemas/ApiException"
      },
      "example":{
       "requestError":{
        "serviceException":{
         "messageId":"GENERAL_ERROR",
         "text":"Something went wrong. Please contact support."
        }
       }
      }
     },
     "application/xml":{
      "schema":{
       "$ref":"#/components/schemas/ApiException"
      },
      "example":"<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n  <requestError>\n    <serviceException>\n      <messageId>GENERAL_ERROR</messageId>\n      <text>Something went wrong. Please contact support.</text>\n    </serviceException>\n  </requestError>\n</ApiException>\n"
     }
    }
   }
  },
  "parameters":{},
  "examples":{},
  "requestBodies":{},
  "headers":{},
  "securitySchemes":{
   "APIKeyHeader":{
    "type":"apiKey",
    "description":"This is the most secure authorization type and the one with the most flexibility.\n\nAPI keys can be generated by calling the dedicated API method. Furthermore, API keys can have a limited scope and cover only some API methods. Lastly, they can\nbe revoked at any time. This range of possibilities makes API keys well suited for separating the API access rights across multiple applications or use cases.\nFinally, the loss of an API key is easily manageable.\n\nYou can manage your API keys from [GUI](https://portal.infobip.com/settings/accounts/api-keys), or programmatically\nwith [dedicated API](#platform-&-connectivity/settings).\n\nAPI key Authorization header example:\n\n```shell\nAuthorization: App 003026bbc133714df1834b8638bb496e-8f4b3d9a-e931-478d-a994-28a725159ab9\n```\n",
    "name":"Authorization",
    "in":"header"
   },
   "Basic":{
    "type":"http",
    "description":"Basic authorization type can be used in situations when the API key is not available. For example, API methods for generating API keys should be authenticated\nwith the Basic type.\n\nIn this case, the credentials included in the Authorization header should be a Base64 encoded username and password combination. More formally, basic\nauthentication header can be constructed in three steps:\n\n* Username and password are concatenated using the colon `(:)` as a separator `username:password`.\n* The resulting string is encoded using the [RFC2045-MIME](https://www.ietf.org/rfc/rfc2045.txt) variant of Base64.\n* Encoded string is added as credentials after the `\"Basic \"` type.\n\nExample:\n\n```shell\nUsername: \"Aladdin\"\nPassword: \"openSesame\"\n\nConcatenated string: \"Aladdin:openSesame\"\n\nBase64 encoded string: \"QWxhZGRpbjpvcGVuU2VzYW1l\"\n\nAuthorization header: \"Basic QWxhZGRpbjpvcGVuU2VzYW1l\"\n```\n\n> **Implementation detail**: Base64 encoding is a standard and many available programming languages and frameworks provide convenient methods for encoding\n> strings.\n",
    "scheme":"basic"
   },
   "IBSSOTokenHeader":{
    "type":"apiKey",
    "description":"This authorization type is suited for situations when you do not want to store Infobip credentials in your own app. Instead, your users will input their Infobip\ncredentials every time they access your application and the application will use those credentials to create a session. From then on, the session token can be\nused to authenticate subsequent API requests. Note that the session will expire automatically after a predefined period of inactivity, and can also be manually\nterminated by making an appropriate API call.\n\nYou can find more details on the creation and behavior of the session at\nthe [dedicated documentation page](#platform-connectivity/account-management/create-session).\n\nAfter obtaining the session token by calling the above-referenced API method you can include it in the Authorization header like this:\n\n```shell\nAuthorization: IBSSO 2f9b4d31-2d0d-49a8-85f0-9b862bdca394\n```\n",
    "name":"Authorization",
    "in":"header"
   },
   "OAuth2":{
    "type":"oauth2",
    "description":"Similarly to the IBSSO Token authentication you can use OAuth 2.0 bearer token with Infobip serving both as resource and authorization server. You can obtain\nthe access token using the client credentials grant from `auth/1/oauth2/token` endpoint. It will provide you with your access token, and its expiration period.\nYou can use the token to authorize your API calls until it expires. You can find out more about the process in\nthe [official specification](https://tools.ietf.org/html/rfc6749#section-4.4).\n\nYou can include your access token in the Authorization HTTP request header like this:\n\n```http\nAuthorization: Bearer <access_token>\n```",
    "flows":{
     "clientCredentials":{
      "tokenUrl":"https://api.infobip.com/auth/1/oauth2/token",
      "scopes":{}
     }
    }
   }
  },
  "links":{},
  "callbacks":{}
 },
 "webhooks":{
  "brand-registration-status-change-notification":{
   "post":{
    "tags":[
     "platform",
     "numbers",
     "number-registration",
     "brands",
     "brand-management"
    ],
    "summary":"Receive Brand Status Update",
    "description":"Any time brand registration is completed or failed, an event is sent.\nYou need to subscribe to this event over 'REGISTRATION' channel, and specify the 'BRAND_STATUS_UPDATE' event.",
    "externalDocs":{
     "description":"Learn more about subscription.",
     "url":"https://www.infobip.com/docs/api/platform/subscriptions-api/create-subscription"
    },
    "operationId":"brand-registration-status-change-notification",
    "requestBody":{
     "content":{
      "application/json":{
       "schema":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandRegistrationWebhookResponse"
       }
      }
     }
    },
    "responses":{
     "200":{
      "description":"Your server returns this code if it accepts the callback."
     }
    }
   }
  },
  "brand-auth-2fa-update-notification":{
   "post":{
    "tags":[
     "platform",
     "numbers",
     "number-registration",
     "brands",
     "brand-management"
    ],
    "summary":"Receive Brand Auth 2FA Update",
    "description":"Any time brand 2FA email is sent or authentication is completed, an event is sent.\nYou need to subscribe to this event over 'REGISTRATION' channel, and specify the 'BRAND_AUTH_UPDATE' event.",
    "externalDocs":{
     "description":"Learn more about subscription.",
     "url":"https://www.infobip.com/docs/api/platform/subscriptions-api/create-subscription"
    },
    "operationId":"brand-auth-2fa-update-notification",
    "requestBody":{
     "content":{
      "application/json":{
       "schema":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandAuthUpdateWebhookResponse"
       }
      }
     }
    },
    "responses":{
     "200":{
      "description":"Your server returns this code if it accepts the callback."
     }
    }
   }
  },
  "brand-vet-notification":{
   "post":{
    "tags":[
     "platform",
     "numbers",
     "number-registration",
     "brands",
     "brand-vetting"
    ],
    "summary":"Receive Brand Vet Update",
    "description":"Any time a brand vet is completed or failed, an event is sent.\nYou need to subscribe to this event over 'REGISTRATION' channel, and specify the 'BRAND_VET_UPDATE' event.",
    "externalDocs":{
     "description":"Learn more about subscription.",
     "url":"https://www.infobip.com/docs/api/platform/subscriptions-api/create-subscription"
    },
    "operationId":"brand-vet-notification",
    "requestBody":{
     "content":{
      "application/json":{
       "schema":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandVetStatusWebhookResponse"
       }
      }
     }
    },
    "responses":{
     "200":{
      "description":"Your server returns this code if it accepts the callback."
     }
    }
   }
  },
  "campaign-network-status-notification":{
   "post":{
    "tags":[
     "platform",
     "numbers",
     "number-registration",
     "campaigns"
    ],
    "summary":"Receive Campaign Network Status Update",
    "description":"Any time a campaign changes status on carrier side, an event is sent.\nYou need to subscribe to this event over 'REGISTRATION' channel, and specify the 'CAMPAIGN_NETWORK_STATUS_UPDATE' event.",
    "externalDocs":{
     "description":"Learn more about subscription.",
     "url":"https://www.infobip.com/docs/api/platform/subscriptions-api/create-subscription"
    },
    "operationId":"campaign-network-status-notification",
    "requestBody":{
     "content":{
      "application/json":{
       "schema":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignNetworkStatusWebhookResponse"
       }
      }
     }
    },
    "responses":{
     "200":{
      "description":"Your server returns this code if it accepts the callback."
     }
    }
   }
  },
  "campaign-status-change-notification":{
   "post":{
    "tags":[
     "platform",
     "numbers",
     "number-registration",
     "campaigns"
    ],
    "summary":"Receive Campaign Status Update",
    "description":"Any time campaign status is changed, an event is sent.\nYou need to subscribe to this event over 'REGISTRATION' channel, and specify the 'CAMPAIGN_STATUS_UPDATE' event.",
    "externalDocs":{
     "description":"Learn more about subscription.",
     "url":"https://www.infobip.com/docs/api/platform/subscriptions-api/create-subscription"
    },
    "operationId":"campaign-status-change-notification",
    "requestBody":{
     "content":{
      "application/json":{
       "schema":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignStatusWebhookResponse"
       }
      }
     }
    },
    "responses":{
     "200":{
      "description":"Your server returns this code if it accepts the callback."
     }
    }
   }
  },
  "campaign-ai-feedback-notification":{
   "post":{
    "tags":[
     "platform",
     "numbers",
     "number-registration",
     "ai-assistant"
    ],
    "summary":"Receive AI Campaign Feedback",
    "description":"Any time a campaign AI review is finished and ready for the results to be fetched, an event is sent.\nYou need to subscribe to this event over 'REGISTRATION' channel, and specify the 'AI_CAMPAIGN_FEEDBACK' event.",
    "externalDocs":{
     "description":"Learn more about subscription.",
     "url":"https://www.infobip.com/docs/api/platform/subscriptions-api/create-subscription"
    },
    "operationId":"campaign-ai-feedback-notification",
    "requestBody":{
     "content":{
      "application/json":{
       "schema":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignAiFeedbackWebhookResponse"
       }
      }
     }
    },
    "responses":{
     "200":{
      "description":"Your server returns this code if it accepts the callback."
     }
    }
   }
  },
  "campaign-ai-builder-notification":{
   "post":{
    "tags":[
     "platform",
     "numbers",
     "number-registration",
     "ai-assistant"
    ],
    "summary":"Receive AI Campaign Builder Completion Notification",
    "description":"Any time a campaign AI builder job is finished and ready for the results to be fetched, an event is sent.\nYou need to subscribe to this event over 'REGISTRATION' channel, and specify the 'AI_CAMPAIGN_BUILDER' event.",
    "externalDocs":{
     "description":"Learn more about subscription.",
     "url":"https://www.infobip.com/docs/api/platform/subscriptions-api/create-subscription"
    },
    "operationId":"campaign-ai-builder-notification",
    "requestBody":{
     "content":{
      "application/json":{
       "schema":{
        "$ref":"#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignAiBuilderWebhookResponse"
       }
      }
     }
    },
    "responses":{
     "200":{
      "description":"Your server returns this code if it accepts the callback."
     }
    },
    "x-is-early-access":true
   }
  }
 }
}