Numbers are essential for two way communication and your branding. Buy and manage your numbers to send and receive messages and voice calls. — 47 operation path(s) and 7 webhook(s) in Infobip's published OpenAPI.
{
"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"
# --- truncated at 32 KB (515 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/infobip/refs/heads/main/openapi/infobip-numbers-openapi.json