{
"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:59.220824166Z"
},
"tags":[
{
"name":"platform",
"description":"Modular tools to scale and automate your business.\n",
"x-type":"category",
"x-displayName":"Platform"
},
{
"name":"resources",
"description":"The __Resources API__ is a set of endpoints designed to manage and request communication resources, such as __alphanumeric senders__ and __numbers__.\nAutomate resource registration, validation, and provisioning to reduce manual workload.\n\nThe Resources API contains the following sections:\n * __Resource Management__ – Get the resources you have already, check SMS coverage for alphas and numbers, and manage inbound configuration\n * __Resource Request__ – check the necessary requirements, then submit and track requests for new resources, and receive request status updates on a webhook\n",
"x-type":"product",
"x-displayName":"Resources"
},
{
"name":"resource-management",
"description":"The __Resource Management API__ streamlines the process for handling and configuring registered communication resources, such as __alphanumeric senders__ and __numbers__.\n\nWith the __Resource Management API__:\n * Set up configuration for inbound messages\n * View existing configurations\n * View SMS coverage for alphanumeric senders or numbers\n * List all the resources, including senders and usable numbers\n\nUse this API to maintain full control over your messaging resources.\n\nFor more information, see [Manage resources](https://www.infobip.com/docs/resources/manage-resources).\n",
"x-type":"module",
"x-displayName":"Resource Management"
},
{
"name":"resource-request",
"description":"The __Resource Request API__ streamlines the process of requesting alphanumeric senders and numbers. This API enables seamless integration with Infobip’s registration and purchasing system.\n\nSome resources require additional data for registration, known as __data requirements__. These vary depending on the type of resource being requested and may include documentation or specific business details.\n\nThe API also provides status tracking for all submitted requests. Some feedback is provided over email with [Infobip Support](mailto:support@infobip.com).\n\nFor more information, see [Request resources](https://www.infobip.com/docs/resources/request-resources).\n",
"x-type":"module",
"x-displayName":"Resource Request"
}
],
"paths":{
"/resource-management/1/inbound-message-configurations":{
"get":{
"tags":[
"platform",
"resources",
"resource-management"
],
"summary":"Get inbound configurations",
"description":"Get all configurations using a filter.
\nIf you want configuration for a specific number or resource, then one of the following parameters is required: number, numberKey, resource or resourceKey.
\nIf you are using configurationKey none of previously mentioned parameters are needed.",
"externalDocs":{
"description":"Read more about keywords",
"url":"https://www.infobip.com/docs/numbers/keywords-and-actions"
},
"operationId":"get-inbound-configurations",
"parameters":[
{
"name":"configurationKey",
"in":"query",
"description":"Unique ID of configuration.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"description":"Unique ID of configuration.",
"example":"58BC6DB7966CB9F69A91EB956DF73239"
},
"example":"58BC6DB7966CB9F69A91EB956DF73239"
},
{
"name":"number",
"in":"query",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"example":"41793026727"
},
"example":41793026727
},
{
"name":"numberKey",
"in":"query",
"description":"Unique ID of a number.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"description":"Unique ID of a number.",
"example":"58BC6DB7966CB9F69A91EB956DF73239"
},
"example":"58BC6DB7966CB9F69A91EB956DF73239"
},
{
"name":"resource",
"in":"query",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"example":"41793026727"
},
"example":41793026727
},
{
"name":"resourceKey",
"in":"query",
"description":"Unique ID of a resource.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"description":"Unique ID of a resource.",
"example":"58BC6DB7966CB9F69A91EB956DF73239"
},
"example":"58BC6DB7966CB9F69A91EB956DF73239"
},
{
"name":"keyword",
"in":"query",
"description":"Configuration keyword.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"description":"Configuration keyword.",
"example":"STARTKW",
"maxLength":50,
"minLength":0
},
"example":"STARTKW"
},
{
"name":"channel",
"in":"query",
"description":"Required if number, numberKey, resource or resourceKey present.",
"required":true,
"style":"form",
"explode":true,
"schema":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ConfigurationType"
},
"example":"SMS"
},
{
"name":"countryCode",
"in":"query",
"description":"Country code in two-letter ISO standard. Required for identifying country specific resources (for instance, short code number types).",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"description":"Country code in two-letter ISO standard. Required for identifying country specific resources (for instance, short code number types).",
"example":"GB",
"pattern":"^[A-Z]{2}$"
},
"example":"GB"
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoConfigurationResponse"
}
}
}
}
},
"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"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":2,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
},
"post":{
"tags":[
"platform",
"resources",
"resource-management"
],
"summary":"Manage inbound configuration",
"description":"Create and update configuration details for incoming messages. Each action type and channel will require different parameters.",
"externalDocs":{
"description":"Read more about keywords",
"url":"https://www.infobip.com/docs/numbers/keywords-and-actions"
},
"operationId":"manage-inbound-configuration",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoConfigurationRequest"
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoConfigurationResponse"
}
}
}
},
"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":"token",
"replenishRate":2,
"requestedTokens":1,
"burstCapacity":10
}
]
}
},
"/resource-management/1/inbound-message-configurations/{configurationKey}":{
"delete":{
"tags":[
"platform",
"resources",
"resource-management"
],
"summary":"Delete inbound configuration",
"description":"This method will delete the configuration.",
"externalDocs":{
"description":"Read more about keywords",
"url":"https://www.infobip.com/docs/numbers/keywords-and-actions"
},
"operationId":"delete-inbound-configuration",
"parameters":[
{
"name":"configurationKey",
"in":"path",
"description":"Unique ID of configuration.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string",
"description":"Unique ID of configuration.",
"example":"58BC6DB7966CB9F69A91EB956DF73239"
},
"example":"58BC6DB7966CB9F69A91EB956DF73239"
}
],
"responses":{
"204":{
"description":"No Content"
},
"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"
}
]
}
},
"/resources/1/resources":{
"post":{
"tags":[
"platform",
"resources",
"resource-management"
],
"summary":"Search resources",
"description":"Search resources already owned by your account, such as senders and usable numbers, using filters. This endpoint does not return available resources for purchase or request, it only lists resources that are currently assigned to you.
\nPagination is supported; however, if no pagination arguments are supplied, the full unpaginated result set will be returned.\n",
"operationId":"list-resources",
"parameters":[
{
"name":"page",
"in":"query",
"description":"Results page to retrieve (0..N).",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32",
"default":0,
"minimum":0
}
},
{
"name":"size",
"in":"query",
"description":"Number of items per page.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32",
"default":20,
"minimum":1
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourcesFilter"
}
}
}
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourcesResponse"
},
"examples":{
"Response example":{
"summary":"Response example",
"value":{
"results":[
{
"number":"447860041117",
"numberKey":"58B3840032C7774BAC840EEEA2C23A44",
"platform":{
"applicationId":"myApplicationId",
"entityId":"myEntityId"
},
"numberType":"VIRTUAL_LONG_NUMBER",
"countryCode":"GB",
"countryName":"United Kingdom",
"capabilities":[
"SMS"
],
"resourceType":"NUMBER"
}
],
"paging":{
"page":0,
"size":1,
"totalPages":1,
"totalResults":1
}
}
}
}
}
}
},
"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":10,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/resources/1/coverage-lookup":{
"post":{
"tags":[
"platform",
"resources",
"resource-management"
],
"summary":"Lookup coverage for a resource",
"description":"Look up the coverage for a single resource by specifying the resource type, identifier (such as sender name or phone number), and associated country code.
\n",
"operationId":"lookup-resource-coverage",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceCoverageKey"
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceCoverageInfo"
}
}
}
},
"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":10,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/resources/1/requirements-lookup":{
"post":{
"tags":[
"platform",
"resources",
"resource-request"
],
"summary":"Get resource requirements",
"description":"Get a list of requirements needed for requesting a specific resource.",
"operationId":"resources-requirements-lookup",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.RequirementSpecsRequestApiDoc"
},
"examples":{
"Alphanumeric Registration":{
"summary":"Alphanumeric Registration",
"value":{
"type":"ALPHANUMERIC_REGISTRATION",
"countryCode":"HR",
"trafficOrigin":"LOCAL",
"trafficType":"TRANSACTIONAL"
},
"x-label":{
"type":[
"Alphanumeric Registration"
]
}
},
"Number Purchase":{
"summary":"Number Purchase",
"value":{
"type":"NUMBER_PURCHASE",
"quantity":1,
"numberType":"TEN_DIGIT_LONG_CODE",
"capabilities":[
"SMS"
],
"countryCode":"US"
},
"x-label":{
"type":[
"Number Purchase"
]
}
},
"Number Purchase - Local client type":{
"summary":"Number Purchase - Local client type",
"value":{
"type":"NUMBER_PURCHASE",
"quantity":1,
"numberType":"VIRTUAL_LONG_NUMBER",
"capabilities":[
"SMS"
],
"clientType":"LOCAL",
"countryCode":"HR"
},
"x-label":{
"type":[
"Number Purchase"
]
}
},
"RCS Sender Launch":{
"summary":"RCS Sender Launch",
"value":{
"type":"RCS_SENDER_LAUNCH",
"countryCode":"HR",
"excludedCarriers":[
"Carrier A",
"Carrier B"
],
"trafficOrigin":"LOCAL"
},
"x-label":{
"type":[
"RCS Sender Launch"
]
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.RequirementSpecs"
},
"examples":{
"Requirements present":{
"summary":"Requirements present",
"value":{
"requirements":[
{
"key":"companyName",
"type":"TEXT",
"name":"Company Name",
"description":"The legal name of the company.",
"required":true,
"category":"BUSINESS_DETAILS",
"validation":{
"minLength":3,
"maxLength":100
}
},
{
"key":"vatNumber",
"type":"TEXT",
"name":"VAT Number",
"description":"The company's VAT registration number.",
"required":false,
"category":"BUSINESS_DETAILS",
"validation":{
"pattern":"^[A-Z]{2}[0-9]{8,12}$"
}
},
{
"key":"useCase",
"type":"TEXT",
"name":"Use Case",
"description":"Describe the intended messaging use case.",
"required":true,
"category":"USE_CASE_DETAILS",
"options":[
"OTP",
"Alerts",
"Promotions",
"Notifications"
]
},
{
"key":"expectedMonthlyMessages",
"type":"INTEGER",
"name":"Expected Monthly Messages",
"description":"Estimated number of messages you plan to send per month.",
"required":false,
"category":"USE_CASE_DETAILS",
"validation":{
"minValue":1000,
"maxValue":10000000
}
},
{
"key":"companyEmailAddresses",
"type":"EMAIL",
"name":"Company Email Addresses",
"description":"Email addresses associated with the company.",
"required":false,
"multipleValuesSupported":true,
"category":"CONTACT_INFORMATION"
},
{
"key":"companyWebsite",
"type":"URL",
"name":"Company Website",
"description":"The official website of the company.",
"required":true,
"category":"BUSINESS_DETAILS"
},
{
"key":"contactPhoneNumber",
"type":"GSM",
"name":"Contact Phone Number",
"description":"Primary contact phone number in international format.",
"required":false,
"category":"CONTACT_INFORMATION"
},
{
"key":"companyRegistrationDocument",
"type":"DOCUMENT",
"name":"Company Registration Document",
"description":"Official document confirming company registration.",
"required":true,
"category":"BUSINESS_DETAILS"
},
{
"key":"registrationForm",
"type":"DOCUMENT",
"name":"Registration Form",
"description":"Please fill in the provided template and upload the completed document.",
"required":false,
"category":"OTHER",
"attachment":{
"documentId":"103AFCC51DC08FDD351D6ACB689FA071FDF7F7EB92FD6451F62A3AA92EBFA69596150BE4C4BFFBC97182A27D716ED0D3CB67682EF7E0D615EC501064A8B9A201",
"documentType":"TEMPLATE"
}
},
{
"key":"registrationConsent",
"type":"TEXT",
"name":"Registration Consent",
"description":"Confirm your consent for Infobip to perform the registration on your behalf.",
"required":true,
"category":"OTHER",
"options":[
"I consent that Infobip will do registration in my name."
]
}
]
}
},
"No requirements present":{
"summary":"No requirements present",
"value":{
"requirements":[]
}
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"examples":{
"Virtual Long Number not supported for US":{
"summary":"Virtual Long Number not supported for US",
"value":{
"errorCode":"RR-NUMBER-PURCHASE-US-VLN-UNSUPPORTED400",
"description":"Virtual Long Number is not supported for the US.",
"action":"For the US, TEN_DIGIT_LONG_CODE or TOLL_FREE_NUMBER are the supported number types.",
"violations":[],
"resources":[]
},
"x-label":{
"type":[
"Number Purchase"
]
}
},
"Short Code for US available via web only":{
"summary":"Short Code for US available via web only",
"value":{
"errorCode":"RR-NUMBER-PURCHASE-US-SC-WEB-ONLY400",
"description":"Short Code purchase for the US is not available via API.",
"action":"US Short Codes can be requested through Infobip Web Interface.",
"violations":[],
"resources":[]
},
"x-label":{
"type":[
"Number Purchase"
]
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"errorCode":"E400",
"description":"Request cannot be processed.",
"action":"Check the syntax, violations and adjust the request.",
"violations":[
{
"property":"property.path",
"violation":"Violation message."
}
],
"resources":[]
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiError401"
},
"403":{
"$ref":"#/components/responses/ApiError403"
},
"404":{
"description":"Not Found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"examples":{
"Alphanumeric sender not available for country":{
"summary":"Alphanumeric sender not available for country",
"value":{
"errorCode":"RR-ALPHA-UNAVAILABLE404",
"description":"Alphanumeric sender resource not available for given country.",
"action":"Please try again with a different country code.",
"violations":[],
"resources":[]
},
"x-label":{
"type":[
"Alphanumeric Registration"
]
}
},
"Numbers not available for given parameters":{
"summary":"Numbers not available for given parameters",
"value":{
"errorCode":"RR-NUMBER-PURCHASE-UNAVAILABLE404",
"description":"Number resource not available for given parameters.",
"action":"Please adjust your parameters (capabilities, number type, quantity, country) and try again.",
"violations":[],
"resources":[]
},
"x-label":{
"type":[
"Number Purchase"
]
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiError429"
},
"500":{
"$ref":"#/components/responses/ApiError500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"resource-request-hub:manage",
"resource-request-hub:read"
],
"x-is-early-access":true,
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":10,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/resources/1/requests":{
"get":{
"tags":[
"platform",
"resources",
"resource-request"
],
"summary":"Get resource requests",
"description":"Gets a page of resource requests, using query parameters to filter results.",
"operationId":"get-resource-requests",
"parameters":[
{
"name":"countryCode",
"in":"query",
"description":"Filters resources to those that match the supplied country code.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"array",
"items":{
"type":"string"
}
},
"example":"US,HR"
},
{
"name":"status",
"in":"query",
"description":"Filters resources to those that match the resource request status.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.ResourceOrderStatus"
}
},
"example":"IN_REVIEW,UPDATE_REQUESTED_BY_INTERNAL_REVIEWER,IN_PROGRESS,COMPLETED,REJECTED"
},
{
"name":"type",
"in":"query",
"description":"Filters resources to those that match the supplied resource type.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"array",
"items":{
"type":"string",
"enum":[
"ALPHANUMERIC_REGISTRATION",
"NUMBER_PURCHASE",
"RCS_SENDER_LAUNCH"
]
}
},
"example":"ALPHANUMERIC_REGISTRATION,NUMBER_PURCHASE,RCS_SENDER_LAUNCH"
},
{
"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 descending by last modified date. Sortable Properties: 'status', 'requestedDate'.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"array",
"items":{
"type":"string"
}
},
"example":"requestedDate,desc"
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.PageResourceOrderApiDoc"
},
"examples":{
"Resource requests page":{
"summary":"Resource requests page",
"value":{
"results":[
{
"id":"d3f96668-b174-4d76-8b21-b3098d566b52",
"type":"RCS_SENDER_LAUNCH",
"status":"IN_REVIEW",
"countryCode":"HR",
"excludedCarriers":[
"Carrier A",
"Carrier B"
],
"senderName":"Example sender",
"requestedByEmailAddress":"examples@example.com",
"additionalContactEmails":[
"examples@example.com",
"example.two@example.com"
],
"requestedDate":"2026-02-14T13:57:21.000+0000",
"trafficOrigin":"LOCAL",
"requirements":[
{
"key":"legalBrandCompanyName",
"value":"example"
},
{
"key":"stockExchange",
"value":"EXAMPLE"
},
{
"key":"contactPersonEmailAddresses",
"value":"example@example.com"
},
{
"key":"contactPersonPhoneNumber",
"value":"1234567891"
},
{
"key":"attestationLetter",
"value":"documentId"
},
{
"key":"stopMessage",
"value":"stopMessageExample"
}
],
"requirementsFeedback":[],
"platform":{
"applicationId":"application-id",
"entityId":"entity-id"
}
},
{
"id":"c2e85557-a063-4f65-ab10-a2987c455a41",
"type":"NUMBER_PURCHASE",
"countryCode":"US",
"requestedByEmailAddress":"examples@example.com",
"additionalContactEmailAddresses":[],
"requestedDate":"2026-01-28T08:30:55.000+0000",
"status":"COMPLETED",
"numberType":"TEN_DIGIT_LONG_CODE",
"capabilities":[
"SMS"
],
"quantity":1,
"numbers":[
{
"number":"13179090123",
"numberKey":"7B4C1E93AD25F860E3917D4BC08E52F1",
"status":"SUCCESS"
}
],
"requirementsFeedback":[],
"requirements":[
{
"key":"state",
"value":"IN"
},
{
"key":"npa",
"value":"317"
},
{
"key":"nxx",
"value":"909"
}
],
"platform":{
"applicationId":"application-id",
"entityId":"entity-id"
}
},
{
"id":"b1d74446-f952-4e54-af09-f1876b344f30",
"type":"NUMBER_PURCHASE",
"countryCode":"HR",
"requestedByEmailAddress":"billing@infobip.com",
"additionalContactEmailAddresses":[],
"requestedDate":"2025-11-19T11:45:10.000+0000",
"status":"IN_PROGRESS",
"numberType":"VIRTUAL_LONG_NUMBER",
"capabilities":[
"SMS",
"MMS"
],
"quantity":5,
"numbers":[
{
"number":"+38591234567",
"numberKey":"A3F8C21D04E7B96F2150C8DA3E47B01F",
"status":"SUCCESS"
},
{
"number":"+38591234568",
"numberKey":"D92E4B810FC6A3571E08B29CD54F7A2E",
"status":"SUCCESS"
}
],
"requirementsFeedback":[],
"requirements":[
{
"key":"companyName",
"value":"Infobip"
},
{
"key":"vatNumber",
"value":"HR12345678901"
},
{
"key":"companyWebsite",
"value":"https://www.infobip.com"
}
],
"platform":{
"applicationId":"application-id",
"entityId":"entity-id"
}
},
{
"id":"e4a07779-a952-4e54-bf10-a2987c455b41",
"type":"ALPHANUMERIC_REGISTRATION",
"countryCode":"US",
"senderName":"InfobipUS",
"requestedByEmailAddress":"alphanumeric@infobip.com",
"additionalContactEmailAddresses":[],
"requestedDate":"2025-07-04T16:08:33.000+0000",
"status":"UPDATE_REQUESTED_BY_INTERNAL_REVIEWER",
"trafficOrigin":"INTERNATIONAL",
"trafficType":"PROMOTIONAL",
"requirementsFeedback":[
{
"key":"contactPhoneNumber",
"code":"RES_REQ_FEED_REQUIRED",
"feedback":"This field is required and cannot be empty."
},
{
"key":"expectedMonthlyMessages",
"code":"RES_REQ_FEED_VALUE_OOR",
"feedback":"Value must be between 1 and 10000000."
}
],
"requirements":[
{
"key":"companyName",
"value":"Infobip"
},
{
"key":"companyWebsite",
"value":"https://www.infobip.com"
},
{
"key":"useCase",
"value":"Promotions"
},
{
"key":"expectedMonthlyMessages",
"value":50000000
}
],
"platform":{
"applicationId":"application-id",
"entityId":"entity-id"
}
},
{
"id":"a0c63335-f841-4d43-9ef8-e0765a233f29",
"type":"ALPHANUMERIC_REGISTRATION",
"countryCode":"HR",
"senderName":"InfobipHR",
"requestedByEmailAddress":"alphanumeric@infobip.com",
"additionalContactEmailAddresses":[],
"requestedDate":"2025-03-11T09:22:47.000+0000",
"status":"REJECTED",
"trafficOrigin":"LOCAL",
"trafficType":"TRANSACTIONAL",
"note":"Your request has been rejected because it contains invalid information for the selected destination.",
"requirementsFeedback":[],
"requirements":[
{
"key":"companyName",
"value":"Infobip"
},
{
"key":"vatNumber",
"value":"HR12345678901"
},
{
"key":"useCase",
"value":"Notifications"
},
{
"key":"expectedMonthlyMessages",
"value":50000
},
{
"key":"companyEmailAddresses",
"value":[
"contact@infobip.com",
"info@infobip.com"
]
},
{
"key":"companyWebsite",
"value":"https://www.infobip.com"
},
{
"key":"contactPhoneNumber",
"value":"+385911234567"
}
],
"platform":{
"applicationId":"application-id",
"entityId":"entity-id"
}
}
],
"paging":{
"page":0,
"size":20,
"totalPages":1,
"totalResults":5
}
}
}
}
}
}
},
"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":[
"resource-request-hub:manage",
"resource-request-hub:read"
],
"x-is-early-access":true,
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":10,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
},
"post":{
"tags":[
"platform",
"resources",
"resource-request"
],
"summary":"Submit resource request",
"description":"Submits a resource request with Infobip. Please note that costs may apply.",
"operationId":"submit-resource-request",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.ResourceOrderRequestApiDoc"
},
"examples":{
"Alphanumeric Registration":{
"summary":"Alphanumeric Registration",
"value":{
"type":"ALPHANUMERIC_REGISTRATION",
"senderName":"InfobipHR",
"additionalContactEmails":[
"alphanumeric@infobip.com"
],
"countryCode":"HR",
"trafficOrigin":"LOCAL",
"trafficType":"TRANSACTIONAL",
"requirements":[
{
"key":"companyName",
"value":"Infobip"
},
{
"key":"vatNumber",
"value":"HR12345678901"
},
{
"key":"useCase",
"value":"Notifications"
},
{
"key":"expectedMonthlyMessages",
"value":50000
},
{
"key":"companyEmailAddresses",
"value":[
"contact@infobip.com",
"info@infobip.com"
]
},
{
"key":"companyWebsite",
"value":"https://www.infobip.com"
},
{
"key":"contactPhoneNumber",
"value":"+385911234567"
},
{
"key":"companyRegistrationDocument",
"value":"A3F8C21D04E7B96F2150C8DA3E47B01FCA8D5E92F3B741082E6C50D9A1FB8327E4C09B6D2A75F83190EC621B4D5A7803F96E12C48B3D07A95F12E840BC369241"
},
{
"key":"registrationForm",
"value":"2B7E4A91F53D08CC461E9BAD3F80712EDB9C6E53A2F841076D5B40E8C2FA9318B5D07C6E3A84F92180EB531C4D6A8702F85E13C49B4D08A96F23E951BD470352"
},
{
"key":"registrationConsent",
"value":"I consent that Infobip will do registration in my name."
}
],
"platform":{
"applicationId":"application-id",
"entityId":"entity-id"
}
},
"x-label":{
"type":[
"Alphanumeric Registration"
]
}
},
"Number Purchase - Virtual Long Number":{
"summary":"Number Purchase - Virtual Long Number",
"value":{
"type":"NUMBER_PURCHASE",
"quantity":5,
"numberType":"VIRTUAL_LONG_NUMBER",
"capabilities":[
"SMS",
"MMS"
],
"additionalContactEmails":[
"billing@infobip.com"
],
"countryCode":"HR",
"requirements":[
{
"key":"companyName",
"value":"Infobip"
},
{
"key":"vatNumber",
"value":"HR12345678901"
},
{
"key":"useCase",
"value":"Notifications"
},
{
"key":"expectedMonthlyMessages",
"value":50000
},
{
"key":"companyEmailAddresses",
"value":[
"contact@infobip.com",
"info@infobip.com"
]
},
{
"key":"companyWebsite",
"value":"https://www.infobip.com"
},
{
"key":"contactPhoneNumber",
"value":"+385911234567"
},
{
"key":"companyRegistrationDocument",
"value":"A3F8C21D04E7B96F2150C8DA3E47B01FCA8D5E92F3B741082E6C50D9A1FB8327E4C09B6D2A75F83190EC621B4D5A7803F96E12C48B3D07A95F12E840BC369241"
},
{
"key":"registrationForm",
"value":"2B7E4A91F53D08CC461E9BAD3F80712EDB9C6E53A2F841076D5B40E8C2FA9318B5D07C6E3A84F92180EB531C4D6A8702F85E13C49B4D08A96F23E951BD470352"
},
{
"key":"registrationConsent",
"value":"I consent that Infobip will do registration in my name."
}
],
"platform":{
"applicationId":"application-id",
"entityId":"entity-id"
}
},
"x-label":{
"type":[
"Number Purchase"
],
"numberType":[
"Virtual Long Number"
]
}
},
"Number Purchase - 10DLC":{
"summary":"Number Purchase - 10DLC",
"value":{
"type":"NUMBER_PURCHASE",
"quantity":1,
"numberType":"TEN_DIGIT_LONG_CODE",
"capabilities":[
"SMS"
],
"countryCode":"US",
"requirements":[
{
"key":"state",
"value":"IN"
},
{
"key":"npa",
"value":"317"
},
{
"key":"nxx",
"value":"909"
}
],
"platform":{
"applicationId":"application-id",
"entityId":"entity-id"
}
},
"x-label":{
"type":[
"Number Purchase"
],
"numberType":[
"10DLC"
]
}
},
"Number Purchase - Toll-Free Number":{
"summary":"Number Purchase - Toll-Free Number",
"value":{
"type":"NUMBER_PURCHASE",
"quantity":1,
"numberType":"TOLL_FREE_NUMBER",
"capabilities":[
"SMS"
],
"countryCode":"US",
"requirements":[],
"platform":{
"applicationId":"application-id",
"entityId":"entity-id"
}
},
"x-label":{
"type":[
"Number Purchase"
],
"numberType":[
"Toll-Free Number"
]
}
},
"Number Purchase - Short Code":{
"summary":"Number Purchase - Short Code",
"value":{
"type":"NUMBER_PURCHASE",
"quantity":1,
"numberType":"SHORT_CODE",
"capabilities":[
"SMS"
],
"countryCode":"DE",
"requirements":[
{
"key":"companyName",
"value":"Infobip"
},
{
"key":"companyPhoneNumber",
"value":"+385911234567"
},
{
"key":"contactEmailAddress",
"value":"contact@infobip.com"
},
{
"key":"useCaseDescription",
"value":"Sending transactional notifications to end users."
},
{
"key":"serviceName",
"value":"Infobip Notifications"
},
{
"key":"messageExample",
"value":"Your verification code is 123456."
},
{
"key":"monthlyOutboundSmsEstimate",
"value":"50000"
},
{
"key":"monthlyInboundSmsEstimate",
"value":"5000"
},
{
"key":"typesOfTraffic",
"value":"Transactional"
},
{
"key":"brandName",
"value":"Infobip"
}
],
"platform":{
"applicationId":"application-id",
"entityId":"entity-id"
}
},
"x-label":{
"type":[
"Number Purchase"
],
"numberType":[
"Short Code"
]
}
},
"RCS Sender Launch":{
"summary":"RCS Sender Launch",
"value":{
"type":"RCS_SENDER_LAUNCH",
"senderName":"Example sender",
"additionalContactEmails":[
"examples@example.com",
"example.two@example.com"
],
"countryCode":"HR",
"excludedCarriers":[
"Carrier A",
"Carrier B"
],
"trafficOrigin":"LOCAL",
"requirements":[
{
"key":"legalBrandCompanyName",
"value":"example"
},
{
"key":"stockExchange",
"value":"EXAMPLE"
},
{
"key":"contactPersonEmailAddresses",
"value":"example@example.com"
},
{
"key":"contactPersonPhoneNumber",
"value":"1234567891"
},
{
"key":"attestationLetter",
"value":"documentId"
},
{
"key":"stopMessage",
"value":"stopMessageExample"
}
],
"platform":{
"applicationId":"application-id",
"entityId":"entity-id"
}
},
"x-label":{
"type":[
"RCS Sender Launch"
]
}
}
}
}
},
"required":true
},
"responses":{
"201":{
"description":"Created",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.ResourceOrderIdentifier"
},
"examples":{
"Resource request created":{
"summary":"Resource request created",
"value":{
"id":"a0c63335-f841-4d43-9ef8-e0765a233f29"
}
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"examples":{
"Alphanumeric sender name already exists":{
"summary":"Alphanumeric sender name already exists",
"value":{
"errorCode":"RR-ALPHA-SENDER-ALREADY-EXISTS400",
"description":"Alphanumeric sender name already exists for given country.",
"action":"Please try again with different sender name.",
"violations":[],
"resources":[]
},
"x-label":{
"type":[
"Alphanumeric Registration"
]
}
},
"Alphanumeric pending request limit exceeded":{
"summary":"Alphanumeric pending request limit exceeded",
"value":{
"errorCode":"RR-ALPHA-SS-LIMIT400",
"description":"You can have up to 2 pending sender requests at once.",
"action":"Track their status in Get resource request, or contact us for more information.",
"violations":[],
"resources":[]
},
"x-label":{
"type":[
"Alphanumeric Registration"
]
}
},
"Alphanumeric not enough credits":{
"summary":"Alphanumeric not enough credits",
"value":{
"errorCode":"RR-NO-FUNDS400",
"description":"Not enough credits. Your account does not meet the credit threshold.",
"action":"Please add more funds.",
"violations":[],
"resources":[]
},
"x-label":{
"type":[
"Alphanumeric Registration"
]
}
},
"Virtual Long Number not supported for US":{
"summary":"Virtual Long Number not supported for US",
"value":{
"errorCode":"RR-NUMBER-PURCHASE-US-VLN-UNSUPPORTED400",
"description":"Virtual Long Number is not supported for the US.",
"action":"For the US, TEN_DIGIT_LONG_CODE or TOLL_FREE_NUMBER are the supported number types.",
"violations":[],
"resources":[]
},
"x-label":{
"type":[
"Number Purchase"
]
}
},
"Short Code for US available via web only":{
"summary":"Short Code for US available via web only",
"value":{
"errorCode":"RR-NUMBER-PURCHASE-US-SC-WEB-ONLY400",
"description":"Short Code purchase for the US is not available via API.",
"action":"US Short Codes can be requested through Infobip Web Interface.",
"violations":[],
"resources":[]
},
"x-label":{
"type":[
"Number Purchase"
]
}
},
"Number purchase not enough credits":{
"summary":"Number purchase not enough credits",
"value":{
"errorCode":"RR-NO-FUNDS400",
"description":"Not enough credits. Your account does not meet the credit threshold.",
"action":"Please add more funds.",
"violations":[],
"resources":[]
},
"x-label":{
"type":[
"Number Purchase"
]
}
},
"Provided nxx requires valid npa and state combination":{
"summary":"Provided nxx requires valid npa and state combination",
"value":{
"errorCode":"RR-NUMBER-PURCHASE-NXX-REQUIRES-NPA-STATE400",
"description":"Provided nxx requires a valid npa and state combination.",
"action":"Please provide a valid npa and state for the requested nxx.",
"violations":[],
"resources":[]
},
"x-label":{
"type":[
"Number Purchase"
]
}
},
"Invalid state and npa combination":{
"summary":"Invalid state and npa combination",
"value":{
"errorCode":"RR-NUMBER-PURCHASE-INVALID-STATE-NPA-COMBO400",
"description":"Invalid state and npa combination.",
"action":"Please provide a valid state and npa combination.",
"violations":[],
"resources":[]
},
"x-label":{
"type":[
"Number Purchase"
]
}
},
"Invalid npa and nxx combination":{
"summary":"Invalid npa and nxx combination",
"value":{
"errorCode":"RR-NUMBER-PURCHASE-INVALID-NPA-NXX-COMBO400",
"description":"Invalid npa and nxx combination.",
"action":"Please provide a valid npa and nxx combination.",
"violations":[],
"resources":[]
},
"x-label":{
"type":[
"Number Purchase"
]
}
},
"RCS sender already launched":{
"summary":"RCS sender already launched",
"value":{
"errorCode":"RR-RCS-SENDER-ALREADY-LAUNCHED400",
"description":"RCS sender has already been launched.",
"action":"Sender cannot be launched in multiple countries. Create a new sender to start the launch process.",
"violations":[],
"resources":[]
},
"x-label":{
"type":[
"RCS Sender Launch"
]
}
},
"RCS sender launch already requested":{
"summary":"RCS sender launch already requested",
"value":{
"errorCode":"RR-RCS-SENDER-ALREADY-REQUESTED400",
"description":"A launch request for this RCS sender is already in progress.",
"action":"Please wait for the current launch process to finish before taking any further action with this sender.",
"violations":[],
"resources":[]
},
"x-label":{
"type":[
"RCS Sender Launch"
]
}
},
"RCS not supported in country":{
"summary":"RCS not supported in country",
"value":{
"errorCode":"RR-RCS-SENDER-COUNTRY-UNSUPPORTED400",
"description":"RCS is not supported in the specified country.",
"action":"Please select a supported country to launch an RCS sender.",
"violations":[],
"resources":[]
},
"x-label":{
"type":[
"RCS Sender Launch"
]
}
},
"RCS sender invalid carriers":{
"summary":"RCS sender invalid carriers",
"value":{
"errorCode":"RR-RCS-SENDER-INVALID-CARRIERS400",
"description":"One or more specified carrier names are invalid for the target country.",
"action":"Verify carrier names are correct for the specified country.",
"violations":[],
"resources":[]
},
"x-label":{
"type":[
"RCS Sender Launch"
]
}
},
"RCS sender invalid brand contact email":{
"summary":"RCS sender invalid brand contact email",
"value":{
"errorCode":"RR-RCS-SENDER-INVALID-BRAND-CONTACT-EMAIL400",
"description":"Brand contact email must be an individual business email, not a shared or team address (e.g., info@, support@, team@).",
"action":"Provide a personal business email linked to the contact person's name and company domain.",
"violations":[],
"resources":[]
},
"x-label":{
"type":[
"RCS Sender Launch"
]
}
},
"RCS sender phone number conflict":{
"summary":"RCS sender phone number conflict",
"value":{
"errorCode":"RR-RCS-SENDER-PHONE-NUMBER-CONFLICT400",
"description":"Company phone number cannot be the same as the brand contact's mobile number.",
"action":"Provide a different company phone number that is distinct from the brand contact's personal mobile number.",
"violations":[],
"resources":[]
},
"x-label":{
"type":[
"RCS Sender Launch"
]
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"errorCode":"E400",
"description":"Request cannot be processed.",
"action":"Check the syntax, violations and adjust the request.",
"violations":[
{
"property":"property.path",
"violation":"Violation message."
}
],
"resources":[]
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiError401"
},
"403":{
"$ref":"#/components/responses/ApiError403"
},
"404":{
"description":"Not Found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"examples":{
"Alphanumeric sender not available for country":{
"summary":"Alphanumeric sender not available for country",
"value":{
"errorCode":"RR-ALPHA-UNAVAILABLE404",
"description":"Alphanumeric sender resource not available for given country.",
"action":"Please try again with a different country code.",
"violations":[],
"resources":[]
},
"x-label":{
"type":[
"Alphanumeric Registration"
]
}
},
"Numbers not available for given parameters":{
"summary":"Numbers not available for given parameters",
"value":{
"errorCode":"RR-NUMBER-PURCHASE-UNAVAILABLE404",
"description":"Number resource not available for given parameters.",
"action":"Please adjust your parameters (capabilities, number type, quantity, country) and try again.",
"violations":[],
"resources":[]
},
"x-label":{
"type":[
"Number Purchase"
]
}
},
"RCS sender not found":{
"summary":"RCS sender not found",
"value":{
"errorCode":"RR-RCS-SENDER404",
"description":"The specified RCS sender was not found.",
"action":"Verify the sender name or create a new sender before proceeding.",
"violations":[],
"resources":[]
},
"x-label":{
"type":[
"RCS Sender Launch"
]
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiError429"
},
"500":{
"$ref":"#/components/responses/ApiError500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"resource-request-hub:manage",
"resource-request-hub:read"
],
"x-is-early-access":true,
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":1,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/resources/1/requests/{id}":{
"get":{
"tags":[
"platform",
"resources",
"resource-request"
],
"summary":"Get resource request",
"description":"Retrieves a previously submitted resource request by its ID.",
"operationId":"get-resource-request",
"parameters":[
{
"name":"id",
"in":"path",
"description":"The ID of the desired resource.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string",
"format":"uuid",
"description":"The ID of the desired resource."
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.ResourceOrderApiDoc"
},
"examples":{
"Alphanumeric Registration - PENDING":{
"summary":"Alphanumeric Registration - PENDING",
"value":{
"id":"a0c63335-f841-4d43-9ef8-e0765a233f29",
"type":"ALPHANUMERIC_REGISTRATION",
"countryCode":"HR",
"senderName":"InfobipHR",
"requestedByEmailAddress":"alphanumeric@infobip.com",
"additionalContactEmailAddresses":[
"contact@infobip.com"
],
"requestedDate":"2025-03-11T09:22:47.000+0000",
"status":"PENDING",
"trafficOrigin":"LOCAL",
"trafficType":"TRANSACTIONAL",
"requirementsFeedback":[],
"requirements":[
{
"key":"companyName",
"value":"Infobip"
},
{
"key":"vatNumber",
"value":"HR12345678901"
},
{
"key":"useCase",
"value":"Notifications"
},
{
"key":"expectedMonthlyMessages",
"value":50000
},
{
"key":"companyEmailAddresses",
"value":[
"contact@infobip.com",
"info@infobip.com"
]
},
{
"key":"companyWebsite",
"value":"https://www.infobip.com"
},
{
"key":"contactPhoneNumber",
"value":"+385911234567"
},
{
"key":"companyRegistrationDocument",
"value":"A3F8C21D04E7B96F2150C8DA3E47B01FCA8D5E92F3B741082E6C50D9A1FB8327E4C09B6D2A75F83190EC621B4D5A7803F96E12C48B3D07A95F12E840BC369241"
},
{
"key":"registrationForm",
"value":"2B7E4A91F53D08CC461E9BAD3F80712EDB9C6E53A2F841076D5B40E8C2FA9318B5D07C6E3A84F92180EB531C4D6A8702F85E13C49B4D08A96F23E951BD470352"
},
{
"key":"registrationConsent",
"value":"I consent that Infobip will do registration in my name."
}
],
"platform":{
"applicationId":"application-id",
"entityId":"entity-id"
}
},
"x-label":{
"type":[
"Alphanumeric Registration"
],
"status":[
"PENDING"
]
}
},
"Alphanumeric Registration - AUTOMATIC_VALIDATION":{
"summary":"Alphanumeric Registration - AUTOMATIC_VALIDATION",
"value":{
"id":"a0c63335-f841-4d43-9ef8-e0765a233f29",
"type":"ALPHANUMERIC_REGISTRATION",
"countryCode":"HR",
"senderName":"InfobipHR",
"requestedByEmailAddress":"alphanumeric@infobip.com",
"additionalContactEmailAddresses":[
"contact@infobip.com"
],
"requestedDate":"2025-03-11T09:22:47.000+0000",
"status":"AUTOMATIC_VALIDATION",
"trafficOrigin":"LOCAL",
"trafficType":"TRANSACTIONAL",
"requirementsFeedback":[],
"requirements":[
{
"key":"companyName",
"value":"Infobip"
},
{
"key":"vatNumber",
"value":"HR12345678901"
},
{
"key":"useCase",
"value":"Notifications"
},
{
"key":"expectedMonthlyMessages",
"value":50000
},
{
"key":"companyEmailAddresses",
"value":[
"contact@infobip.com",
"info@infobip.com"
]
},
{
"key":"companyWebsite",
"value":"https://www.infobip.com"
},
{
"key":"contactPhoneNumber",
"value":"+385911234567"
},
{
"key":"companyRegistrationDocument",
"value":"A3F8C21D04E7B96F2150C8DA3E47B01FCA8D5E92F3B741082E6C50D9A1FB8327E4C09B6D2A75F83190EC621B4D5A7803F96E12C48B3D07A95F12E840BC369241"
},
{
"key":"registrationForm",
"value":"2B7E4A91F53D08CC461E9BAD3F80712EDB9C6E53A2F841076D5B40E8C2FA9318B5D07C6E3A84F92180EB531C4D6A8702F85E13C49B4D08A96F23E951BD470352"
},
{
"key":"registrationConsent",
"value":"I consent that Infobip will do registration in my name."
}
],
"platform":{
"applicationId":"application-id",
"entityId":"entity-id"
}
},
"x-label":{
"type":[
"Alphanumeric Registration"
],
"status":[
"AUTOMATIC_VALIDATION"
]
}
},
"Alphanumeric Registration - UPDATE_REQUESTED":{
"summary":"Alphanumeric Registration - UPDATE_REQUESTED",
"value":{
"id":"a0c63335-f841-4d43-9ef8-e0765a233f29",
"type":"ALPHANUMERIC_REGISTRATION",
"countryCode":"HR",
"senderName":"InfobipHR",
"requestedByEmailAddress":"alphanumeric@infobip.com",
"additionalContactEmailAddresses":[
"contact@infobip.com"
],
"requestedDate":"2025-03-11T09:22:47.000+0000",
"status":"UPDATE_REQUESTED",
"trafficOrigin":"LOCAL",
"trafficType":"TRANSACTIONAL",
"requirementsFeedback":[
{
"key":"contactPhoneNumber",
"code":"RES_REQ_FEED_REQUIRED",
"feedback":"This field is required and cannot be empty."
},
{
"key":"companyName",
"code":"RES_REQ_FEED_LENGTH_OOR",
"feedback":"Text length must be between 2 and 100."
}
],
"requirements":[
{
"key":"companyName",
"value":"Infobip"
},
{
"key":"vatNumber",
"value":"HR12345678901"
},
{
"key":"useCase",
"value":"Notifications"
},
{
"key":"expectedMonthlyMessages",
"value":50000
},
{
"key":"companyEmailAddresses",
"value":[
"contact@infobip.com",
"info@infobip.com"
]
},
{
"key":"companyWebsite",
"value":"https://www.infobip.com"
},
{
"key":"contactPhoneNumber",
"value":"+385911234567"
},
{
"key":"companyRegistrationDocument",
"value":"A3F8C21D04E7B96F2150C8DA3E47B01FCA8D5E92F3B741082E6C50D9A1FB8327E4C09B6D2A75F83190EC621B4D5A7803F96E12C48B3D07A95F12E840BC369241"
},
{
"key":"registrationForm",
"value":"2B7E4A91F53D08CC461E9BAD3F80712EDB9C6E53A2F841076D5B40E8C2FA9318B5D07C6E3A84F92180EB531C4D6A8702F85E13C49B4D08A96F23E951BD470352"
},
{
"key":"registrationConsent",
"value":"I consent that Infobip will do registration in my name."
}
],
"platform":{
"applicationId":"application-id",
"entityId":"entity-id"
}
},
"x-label":{
"type":[
"Alphanumeric Registration"
],
"status":[
"UPDATE_REQUESTED"
]
}
},
"Alphanumeric Registration - PENDING_REVIEW":{
"summary":"Alphanumeric Registration - PENDING_REVIEW",
"value":{
"id":"a0c63335-f841-4d43-9ef8-e0765a233f29",
"type":"ALPHANUMERIC_REGISTRATION",
"countryCode":"HR",
"senderName":"InfobipHR",
"requestedByEmailAddress":"alphanumeric@infobip.com",
"additionalContactEmailAddresses":[
"contact@infobip.com"
],
"requestedDate":"2025-03-11T09:22:47.000+0000",
"status":"PENDING_REVIEW",
"trafficOrigin":"LOCAL",
"trafficType":"TRANSACTIONAL",
"requirementsFeedback":[],
"requirements":[
{
"key":"companyName",
"value":"Infobip"
},
{
"key":"vatNumber",
"value":"HR12345678901"
},
{
"key":"useCase",
"value":"Notifications"
},
{
"key":"expectedMonthlyMessages",
"value":50000
},
{
"key":"companyEmailAddresses",
"value":[
"contact@infobip.com",
"info@infobip.com"
]
},
{
"key":"companyWebsite",
"value":"https://www.infobip.com"
},
{
"key":"contactPhoneNumber",
"value":"+385911234567"
},
{
"key":"companyRegistrationDocument",
"value":"A3F8C21D04E7B96F2150C8DA3E47B01FCA8D5E92F3B741082E6C50D9A1FB8327E4C09B6D2A75F83190EC621B4D5A7803F96E12C48B3D07A95F12E840BC369241"
},
{
"key":"registrationForm",
"value":"2B7E4A91F53D08CC461E9BAD3F80712EDB9C6E53A2F841076D5B40E8C2FA9318B5D07C6E3A84F92180EB531C4D6A8702F85E13C49B4D08A96F23E951BD470352"
},
{
"key":"registrationConsent",
"value":"I consent that Infobip will do registration in my name."
}
],
"platform":{
"applicationId":"application-id",
"entityId":"entity-id"
}
},
"x-label":{
"type":[
"Alphanumeric Registration"
],
"status":[
"PENDING_REVIEW"
]
}
},
"Alphanumeric Registration - IN_REVIEW":{
"summary":"Alphanumeric Registration - IN_REVIEW",
"value":{
"id":"a0c63335-f841-4d43-9ef8-e0765a233f29",
"type":"ALPHANUMERIC_REGISTRATION",
"countryCode":"HR",
"senderName":"InfobipHR",
"requestedByEmailAddress":"alphanumeric@infobip.com",
"additionalContactEmailAddresses":[
"contact@infobip.com"
],
"requestedDate":"2025-03-11T09:22:47.000+0000",
"status":"IN_REVIEW",
"trafficOrigin":"LOCAL",
"trafficType":"TRANSACTIONAL",
"requirementsFeedback":[],
"requirements":[
{
"key":"companyName",
"value":"Infobip"
},
{
"key":"vatNumber",
"value":"HR12345678901"
},
{
"key":"useCase",
"value":"Notifications"
},
{
"key":"expectedMonthlyMessages",
"value":50000
},
{
"key":"companyEmailAddresses",
"value":[
"contact@infobip.com",
"info@infobip.com"
]
},
{
"key":"companyWebsite",
"value":"https://www.infobip.com"
},
{
"key":"contactPhoneNumber",
"value":"+385911234567"
},
{
"key":"companyRegistrationDocument",
"value":"A3F8C21D04E7B96F2150C8DA3E47B01FCA8D5E92F3B741082E6C50D9A1FB8327E4C09B6D2A75F83190EC621B4D5A7803F96E12C48B3D07A95F12E840BC369241"
},
{
"key":"registrationForm",
"value":"2B7E4A91F53D08CC461E9BAD3F80712EDB9C6E53A2F841076D5B40E8C2FA9318B5D07C6E3A84F92180EB531C4D6A8702F85E13C49B4D08A96F23E951BD470352"
},
{
"key":"registrationConsent",
"value":"I consent that Infobip will do registration in my name."
}
],
"platform":{
"applicationId":"application-id",
"entityId":"entity-id"
}
},
"x-label":{
"type":[
"Alphanumeric Registration"
],
"status":[
"IN_REVIEW"
]
}
},
"Alphanumeric Registration - UPDATE_REQUESTED_BY_INTERNAL_REVIEWER":{
"summary":"Alphanumeric Registration - UPDATE_REQUESTED_BY_INTERNAL_REVIEWER",
"value":{
"id":"a0c63335-f841-4d43-9ef8-e0765a233f29",
"type":"ALPHANUMERIC_REGISTRATION",
"countryCode":"HR",
"senderName":"InfobipHR",
"requestedByEmailAddress":"alphanumeric@infobip.com",
"additionalContactEmailAddresses":[
"contact@infobip.com"
],
"requestedDate":"2025-03-11T09:22:47.000+0000",
"status":"UPDATE_REQUESTED_BY_INTERNAL_REVIEWER",
"trafficOrigin":"LOCAL",
"trafficType":"TRANSACTIONAL",
"requirementsFeedback":[
{
"key":"contactPhoneNumber",
"code":"RES_REQ_FEED_REQUIRED",
"feedback":"This field is required and cannot be empty."
},
{
"key":"companyName",
"code":"RES_REQ_FEED_LENGTH_OOR",
"feedback":"Text length must be between 2 and 100."
}
],
"requirements":[
{
"key":"companyName",
"value":"Infobip"
},
{
"key":"vatNumber",
"value":"HR12345678901"
},
{
"key":"useCase",
"value":"Notifications"
},
{
"key":"expectedMonthlyMessages",
"value":50000
},
{
"key":"companyEmailAddresses",
"value":[
"contact@infobip.com",
"info@infobip.com"
]
},
{
"key":"companyWebsite",
"value":"https://www.infobip.com"
},
{
"key":"contactPhoneNumber",
"value":"+385911234567"
},
{
"key":"companyRegistrationDocument",
"value":"A3F8C21D04E7B96F2150C8DA3E47B01FCA8D5E92F3B741082E6C50D9A1FB8327E4C09B6D2A75F83190EC621B4D5A7803F96E12C48B3D07A95F12E840BC369241"
},
{
"key":"registrationForm",
"value":"2B7E4A91F53D08CC461E9BAD3F80712EDB9C6E53A2F841076D5B40E8C2FA9318B5D07C6E3A84F92180EB531C4D6A8702F85E13C49B4D08A96F23E951BD470352"
},
{
"key":"registrationConsent",
"value":"I consent that Infobip will do registration in my name."
}
],
"platform":{
"applicationId":"application-id",
"entityId":"entity-id"
}
},
"x-label":{
"type":[
"Alphanumeric Registration"
],
"status":[
"UPDATE_REQUESTED_BY_INTERNAL_REVIEWER"
]
}
},
"Alphanumeric Registration - IN_PROGRESS":{
"summary":"Alphanumeric Registration - IN_PROGRESS",
"value":{
"id":"a0c63335-f841-4d43-9ef8-e0765a233f29",
"type":"ALPHANUMERIC_REGISTRATION",
"countryCode":"HR",
"senderName":"InfobipHR",
"requestedByEmailAddress":"alphanumeric@infobip.com",
"additionalContactEmailAddresses":[
"contact@infobip.com"
],
"requestedDate":"2025-03-11T09:22:47.000+0000",
"status":"IN_PROGRESS",
"trafficOrigin":"LOCAL",
"trafficType":"TRANSACTIONAL",
"requirementsFeedback":[],
"requirements":[
{
"key":"companyName",
"value":"Infobip"
},
{
"key":"vatNumber",
"value":"HR12345678901"
},
{
"key":"useCase",
"value":"Notifications"
},
{
"key":"expectedMonthlyMessages",
"value":50000
},
{
"key":"companyEmailAddresses",
"value":[
"contact@infobip.com",
"info@infobip.com"
]
},
{
"key":"companyWebsite",
"value":"https://www.infobip.com"
},
{
"key":"contactPhoneNumber",
"value":"+385911234567"
},
{
"key":"companyRegistrationDocument",
"value":"A3F8C21D04E7B96F2150C8DA3E47B01FCA8D5E92F3B741082E6C50D9A1FB8327E4C09B6D2A75F83190EC621B4D5A7803F96E12C48B3D07A95F12E840BC369241"
},
{
"key":"registrationForm",
"value":"2B7E4A91F53D08CC461E9BAD3F80712EDB9C6E53A2F841076D5B40E8C2FA9318B5D07C6E3A84F92180EB531C4D6A8702F85E13C49B4D08A96F23E951BD470352"
},
{
"key":"registrationConsent",
"value":"I consent that Infobip will do registration in my name."
}
],
"platform":{
"applicationId":"application-id",
"entityId":"entity-id"
}
},
"x-label":{
"type":[
"Alphanumeric Registration"
],
"status":[
"IN_PROGRESS"
]
}
},
"Alphanumeric Registration - COMPLETED":{
"summary":"Alphanumeric Registration - COMPLETED",
"value":{
"id":"a0c63335-f841-4d43-9ef8-e0765a233f29",
"type":"ALPHANUMERIC_REGISTRATION",
"countryCode":"HR",
"senderName":"InfobipHR",
"requestedByEmailAddress":"alphanumeric@infobip.com",
"additionalContactEmailAddresses":[
"contact@infobip.com"
],
"requestedDate":"2025-03-11T09:22:47.000+0000",
"status":"COMPLETED",
"trafficOrigin":"LOCAL",
"trafficType":"TRANSACTIONAL",
"requirementsFeedback":[],
"requirements":[
{
"key":"companyName",
"value":"Infobip"
},
{
"key":"vatNumber",
"value":"HR12345678901"
},
{
"key":"useCase",
"value":"Notifications"
},
{
"key":"expectedMonthlyMessages",
"value":50000
},
{
"key":"companyEmailAddresses",
"value":[
"contact@infobip.com",
"info@infobip.com"
]
},
{
"key":"companyWebsite",
"value":"https://www.infobip.com"
},
{
"key":"contactPhoneNumber",
"value":"+385911234567"
},
{
"key":"companyRegistrationDocument",
"value":"A3F8C21D04E7B96F2150C8DA3E47B01FCA8D5E92F3B741082E6C50D9A1FB8327E4C09B6D2A75F83190EC621B4D5A7803F96E12C48B3D07A95F12E840BC369241"
},
{
"key":"registrationForm",
"value":"2B7E4A91F53D08CC461E9BAD3F80712EDB9C6E53A2F841076D5B40E8C2FA9318B5D07C6E3A84F92180EB531C4D6A8702F85E13C49B4D08A96F23E951BD470352"
},
{
"key":"registrationConsent",
"value":"I consent that Infobip will do registration in my name."
}
],
"platform":{
"applicationId":"application-id",
"entityId":"entity-id"
}
},
"x-label":{
"type":[
"Alphanumeric Registration"
],
"status":[
"COMPLETED"
]
}
},
"Alphanumeric Registration - REJECTED":{
"summary":"Alphanumeric Registration - REJECTED",
"value":{
"id":"a0c63335-f841-4d43-9ef8-e0765a233f29",
"type":"ALPHANUMERIC_REGISTRATION",
"countryCode":"HR",
"senderName":"InfobipHR",
"requestedByEmailAddress":"alphanumeric@infobip.com",
"additionalContactEmailAddresses":[
"contact@infobip.com"
],
"requestedDate":"2025-03-11T09:22:47.000+0000",
"status":"REJECTED",
"trafficOrigin":"LOCAL",
"trafficType":"TRANSACTIONAL",
"note":"Your request has been rejected because it contains invalid information for the selected destination.",
"requirementsFeedback":[],
"requirements":[
{
"key":"companyName",
"value":"Infobip"
},
{
"key":"vatNumber",
"value":"HR12345678901"
},
{
"key":"useCase",
"value":"Notifications"
},
{
"key":"expectedMonthlyMessages",
"value":50000
},
{
"key":"companyEmailAddresses",
"value":[
"contact@infobip.com",
"info@infobip.com"
]
},
{
"key":"companyWebsite",
"value":"https://www.infobip.com"
},
{
"key":"contactPhoneNumber",
"value":"+385911234567"
},
{
"key":"companyRegistrationDocument",
"value":"A3F8C21D04E7B96F2150C8DA3E47B01FCA8D5E92F3B741082E6C50D9A1FB8327E4C09B6D2A75F83190EC621B4D5A7803F96E12C48B3D07A95F12E840BC369241"
},
{
"key":"registrationForm",
"value":"2B7E4A91F53D08CC461E9BAD3F80712EDB9C6E53A2F841076D5B40E8C2FA9318B5D07C6E3A84F92180EB531C4D6A8702F85E13C49B4D08A96F23E951BD470352"
},
{
"key":"registrationConsent",
"value":"I consent that Infobip will do registration in my name."
}
],
"platform":{
"applicationId":"application-id",
"entityId":"entity-id"
}
},
"x-label":{
"type":[
"Alphanumeric Registration"
],
"status":[
"REJECTED"
]
}
},
"Alphanumeric Registration - CANCELED":{
"summary":"Alphanumeric Registration - CANCELED",
"value":{
"id":"a0c63335-f841-4d43-9ef8-e0765a233f29",
"type":"ALPHANUMERIC_REGISTRATION",
"countryCode":"HR",
"senderName":"InfobipHR",
"requestedByEmailAddress":"alphanumeric@infobip.com",
"additionalContactEmailAddresses":[
"contact@infobip.com"
],
"requestedDate":"2025-03-11T09:22:47.000+0000",
"status":"CANCELED",
"trafficOrigin":"LOCAL",
"trafficType":"TRANSACTIONAL",
"requirementsFeedback":[],
"requirements":[
{
"key":"companyName",
"value":"Infobip"
},
{
"key":"vatNumber",
"value":"HR12345678901"
},
{
"key":"useCase",
"value":"Notifications"
},
{
"key":"expectedMonthlyMessages",
"value":50000
},
{
"key":"companyEmailAddresses",
"value":[
"contact@infobip.com",
"info@infobip.com"
]
},
{
"key":"companyWebsite",
"value":"https://www.infobip.com"
},
{
"key":"contactPhoneNumber",
"value":"+385911234567"
},
{
"key":"companyRegistrationDocument",
"value":"A3F8C21D04E7B96F2150C8DA3E47B01FCA8D5E92F3B741082E6C50D9A1FB8327E4C09B6D2A75F83190EC621B4D5A7803F96E12C48B3D07A95F12E840BC369241"
},
{
"key":"registrationForm",
"value":"2B7E4A91F53D08CC461E9BAD3F80712EDB9C6E53A2F841076D5B40E8C2FA9318B5D07C6E3A84F92180EB531C4D6A8702F85E13C49B4D08A96F23E951BD470352"
},
{
"key":"registrationConsent",
"value":"I consent that Infobip will do registration in my name."
}
],
"platform":{
"applicationId":"application-id",
"entityId":"entity-id"
}
},
"x-label":{
"type":[
"Alphanumeric Registration"
],
"status":[
"CANCELED"
]
}
},
"Number Purchase - PENDING":{
"summary":"Number Purchase - PENDING",
"value":{
"id":"b1d74446-f952-4e54-af09-f1876b344f30",
"type":"NUMBER_PURCHASE",
"countryCode":"HR",
"requestedByEmailAddress":"billing@infobip.com",
"additionalContactEmailAddresses":[],
"requestedDate":"2025-07-04T16:08:33.000+0000",
"status":"PENDING",
"numberType":"VIRTUAL_LONG_NUMBER",
"capabilities":[
"SMS",
"MMS"
],
"quantity":5,
"numbers":[],
"requirementsFeedback":[],
"requirements":[
{
"key":"companyName",
"value":"Infobip"
},
{
"key":"vatNumber",
"value":"HR12345678901"
},
{
"key":"useCase",
"value":"Notifications"
},
{
"key":"expectedMonthlyMessages",
"value":50000
},
{
"key":"companyEmailAddresses",
"value":[
"contact@infobip.com",
"info@infobip.com"
]
},
{
"key":"companyWebsite",
"value":"https://www.infobip.com"
},
{
"key":"contactPhoneNumber",
"value":"+385911234567"
},
{
"key":"companyRegistrationDocument",
"value":"A3F8C21D04E7B96F2150C8DA3E47B01FCA8D5E92F3B741082E6C50D9A1FB8327E4C09B6D2A75F83190EC621B4D5A7803F96E12C48B3D07A95F12E840BC369241"
},
{
"key":"registrationForm",
"value":"2B7E4A91F53D08CC461E9BAD3F80712EDB9C6E53A2F841076D5B40E8C2FA9318B5D07C6E3A84F92180EB531C4D6A8702F85E13C49B4D08A96F23E951BD470352"
},
{
"key":"registrationConsent",
"value":"I consent that Infobip will do registration in my name."
}
],
"platform":{
"applicationId":"application-id",
"entityId":"entity-id"
}
},
"x-label":{
"type":[
"Number Purchase"
],
"status":[
"PENDING"
]
}
},
"Number Purchase - AUTOMATIC_VALIDATION":{
"summary":"Number Purchase - AUTOMATIC_VALIDATION",
"value":{
"id":"b1d74446-f952-4e54-af09-f1876b344f30",
"type":"NUMBER_PURCHASE",
"countryCode":"HR",
"requestedByEmailAddress":"billing@infobip.com",
"additionalContactEmailAddresses":[],
"requestedDate":"2025-07-04T16:08:33.000+0000",
"status":"AUTOMATIC_VALIDATION",
"numberType":"VIRTUAL_LONG_NUMBER",
"capabilities":[
"SMS",
"MMS"
],
"quantity":5,
"numbers":[],
"requirementsFeedback":[],
"requirements":[
{
"key":"companyName",
"value":"Infobip"
},
{
"key":"vatNumber",
"value":"HR12345678901"
},
{
"key":"useCase",
"value":"Notifications"
},
{
"key":"expectedMonthlyMessages",
"value":50000
},
{
"key":"companyEmailAddresses",
"value":[
"contact@infobip.com",
"info@infobip.com"
]
},
{
"key":"companyWebsite",
"value":"https://www.infobip.com"
},
{
"key":"contactPhoneNumber",
"value":"+385911234567"
},
{
"key":"companyRegistrationDocument",
"value":"A3F8C21D04E7B96F2150C8DA3E47B01FCA8D5E92F3B741082E6C50D9A1FB8327E4C09B6D2A75F83190EC621B4D5A7803F96E12C48B3D07A95F12E840BC369241"
},
{
"key":"registrationForm",
"value":"2B7E4A91F53D08CC461E9BAD3F80712EDB9C6E53A2F841076D5B40E8C2FA9318B5D07C6E3A84F92180EB531C4D6A8702F85E13C49B4D08A96F23E951BD470352"
},
{
"key":"registrationConsent",
"value":"I consent that Infobip will do registration in my name."
}
],
"platform":{
"applicationId":"application-id",
"entityId":"entity-id"
}
},
"x-label":{
"type":[
"Number Purchase"
],
"status":[
"AUTOMATIC_VALIDATION"
]
}
},
"Number Purchase - UPDATE_REQUESTED":{
"summary":"Number Purchase - UPDATE_REQUESTED",
"value":{
"id":"b1d74446-f952-4e54-af09-f1876b344f30",
"type":"NUMBER_PURCHASE",
"countryCode":"HR",
"requestedByEmailAddress":"billing@infobip.com",
"additionalContactEmailAddresses":[],
"requestedDate":"2025-07-04T16:08:33.000+0000",
"status":"UPDATE_REQUESTED",
"numberType":"VIRTUAL_LONG_NUMBER",
"capabilities":[
"SMS",
"MMS"
],
"quantity":5,
"numbers":[],
"requirementsFeedback":[
{
"key":"contactPhoneNumber",
"code":"RES_REQ_FEED_REQUIRED",
"feedback":"This field is required and cannot be empty."
},
{
"key":"companyName",
"code":"RES_REQ_FEED_LENGTH_OOR",
"feedback":"Text length must be between 2 and 100."
}
],
"requirements":[
{
"key":"companyName",
"value":"Infobip"
},
{
"key":"vatNumber",
"value":"HR12345678901"
},
{
"key":"useCase",
"value":"Notifications"
},
{
"key":"expectedMonthlyMessages",
"value":50000
},
{
"key":"companyEmailAddresses",
"value":[
"contact@infobip.com",
"info@infobip.com"
]
},
{
"key":"companyWebsite",
"value":"https://www.infobip.com"
},
{
"key":"contactPhoneNumber",
"value":"+385911234567"
},
{
"key":"companyRegistrationDocument",
"value":"A3F8C21D04E7B96F2150C8DA3E47B01FCA8D5E92F3B741082E6C50D9A1FB8327E4C09B6D2A75F83190EC621B4D5A7803F96E12C48B3D07A95F12E840BC369241"
},
{
"key":"registrationForm",
"value":"2B7E4A91F53D08CC461E9BAD3F80712EDB9C6E53A2F841076D5B40E8C2FA9318B5D07C6E3A84F92180EB531C4D6A8702F85E13C49B4D08A96F23E951BD470352"
},
{
"key":"registrationConsent",
"value":"I consent that Infobip will do registration in my name."
}
],
"platform":{
"applicationId":"application-id",
"entityId":"entity-id"
}
},
"x-label":{
"type":[
"Number Purchase"
],
"status":[
"UPDATE_REQUESTED"
]
}
},
"Number Purchase - PENDING_REVIEW":{
"summary":"Number Purchase - PENDING_REVIEW",
"value":{
"id":"b1d74446-f952-4e54-af09-f1876b344f30",
"type":"NUMBER_PURCHASE",
"countryCode":"HR",
"requestedByEmailAddress":"billing@infobip.com",
"additionalContactEmailAddresses":[],
"requestedDate":"2025-07-04T16:08:33.000+0000",
"status":"PENDING_REVIEW",
"numberType":"VIRTUAL_LONG_NUMBER",
"capabilities":[
"SMS",
"MMS"
],
"quantity":5,
"numbers":[],
"requirementsFeedback":[],
"requirements":[
{
"key":"companyName",
"value":"Infobip"
},
{
"key":"vatNumber",
"value":"HR12345678901"
},
{
"key":"useCase",
"value":"Notifications"
},
{
"key":"expectedMonthlyMessages",
"value":50000
},
{
"key":"companyEmailAddresses",
"value":[
"contact@infobip.com",
"info@infobip.com"
]
},
{
"key":"companyWebsite",
"value":"https://www.infobip.com"
},
{
"key":"contactPhoneNumber",
"value":"+385911234567"
},
{
"key":"companyRegistrationDocument",
"value":"A3F8C21D04E7B96F2150C8DA3E47B01FCA8D5E92F3B741082E6C50D9A1FB8327E4C09B6D2A75F83190EC621B4D5A7803F96E12C48B3D07A95F12E840BC369241"
},
{
"key":"registrationForm",
"value":"2B7E4A91F53D08CC461E9BAD3F80712EDB9C6E53A2F841076D5B40E8C2FA9318B5D07C6E3A84F92180EB531C4D6A8702F85E13C49B4D08A96F23E951BD470352"
},
{
"key":"registrationConsent",
"value":"I consent that Infobip will do registration in my name."
}
],
"platform":{
"applicationId":"application-id",
"entityId":"entity-id"
}
},
"x-label":{
"type":[
"Number Purchase"
],
"status":[
"PENDING_REVIEW"
]
}
},
"Number Purchase - IN_REVIEW":{
"summary":"Number Purchase - IN_REVIEW",
"value":{
"id":"b1d74446-f952-4e54-af09-f1876b344f30",
"type":"NUMBER_PURCHASE",
"countryCode":"HR",
"requestedByEmailAddress":"billing@infobip.com",
"additionalContactEmailAddresses":[],
"requestedDate":"2025-07-04T16:08:33.000+0000",
"status":"IN_REVIEW",
"numberType":"VIRTUAL_LONG_NUMBER",
"capabilities":[
"SMS",
"MMS"
],
"quantity":5,
"numbers":[],
"requirementsFeedback":[],
"requirements":[
{
"key":"companyName",
"value":"Infobip"
},
{
"key":"vatNumber",
"value":"HR12345678901"
},
{
"key":"useCase",
"value":"Notifications"
},
{
"key":"expectedMonthlyMessages",
"value":50000
},
{
"key":"companyEmailAddresses",
"value":[
"contact@infobip.com",
"info@infobip.com"
]
},
{
"key":"companyWebsite",
"value":"https://www.infobip.com"
},
{
"key":"contactPhoneNumber",
"value":"+385911234567"
},
{
"key":"companyRegistrationDocument",
"value":"A3F8C21D04E7B96F2150C8DA3E47B01FCA8D5E92F3B741082E6C50D9A1FB8327E4C09B6D2A75F83190EC621B4D5A7803F96E12C48B3D07A95F12E840BC369241"
},
{
"key":"registrationForm",
"value":"2B7E4A91F53D08CC461E9BAD3F80712EDB9C6E53A2F841076D5B40E8C2FA9318B5D07C6E3A84F92180EB531C4D6A8702F85E13C49B4D08A96F23E951BD470352"
},
{
"key":"registrationConsent",
"value":"I consent that Infobip will do registration in my name."
}
],
"platform":{
"applicationId":"application-id",
"entityId":"entity-id"
}
},
"x-label":{
"type":[
"Number Purchase"
],
"status":[
"IN_REVIEW"
]
}
},
"Number Purchase - UPDATE_REQUESTED_BY_INTERNAL_REVIEWER":{
"summary":"Number Purchase - UPDATE_REQUESTED_BY_INTERNAL_REVIEWER",
"value":{
"id":"b1d74446-f952-4e54-af09-f1876b344f30",
"type":"NUMBER_PURCHASE",
"countryCode":"HR",
"requestedByEmailAddress":"billing@infobip.com",
"additionalContactEmailAddresses":[],
"requestedDate":"2025-07-04T16:08:33.000+0000",
"status":"UPDATE_REQUESTED_BY_INTERNAL_REVIEWER",
"numberType":"VIRTUAL_LONG_NUMBER",
"capabilities":[
"SMS",
"MMS"
],
"quantity":5,
"numbers":[],
"requirementsFeedback":[
{
"key":"contactPhoneNumber",
"code":"RES_REQ_FEED_REQUIRED",
"feedback":"This field is required and cannot be empty."
},
{
"key":"companyName",
"code":"RES_REQ_FEED_LENGTH_OOR",
"feedback":"Text length must be between 2 and 100."
}
],
"requirements":[
{
"key":"companyName",
"value":"Infobip"
},
{
"key":"vatNumber",
"value":"HR12345678901"
},
{
"key":"useCase",
"value":"Notifications"
},
{
"key":"expectedMonthlyMessages",
"value":50000
},
{
"key":"companyEmailAddresses",
"value":[
"contact@infobip.com",
"info@infobip.com"
]
},
{
"key":"companyWebsite",
"value":"https://www.infobip.com"
},
{
"key":"contactPhoneNumber",
"value":"+385911234567"
},
{
"key":"companyRegistrationDocument",
"value":"A3F8C21D04E7B96F2150C8DA3E47B01FCA8D5E92F3B741082E6C50D9A1FB8327E4C09B6D2A75F83190EC621B4D5A7803F96E12C48B3D07A95F12E840BC369241"
},
{
"key":"registrationForm",
"value":"2B7E4A91F53D08CC461E9BAD3F80712EDB9C6E53A2F841076D5B40E8C2FA9318B5D07C6E3A84F92180EB531C4D6A8702F85E13C49B4D08A96F23E951BD470352"
},
{
"key":"registrationConsent",
"value":"I consent that Infobip will do registration in my name."
}
],
"platform":{
"applicationId":"application-id",
"entityId":"entity-id"
}
},
"x-label":{
"type":[
"Number Purchase"
],
"status":[
"UPDATE_REQUESTED_BY_INTERNAL_REVIEWER"
]
}
},
"Number Purchase - IN_PROGRESS":{
"summary":"Number Purchase - IN_PROGRESS",
"value":{
"id":"b1d74446-f952-4e54-af09-f1876b344f30",
"type":"NUMBER_PURCHASE",
"countryCode":"HR",
"requestedByEmailAddress":"billing@infobip.com",
"additionalContactEmailAddresses":[],
"requestedDate":"2025-07-04T16:08:33.000+0000",
"status":"IN_PROGRESS",
"numberType":"VIRTUAL_LONG_NUMBER",
"capabilities":[
"SMS",
"MMS"
],
"quantity":5,
"numbers":[
{
"number":"+38591234567",
"numberKey":"A3F8C21D04E7B96F2150C8DA3E47B01F",
"status":"SUCCESS"
},
{
"number":"+38591234568",
"numberKey":"D92E4B810FC6A3571E08B29CD54F7A2E",
"status":"SUCCESS"
}
],
"requirementsFeedback":[],
"requirements":[
{
"key":"companyName",
"value":"Infobip"
},
{
"key":"vatNumber",
"value":"HR12345678901"
},
{
"key":"useCase",
"value":"Notifications"
},
{
"key":"expectedMonthlyMessages",
"value":50000
},
{
"key":"companyEmailAddresses",
"value":[
"contact@infobip.com",
"info@infobip.com"
]
},
{
"key":"companyWebsite",
"value":"https://www.infobip.com"
},
{
"key":"contactPhoneNumber",
"value":"+385911234567"
},
{
"key":"companyRegistrationDocument",
"value":"A3F8C21D04E7B96F2150C8DA3E47B01FCA8D5E92F3B741082E6C50D9A1FB8327E4C09B6D2A75F83190EC621B4D5A7803F96E12C48B3D07A95F12E840BC369241"
},
{
"key":"registrationForm",
"value":"2B7E4A91F53D08CC461E9BAD3F80712EDB9C6E53A2F841076D5B40E8C2FA9318B5D07C6E3A84F92180EB531C4D6A8702F85E13C49B4D08A96F23E951BD470352"
},
{
"key":"registrationConsent",
"value":"I consent that Infobip will do registration in my name."
}
],
"platform":{
"applicationId":"application-id",
"entityId":"entity-id"
}
},
"x-label":{
"type":[
"Number Purchase"
],
"status":[
"IN_PROGRESS"
]
}
},
"Number Purchase - COMPLETED":{
"summary":"Number Purchase - COMPLETED",
"value":{
"id":"b1d74446-f952-4e54-af09-f1876b344f30",
"type":"NUMBER_PURCHASE",
"countryCode":"HR",
"requestedByEmailAddress":"billing@infobip.com",
"additionalContactEmailAddresses":[],
"requestedDate":"2025-07-04T16:08:33.000+0000",
"status":"COMPLETED",
"numberType":"VIRTUAL_LONG_NUMBER",
"capabilities":[
"SMS",
"MMS"
],
"quantity":5,
"note":"Only 2 out of 5 requested numbers could be procured.",
"numbers":[
{
"number":"+38591234567",
"numberKey":"A3F8C21D04E7B96F2150C8DA3E47B01F",
"status":"SUCCESS"
},
{
"number":"+38591234568",
"numberKey":"D92E4B810FC6A3571E08B29CD54F7A2E",
"status":"SUCCESS"
}
],
"requirementsFeedback":[],
"requirements":[
{
"key":"companyName",
"value":"Infobip"
},
{
"key":"vatNumber",
"value":"HR12345678901"
},
{
"key":"useCase",
"value":"Notifications"
},
{
"key":"expectedMonthlyMessages",
"value":50000
},
{
"key":"companyEmailAddresses",
"value":[
"contact@infobip.com",
"info@infobip.com"
]
},
{
"key":"companyWebsite",
"value":"https://www.infobip.com"
},
{
"key":"contactPhoneNumber",
"value":"+385911234567"
},
{
"key":"companyRegistrationDocument",
"value":"A3F8C21D04E7B96F2150C8DA3E47B01FCA8D5E92F3B741082E6C50D9A1FB8327E4C09B6D2A75F83190EC621B4D5A7803F96E12C48B3D07A95F12E840BC369241"
},
{
"key":"registrationForm",
"value":"2B7E4A91F53D08CC461E9BAD3F80712EDB9C6E53A2F841076D5B40E8C2FA9318B5D07C6E3A84F92180EB531C4D6A8702F85E13C49B4D08A96F23E951BD470352"
},
{
"key":"registrationConsent",
"value":"I consent that Infobip will do registration in my name."
}
],
"platform":{
"applicationId":"application-id",
"entityId":"entity-id"
}
},
"x-label":{
"type":[
"Number Purchase"
],
"status":[
"COMPLETED"
]
}
},
"Number Purchase - REJECTED":{
"summary":"Number Purchase - REJECTED",
"value":{
"id":"b1d74446-f952-4e54-af09-f1876b344f30",
"type":"NUMBER_PURCHASE",
"countryCode":"HR",
"requestedByEmailAddress":"billing@infobip.com",
"additionalContactEmailAddresses":[],
"requestedDate":"2025-07-04T16:08:33.000+0000",
"status":"REJECTED",
"numberType":"VIRTUAL_LONG_NUMBER",
"capabilities":[
"SMS",
"MMS"
],
"quantity":5,
"note":"Your request has been rejected because it contains invalid information for the selected destination.",
"numbers":[],
"requirementsFeedback":[],
"requirements":[
{
"key":"companyName",
"value":"Infobip"
},
{
"key":"vatNumber",
"value":"HR12345678901"
},
{
"key":"useCase",
"value":"Notifications"
},
{
"key":"expectedMonthlyMessages",
"value":50000
},
{
"key":"companyEmailAddresses",
"value":[
"contact@infobip.com",
"info@infobip.com"
]
},
{
"key":"companyWebsite",
"value":"https://www.infobip.com"
},
{
"key":"contactPhoneNumber",
"value":"+385911234567"
},
{
"key":"companyRegistrationDocument",
"value":"A3F8C21D04E7B96F2150C8DA3E47B01FCA8D5E92F3B741082E6C50D9A1FB8327E4C09B6D2A75F83190EC621B4D5A7803F96E12C48B3D07A95F12E840BC369241"
},
{
"key":"registrationForm",
"value":"2B7E4A91F53D08CC461E9BAD3F80712EDB9C6E53A2F841076D5B40E8C2FA9318B5D07C6E3A84F92180EB531C4D6A8702F85E13C49B4D08A96F23E951BD470352"
},
{
"key":"registrationConsent",
"value":"I consent that Infobip will do registration in my name."
}
],
"platform":{
"applicationId":"application-id",
"entityId":"entity-id"
}
},
"x-label":{
"type":[
"Number Purchase"
],
"status":[
"REJECTED"
]
}
},
"Number Purchase - CANCELED":{
"summary":"Number Purchase - CANCELED",
"value":{
"id":"b1d74446-f952-4e54-af09-f1876b344f30",
"type":"NUMBER_PURCHASE",
"countryCode":"HR",
"requestedByEmailAddress":"billing@infobip.com",
"additionalContactEmailAddresses":[],
"requestedDate":"2025-07-04T16:08:33.000+0000",
"status":"CANCELED",
"numberType":"VIRTUAL_LONG_NUMBER",
"capabilities":[
"SMS",
"MMS"
],
"quantity":5,
"numbers":[],
"requirementsFeedback":[],
"requirements":[
{
"key":"companyName",
"value":"Infobip"
},
{
"key":"vatNumber",
"value":"HR12345678901"
},
{
"key":"useCase",
"value":"Notifications"
},
{
"key":"expectedMonthlyMessages",
"value":50000
},
{
"key":"companyEmailAddresses",
"value":[
"contact@infobip.com",
"info@infobip.com"
]
},
{
"key":"companyWebsite",
"value":"https://www.infobip.com"
},
{
"key":"contactPhoneNumber",
"value":"+385911234567"
},
{
"key":"companyRegistrationDocument",
"value":"A3F8C21D04E7B96F2150C8DA3E47B01FCA8D5E92F3B741082E6C50D9A1FB8327E4C09B6D2A75F83190EC621B4D5A7803F96E12C48B3D07A95F12E840BC369241"
},
{
"key":"registrationForm",
"value":"2B7E4A91F53D08CC461E9BAD3F80712EDB9C6E53A2F841076D5B40E8C2FA9318B5D07C6E3A84F92180EB531C4D6A8702F85E13C49B4D08A96F23E951BD470352"
},
{
"key":"registrationConsent",
"value":"I consent that Infobip will do registration in my name."
}
],
"platform":{
"applicationId":"application-id",
"entityId":"entity-id"
}
},
"x-label":{
"type":[
"Number Purchase"
],
"status":[
"CANCELED"
]
}
},
"RCS Sender Launch - PENDING":{
"summary":"RCS Sender Launch - PENDING",
"value":{
"id":"d3f96668-b174-4d76-8b21-b3098d566b52",
"type":"RCS_SENDER_LAUNCH",
"status":"PENDING",
"countryCode":"HR",
"excludedCarriers":[
"Carrier A",
"Carrier B"
],
"senderName":"Example sender",
"requestedByEmailAddress":"examples@example.com",
"additionalContactEmails":[
"examples@example.com"
],
"requestedDate":"2025-11-19T11:45:10.000+0000",
"trafficOrigin":"LOCAL",
"requirements":[
{
"key":"legalBrandCompanyName",
"value":"example"
},
{
"key":"stockExchange",
"value":"EXAMPLE"
},
{
"key":"contactPersonEmailAddresses",
"value":"example@example.com"
},
{
"key":"contactPersonPhoneNumber",
"value":"1234567891"
},
{
"key":"attestationLetter",
"value":"documentId"
},
{
"key":"stopMessage",
"value":"stopMessageExample"
}
],
"requirementsFeedback":[],
"platform":{
"applicationId":"application-id",
"entityId":"entity-id"
}
},
"x-label":{
"type":[
"RCS Sender Launch"
],
"status":[
"PENDING"
]
}
},
"RCS Sender Launch - AUTOMATIC_VALIDATION":{
"summary":"RCS Sender Launch - AUTOMATIC_VALIDATION",
"value":{
"id":"d3f96668-b174-4d76-8b21-b3098d566b52",
"type":"RCS_SENDER_LAUNCH",
"status":"AUTOMATIC_VALIDATION",
"countryCode":"HR",
"excludedCarriers":[
"Carrier A",
"Carrier B"
],
"senderName":"Example sender",
"requestedByEmailAddress":"examples@example.com",
"additionalContactEmails":[
"examples@example.com"
],
"requestedDate":"2025-11-19T11:45:10.000+0000",
"trafficOrigin":"LOCAL",
"requirements":[
{
"key":"legalBrandCompanyName",
"value":"example"
},
{
"key":"stockExchange",
"value":"EXAMPLE"
},
{
"key":"contactPersonEmailAddresses",
"value":"example@example.com"
},
{
"key":"contactPersonPhoneNumber",
"value":"1234567891"
},
{
"key":"attestationLetter",
"value":"documentId"
},
{
"key":"stopMessage",
"value":"stopMessageExample"
}
],
"requirementsFeedback":[],
"platform":{
"applicationId":"application-id",
"entityId":"entity-id"
}
},
"x-label":{
"type":[
"RCS Sender Launch"
],
"status":[
"AUTOMATIC_VALIDATION"
]
}
},
"RCS Sender Launch - UPDATE_REQUESTED":{
"summary":"RCS Sender Launch - UPDATE_REQUESTED",
"value":{
"id":"d3f96668-b174-4d76-8b21-b3098d566b52",
"type":"RCS_SENDER_LAUNCH",
"status":"UPDATE_REQUESTED",
"countryCode":"HR",
"excludedCarriers":[
"Carrier A",
"Carrier B"
],
"senderName":"Example sender",
"requestedByEmailAddress":"examples@example.com",
"additionalContactEmails":[
"examples@example.com"
],
"requestedDate":"2025-11-19T11:45:10.000+0000",
"trafficOrigin":"LOCAL",
"requirements":[
{
"key":"legalBrandCompanyName",
"value":"example"
},
{
"key":"stockExchange",
"value":"EXAMPLE"
},
{
"key":"contactPersonEmailAddresses",
"value":"example@example.com"
},
{
"key":"contactPersonPhoneNumber",
"value":"1234567891"
},
{
"key":"attestationLetter",
"value":"documentId"
},
{
"key":"stopMessage",
"value":"stopMessageExample"
}
],
"requirementsFeedback":[
{
"key":"contactPhoneNumber",
"code":"RES_REQ_FEED_REQUIRED",
"feedback":"This field is required and cannot be empty."
},
{
"key":"companyName",
"code":"RES_REQ_FEED_LENGTH_OOR",
"feedback":"Text length must be between 2 and 100."
}
],
"platform":{
"applicationId":"application-id",
"entityId":"entity-id"
}
},
"x-label":{
"type":[
"RCS Sender Launch"
],
"status":[
"UPDATE_REQUESTED"
]
}
},
"RCS Sender Launch - PENDING_REVIEW":{
"summary":"RCS Sender Launch - PENDING_REVIEW",
"value":{
"id":"d3f96668-b174-4d76-8b21-b3098d566b52",
"type":"RCS_SENDER_LAUNCH",
"status":"PENDING_REVIEW",
"countryCode":"HR",
"excludedCarriers":[
"Carrier A",
"Carrier B"
],
"senderName":"Example sender",
"requestedByEmailAddress":"examples@example.com",
"additionalContactEmails":[
"examples@example.com"
],
"requestedDate":"2025-11-19T11:45:10.000+0000",
"trafficOrigin":"LOCAL",
"requirements":[
{
"key":"legalBrandCompanyName",
"value":"example"
},
{
"key":"stockExchange",
"value":"EXAMPLE"
},
{
"key":"contactPersonEmailAddresses",
"value":"example@example.com"
},
{
"key":"contactPersonPhoneNumber",
"value":"1234567891"
},
{
"key":"attestationLetter",
"value":"documentId"
},
{
"key":"stopMessage",
"value":"stopMessageExample"
}
],
"requirementsFeedback":[],
"platform":{
"applicationId":"application-id",
"entityId":"entity-id"
}
},
"x-label":{
"type":[
"RCS Sender Launch"
],
"status":[
"PENDING_REVIEW"
]
}
},
"RCS Sender Launch - IN_REVIEW":{
"summary":"RCS Sender Launch - IN_REVIEW",
"value":{
"id":"d3f96668-b174-4d76-8b21-b3098d566b52",
"type":"RCS_SENDER_LAUNCH",
"status":"IN_REVIEW",
"countryCode":"HR",
"excludedCarriers":[
"Carrier A",
"Carrier B"
],
"senderName":"Example sender",
"requestedByEmailAddress":"examples@example.com",
"additionalContactEmails":[
"examples@example.com"
],
"requestedDate":"2025-11-19T11:45:10.000+0000",
"trafficOrigin":"LOCAL",
"requirements":[
{
"key":"legalBrandCompanyName",
"value":"example"
},
{
"key":"stockExchange",
"value":"EXAMPLE"
},
{
"key":"contactPersonEmailAddresses",
"value":"example@example.com"
},
{
"key":"contactPersonPhoneNumber",
"value":"1234567891"
},
{
"key":"attestationLetter",
"value":"documentId"
},
{
"key":"stopMessage",
"value":"stopMessageExample"
}
],
"requirementsFeedback":[],
"platform":{
"applicationId":"application-id",
"entityId":"entity-id"
}
},
"x-label":{
"type":[
"RCS Sender Launch"
],
"status":[
"IN_REVIEW"
]
}
},
"RCS Sender Launch - UPDATE_REQUESTED_BY_INTERNAL_REVIEWER":{
"summary":"RCS Sender Launch - UPDATE_REQUESTED_BY_INTERNAL_REVIEWER",
"value":{
"id":"d3f96668-b174-4d76-8b21-b3098d566b52",
"type":"RCS_SENDER_LAUNCH",
"status":"UPDATE_REQUESTED_BY_INTERNAL_REVIEWER",
"countryCode":"HR",
"excludedCarriers":[
"Carrier A",
"Carrier B"
],
"senderName":"Example sender",
"requestedByEmailAddress":"examples@example.com",
"additionalContactEmails":[
"examples@example.com"
],
"requestedDate":"2025-11-19T11:45:10.000+0000",
"trafficOrigin":"LOCAL",
"requirements":[
{
"key":"legalBrandCompanyName",
"value":"example"
},
{
"key":"stockExchange",
"value":"EXAMPLE"
},
{
"key":"contactPersonEmailAddresses",
"value":"example@example.com"
},
{
"key":"contactPersonPhoneNumber",
"value":"1234567891"
},
{
"key":"attestationLetter",
"value":"documentId"
},
{
"key":"stopMessage",
"value":"stopMessageExample"
}
],
"requirementsFeedback":[
{
"key":"contactPhoneNumber",
"code":"RES_REQ_FEED_REQUIRED",
"feedback":"This field is required and cannot be empty."
},
{
"key":"companyName",
"code":"RES_REQ_FEED_LENGTH_OOR",
"feedback":"Text length must be between 2 and 100."
}
],
"platform":{
"applicationId":"application-id",
"entityId":"entity-id"
}
},
"x-label":{
"type":[
"RCS Sender Launch"
],
"status":[
"UPDATE_REQUESTED_BY_INTERNAL_REVIEWER"
]
}
},
"RCS Sender Launch - IN_PROGRESS":{
"summary":"RCS Sender Launch - IN_PROGRESS",
"value":{
"id":"d3f96668-b174-4d76-8b21-b3098d566b52",
"type":"RCS_SENDER_LAUNCH",
"status":"IN_PROGRESS",
"countryCode":"HR",
"excludedCarriers":[
"Carrier A",
"Carrier B"
],
"senderName":"Example sender",
"requestedByEmailAddress":"examples@example.com",
"additionalContactEmails":[
"examples@example.com"
],
"requestedDate":"2025-11-19T11:45:10.000+0000",
"trafficOrigin":"LOCAL",
"requirements":[
{
"key":"legalBrandCompanyName",
"value":"example"
},
{
"key":"stockExchange",
"value":"EXAMPLE"
},
{
"key":"contactPersonEmailAddresses",
"value":"example@example.com"
},
{
"key":"contactPersonPhoneNumber",
"value":"1234567891"
},
{
"key":"attestationLetter",
"value":"documentId"
},
{
"key":"stopMessage",
"value":"stopMessageExample"
}
],
"requirementsFeedback":[],
"platform":{
"applicationId":"application-id",
"entityId":"entity-id"
}
},
"x-label":{
"type":[
"RCS Sender Launch"
],
"status":[
"IN_PROGRESS"
]
}
},
"RCS Sender Launch - COMPLETED":{
"summary":"RCS Sender Launch - COMPLETED",
"value":{
"id":"d3f96668-b174-4d76-8b21-b3098d566b52",
"type":"RCS_SENDER_LAUNCH",
"status":"COMPLETED",
"countryCode":"HR",
"excludedCarriers":[
"Carrier A",
"Carrier B"
],
"senderName":"Example sender",
"requestedByEmailAddress":"examples@example.com",
"additionalContactEmails":[
"examples@example.com"
],
"requestedDate":"2025-11-19T11:45:10.000+0000",
"trafficOrigin":"LOCAL",
"requirements":[
{
"key":"legalBrandCompanyName",
"value":"example"
},
{
"key":"stockExchange",
"value":"EXAMPLE"
},
{
"key":"contactPersonEmailAddresses",
"value":"example@example.com"
},
{
"key":"contactPersonPhoneNumber",
"value":"1234567891"
},
{
"key":"attestationLetter",
"value":"documentId"
},
{
"key":"stopMessage",
"value":"stopMessageExample"
}
],
"requirementsFeedback":[],
"platform":{
"applicationId":"application-id",
"entityId":"entity-id"
}
},
"x-label":{
"type":[
"RCS Sender Launch"
],
"status":[
"COMPLETED"
]
}
},
"RCS Sender Launch - REJECTED":{
"summary":"RCS Sender Launch - REJECTED",
"value":{
"id":"d3f96668-b174-4d76-8b21-b3098d566b52",
"type":"RCS_SENDER_LAUNCH",
"status":"REJECTED",
"countryCode":"HR",
"excludedCarriers":[
"Carrier A",
"Carrier B"
],
"senderName":"Example sender",
"requestedByEmailAddress":"examples@example.com",
"additionalContactEmails":[
"examples@example.com"
],
"requestedDate":"2025-11-19T11:45:10.000+0000",
"trafficOrigin":"LOCAL",
"note":"Your request has been rejected because it contains invalid information for the selected destination.",
"requirements":[
{
"key":"legalBrandCompanyName",
"value":"example"
},
{
"key":"stockExchange",
"value":"EXAMPLE"
},
{
"key":"contactPersonEmailAddresses",
"value":"example@example.com"
},
{
"key":"contactPersonPhoneNumber",
"value":"1234567891"
},
{
"key":"attestationLetter",
"value":"documentId"
},
{
"key":"stopMessage",
"value":"stopMessageExample"
}
],
"requirementsFeedback":[],
"platform":{
"applicationId":"application-id",
"entityId":"entity-id"
}
},
"x-label":{
"type":[
"RCS Sender Launch"
],
"status":[
"REJECTED"
]
}
},
"RCS Sender Launch - CANCELED":{
"summary":"RCS Sender Launch - CANCELED",
"value":{
"id":"d3f96668-b174-4d76-8b21-b3098d566b52",
"type":"RCS_SENDER_LAUNCH",
"status":"CANCELED",
"countryCode":"HR",
"excludedCarriers":[
"Carrier A",
"Carrier B"
],
"senderName":"Example sender",
"requestedByEmailAddress":"examples@example.com",
"additionalContactEmails":[
"examples@example.com"
],
"requestedDate":"2025-11-19T11:45:10.000+0000",
"trafficOrigin":"LOCAL",
"requirements":[
{
"key":"legalBrandCompanyName",
"value":"example"
},
{
"key":"stockExchange",
"value":"EXAMPLE"
},
{
"key":"contactPersonEmailAddresses",
"value":"example@example.com"
},
{
"key":"contactPersonPhoneNumber",
"value":"1234567891"
},
{
"key":"attestationLetter",
"value":"documentId"
},
{
"key":"stopMessage",
"value":"stopMessageExample"
}
],
"requirementsFeedback":[],
"platform":{
"applicationId":"application-id",
"entityId":"entity-id"
}
},
"x-label":{
"type":[
"RCS Sender Launch"
],
"status":[
"CANCELED"
]
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiError401"
},
"403":{
"$ref":"#/components/responses/ApiError403"
},
"404":{
"description":"Not Found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"examples":{
"Resource request not found":{
"summary":"Resource request not found",
"value":{
"errorCode":"RR404",
"description":"Resource request not found.",
"action":"Please verify the resource request ID and adjust your request.",
"violations":[],
"resources":[]
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiError429"
},
"500":{
"$ref":"#/components/responses/ApiError500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"resource-request-hub:manage",
"resource-request-hub:read"
],
"x-is-early-access":true,
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":10,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
},
"patch":{
"tags":[
"platform",
"resources",
"resource-request"
],
"summary":"Update resource request",
"description":"Updates an existing resource request with Infobip. Resource request may only be updated when in UPDATE_REQUESTED and UPDATE_REQUESTED_BY_INTERNAL_REVIEWER status.\nLimited to ALPHANUMERIC_REGISTRATION, NUMBER_PURCHASE and RCS_SENDER_LAUNCH requests only.\n**All requirements data must be provided within the request, not just the incorrect or changed ones.**\n",
"operationId":"update-resource-request",
"parameters":[
{
"name":"id",
"in":"path",
"description":"The ID of the resource request.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string",
"format":"uuid",
"description":"The ID of the resource request."
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.UpdateResourceOrderRequest"
},
"examples":{
"Update resource request":{
"summary":"Update resource request",
"value":{
"requirements":[
{
"key":"companyName",
"value":"Infobip"
},
{
"key":"companyWebsite",
"value":"https://www.infobip.com"
},
{
"key":"useCase",
"value":"Promotions"
},
{
"key":"expectedMonthlyMessages",
"value":50000
},
{
"key":"contactPhoneNumber",
"value":"+13125550123"
}
]
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.ResourceOrderApiDoc"
},
"examples":{
"Resource request updated":{
"summary":"Resource request updated",
"value":{
"id":"e4a07779-a952-4e54-bf10-a2987c455b41",
"type":"ALPHANUMERIC_REGISTRATION",
"countryCode":"US",
"senderName":"InfobipUS",
"requestedByEmailAddress":"alphanumeric@infobip.com",
"additionalContactEmailAddresses":[],
"requestedDate":"2025-07-04T16:08:33.000+0000",
"status":"AUTOMATIC_VALIDATION",
"trafficOrigin":"INTERNATIONAL",
"trafficType":"PROMOTIONAL",
"requirementsFeedback":[],
"requirements":[
{
"key":"companyName",
"value":"Infobip"
},
{
"key":"companyWebsite",
"value":"https://www.infobip.com"
},
{
"key":"useCase",
"value":"Promotions"
},
{
"key":"expectedMonthlyMessages",
"value":50000
},
{
"key":"contactPhoneNumber",
"value":"+13125550123"
}
],
"platform":{
"applicationId":"application-id",
"entityId":"entity-id"
}
}
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"examples":{
"Resource request is in invalid status":{
"summary":"Resource request is in invalid status",
"value":{
"errorCode":"RR-INVALID-STATUS400",
"description":"The resource request is in a status that does not allow updates or cancellations.",
"action":"Please verify the resource request status and perform this action only when it is in an allowed state.",
"violations":[],
"resources":[]
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"errorCode":"E400",
"description":"Request cannot be processed.",
"action":"Check the syntax, violations and adjust the request.",
"violations":[
{
"property":"property.path",
"violation":"Violation message."
}
],
"resources":[]
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiError401"
},
"403":{
"$ref":"#/components/responses/ApiError403"
},
"404":{
"description":"Not Found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"examples":{
"Resource request not found":{
"summary":"Resource request not found",
"value":{
"errorCode":"RR404",
"description":"Resource request not found.",
"action":"Please verify the resource request ID and adjust your request.",
"violations":[],
"resources":[]
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiError429"
},
"500":{
"$ref":"#/components/responses/ApiError500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"resource-request-hub:manage",
"resource-request-hub:read"
],
"x-is-early-access":true,
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":1,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/resources/1/requests/{id}/cancel":{
"post":{
"tags":[
"platform",
"resources",
"resource-request"
],
"summary":"Cancel resource request",
"description":"Cancels an existing resource request with Infobip. Resource request may only be canceled when in UPDATE_REQUESTED and UPDATE_REQUESTED_BY_INTERNAL_REVIEWER status.\nLimited to ALPHANUMERIC_REGISTRATION, NUMBER_PURCHASE and RCS_SENDER_LAUNCH requests only.\n",
"operationId":"cancel-resource-request",
"parameters":[
{
"name":"id",
"in":"path",
"description":"The ID of the resource request.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string",
"format":"uuid",
"description":"The ID of the resource request."
}
}
],
"responses":{
"204":{
"description":"No Content"
},
"400":{
"description":"Bad Request",
"content":{
"*/*":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"examples":{
"Resource request is in invalid status":{
"summary":"Resource request is in invalid status",
"value":{
"errorCode":"RR-INVALID-STATUS400",
"description":"The resource request is in a status that does not allow updates or cancellations.",
"action":"Please verify the resource request status and perform this action only when it is in an allowed state.",
"violations":[],
"resources":[]
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"errorCode":"E400",
"description":"Request cannot be processed.",
"action":"Check the syntax, violations and adjust the request.",
"violations":[
{
"property":"property.path",
"violation":"Violation message."
}
],
"resources":[]
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiError401"
},
"403":{
"$ref":"#/components/responses/ApiError403"
},
"404":{
"description":"Not Found",
"content":{
"*/*":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"examples":{
"Resource request not found":{
"summary":"Resource request not found",
"value":{
"errorCode":"RR404",
"description":"Resource request not found.",
"action":"Please verify the resource request ID and adjust your request.",
"violations":[],
"resources":[]
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiError429"
},
"500":{
"$ref":"#/components/responses/ApiError500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"resource-request-hub:manage",
"resource-request-hub:read"
],
"x-is-early-access":true,
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":1,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/resources/1/documents":{
"post":{
"tags":[
"platform",
"resources",
"resource-request"
],
"summary":"Upload document",
"description":"Upload a document prior to providing it as a requirement within a resource request.",
"operationId":"upload-document",
"requestBody":{
"content":{
"multipart/form-data":{
"schema":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.UploadDocumentApiDoc"
},
"examples":{
"Upload a document using curl":{
"summary":"Upload a document using curl",
"value":"curl --request POST 'https://{base_url}/resources/1/documents' \\\n--header 'Authorization: {authorization}' \\\n--form 'document=\"@files/image1.jpg\"'\n"
},
"Upload a document using Java":{
"summary":"Upload a document using Java",
"value":"OkHttpClient client = new OkHttpClient().newBuilder().build();\nMediaType mediaType = MediaType.parse(\"text/plain\");\nRequestBody body = new MultipartBody.Builder().setType(MultipartBody.FORM)\n .addFormDataPart(\"document\",\"@files/image1.jpg\")\n .build();\nRequest request = new Request.Builder()\n .url(\"https://{base_url}/resources/1/documents\")\n .method(\"POST\", body)\n .addHeader(\"Authorization\", \"{authorization}\")\n .build();\nResponse response = client.newCall(request).execute();\n"
},
"Upload a document - HTTP":{
"summary":"Upload a document - HTTP",
"value":"POST /resources/1/documents HTTP/1.1\nHost: {base_url}\nAuthorization: {authorization}\nContent-Length: 1370\nContent-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW\n\n@files/image1.jpg\n------WebKitFormBoundary7MA4YWxkTrZu0gW\nContent-Disposition: form-data; name=\"bulkId\"\n"
},
"Upload a document using PHP":{
"summary":"Upload a document using PHP",
"value":"setUrl('https://{base_url}/resources/1/documents');\n $request->setMethod(HTTP_Request2::METHOD_POST);\n $request->setConfig(array(\n 'follow_redirects' => TRUE\n ));\n $request->setHeader(array(\n 'Authorization' => '{authorization}',\n 'Content-Type' => 'multipart/form-data'\n ));\n\n $request->addUpload('document', '/home/files/image.jpg', 'image.jpg', '');\n\n try {\n $response = $request->send();\n if ($response->getStatus() == 200) {\n echo $response->getBody();\n }\n else {\n echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .\n $response->getBody();\n }\n }\n catch(HTTP_Request2_Exception $e) {\n echo 'Error: ' . $e->getMessage();\n }\n?>\n"
},
"Upload a document using C#":{
"summary":"Upload a document using C#",
"value":"var client = new RestClient(\"https://{base_url}/resources/1/documents\");\nclient.Timeout = -1;\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Authorization\", \"{authorization}\");\nrequest.AlwaysMultipartFormData = true;\nrequest.AddParameter(\"document\", \"@files/image1.jpg\");\nIRestResponse response = client.Execute(request);\nConsole.WriteLine(response.Content);\n"
},
"Upload a document using JavaScript":{
"summary":"Upload a document using JavaScript",
"value":"var data = new FormData();\ndata.append(\"document\", \"@files/image1.jpg\");\n\nvar xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function() {\n if(this.readyState === 4) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://%7Bbase_url%7D/resources/1/documents\");\nxhr.setRequestHeader(\"Authorization\", \"{authorization}\");\n\nxhr.send(data);\n"
},
"Upload a document using Python":{
"summary":"Upload a document using Python",
"value":"import requests\nimport json\n\nurl = 'https://{base_url}/resources/1/documents'\nheaders = {'Authorization': '{authorization}'}\n\nfile = open('files/image1.jpg', 'rb')\nfiles = {'document': ('image1.jpg', file)}\n\ndata = {\n 'document': '@/files/image1.jpg'\n}\n\nresponse = requests.post(url, headers=headers, files=files, data=data)\n\nfile.close()\n\nprint(response.text)\n"
}
}
}
}
},
"responses":{
"201":{
"description":"Document successfully uploaded",
"headers":{
"Location":{
"description":"The location of the uploaded document.",
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
},
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.DocumentIdentifier"
},
"examples":{
"Document successfully uploaded":{
"summary":"Document successfully uploaded",
"value":{
"documentId":"103AFCC51DC08FDD351D6ACB689FA071FDF7F7EB92FD6451F62A3AA92EBFA69596150BE4C4BFFBC97182A27D716ED0D3CB67682EF7E0D615EC501064A8B9A201"
}
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"examples":{
"Maximum upload size exceeded":{
"summary":"Maximum upload size exceeded",
"value":{
"errorCode":"E400",
"description":"Request cannot be processed.",
"action":"Check the syntax, violations and adjust the request.",
"violations":[
{
"property":"",
"violation":"Maximum upload size exceeded"
}
],
"resources":[]
}
},
"Document not provided":{
"summary":"Document not provided",
"value":{
"errorCode":"E400",
"description":"Request cannot be processed.",
"action":"Check the syntax, violations and adjust the request.",
"violations":[
{
"property":"document",
"violation":"Must not be null or empty."
}
],
"resources":[]
}
},
"Unsupported document content type":{
"summary":"Unsupported document content type",
"value":{
"errorCode":"E400",
"description":"Request cannot be processed.",
"action":"Check the syntax, violations and adjust the request.",
"violations":[
{
"property":"document",
"violation":"Unsupported document content type."
}
],
"resources":[]
}
},
"Document content type is required":{
"summary":"Document content type is required",
"value":{
"errorCode":"E400",
"description":"Request cannot be processed.",
"action":"Check the syntax, violations and adjust the request.",
"violations":[
{
"property":"document",
"violation":"Document content type is required."
}
],
"resources":[]
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"errorCode":"E400",
"description":"Request cannot be processed.",
"action":"Check the syntax, violations and adjust the request.",
"violations":[
{
"property":"property.path",
"violation":"Violation message."
}
],
"resources":[]
}
}
}
}
}
},
"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":[
"resource-request-hub:manage",
"resource-request-hub:read"
],
"x-is-early-access":true,
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":1,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/resources/1/documents/{documentId}":{
"get":{
"tags":[
"platform",
"resources",
"resource-request"
],
"summary":"Download document",
"description":"Download a requirement supporting document (template or sample) or a document you have previously uploaded.",
"operationId":"download-document",
"parameters":[
{
"name":"documentId",
"in":"path",
"description":"The ID of the desired document.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string",
"description":"The ID of the desired 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":{
"*/*":{
"schema":{
"type":"string",
"format":"binary"
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiError401"
},
"403":{
"$ref":"#/components/responses/ApiError403"
},
"404":{
"description":"Not Found",
"content":{
"*/*":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"examples":{
"Document not found":{
"summary":"Document not found",
"value":{
"errorCode":"RR-DOC404",
"description":"Document not found.",
"action":"Please verify the document ID and adjust your request.",
"violations":[],
"resources":[]
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiError429"
},
"500":{
"$ref":"#/components/responses/ApiError500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"resource-request-hub:manage",
"resource-request-hub:read"
],
"x-is-early-access":true,
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":1,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
},
"delete":{
"tags":[
"platform",
"resources",
"resource-request"
],
"summary":"Delete document",
"description":"Delete a document you have previously uploaded.",
"operationId":"delete-document",
"parameters":[
{
"name":"documentId",
"in":"path",
"description":"The ID of the document for deletion.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string",
"description":"The ID of the document for deletion."
}
}
],
"responses":{
"204":{
"description":"Document successfully deleted"
},
"401":{
"$ref":"#/components/responses/ApiError401"
},
"403":{
"$ref":"#/components/responses/ApiError403"
},
"404":{
"description":"Not Found",
"content":{
"*/*":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"examples":{
"Document not found":{
"summary":"Document not found",
"value":{
"errorCode":"RR-DOC404",
"description":"Document not found.",
"action":"Please verify the document ID and adjust your request.",
"violations":[],
"resources":[]
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiError429"
},
"500":{
"$ref":"#/components/responses/ApiError500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"resource-request-hub:manage",
"resource-request-hub:read"
],
"x-is-early-access":true,
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":20,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
}
},
"components":{
"schemas":{
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.AlphaCoverageInfo":{
"type":"object",
"description":"Information about the sender coverage.",
"properties":{
"senderName":{
"type":"string",
"description":"Alphanumeric sender name.",
"example":"MySender"
},
"countryCode":{
"type":"string",
"description":"Country code in two-letter ISO standard. Required for identifying country specific resources (for instance, short code number types).",
"example":"GB",
"pattern":"^[A-Z]{2}$"
},
"countryName":{
"type":"string",
"description":"Country name.",
"example":"United Kingdom"
},
"capabilities":{
"type":"array",
"items":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceCapability"
},
"uniqueItems":true
},
"resourceType":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceType"
}
},
"required":[
"countryCode"
],
"title":"Alphanumeric"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.AlphaCoverageKey":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceCoverageKey"
},
{
"type":"object",
"properties":{
"senderName":{
"type":"string",
"description":"Alphanumeric sender name.",
"example":"MySender",
"maxLength":255,
"minLength":0
},
"countryCode":{
"type":"string",
"description":"Country code in two-letter ISO standard. Required for identifying country specific resources (for instance, short code number types).",
"example":"GB",
"minLength":1,
"pattern":"^[A-Z]{2}$"
}
}
}
],
"required":[
"countryCode",
"resourceType",
"senderName"
],
"title":"AlphaCoverageKey"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.AlphaResourceFilter":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourcesFilter"
},
{
"type":"object",
"properties":{
"senderName":{
"type":"string",
"description":"Alphanumeric sender name.",
"example":"MySender",
"maxLength":255,
"minLength":1
},
"countryCode":{
"type":"string",
"description":"Country code in two-letter ISO standard. Required for identifying country specific resources (for instance, short code number types).",
"example":"GB",
"pattern":"^[A-Z]{2}$"
},
"resourceType":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceType"
}
}
}
],
"description":"Alphanumeric filter for resources.",
"title":"AlphaResourceFilter"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.AlphaResourceInfo":{
"type":"object",
"description":"Information about alphanumeric type of resource.",
"properties":{
"senderName":{
"type":"string",
"description":"Alphanumeric sender name.",
"example":"MySender"
},
"countryCode":{
"type":"string",
"description":"Country code in two-letter ISO standard. Required for identifying country specific resources (for instance, short code number types).",
"example":"GB",
"pattern":"^[A-Z]{2}$"
},
"countryName":{
"type":"string",
"description":"Country name.",
"example":"United Kingdom"
},
"capabilities":{
"type":"array",
"description":"Capabilities of the sender.",
"items":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ResourceCapabilityChannel"
},
"uniqueItems":true
},
"resourceType":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceType"
}
},
"title":"Alphanumeric"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.AppleCoverageInfo":{
"type":"object",
"description":"Information about the sender coverage.",
"properties":{
"resource":{
"type":"string",
"description":"Resource name.",
"example":"MyResource"
},
"displayName":{
"type":"string",
"description":"Display name.",
"example":"MyDisplayName"
},
"countryCode":{
"type":"string",
"description":"Country code in two-letter ISO standard. Required for identifying country specific resources (for instance, short code number types).",
"example":"GB",
"pattern":"^[A-Z]{2}$"
},
"countryName":{
"type":"string",
"description":"Country name.",
"example":"United Kingdom"
},
"capabilities":{
"type":"array",
"items":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceCapability"
},
"uniqueItems":true
},
"resourceType":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceType"
}
},
"title":"Apple"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.AppleCoverageKey":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceCoverageKey"
},
{
"type":"object",
"properties":{
"resource":{
"type":"string",
"description":"Resource name.",
"example":"MyResource",
"maxLength":255,
"minLength":0
},
"displayName":{
"type":"string",
"description":"Display name.",
"example":"MyDisplayName"
},
"countryCode":{
"type":"string",
"description":"Country code in two-letter ISO standard. Required for identifying country specific resources (for instance, short code number types).",
"example":"GB",
"minLength":1,
"pattern":"^[A-Z]{2}$"
}
}
}
],
"required":[
"countryCode",
"resource",
"resourceType"
],
"title":"AppleCoverageKey"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.AppleMbMoActionDocs":{
"type":"object",
"description":"Forwarding MO action.",
"discriminator":{
"propertyName":"type",
"mapping":{
"HTTP_FORWARD":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.AppleMbMoHttpForwardDocs"
}
},
"example":{
"type":"HTTP_FORWARD",
"url":"https://example.com",
"format":"MO_OTT_CONTACT"
},
"properties":{
"type":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoActionType"
}
},
"title":"AppleMbMoActionDocs"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.AppleMbMoConfigurationRequest":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoConfigurationRequest"
},
{
"type":"object",
"properties":{
"resourceKey":{
"type":"string",
"description":"Required if resource not present.",
"example":"58BC6DB7966CB9F69A91EB956DF73239"
},
"platform":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.PlatformDocs"
},
"resource":{
"type":"string",
"description":"Required if resourceKey not present.",
"example":"41793026727"
},
"forwarding":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.AppleMbMoActionDocs"
},
"conversations":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.UseConversations"
}
}
}
],
"required":[
"channel"
],
"title":"AppleMbMoConfigurationRequest"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.AppleMbMoHttpForwardDocs":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.AppleMbMoActionDocs"
},
{
"type":"object",
"properties":{
"url":{
"type":"string",
"description":"Specifies URL where message will be pushed.",
"minLength":1
},
"format":{
"type":"string",
"default":"MO_OTT_CONTACT",
"description":"Specifies pushed content format."
}
}
}
],
"required":[
"type",
"url"
],
"title":"AppleMbMoHttpForwardDocs"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.AppleResourceFilter":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourcesFilter"
},
{
"type":"object",
"properties":{
"resource":{
"type":"string",
"description":"Resource name.",
"example":"MyResource",
"maxLength":255,
"minLength":1
},
"resourceType":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceType"
}
}
}
],
"description":"Apple filter for resources.",
"title":"AppleResourceFilter"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.AppleResourceInfo":{
"type":"object",
"description":"Information about Apple type of resource.",
"properties":{
"resource":{
"type":"string",
"description":"Resource name.",
"example":"MyResource"
},
"displayName":{
"type":"string",
"description":"Display name.",
"example":"MyDisplayName"
},
"countryCode":{
"type":"string",
"description":"Country code in two-letter ISO standard. Required for identifying country specific resources (for instance, short code number types).",
"example":"GB",
"pattern":"^[A-Z]{2}$"
},
"countryName":{
"type":"string",
"description":"Country name.",
"example":"United Kingdom"
},
"capabilities":{
"type":"array",
"description":"Capabilities of the sender.",
"items":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ResourceCapabilityChannel"
},
"uniqueItems":true
},
"resourceType":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceType"
}
},
"title":"Apple"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.AutoResponseActionV2Request":{
"type":"object",
"description":"Auto-response action configuration.",
"example":{
"message":"Thank you for your message.",
"sender":"MyAutoResponseSender",
"deliveryTimeWindow":{
"from":"08:35",
"to":"16:35",
"days":[
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY"
],
"deliveryTimeZone":"USER_TIME_ZONE"
}
},
"properties":{
"message":{
"type":"string",
"description":"Text that will be sent as a response message.",
"maxLength":1080,
"minLength":0
},
"sender":{
"type":"string",
"description":"If set, it will override the sender of the message in autoresponse sent to the user."
},
"deliveryTimeWindow":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.DeliveryTimeWindow"
}
},
"required":[
"message"
],
"title":"AutoResponseActionV2Request"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.AutoResponseActionV2Response":{
"type":"object",
"description":"Auto-response action configuration.",
"example":{
"message":"Thank you for your message.",
"sender":"MyAutoResponseSender",
"deliveryTimeWindow":{
"from":"08:35",
"to":"16:35",
"days":[
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY"
],
"deliveryTimeZone":"USER_TIME_ZONE"
}
},
"properties":{
"message":{
"type":"string",
"description":"Text that will be sent as a response message."
},
"sender":{
"type":"string",
"description":"If set, it will override the sender of the message in autoresponse sent to the user."
},
"deliveryTimeWindow":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.DeliveryTimeWindowResponse"
}
},
"required":[
"message"
],
"title":"AutoResponseActionV2Response"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.BlockLevelRequest":{
"type":"string",
"description":"The level of block configuration.",
"enum":[
"FROM_SENDER",
"FROM_ANY_SENDER"
],
"title":"BlockLevelRequest"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.BlockLevelResponse":{
"type":"string",
"description":"The level of block configuration. If the value is CUSTOM_NOT_EDITABLE, then the value is not manageable by API.",
"enum":[
"FROM_SENDER",
"FROM_ANY_SENDER",
"CUSTOM_NOT_EDITABLE"
],
"title":"BlockLevelResponse"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.BlockListConfigurationRequest":{
"type":"object",
"description":"Whitelist or blacklist the traffic of MT messages.",
"properties":{
"type":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.BlockListConfigurationType"
},
"level":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.BlockLevelRequest"
}
},
"required":[
"level",
"type"
],
"title":"BlockListConfigurationRequest"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.BlockListConfigurationResponse":{
"type":"object",
"description":"Whitelist or blacklist the traffic of MT messages.",
"properties":{
"type":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.BlockListConfigurationType"
},
"level":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.BlockLevelResponse"
}
},
"required":[
"level",
"type"
],
"title":"BlockListConfigurationResponse"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.BlockListConfigurationType":{
"type":"string",
"description":"The type of block configuration. Defines whether you are configuring blocking (blacklisting) or unblocking (whitelisting) configuration.",
"enum":[
"BLOCK",
"UNBLOCK"
],
"example":"UNBLOCK",
"title":"BlockListConfigurationType"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ConfigurationType":{
"type":"string",
"description":"Channel type.",
"enum":[
"SMS",
"MMS",
"WHATSAPP",
"RCS",
"VIBER_BM",
"APPLE_MB",
"LINE_OA",
"KAKAO_SANGDAM",
"MESSENGER",
"INSTAGRAM_DM",
"ZALO_ZNS",
"TELEGRAM",
"VIBER_BOT",
"EMAIL",
"ZALO_FOLLOWER",
"OPEN_CHANNEL",
"TIKTOK_BM"
],
"example":"SMS",
"title":"ConfigurationType"
},
"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 HH:mm.",
"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 HH:mm.",
"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.DeliveryTimeWindowResponse":{
"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 HH:mm.",
"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 HH:mm.",
"example":"16:35"
},
"days":{
"type":"array",
"description":"Days which are included in the delivery time window.",
"items":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.DayOfWeek"
},
"uniqueItems":true
},
"deliveryTimeZone":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.DeliveryTimeZoneResponse"
}
},
"required":[
"days",
"deliveryTimeZone",
"from",
"to"
],
"title":"DeliveryTimeWindowResponse"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.DeliveryTimeZone":{
"type":"string",
"description":"Sending time zone. If null is sent, User time zone will be set.",
"enum":[
"USER_TIME_ZONE",
"DESTINATION_TIME_ZONE"
],
"title":"DeliveryTimeZone"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.DeliveryTimeZoneResponse":{
"type":"string",
"description":"Sending time zone. If the value is CUSTOM_NOT_EDITABLE, then the value is not manageable by API.",
"enum":[
"USER_TIME_ZONE",
"DESTINATION_TIME_ZONE",
"CUSTOM_NOT_EDITABLE"
],
"title":"DeliveryTimeZoneResponse"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.EmailDomainMoActionDocs":{
"type":"object",
"description":"Forwarding MO action.",
"discriminator":{
"propertyName":"type",
"mapping":{
"HTTP_FORWARD":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.EmailDomainMoHttpForwardDocs"
}
},
"example":{
"type":"HTTP_FORWARD",
"url":"https://example.com",
"format":"MO_MULTIPART"
},
"properties":{
"type":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoActionType"
}
},
"title":"EmailDomainMoActionDocs"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.EmailDomainMoConfigurationRequest":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoConfigurationRequest"
},
{
"type":"object",
"properties":{
"resourceKey":{
"type":"string",
"description":"Required if resource not present.",
"example":"B674B8E8A952E51E44E662D892A62BE2"
},
"resource":{
"type":"string",
"description":"Required if resourceKey not present.",
"example":"Infobip.com"
},
"forwarding":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.EmailDomainMoActionDocs"
},
"platform":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.PlatformDocs"
}
}
}
],
"required":[
"channel"
],
"title":"EmailDomainMoConfigurationRequest"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.EmailDomainMoHttpForwardDocs":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.EmailDomainMoActionDocs"
},
{
"type":"object",
"properties":{
"url":{
"type":"string",
"description":"Specifies URL where message will be pushed.",
"minLength":1
},
"format":{
"type":"string",
"default":"MO_MULTIPART",
"description":"Specifies pushed content format."
}
}
}
],
"required":[
"type",
"url"
],
"title":"EmailDomainMoHttpForwardDocs"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.FacebookCoverageInfo":{
"type":"object",
"description":"Information about the sender coverage.",
"properties":{
"resource":{
"type":"string",
"description":"Resource name.",
"example":"MyResource"
},
"displayName":{
"type":"string",
"description":"Display name.",
"example":"MyDisplayName"
},
"countryCode":{
"type":"string",
"description":"Country code in two-letter ISO standard. Required for identifying country specific resources (for instance, short code number types).",
"example":"GB",
"pattern":"^[A-Z]{2}$"
},
"countryName":{
"type":"string",
"description":"Country name.",
"example":"United Kingdom"
},
"capabilities":{
"type":"array",
"items":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceCapability"
},
"uniqueItems":true
},
"resourceType":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceType"
}
},
"title":"Facebook"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.HttpForwardActionDocs":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoActionDocs"
},
{
"type":"object",
"properties":{
"url":{
"type":"string",
"description":"Specifies URL where message will be pushed.",
"minLength":1
},
"format":{
"type":"string",
"default":"MO_JSON_2",
"description":"Specifies pushed content format."
}
}
}
],
"description":"Used for HTTP push. MO message parameters can be pushed to specified URL in defined format.",
"required":[
"type",
"url"
],
"title":"HttpForwardActionDocs"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceCapability":{
"type":"object",
"description":"Coverage by capability.",
"properties":{
"channel":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ResourceCapabilityChannel"
},
"coverage":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceCoverage"
}
},
"title":"IbResourceCapability"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceCoverage":{
"type":"object",
"description":"Information about the networks configured for the resource.",
"properties":{
"outbound":{
"type":"array",
"items":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NetworkView"
},
"uniqueItems":true
},
"inbound":{
"type":"boolean",
"description":"Indicates if inbound configuration exists.",
"example":false
}
},
"title":"IbResourceCoverage"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceCoverageInfo":{
"type":"object",
"description":"Information about resource coverage.",
"oneOf":[
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.AlphaCoverageInfo"
},
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumberCoverageInfo"
},
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.RcsCoverageInfo"
},
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ViberCoverageInfo"
},
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.AppleCoverageInfo"
},
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.OpenChannelCoverageInfo"
},
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.KakaoCoverageInfo"
},
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.FacebookCoverageInfo"
}
],
"title":"IbResourceCoverageInfo"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceCoverageKey":{
"type":"object",
"discriminator":{
"propertyName":"resourceType",
"mapping":{
"ALPHANUMERIC":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.AlphaCoverageKey",
"NUMBER":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumberCoverageKey",
"RCS_RESOURCE":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.RcsCoverageKey",
"VIBER_RESOURCE":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ViberCoverageKey",
"APPLE_RESOURCE":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.AppleCoverageKey",
"OPEN_CHANNEL_RESOURCE":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.OpenChannelCoverageKey"
}
},
"properties":{
"resourceType":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceType"
}
},
"required":[
"resourceType"
],
"title":"IbResourceCoverageKey"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceInfo":{
"type":"object",
"description":"Resource basic info.",
"oneOf":[
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumberResourceInfo"
},
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.AlphaResourceInfo"
},
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.RcsResourceInfo"
},
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ViberResourceInfo"
},
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.AppleResourceInfo"
},
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.OpenChannelResourceInfo"
}
],
"title":"IbResourceInfo"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceType":{
"type":"string",
"description":"Resource type.",
"enum":[
"ALPHANUMERIC",
"NUMBER",
"RCS_RESOURCE",
"VIBER_RESOURCE",
"APPLE_RESOURCE",
"OPEN_CHANNEL_RESOURCE",
"KAKAO_RESOURCE",
"FACEBOOK_RESOURCE"
],
"example":"FACEBOOK_RESOURCE",
"title":"IbResourceType"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourcesFilter":{
"type":"object",
"description":"Filter for resources.",
"discriminator":{
"propertyName":"resourceType",
"mapping":{
"NUMBER":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumberResourceFilter",
"ALPHANUMERIC":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.AlphaResourceFilter",
"RCS_RESOURCE":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.RcsResourceFilter",
"VIBER_RESOURCE":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ViberResourceFilter",
"APPLE_RESOURCE":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.AppleResourceFilter",
"OPEN_CHANNEL_RESOURCE":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.OpenChannelResourceFilter"
}
},
"properties":{
"resourceType":{
"type":"string"
}
},
"required":[
"resourceType"
],
"title":"IbResourcesFilter"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourcesResponse":{
"type":"object",
"description":"Response containing information about IB resources.",
"properties":{
"results":{
"type":"array",
"description":"List of resources.",
"items":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceInfo"
}
},
"paging":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.PageInfo"
}
},
"title":"IbResourcesResponse"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.InstagramDmHttpForwardDocs":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.InstagramDmMoActionDocs"
},
{
"type":"object",
"properties":{
"url":{
"type":"string",
"description":"Specifies URL where message will be pushed.",
"minLength":1
},
"format":{
"type":"string",
"default":"MO_OTT_MSISDN",
"description":"Specifies pushed content format."
}
}
}
],
"required":[
"type",
"url"
],
"title":"InstagramDmHttpForwardDocs"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.InstagramDmMoActionDocs":{
"type":"object",
"description":"Forwarding MO action.",
"discriminator":{
"propertyName":"type",
"mapping":{
"HTTP_FORWARD":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.InstagramDmHttpForwardDocs"
}
},
"example":{
"type":"HTTP_FORWARD",
"url":"https://example.com",
"format":"MO_OTT_MSISDN"
},
"properties":{
"type":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoActionType"
}
},
"title":"InstagramDmMoActionDocs"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.InstagramDmMoConfigurationRequest":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoConfigurationRequest"
},
{
"type":"object",
"properties":{
"resourceKey":{
"type":"string",
"description":"Required if resource not present.",
"example":"58BC6DB7966CB9F69A91EB956DF73239"
},
"platform":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.PlatformDocs"
},
"resource":{
"type":"string",
"description":"Required if resourceKey not present.",
"example":"41793026727"
},
"forwarding":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.InstagramDmMoActionDocs"
},
"conversations":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.UseConversations"
}
}
}
],
"required":[
"channel"
],
"title":"InstagramDmMoConfigurationRequest"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.KakaoCoverageInfo":{
"type":"object",
"description":"Information about the sender coverage.",
"properties":{
"resource":{
"type":"string",
"description":"Resource name.",
"example":"MyResource"
},
"displayName":{
"type":"string",
"description":"Display name.",
"example":"MyDisplayName"
},
"countryCode":{
"type":"string",
"description":"Country code in two-letter ISO standard. Required for identifying country specific resources (for instance, short code number types).",
"example":"GB",
"pattern":"^[A-Z]{2}$"
},
"countryName":{
"type":"string",
"description":"Country name.",
"example":"United Kingdom"
},
"capabilities":{
"type":"array",
"items":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceCapability"
},
"uniqueItems":true
},
"resourceType":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceType"
}
},
"title":"Kakao"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.KakaoSangdamHttpForwardDocs":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.KakaoSangdamMoActionDocs"
},
{
"type":"object",
"properties":{
"url":{
"type":"string",
"description":"Specifies URL where message will be pushed.",
"minLength":1
},
"format":{
"type":"string",
"default":"MO_OTT_MSISDN",
"description":"Specifies pushed content format."
}
}
}
],
"required":[
"type",
"url"
],
"title":"KakaoSangdamHttpForwardDocs"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.KakaoSangdamMoActionDocs":{
"type":"object",
"description":"Forwarding MO action.",
"discriminator":{
"propertyName":"type",
"mapping":{
"HTTP_FORWARD":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.KakaoSangdamHttpForwardDocs"
}
},
"example":{
"type":"HTTP_FORWARD",
"url":"https://example.com",
"format":"MO_OTT_MSISDN"
},
"properties":{
"type":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoActionType"
}
},
"title":"KakaoSangdamMoActionDocs"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.KakaoSangdamMoConfigurationRequest":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoConfigurationRequest"
},
{
"type":"object",
"properties":{
"resourceKey":{
"type":"string",
"description":"Required if resource not present.",
"example":"58BC6DB7966CB9F69A91EB956DF73239"
},
"platform":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.PlatformDocs"
},
"resource":{
"type":"string",
"description":"Required if resourceKey not present.",
"example":"41793026727"
},
"forwarding":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.KakaoSangdamMoActionDocs"
},
"conversations":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.UseConversations"
}
}
}
],
"required":[
"channel"
],
"title":"KakaoSangdamMoConfigurationRequest"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.LineOaMoActionDocs":{
"type":"object",
"description":"Forwarding MO action.",
"discriminator":{
"propertyName":"type",
"mapping":{
"HTTP_FORWARD":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.LineOaMoHttpForwardDocs"
}
},
"example":{
"type":"HTTP_FORWARD",
"url":"https://example.com",
"format":"MO_OTT_MSISDN"
},
"properties":{
"type":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoActionType"
}
},
"title":"LineOaMoActionDocs"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.LineOaMoConfigurationRequest":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoConfigurationRequest"
},
{
"type":"object",
"properties":{
"resourceKey":{
"type":"string",
"description":"Required if resource not present.",
"example":"58BC6DB7966CB9F69A91EB956DF73239"
},
"resource":{
"type":"string",
"description":"Required if resourceKey not present.",
"example":"41793026727"
},
"forwarding":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.LineOaMoActionDocs"
},
"conversations":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.UseConversations"
}
}
}
],
"required":[
"channel"
],
"title":"LineOaMoConfigurationRequest"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.LineOaMoHttpForwardDocs":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.LineOaMoActionDocs"
},
{
"type":"object",
"properties":{
"url":{
"type":"string",
"description":"Specifies URL where message will be pushed.",
"minLength":1
},
"format":{
"type":"string",
"default":"MO_OTT_MSISDN",
"description":"Specifies pushed content format."
}
}
}
],
"required":[
"type",
"url"
],
"title":"LineOaMoHttpForwardDocs"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MailForwardActionDocs":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoActionDocs"
},
{
"type":"object",
"properties":{
"mail":{
"type":"string",
"description":"Specifies e-mail destination.",
"minLength":1
},
"description":{
"type":"string",
"description":"Additional action description.",
"example":"My description."
}
}
}
],
"required":[
"mail",
"type"
],
"title":"MailForwardActionDocs"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MessengerMoActionDocs":{
"type":"object",
"description":"Forwarding MO action.",
"discriminator":{
"propertyName":"type",
"mapping":{
"HTTP_FORWARD":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MessengerMoHttpForwardDocs"
}
},
"example":{
"type":"HTTP_FORWARD",
"url":"https://example.com",
"format":"MO_OTT_MSISDN"
},
"properties":{
"type":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoActionType"
}
},
"title":"MessengerMoActionDocs"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MessengerMoConfigurationRequest":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoConfigurationRequest"
},
{
"type":"object",
"properties":{
"resourceKey":{
"type":"string",
"description":"Required if resource not present.",
"example":"58BC6DB7966CB9F69A91EB956DF73239"
},
"resource":{
"type":"string",
"description":"Required if resourceKey not present.",
"example":"41793026727"
},
"forwarding":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MessengerMoActionDocs"
},
"conversations":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.UseConversations"
},
"platform":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.PlatformDocs"
}
}
}
],
"required":[
"channel"
],
"title":"MessengerMoConfigurationRequest"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MessengerMoHttpForwardDocs":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MessengerMoActionDocs"
},
{
"type":"object",
"properties":{
"url":{
"type":"string",
"description":"Specifies URL where message will be pushed.",
"minLength":1
},
"format":{
"type":"string",
"default":"MO_OTT_MSISDN",
"description":"Specifies pushed content format."
}
}
}
],
"required":[
"type",
"url"
],
"title":"MessengerMoHttpForwardDocs"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MmsHttpForwardActionDocs":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MmsMoActionDocs"
},
{
"type":"object",
"properties":{
"url":{
"type":"string",
"description":"Specifies URL where message will be pushed.",
"minLength":1
},
"format":{
"type":"string",
"default":"MO_MMS_2",
"description":"Specifies pushed content format."
}
}
}
],
"required":[
"type",
"url"
],
"title":"MmsHttpForwardActionDocs"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MmsMoActionDocs":{
"type":"object",
"description":"Forwarding MO action.",
"discriminator":{
"propertyName":"type",
"mapping":{
"HTTP_FORWARD":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MmsHttpForwardActionDocs",
"PULL":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MmsPullActionDocs"
}
},
"properties":{
"type":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoActionType"
}
},
"required":[
"type"
],
"title":"MmsMoActionDocs"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MmsMoConfigurationRequest":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoConfigurationRequest"
},
{
"type":"object",
"properties":{
"numberKey":{
"type":"string",
"description":"Required if number not present.",
"example":"58BC6DB7966CB9F69A91EB956DF73239"
},
"platform":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.PlatformDocs"
},
"number":{
"type":"string",
"description":"Required if numberKey not present.",
"example":"41793026727"
},
"countryCode":{
"type":"string",
"description":"Country code in two-letter ISO standard. Required for identifying country specific resources (for instance, short code number types).",
"example":"GB",
"pattern":"^[A-Z]{2}$"
},
"forwarding":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MmsMoActionDocs"
},
"autoResponse":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.AutoResponseActionV2Request"
},
"blockListConfiguration":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.BlockListConfigurationRequest"
}
}
}
],
"required":[
"channel"
],
"title":"MmsMoConfigurationRequest"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MmsPullActionDocs":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MmsMoActionDocs"
},
{
"type":"object",
"properties":{
"description":{
"type":"string",
"description":"Additional action description.",
"example":"My description."
}
}
}
],
"required":[
"type"
],
"title":"MmsPullActionDocs"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoActionDocs":{
"type":"object",
"description":"Forwarding MO action.",
"discriminator":{
"propertyName":"type",
"mapping":{
"HTTP_FORWARD":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.HttpForwardActionDocs",
"MAIL_FORWARD":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MailForwardActionDocs",
"SMPP_FORWARD":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.SmppForwardActionDocs",
"PULL":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.PullActionDocs"
}
},
"properties":{
"type":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoActionType"
}
},
"required":[
"type"
],
"title":"MoActionDocs"
},
"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.MoConfigurationRequest":{
"type":"object",
"discriminator":{
"propertyName":"channel",
"mapping":{
"SMS":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.SmsMoConfigurationRequest",
"MMS":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MmsMoConfigurationRequest",
"WHATSAPP":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.WhatsAppMoConfigurationRequest",
"RCS":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.RcsMoConfigurationRequest",
"VIBER_BM":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ViberBmMoConfigurationRequest",
"APPLE_MB":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.AppleMbMoConfigurationRequest",
"LINE_OA":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.LineOaMoConfigurationRequest",
"KAKAO_SANGDAM":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.KakaoSangdamMoConfigurationRequest",
"MESSENGER":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MessengerMoConfigurationRequest",
"INSTAGRAM_DM":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.InstagramDmMoConfigurationRequest",
"ZALO_ZNS":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ZaloZnsMoConfigurationRequest",
"TELEGRAM":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.TelegramMoConfigurationRequest",
"VIBER_BOT":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ViberBotMoConfigurationRequest",
"EMAIL":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.EmailDomainMoConfigurationRequest",
"ZALO_FOLLOWER":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ZaloFollowerMoConfigurationRequest",
"OPEN_CHANNEL":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.OpenChannelMoConfigurationRequest",
"TIKTOK_BM":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.TikTokBmMoConfigurationRequest"
}
},
"properties":{
"keyword":{
"type":"string",
"description":"Omitting this value or sending NULL will set keyword to NULL because it is a valid keyword which will match all values.",
"example":"STARTKW",
"maxLength":50,
"minLength":0
},
"username":{
"type":"string",
"description":"Sets username that will be applied in appropriate actions.",
"example":"myusername",
"maxLength":255,
"minLength":0,
"pattern":"^(?!\\s*$).+"
},
"unset":{
"type":"array",
"description":"Used for unsetting configuration options.
If a property appears both in unset, and in the body of the request, it will FIRST be removed, and then UPDATED with the value from the request body!",
"example":"FORWARDING",
"items":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.UnsetOption"
},
"uniqueItems":true
},
"channel":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ConfigurationType"
}
},
"required":[
"channel"
],
"title":"MoConfigurationRequest"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoConfigurationResponse":{
"type":"object",
"description":"Response for configuring MO resource.",
"properties":{
"configurationKey":{
"type":"string",
"description":"The key of a stored configuration.",
"example":"E9FCDCA496035F08EEA5933702EDF745"
},
"channel":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ConfigurationType"
},
"keyword":{
"type":"string",
"description":"Configuration keyword.",
"example":"STARTKW"
},
"username":{
"type":"string",
"description":"Configuration username.",
"example":"myusername"
},
"platform":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.PlatformDocs"
},
"forwarding":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoActionDocs"
},
"conversations":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.UseConversations"
},
"answers":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.UseAnswers"
},
"autoResponse":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.AutoResponseActionV2Response"
},
"blockListConfiguration":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.BlockListConfigurationResponse"
}
},
"required":[
"configurationKey"
],
"title":"MoConfigurationResponse"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NetworkView":{
"type":"object",
"description":"Network data.",
"properties":{
"mccNnc":{
"type":"string",
"description":"Norm net code uniquely identifying the specific mobile network operator.",
"example":"310260"
},
"networkName":{
"type":"string",
"description":"Network name.",
"example":"Some network"
}
},
"title":"NetworkView"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumberCoverageInfo":{
"type":"object",
"description":"Information about the number coverage.",
"properties":{
"number":{
"type":"string",
"description":"Phone number.",
"example":"447860041117"
},
"numberKey":{
"type":"string",
"description":"Number key.",
"example":"58B3840032C7774BAC840EEEA2C23A44"
},
"platform":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.PlatformDocs"
},
"numberType":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumberType"
},
"countryCode":{
"type":"string",
"description":"Country code in two-letter ISO standard. Required for identifying country specific resources (for instance, short code number types).",
"example":"GB",
"pattern":"^[A-Z]{2}$"
},
"countryName":{
"type":"string",
"description":"Country name.",
"example":"United Kingdom"
},
"capabilities":{
"type":"array",
"items":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceCapability"
},
"uniqueItems":true
},
"resourceType":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceType"
}
},
"title":"Number"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumberCoverageKey":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceCoverageKey"
},
{
"type":"object",
"properties":{
"number":{
"type":"string",
"description":"Phone number.",
"example":"41793026727",
"maxLength":255,
"minLength":0
},
"countryCode":{
"type":"string",
"description":"Country code in two-letter ISO standard. Required for identifying country specific resources (for instance, short code number types).",
"example":"GB",
"minLength":1,
"pattern":"^[A-Z]{2}$"
}
}
}
],
"required":[
"countryCode",
"number",
"resourceType"
],
"title":"NumberCoverageKey"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumberResourceCapabilityChannelDocs":{
"type":"string",
"enum":[
"SMS",
"MMS"
],
"title":"NumberResourceCapabilityChannelDocs"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumberResourceFilter":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourcesFilter"
},
{
"type":"object",
"properties":{
"number":{
"type":"string",
"description":"Phone number.",
"example":"447860041117",
"maxLength":255,
"minLength":1
},
"countryCode":{
"type":"string",
"description":"Country code in two-letter ISO standard. Required for identifying country specific resources (for instance, short code number types).",
"example":"GB",
"pattern":"^[A-Z]{2}$"
},
"capabilities":{
"type":"array",
"description":"Number capabilities",
"items":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumberResourceCapabilityChannelDocs"
}
},
"resourceType":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceType"
}
}
}
],
"description":"Numeric filter for resources.",
"title":"NumberResourceFilter"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumberResourceInfo":{
"type":"object",
"description":"Information about the numeric type of resource.",
"properties":{
"number":{
"type":"string",
"description":"Phone number.",
"example":"447860041117"
},
"numberKey":{
"type":"string",
"description":"Number key.",
"example":"58B3840032C7774BAC840EEEA2C23A44"
},
"platform":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.PlatformDocs"
},
"numberType":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumberTypeResourceMoDocs"
},
"countryCode":{
"type":"string",
"description":"Country code in two-letter ISO standard. Required for identifying country specific resources (for instance, short code number types).",
"example":"GB",
"pattern":"^[A-Z]{2}$"
},
"countryName":{
"type":"string",
"description":"Country name.",
"example":"United Kingdom"
},
"capabilities":{
"type":"array",
"description":"Capabilities of the number.",
"items":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ResourceCapabilityChannel"
},
"uniqueItems":true
},
"resourceType":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceType"
}
},
"title":"Number"
},
"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.NumberTypeResourceMoDocs":{
"type":"string",
"description":"Number type.",
"enum":[
"VIRTUAL_LONG_NUMBER",
"SHORT_CODE"
],
"example":"VIRTUAL_LONG_NUMBER",
"title":"NumberTypeResourceMoDocs"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.OpenChannelCoverageInfo":{
"type":"object",
"description":"Information about the sender coverage.",
"properties":{
"resource":{
"type":"string",
"description":"Resource name.",
"example":"MyResource"
},
"shared":{
"type":"boolean",
"description":"Indicates whether a resource is shared."
},
"capabilities":{
"type":"array",
"items":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceCapability"
},
"uniqueItems":true
},
"resourceType":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceType"
}
},
"title":"Open Channel"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.OpenChannelCoverageKey":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceCoverageKey"
},
{
"type":"object",
"properties":{
"resource":{
"type":"string",
"description":"Resource name.",
"example":"MyResource",
"maxLength":255,
"minLength":0
},
"displayName":{
"type":"string",
"description":"Display name.",
"example":"MyDisplayName"
}
}
}
],
"required":[
"resource",
"resourceType"
],
"title":"OpenChannelCoverageKey"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.OpenChannelHttpForwardDocs":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.OpenChannelMoActionDocs"
},
{
"type":"object",
"properties":{
"url":{
"type":"string",
"description":"Specifies URL where message will be pushed.",
"minLength":1
},
"format":{
"type":"string",
"default":"MO_OTT_MSISDN",
"description":"Specifies pushed content format."
}
}
}
],
"required":[
"type",
"url"
],
"title":"OpenChannelHttpForwardDocs"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.OpenChannelMoActionDocs":{
"type":"object",
"description":"Forwarding MO action.",
"discriminator":{
"propertyName":"type",
"mapping":{
"HTTP_FORWARD":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.OpenChannelHttpForwardDocs"
}
},
"example":{
"type":"HTTP_FORWARD",
"url":"https://example.com",
"format":"MO_OTT_CONTACT"
},
"properties":{
"type":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoActionType"
}
},
"title":"OpenChannelMoActionDocs"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.OpenChannelMoConfigurationRequest":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoConfigurationRequest"
},
{
"type":"object",
"properties":{
"resourceKey":{
"type":"string",
"description":"Required if resource not present.",
"example":"58BC6DB7966CB9F69A91EB956DF73239"
},
"platform":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.PlatformDocs"
},
"resource":{
"type":"string",
"description":"Required if resourceKey not present.",
"example":"ebde59b3-28ec-4f99-b032-2d5f8cc84bb2"
},
"forwarding":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.OpenChannelMoActionDocs"
},
"conversations":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.UseConversations"
},
"answers":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.UseAnswers"
}
}
}
],
"required":[
"channel"
],
"title":"OpenChannelMoConfigurationRequest"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.OpenChannelResourceFilter":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourcesFilter"
},
{
"type":"object",
"properties":{
"resource":{
"type":"string",
"description":"Resource name.",
"example":"MyResource",
"maxLength":255,
"minLength":1
},
"resourceType":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceType"
}
}
}
],
"description":"Open Channel filter for resources.",
"title":"OpenChannelResourceFilter"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.OpenChannelResourceInfo":{
"type":"object",
"description":"Information about Open Channel type of resource.",
"properties":{
"resource":{
"type":"string",
"description":"Resource name.",
"example":"MyResource"
},
"capabilities":{
"type":"array",
"description":"Capabilities of the sender.",
"items":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ResourceCapabilityChannel"
},
"uniqueItems":true
},
"resourceType":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceType"
}
},
"title":"Open Channel"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.PageInfo":{
"type":"object",
"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"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.PlatformDocs":{
"type":"object",
"description":"Platform applicationId and entityId to apply to inbound messages that pair to this configuration. If not provided, or if set to default values (applicationId = default and entityId = null), values from the associated number/resource will be used.",
"externalDocs":{
"description":"Find out more about Application and Entity Management",
"url":"https://www.infobip.com/docs/api/platform/application-entity"
},
"properties":{
"applicationId":{
"type":"string",
"description":"Platform applicationId.",
"example":"myApplicationId",
"maxLength":255,
"minLength":0
},
"entityId":{
"type":"string",
"description":"Platform entityId.",
"example":"myEntityId",
"maxLength":255,
"minLength":0
}
},
"title":"PlatformDocs"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.PullActionDocs":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoActionDocs"
}
],
"required":[
"type"
],
"title":"PullActionDocs"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.RcsCoverageInfo":{
"type":"object",
"description":"Information about the sender coverage.",
"properties":{
"senderName":{
"type":"string",
"description":"Sender name.",
"example":"MySender"
},
"countryCode":{
"type":"string",
"description":"Country code in two-letter ISO standard. Required for identifying country specific resources (for instance, short code number types).",
"example":"GB",
"pattern":"^[A-Z]{2}$"
},
"countryName":{
"type":"string",
"description":"Country name.",
"example":"United Kingdom"
},
"capabilities":{
"type":"array",
"items":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceCapability"
},
"uniqueItems":true
},
"resourceType":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceType"
}
},
"title":"RCS"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.RcsCoverageKey":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceCoverageKey"
},
{
"type":"object",
"properties":{
"senderName":{
"type":"string",
"description":"Sender name.",
"example":"MySender",
"maxLength":255,
"minLength":0
},
"countryCode":{
"type":"string",
"description":"Country code in two-letter ISO standard. Required for identifying country specific resources (for instance, short code number types).",
"example":"GB",
"minLength":1,
"pattern":"^[A-Z]{2}$"
}
}
}
],
"required":[
"countryCode",
"resourceType",
"senderName"
],
"title":"RcsCoverageKey"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.RcsHttpForwardDocs":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.RcsMoActionDocs"
},
{
"type":"object",
"properties":{
"url":{
"type":"string",
"description":"Specifies URL where message will be pushed.",
"minLength":1
},
"format":{
"type":"string",
"default":"MO_RCS_JSON",
"description":"Specifies pushed content format."
}
}
}
],
"required":[
"type",
"url"
],
"title":"RcsHttpForwardDocs"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.RcsMoActionDocs":{
"type":"object",
"description":"Forwarding MO action.",
"discriminator":{
"propertyName":"type",
"mapping":{
"HTTP_FORWARD":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.RcsHttpForwardDocs"
}
},
"example":{
"type":"HTTP_FORWARD",
"url":"https://example.com",
"format":"MO_OTT_MSISDN"
},
"properties":{
"type":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoActionType"
}
},
"title":"RcsMoActionDocs"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.RcsMoConfigurationRequest":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoConfigurationRequest"
},
{
"type":"object",
"properties":{
"resourceKey":{
"type":"string",
"description":"Required if resource not present.",
"example":"58BC6DB7966CB9F69A91EB956DF73239"
},
"platform":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.PlatformDocs"
},
"resource":{
"type":"string",
"description":"Required if resourceKey not present.",
"example":"41793026727"
},
"forwarding":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.RcsMoActionDocs"
},
"conversations":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.UseConversations"
},
"autoResponse":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.AutoResponseActionV2Request"
},
"blockListConfiguration":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.BlockListConfigurationRequest"
}
}
}
],
"required":[
"channel"
],
"title":"RcsMoConfigurationRequest"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.RcsResourceFilter":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourcesFilter"
},
{
"type":"object",
"properties":{
"senderName":{
"type":"string",
"description":"Sender name.",
"example":"MySender",
"maxLength":255,
"minLength":1
},
"resourceType":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceType"
}
}
}
],
"description":"RCS filter for resources.",
"title":"RcsResourceFilter"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.RcsResourceInfo":{
"type":"object",
"description":"Information about RCS type of resource.",
"properties":{
"senderName":{
"type":"string",
"description":"Sender name.",
"example":"MySender"
},
"countryCode":{
"type":"string",
"description":"Country code in two-letter ISO standard. Required for identifying country specific resources (for instance, short code number types).",
"example":"GB",
"pattern":"^[A-Z]{2}$"
},
"countryName":{
"type":"string",
"description":"Country name.",
"example":"United Kingdom"
},
"capabilities":{
"type":"array",
"description":"Capabilities of the sender.",
"items":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ResourceCapabilityChannel"
},
"uniqueItems":true
},
"resourceType":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceType"
}
},
"title":"RCS"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ResourceCapabilityChannel":{
"type":"string",
"description":"Indicates the channel supported by the resource.",
"enum":[
"SMS",
"MMS",
"RCS",
"VIBER_BM",
"VIBER_BOT",
"APPLE_MB",
"OPEN_CHANNEL",
"KAKAO_CHINGU",
"KAKAO_ALIM",
"KAKAO_SANGDAM",
"FACEBOOK_POSTS",
"MESSENGER"
],
"example":"SMS",
"title":"ResourceCapabilityChannel"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.SmppForwardActionDocs":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoActionDocs"
},
{
"type":"object",
"properties":{
"description":{
"type":"string",
"description":"Additional action description.",
"example":"My description."
}
}
}
],
"required":[
"type"
],
"title":"SmppForwardActionDocs"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.SmsMoConfigurationRequest":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoConfigurationRequest"
},
{
"type":"object",
"properties":{
"numberKey":{
"type":"string",
"description":"Required if number not present.",
"example":"58BC6DB7966CB9F69A91EB956DF73239"
},
"platform":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.PlatformDocs"
},
"number":{
"type":"string",
"description":"Required if numberKey not present.",
"example":"41793026727"
},
"countryCode":{
"type":"string",
"description":"Country code in two-letter ISO standard. Required for identifying country specific resources (for instance, short code number types).",
"example":"GB",
"pattern":"^[A-Z]{2}$"
},
"forwarding":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoActionDocs"
},
"conversations":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.UseConversations"
},
"autoResponse":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.AutoResponseActionV2Request"
},
"blockListConfiguration":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.BlockListConfigurationRequest"
}
}
}
],
"description":"SMS configuration request.",
"required":[
"channel"
],
"title":"SmsMoConfigurationRequest"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.TelegramMoConfigurationRequest":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoConfigurationRequest"
},
{
"type":"object",
"properties":{
"resourceKey":{
"type":"string",
"description":"Required if resource not present.",
"example":"58BC6DB7966CB9F69A91EB956DF73239"
},
"resource":{
"type":"string",
"description":"Required if resourceKey not present.",
"example":"41793026727"
},
"conversations":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.UseConversations"
}
}
}
],
"required":[
"channel"
],
"title":"TelegramMoConfigurationRequest"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.TikTokBmMoActionDocs":{
"type":"object",
"description":"Forwarding MO action.",
"discriminator":{
"propertyName":"type",
"mapping":{
"HTTP_FORWARD":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.TikTokBmMoHttpForwardDocs"
}
},
"example":{
"type":"HTTP_FORWARD",
"url":"https://example.com",
"format":"MO_OTT_CONTACT"
},
"properties":{
"type":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoActionType"
}
},
"title":"TikTokBmMoActionDocs"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.TikTokBmMoConfigurationRequest":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoConfigurationRequest"
},
{
"type":"object",
"properties":{
"resourceKey":{
"type":"string",
"description":"Required if resource not present.",
"example":"58BC6DB7966CB9F69A91EB956DF73239"
},
"platform":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.PlatformDocs"
},
"resource":{
"type":"string",
"description":"Required if resourceKey not present.",
"example":"41793026727"
},
"forwarding":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.TikTokBmMoActionDocs"
},
"conversations":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.UseConversations"
}
}
}
],
"required":[
"channel"
],
"title":"TikTokBmMoConfigurationRequest"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.TikTokBmMoHttpForwardDocs":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.TikTokBmMoActionDocs"
},
{
"type":"object",
"properties":{
"url":{
"type":"string",
"description":"Specifies URL where message will be pushed.",
"minLength":1
},
"format":{
"type":"string",
"default":"MO_OTT_CONTACT",
"description":"Specifies pushed content format."
}
}
}
],
"required":[
"type",
"url"
],
"title":"TikTokBmMoHttpForwardDocs"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.UnsetOption":{
"type":"string",
"description":"Used for unsetting configuration options.
If a property appears both in unset, and in the body of the request, it will FIRST be removed, and then UPDATED with the value from the request body!",
"enum":[
"USERNAME",
"PLATFORM",
"FORWARDING",
"CONVERSATIONS",
"ANSWERS",
"AUTORESPONSE",
"BLOCKLISTCONFIGURATION"
],
"example":"FORWARDING",
"title":"UnsetOption"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.UseAnswers":{
"type":"object",
"description":"Used for forwarding messages to Answers service.",
"externalDocs":{
"description":"Find out more about Answers",
"url":"https://www.infobip.com/docs/answers"
},
"properties":{
"enabled":{
"type":"boolean",
"description":"Flag which indicates if this action should be enabled. If set to false, the effect will be the same as adding the answers to unset which will remove the object.",
"example":true
}
},
"required":[
"enabled"
],
"title":"UseAnswers"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.UseConversations":{
"type":"object",
"description":"Used for forwarding messages to Conversations service.",
"externalDocs":{
"description":"Find out more about Conversations",
"url":"https://www.infobip.com/docs/conversations"
},
"properties":{
"enabled":{
"type":"boolean",
"description":"Flag which indicates if this action should be enabled. If set to false, the effect will be the same as adding the conversations to unset which will remove the object.",
"example":true
}
},
"required":[
"enabled"
],
"title":"UseConversations"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ViberBmHttpForwardDocs":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ViberBmMoActionDocs"
},
{
"type":"object",
"properties":{
"url":{
"type":"string",
"description":"Specifies URL where message will be pushed.",
"minLength":1
},
"format":{
"type":"string",
"default":"MO_OTT_MSISDN",
"description":"Specifies pushed content format."
}
}
}
],
"required":[
"type",
"url"
],
"title":"ViberBmHttpForwardDocs"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ViberBmMoActionDocs":{
"type":"object",
"description":"Forwarding MO action.",
"discriminator":{
"propertyName":"type",
"mapping":{
"HTTP_FORWARD":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ViberBmHttpForwardDocs"
}
},
"example":{
"type":"HTTP_FORWARD",
"url":"https://example.com",
"format":"MO_OTT_MSISDN"
},
"properties":{
"type":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoActionType"
}
},
"title":"ViberBmMoActionDocs"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ViberBmMoConfigurationRequest":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoConfigurationRequest"
},
{
"type":"object",
"properties":{
"resourceKey":{
"type":"string",
"description":"Required if resource not present.",
"example":"58BC6DB7966CB9F69A91EB956DF73239"
},
"platform":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.PlatformDocs"
},
"resource":{
"type":"string",
"description":"Required if resourceKey not present.",
"example":"41793026727"
},
"forwarding":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ViberBmMoActionDocs"
},
"conversations":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.UseConversations"
},
"autoResponse":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.AutoResponseActionV2Request"
}
}
}
],
"required":[
"channel"
],
"title":"ViberBmMoConfigurationRequest"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ViberBotHttpForwardDocs":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ViberBotMoActionDocs"
},
{
"type":"object",
"properties":{
"url":{
"type":"string",
"description":"Specifies URL where message will be pushed.",
"minLength":1
},
"format":{
"type":"string",
"default":"MO_OTT_MSISDN",
"description":"Specifies pushed content format."
}
}
}
],
"required":[
"type",
"url"
],
"title":"ViberBotHttpForwardDocs"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ViberBotMoActionDocs":{
"type":"object",
"description":"Forwarding MO action.",
"discriminator":{
"propertyName":"type",
"mapping":{
"HTTP_FORWARD":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ViberBotHttpForwardDocs"
}
},
"example":{
"type":"HTTP_FORWARD",
"url":"https://example.com",
"format":"MO_OTT_MSISDN"
},
"properties":{
"type":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoActionType"
}
},
"title":"ViberBotMoActionDocs"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ViberBotMoConfigurationRequest":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoConfigurationRequest"
},
{
"type":"object",
"properties":{
"resourceKey":{
"type":"string",
"description":"Required if resource not present.",
"example":"58BC6DB7966CB9F69A91EB956DF73239"
},
"platform":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.PlatformDocs"
},
"resource":{
"type":"string",
"description":"Required if resourceKey not present.",
"example":"41793026727"
},
"forwarding":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ViberBotMoActionDocs"
},
"conversations":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.UseConversations"
}
}
}
],
"required":[
"channel"
],
"title":"ViberBotMoConfigurationRequest"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ViberCoverageInfo":{
"type":"object",
"description":"Information about the sender coverage.",
"properties":{
"resource":{
"type":"string",
"description":"Resource name.",
"example":"MyResource"
},
"shared":{
"type":"boolean",
"description":"Indicates whether a resource is shared."
},
"originalResourceName":{
"type":"string",
"description":"Original resource name.",
"example":"MyOriginalResource"
},
"countryCode":{
"type":"string",
"description":"Country code in two-letter ISO standard. Required for identifying country specific resources (for instance, short code number types).",
"example":"GB",
"pattern":"^[A-Z]{2}$"
},
"countryName":{
"type":"string",
"description":"Country name.",
"example":"United Kingdom"
},
"capabilities":{
"type":"array",
"items":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceCapability"
},
"uniqueItems":true
},
"resourceType":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceType"
}
},
"title":"Viber"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ViberCoverageKey":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceCoverageKey"
},
{
"type":"object",
"properties":{
"resource":{
"type":"string",
"description":"Resource name.",
"example":"MyResource",
"maxLength":255,
"minLength":0
},
"shared":{
"type":"boolean",
"description":"Indicates whether a resource is shared."
},
"originalResourceName":{
"type":"string",
"description":"Original resource name.",
"example":"MyOriginalResource"
},
"countryCode":{
"type":"string",
"description":"Country code in two-letter ISO standard. Required for identifying country specific resources (for instance, short code number types).",
"example":"GB",
"minLength":1,
"pattern":"^[A-Z]{2}$"
}
}
}
],
"required":[
"countryCode",
"resource",
"resourceType"
],
"title":"ViberCoverageKey"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ViberResourceFilter":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourcesFilter"
},
{
"type":"object",
"properties":{
"resource":{
"type":"string",
"description":"Resource name.",
"example":"MyResource",
"maxLength":255,
"minLength":1
},
"resourceType":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceType"
}
}
}
],
"description":"Viber filter for resources.",
"title":"ViberResourceFilter"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ViberResourceInfo":{
"type":"object",
"description":"Information about Viber type of resource.",
"properties":{
"resource":{
"type":"string",
"description":"Resource name.",
"example":"MyResource"
},
"shared":{
"type":"boolean",
"description":"Indicates whether a resource is shared."
},
"originalResourceName":{
"type":"string",
"description":"Original resource name.",
"example":"MyOriginalResource"
},
"countryCode":{
"type":"string",
"description":"Country code in two-letter ISO standard. Required for identifying country specific resources (for instance, short code number types).",
"example":"GB",
"pattern":"^[A-Z]{2}$"
},
"countryName":{
"type":"string",
"description":"Country name.",
"example":"United Kingdom"
},
"capabilities":{
"type":"array",
"description":"Capabilities of the sender.",
"items":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ResourceCapabilityChannel"
},
"uniqueItems":true
},
"resourceType":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceType"
}
},
"title":"Viber"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.WhatsAppHttpForwardDocs":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.WhatsAppMoActionDocs"
},
{
"type":"object",
"properties":{
"url":{
"type":"string",
"description":"Specifies URL where message will be pushed.",
"minLength":1
},
"format":{
"type":"string",
"default":"MO_OTT_CONTACT",
"description":"Specifies pushed content format."
}
}
}
],
"required":[
"type",
"url"
],
"title":"WhatsAppHttpForwardDocs"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.WhatsAppMoActionDocs":{
"type":"object",
"description":"Forwarding MO action.",
"discriminator":{
"propertyName":"type",
"mapping":{
"HTTP_FORWARD":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.WhatsAppHttpForwardDocs"
}
},
"example":{
"type":"HTTP_FORWARD",
"url":"https://example.com",
"format":"MO_OTT_MSISDN"
},
"properties":{
"type":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoActionType"
}
},
"title":"WhatsAppMoActionDocs"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.WhatsAppMoConfigurationRequest":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoConfigurationRequest"
},
{
"type":"object",
"properties":{
"numberKey":{
"type":"string",
"description":"Required if number not present.",
"example":"58BC6DB7966CB9F69A91EB956DF73239"
},
"platform":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.PlatformDocs"
},
"number":{
"type":"string",
"description":"Required if numberKey not present.",
"example":"41793026727"
},
"forwarding":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.WhatsAppMoActionDocs"
},
"conversations":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.UseConversations"
},
"autoResponse":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.AutoResponseActionV2Request"
},
"blockListConfiguration":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.BlockListConfigurationRequest"
}
}
}
],
"required":[
"channel"
],
"title":"WhatsAppMoConfigurationRequest"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ZaloFollowerMoActionDocs":{
"type":"object",
"description":"Forwarding MO action.",
"discriminator":{
"propertyName":"type",
"mapping":{
"HTTP_FORWARD":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ZaloFollowerMoHttpForwardDocs"
}
},
"example":{
"type":"HTTP_FORWARD",
"url":"https://example.com",
"format":"MO_OTT_MSISDN"
},
"properties":{
"type":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoActionType"
}
},
"title":"ZaloFollowerMoActionDocs"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ZaloFollowerMoConfigurationRequest":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoConfigurationRequest"
},
{
"type":"object",
"properties":{
"resourceKey":{
"type":"string",
"description":"Required if resource not present.",
"example":"58BC6DB7966CB9F69A91EB956DF73239"
},
"resource":{
"type":"string",
"description":"Required if resourceKey not present.",
"example":"41793026727"
},
"forwarding":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ZaloFollowerMoActionDocs"
},
"platform":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.PlatformDocs"
}
}
}
],
"required":[
"channel"
],
"title":"ZaloFollowerMoConfigurationRequest"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ZaloFollowerMoHttpForwardDocs":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ZaloFollowerMoActionDocs"
},
{
"type":"object",
"properties":{
"url":{
"type":"string",
"description":"Specifies URL where message will be pushed.",
"minLength":1
},
"format":{
"type":"string",
"default":"MO_OTT_MSISDN",
"description":"Specifies pushed content format."
}
}
}
],
"required":[
"type",
"url"
],
"title":"ZaloFollowerMoHttpForwardDocs"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ZaloZnsMoActionDocs":{
"type":"object",
"description":"Forwarding MO action.",
"discriminator":{
"propertyName":"type",
"mapping":{
"HTTP_FORWARD":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ZaloZnsMoHttpForwardDocs"
}
},
"example":{
"type":"HTTP_FORWARD",
"url":"https://example.com",
"format":"MO_OTT_MSISDN"
},
"properties":{
"type":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoActionType"
}
},
"title":"ZaloZnsMoActionDocs"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ZaloZnsMoConfigurationRequest":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoConfigurationRequest"
},
{
"type":"object",
"properties":{
"resourceKey":{
"type":"string",
"description":"Required if resource not present.",
"example":"58BC6DB7966CB9F69A91EB956DF73239"
},
"resource":{
"type":"string",
"description":"Required if resourceKey not present.",
"example":"41793026727"
},
"forwarding":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ZaloZnsMoActionDocs"
},
"conversations":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.UseConversations"
},
"platform":{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.PlatformDocs"
}
}
}
],
"required":[
"channel"
],
"title":"ZaloZnsMoConfigurationRequest"
},
"7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ZaloZnsMoHttpForwardDocs":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ZaloZnsMoActionDocs"
},
{
"type":"object",
"properties":{
"url":{
"type":"string",
"description":"Specifies URL where message will be pushed.",
"minLength":1
},
"format":{
"type":"string",
"default":"MO_OTT_MSISDN",
"description":"Specifies pushed content format."
}
}
}
],
"required":[
"type",
"url"
],
"title":"ZaloZnsMoHttpForwardDocs"
},
"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"
},
"c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.AlphaRequirementSpecsRequestApiDoc":{
"type":"object",
"properties":{
"type":{
"type":"string",
"description":"Type of resource.",
"enum":[
"ALPHANUMERIC_REGISTRATION"
]
},
"countryCode":{
"type":"string",
"description":"Country code in two-letter ISO standard."
},
"trafficOrigin":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.TrafficOrigin"
},
"trafficType":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.TrafficType"
}
},
"required":[
"countryCode",
"type"
],
"title":"ALPHANUMERIC_REGISTRATION"
},
"c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.AlphaResourceOrderApiDoc":{
"type":"object",
"properties":{
"id":{
"type":"string",
"format":"uuid",
"description":"The ID of the resource."
},
"type":{
"type":"string",
"description":"Type of resource.",
"enum":[
"ALPHANUMERIC_REGISTRATION"
]
},
"countryCode":{
"type":"string",
"description":"Country code in two-letter ISO standard."
},
"senderName":{
"type":"string",
"description":"Sender name."
},
"requestedByEmailAddress":{
"type":"string",
"description":"Email address of the requester."
},
"additionalContactEmailAddresses":{
"type":"array",
"description":"Additional email addresses.",
"items":{
"type":"string",
"description":"Additional email addresses."
}
},
"requestedDate":{
"type":"string",
"format":"date-time",
"description":"Date and time the resource was requested."
},
"status":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.ResourceOrderStatus"
},
"trafficOrigin":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.TrafficOrigin"
},
"trafficType":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.TrafficType"
},
"note":{
"type":"string",
"description":"A note containing extra data about the request."
},
"requirementsFeedback":{
"type":"array",
"description":"List of feedback for requirements.",
"items":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.FilledRequirementFeedback"
}
},
"requirements":{
"type":"array",
"description":"List of requirements for the resource.",
"items":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.FilledRequirement"
}
},
"platform":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.Platform"
}
},
"title":"ALPHANUMERIC_REGISTRATION"
},
"c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.AlphaResourceOrderRequestApiDoc":{
"type":"object",
"properties":{
"type":{
"type":"string",
"description":"Type of resource.",
"enum":[
"ALPHANUMERIC_REGISTRATION"
]
},
"senderName":{
"type":"string",
"description":"Sender name. GSM7 format required, with at least one letter.",
"maxLength":11,
"minLength":3
},
"additionalContactEmails":{
"type":"array",
"description":"Email addresses that would be contacted by Infobip support team for any request related matter.",
"items":{
"type":"string",
"description":"Email addresses that would be contacted by Infobip support team for any request related matter."
},
"maxItems":3,
"minItems":0
},
"countryCode":{
"type":"string",
"description":"Country code in two-letter ISO standard."
},
"trafficOrigin":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.TrafficOrigin"
},
"trafficType":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.TrafficType"
},
"requirements":{
"type":"array",
"description":"List of requirements for the resource.",
"items":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.FilledRequirement"
}
},
"platform":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.Platform"
}
},
"required":[
"countryCode",
"requirements",
"senderName",
"type"
],
"title":"ALPHANUMERIC_REGISTRATION"
},
"c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.AlphaWebhookStatusNotifApiDoc":{
"type":"object",
"properties":{
"id":{
"type":"string",
"description":"ID of the resource request."
},
"status":{
"type":"string",
"description":"Status of the resource request.",
"enum":[
"UPDATE_REQUESTED",
"UPDATE_REQUESTED_BY_INTERNAL_REVIEWER",
"REJECTED",
"COMPLETED"
]
},
"type":{
"type":"string",
"description":"Type of resource.",
"enum":[
"ALPHANUMERIC_REGISTRATION"
]
},
"requirementsFeedback":{
"type":"array",
"description":"Feedback for requirements. Present only for UPDATE_REQUESTED and UPDATE_REQUESTED_BY_INTERNAL_REVIEWER statuses.",
"items":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.FilledRequirementFeedbackApiDoc"
}
},
"note":{
"type":"string",
"description":"A note containing extra data about the request."
}
},
"required":[
"id",
"status"
],
"title":"ALPHANUMERIC_REGISTRATION"
},
"c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.Attachment":{
"type":"object",
"description":"Attachment.",
"properties":{
"documentId":{
"type":"string",
"description":"The ID of the document."
},
"documentType":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.DocumentType"
}
},
"title":"Attachment"
},
"c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.Category":{
"type":"string",
"description":"Category of the requirement.",
"enum":[
"BUSINESS_DETAILS",
"CONTACT_INFORMATION",
"CUSTOMER_SUPPORT_INFORMATION",
"MARKET_SPECIFIC_DETAILS",
"USE_CASE_DETAILS",
"CONFIRMATION",
"OTHER"
],
"title":"Category"
},
"c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.DocumentIdentifier":{
"type":"object",
"properties":{
"documentId":{
"type":"string",
"description":"The ID of the document."
}
},
"title":"DocumentIdentifier"
},
"c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.DocumentRequirementSpec":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.RequirementSpec"
},
{
"type":"object",
"properties":{
"key":{
"type":"string",
"description":"Key of the requirement."
},
"name":{
"type":"string",
"description":"Name of the requirement."
},
"description":{
"type":"string",
"description":"Description of the requirement."
},
"required":{
"type":"boolean",
"description":"Flag that indicates if the requirement is required."
},
"multipleValuesSupported":{
"type":"boolean",
"description":"Flag that indicates if multiple values can be provided."
},
"category":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.Category"
},
"attachment":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.Attachment"
}
}
}
],
"title":"DocumentRequirementSpec"
},
"c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.DocumentType":{
"type":"string",
"description":"Type of document.",
"enum":[
"TEMPLATE",
"SAMPLE",
"PREFILLED_DOCUMENT"
],
"title":"DocumentType"
},
"c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.EmailRequirementSpec":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.RequirementSpec"
},
{
"type":"object",
"properties":{
"key":{
"type":"string",
"description":"Key of the requirement."
},
"name":{
"type":"string",
"description":"Name of the requirement."
},
"description":{
"type":"string",
"description":"Description of the requirement."
},
"required":{
"type":"boolean",
"description":"Flag that indicates if the requirement is required."
},
"multipleValuesSupported":{
"type":"boolean",
"description":"Flag that indicates if multiple values can be provided."
},
"category":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.Category"
}
}
}
],
"title":"EmailRequirementSpec"
},
"c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.FeedbackCode":{
"type":"string",
"description":"Code of the feedback.",
"enum":[
"RES_REQ_FEED_REQUIRED",
"RES_REQ_FEED_FORMAT",
"RES_REQ_FEED_LENGTH_OOR",
"RES_REQ_FEED_VALUE_OOR",
"RES_REQ_FEED_OTHER",
"RES_REQ_FEED_USER_ACTION_REQUIRED"
],
"title":"FeedbackCode"
},
"c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.FieldType":{
"type":"string",
"description":"Type of the requirement.",
"enum":[
"TEXT",
"INTEGER",
"EMAIL",
"URL",
"GSM",
"DOCUMENT"
],
"title":"FieldType"
},
"c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.FilledRequirement":{
"type":"object",
"description":"List of requirements for the resource.",
"properties":{
"key":{
"type":"string",
"description":"The key of the requirement."
},
"value":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.JsonNode"
}
},
"required":[
"key",
"value"
],
"title":"FilledRequirement"
},
"c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.FilledRequirementFeedback":{
"type":"object",
"description":"List of feedback for requirements.",
"properties":{
"key":{
"type":"string",
"description":"Key of the requirement for which feedback is provided."
},
"code":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.FeedbackCode"
},
"feedback":{
"type":"string",
"description":"Feedback for the requirement."
}
},
"title":"FilledRequirementFeedback"
},
"c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.FilledRequirementFeedbackApiDoc":{
"type":"object",
"description":"Feedback for requirements. Present only for UPDATE_REQUESTED and UPDATE_REQUESTED_BY_INTERNAL_REVIEWER statuses.",
"properties":{
"key":{
"type":"string",
"description":"Key of the requirement for which feedback is provided."
},
"code":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.FeedbackCode"
},
"feedback":{
"type":"string",
"description":"Feedback for the requirement."
}
},
"title":"FilledRequirementFeedbackApiDoc"
},
"c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.GsmRequirementSpec":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.RequirementSpec"
},
{
"type":"object",
"properties":{
"key":{
"type":"string",
"description":"Key of the requirement."
},
"name":{
"type":"string",
"description":"Name of the requirement."
},
"description":{
"type":"string",
"description":"Description of the requirement."
},
"required":{
"type":"boolean",
"description":"Flag that indicates if the requirement is required."
},
"multipleValuesSupported":{
"type":"boolean",
"description":"Flag that indicates if multiple values can be provided."
},
"category":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.Category"
}
}
}
],
"title":"GsmRequirementSpec"
},
"c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.IntegerRequirementSpec":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.RequirementSpec"
},
{
"type":"object",
"properties":{
"key":{
"type":"string",
"description":"Key of the requirement."
},
"name":{
"type":"string",
"description":"Name of the requirement."
},
"description":{
"type":"string",
"description":"Description of the requirement."
},
"required":{
"type":"boolean",
"description":"Flag that indicates if the requirement is required."
},
"multipleValuesSupported":{
"type":"boolean",
"description":"Flag that indicates if multiple values can be provided."
},
"category":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.Category"
},
"options":{
"type":"array",
"description":"List of options for the requirement.",
"items":{
"type":"string",
"description":"List of options for the requirement."
}
},
"validation":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.IntegerRequirementValidation"
}
}
}
],
"title":"IntegerRequirementSpec"
},
"c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.IntegerRequirementValidation":{
"type":"object",
"description":"Validation rules.",
"properties":{
"minValue":{
"type":"integer",
"format":"int32",
"description":"The minimum value of the integer."
},
"maxValue":{
"type":"integer",
"format":"int32",
"description":"The maximum value of the integer."
}
},
"title":"IntegerRequirementValidation"
},
"c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.JsonNode":{
"type":"object",
"description":"The value of the requirement. Can be a string, integer, or a list of strings and integers.",
"title":"JsonNode"
},
"c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.NumberOfferClientType":{
"type":"string",
"description":"Type of client. LOCAL resolves numbers preferring local options, falling back to international if none are available. INTERNATIONAL and null resolve international numbers only.",
"enum":[
"LOCAL",
"INTERNATIONAL"
],
"title":"NumberOfferClientType"
},
"c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.NumberRequirementSpecsRequestApiDoc":{
"type":"object",
"properties":{
"type":{
"type":"string",
"description":"Type of resource.",
"enum":[
"NUMBER_PURCHASE"
]
},
"quantity":{
"type":"integer",
"format":"int32",
"description":"Amount of numbers. Default value is 1.",
"maximum":49,
"minimum":1
},
"numberType":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.ResourceNumberType"
},
"capabilities":{
"type":"array",
"description":"Capabilities of the numbers.",
"items":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.ResourceNumberCapability"
}
},
"clientType":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.NumberOfferClientType"
},
"countryCode":{
"type":"string",
"description":"Country code in two-letter ISO standard."
}
},
"required":[
"capabilities",
"countryCode",
"numberType",
"type"
],
"title":"NUMBER_PURCHASE"
},
"c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.NumberResourceOrderApiDoc":{
"type":"object",
"properties":{
"id":{
"type":"string",
"format":"uuid",
"description":"The ID of the resource."
},
"type":{
"type":"string",
"description":"Type of resource.",
"enum":[
"NUMBER_PURCHASE"
]
},
"countryCode":{
"type":"string",
"description":"Country code in two-letter ISO standard."
},
"requestedByEmailAddress":{
"type":"string",
"description":"Email address of the requester."
},
"additionalContactEmailAddresses":{
"type":"array",
"description":"Additional email addresses.",
"items":{
"type":"string",
"description":"Additional email addresses."
}
},
"requestedDate":{
"type":"string",
"format":"date-time",
"description":"Date and time the resource was requested."
},
"status":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.ResourceOrderStatus"
},
"numberType":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.ResourceNumberType"
},
"capabilities":{
"type":"array",
"description":"Capabilities of the numbers.",
"items":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.ResourceNumberCapability"
}
},
"quantity":{
"type":"integer",
"format":"int32",
"description":"Amount of numbers."
},
"note":{
"type":"string",
"description":"A note containing extra data about the request."
},
"numbers":{
"type":"array",
"description":"List of numbers linked with the resource.",
"items":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.ProcuredNumber"
}
},
"requirementsFeedback":{
"type":"array",
"description":"List of feedback for requirements.",
"items":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.FilledRequirementFeedback"
}
},
"requirements":{
"type":"array",
"description":"List of requirements for the resource.",
"items":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.FilledRequirement"
}
},
"platform":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.Platform"
}
},
"title":"NUMBER_PURCHASE"
},
"c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.NumberResourceOrderRequestApiDoc":{
"type":"object",
"properties":{
"type":{
"type":"string",
"description":"Type of resource.",
"enum":[
"NUMBER_PURCHASE"
]
},
"quantity":{
"type":"integer",
"format":"int32",
"description":"Amount of numbers.",
"maximum":49,
"minimum":1
},
"numberType":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.ResourceNumberType"
},
"capabilities":{
"type":"array",
"description":"Capabilities of the numbers.",
"items":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.ResourceNumberCapability"
}
},
"clientType":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.NumberOfferClientType"
},
"additionalContactEmails":{
"type":"array",
"description":"Email addresses that would be contacted by Infobip support team for any request related matter.",
"items":{
"type":"string",
"description":"Email addresses that would be contacted by Infobip support team for any request related matter."
},
"maxItems":3,
"minItems":0
},
"countryCode":{
"type":"string",
"description":"Country code in two-letter ISO standard."
},
"requirements":{
"type":"array",
"description":"List of requirements for the resource.",
"items":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.FilledRequirement"
}
},
"platform":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.Platform"
}
},
"required":[
"capabilities",
"countryCode",
"numberType",
"type"
],
"title":"NUMBER_PURCHASE"
},
"c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.NumberStatus":{
"type":"string",
"description":"Status of the number.",
"enum":[
"SUCCESS"
],
"title":"NumberStatus"
},
"c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.NumberWebhookStatusNotifApiDoc":{
"type":"object",
"properties":{
"id":{
"type":"string",
"description":"ID of the resource request."
},
"status":{
"type":"string",
"description":"Status of the resource request.",
"enum":[
"UPDATE_REQUESTED",
"UPDATE_REQUESTED_BY_INTERNAL_REVIEWER",
"REJECTED",
"COMPLETED"
]
},
"type":{
"type":"string",
"description":"Type of resource.",
"enum":[
"NUMBER_PURCHASE"
]
},
"numbers":{
"type":"array",
"description":"List of numbers linked with the resource.",
"items":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.ProcuredNumber"
}
},
"requirementsFeedback":{
"type":"array",
"description":"Feedback for requirements. Present only for UPDATE_REQUESTED and UPDATE_REQUESTED_BY_INTERNAL_REVIEWER statuses.",
"items":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.FilledRequirementFeedbackApiDoc"
}
},
"note":{
"type":"string",
"description":"A note containing extra data about the request."
}
},
"required":[
"id",
"status"
],
"title":"NUMBER_PURCHASE"
},
"c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.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"
},
"c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.PageResourceOrderApiDoc":{
"type":"object",
"properties":{
"results":{
"type":"array",
"description":"The list of the results for this page.",
"items":{
"type":"object",
"description":"The list of the results for this page.",
"oneOf":[
{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.AlphaResourceOrderApiDoc"
},
{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.NumberResourceOrderApiDoc"
},
{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.RcsSenderResourceOrderApiDoc"
}
]
}
},
"paging":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.PageInfo"
}
},
"title":"PageResourceOrderApiDoc"
},
"c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.Platform":{
"type":"object",
"description":"CPaaS X properties.",
"properties":{
"applicationId":{
"type":"string",
"description":"ID of the Application that would be associated with the resource request.",
"example":"application-id",
"externalDocs":{
"description":"Find out more about Application and Entity 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 resource request.",
"example":"entity-id",
"externalDocs":{
"description":"Find out more about Application and Entity Management",
"url":"https://www.infobip.com/docs/api/platform/application-entity"
},
"maxLength":255,
"minLength":0
}
},
"title":"Platform"
},
"c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.ProcuredNumber":{
"type":"object",
"description":"List of numbers linked with the resource.",
"properties":{
"number":{
"type":"string",
"description":"Number."
},
"numberKey":{
"type":"string",
"description":"Unique ID of a number."
},
"status":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.NumberStatus"
}
},
"required":[
"number",
"status"
],
"title":"ProcuredNumber"
},
"c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.RcsRequirementSpecsRequestApiDoc":{
"type":"object",
"properties":{
"type":{
"type":"string",
"description":"Type of resource.",
"enum":[
"RCS_SENDER_LAUNCH"
]
},
"countryCode":{
"type":"string",
"description":"Country code in two-letter ISO standard."
},
"excludedCarriers":{
"type":"array",
"description":"List of carrier names excluded from the sender launch.",
"items":{
"type":"string",
"description":"List of carrier names excluded from the sender launch."
}
},
"trafficOrigin":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.TrafficOrigin"
}
},
"required":[
"countryCode",
"trafficOrigin",
"type"
],
"title":"RCS_SENDER_LAUNCH"
},
"c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.RcsSenderResourceOrderApiDoc":{
"type":"object",
"properties":{
"id":{
"type":"string",
"format":"uuid",
"description":"The ID of the resource."
},
"type":{
"type":"string",
"description":"Type of resource.",
"enum":[
"RCS_SENDER_LAUNCH"
]
},
"status":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.ResourceOrderStatus"
},
"countryCode":{
"type":"string",
"description":"Country code in two-letter ISO standard."
},
"excludedCarriers":{
"type":"array",
"description":"List of carrier names excluded from the sender launch.",
"items":{
"type":"string",
"description":"List of carrier names excluded from the sender launch."
}
},
"senderName":{
"type":"string",
"description":"Sender name."
},
"requestedByEmailAddress":{
"type":"string",
"description":"Email address of the requester."
},
"additionalContactEmails":{
"type":"array",
"description":"Additional email addresses.",
"items":{
"type":"string",
"description":"Additional email addresses."
}
},
"requestedDate":{
"type":"string",
"format":"date-time",
"description":"Date and time the resource was requested."
},
"trafficOrigin":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.TrafficOrigin"
},
"note":{
"type":"string",
"description":"A note containing extra data about the request."
},
"requirements":{
"type":"array",
"description":"List of requirements for the resource.",
"items":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.FilledRequirement"
}
},
"requirementsFeedback":{
"type":"array",
"description":"List of feedback for requirements.",
"items":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.FilledRequirementFeedback"
}
},
"platform":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.Platform"
}
},
"title":"RCS_SENDER_LAUNCH"
},
"c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.RcsSenderResourceOrderRequestApiDoc":{
"type":"object",
"properties":{
"type":{
"type":"string",
"description":"Type of resource.",
"enum":[
"RCS_SENDER_LAUNCH"
]
},
"senderName":{
"type":"string",
"description":"Sender name.",
"maxLength":255,
"minLength":1
},
"additionalContactEmails":{
"type":"array",
"description":"Email addresses that would be contacted by Infobip support team for any request related matter.",
"items":{
"type":"string",
"description":"Email addresses that would be contacted by Infobip support team for any request related matter."
},
"maxItems":3,
"minItems":0
},
"countryCode":{
"type":"string",
"description":"Country code in two-letter ISO standard."
},
"excludedCarriers":{
"type":"array",
"description":"List of carrier names excluded from the sender launch.",
"items":{
"type":"string",
"description":"List of carrier names excluded from the sender launch."
}
},
"trafficOrigin":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.TrafficOrigin"
},
"requirements":{
"type":"array",
"description":"List of requirements for the resource.",
"items":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.FilledRequirement"
}
},
"platform":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.Platform"
}
},
"required":[
"countryCode",
"requirements",
"senderName",
"trafficOrigin",
"type"
],
"title":"RCS_SENDER_LAUNCH"
},
"c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.RcsWebhookStatusNotifApiDoc":{
"type":"object",
"properties":{
"id":{
"type":"string",
"description":"ID of the resource request."
},
"status":{
"type":"string",
"description":"Status of the resource request.",
"enum":[
"UPDATE_REQUESTED",
"UPDATE_REQUESTED_BY_INTERNAL_REVIEWER",
"REJECTED",
"COMPLETED"
]
},
"type":{
"type":"string",
"description":"Type of resource.",
"enum":[
"RCS_SENDER_LAUNCH"
]
},
"requirementsFeedback":{
"type":"array",
"description":"Feedback for requirements. Present only for UPDATE_REQUESTED and UPDATE_REQUESTED_BY_INTERNAL_REVIEWER statuses.",
"items":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.FilledRequirementFeedbackApiDoc"
}
},
"note":{
"type":"string",
"description":"A note containing extra data about the request."
}
},
"required":[
"id",
"status"
],
"title":"RCS_SENDER_LAUNCH"
},
"c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.RequirementSpec":{
"type":"object",
"description":"List of requirements needed for the resource request.",
"discriminator":{
"propertyName":"type",
"mapping":{
"TEXT":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.TextRequirementSpec",
"INTEGER":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.IntegerRequirementSpec",
"EMAIL":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.EmailRequirementSpec",
"URL":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.UrlRequirementSpec",
"GSM":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.GsmRequirementSpec",
"DOCUMENT":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.DocumentRequirementSpec"
}
},
"properties":{
"type":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.FieldType"
}
},
"title":"RequirementSpec"
},
"c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.RequirementSpecs":{
"type":"object",
"properties":{
"requirements":{
"type":"array",
"description":"List of requirements needed for the resource request.",
"items":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.RequirementSpec"
}
}
},
"title":"RequirementSpecs"
},
"c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.RequirementSpecsRequestApiDoc":{
"type":"object",
"discriminator":{
"propertyName":"type"
},
"oneOf":[
{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.AlphaRequirementSpecsRequestApiDoc"
},
{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.NumberRequirementSpecsRequestApiDoc"
},
{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.RcsRequirementSpecsRequestApiDoc"
}
],
"title":"RequirementSpecsRequestApiDoc"
},
"c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.ResourceNumberCapability":{
"type":"string",
"description":"Capabilities of the numbers.",
"enum":[
"SMS",
"VOICE",
"MMS"
],
"title":"ResourceNumberCapability"
},
"c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.ResourceNumberType":{
"type":"string",
"description":"Type of numbers.",
"enum":[
"SHORT_CODE",
"VIRTUAL_LONG_NUMBER",
"TEN_DIGIT_LONG_CODE",
"TOLL_FREE_NUMBER"
],
"title":"ResourceNumberType"
},
"c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.ResourceOrderApiDoc":{
"type":"object",
"discriminator":{
"propertyName":"type"
},
"oneOf":[
{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.AlphaResourceOrderApiDoc"
},
{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.NumberResourceOrderApiDoc"
},
{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.RcsSenderResourceOrderApiDoc"
}
],
"title":"ResourceOrderApiDoc"
},
"c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.ResourceOrderIdentifier":{
"type":"object",
"properties":{
"id":{
"type":"string",
"format":"uuid",
"description":"The ID of the resource request."
}
},
"title":"ResourceOrderIdentifier"
},
"c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.ResourceOrderRequestApiDoc":{
"type":"object",
"discriminator":{
"propertyName":"type"
},
"oneOf":[
{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.AlphaResourceOrderRequestApiDoc"
},
{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.NumberResourceOrderRequestApiDoc"
},
{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.RcsSenderResourceOrderRequestApiDoc"
}
],
"title":"ResourceOrderRequestApiDoc"
},
"c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.ResourceOrderStatus":{
"type":"string",
"description":"Current status of the resource request.",
"enum":[
"PENDING",
"UPDATE_REQUESTED_BY_INTERNAL_REVIEWER",
"CANCELED",
"AUTOMATIC_VALIDATION",
"UPDATE_REQUESTED",
"REJECTED",
"COMPLETED",
"PENDING_REVIEW",
"IN_REVIEW",
"IN_PROGRESS",
"CANCEL_REQUESTED"
],
"title":"ResourceOrderStatus"
},
"c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.TextRequirementSpec":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.RequirementSpec"
},
{
"type":"object",
"properties":{
"key":{
"type":"string",
"description":"Key of the requirement."
},
"name":{
"type":"string",
"description":"Name of the requirement."
},
"description":{
"type":"string",
"description":"Description of the requirement."
},
"required":{
"type":"boolean",
"description":"Flag that indicates if the requirement is required."
},
"multipleValuesSupported":{
"type":"boolean",
"description":"Flag that indicates if multiple values can be provided."
},
"category":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.Category"
},
"options":{
"type":"array",
"description":"List of options for the requirement.",
"items":{
"type":"string",
"description":"List of options for the requirement."
}
},
"validation":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.TextRequirementValidation"
}
}
}
],
"title":"TextRequirementSpec"
},
"c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.TextRequirementValidation":{
"type":"object",
"description":"Validation rules.",
"properties":{
"minLength":{
"type":"integer",
"format":"int32",
"description":"The minimum length of the text."
},
"maxLength":{
"type":"integer",
"format":"int32",
"description":"The maximum length of the text."
},
"pattern":{
"type":"string",
"description":"The pattern of the text."
}
},
"title":"TextRequirementValidation"
},
"c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.TrafficOrigin":{
"type":"string",
"description":"The location from which outbound messages are sent, relative to the country associated with the sender.\n- LOCAL: Indicates that the business sending the messages is headquartered in the same country as the sender being launched.\n- INTERNATIONAL: Indicates that the business is headquartered outside the country associated with the sender being launched.\n",
"enum":[
"LOCAL",
"INTERNATIONAL"
],
"title":"TrafficOrigin"
},
"c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.TrafficType":{
"type":"string",
"description":"Type of SMS messages you will send.\n- TRANSACTIONAL: Messages triggered by user actions or system events, such as one-time passwords (OTP/PIN), transaction alerts, password resets, or service notifications.\n- PROMOTIONAL: Messages sent for marketing or advertising purposes, such as promotions, offers, campaigns, or announcements.\n",
"enum":[
"PROMOTIONAL",
"TRANSACTIONAL"
],
"title":"TrafficType"
},
"c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.UpdateResourceOrderRequest":{
"type":"object",
"properties":{
"requirements":{
"type":"array",
"description":"List of requirements for the resource.",
"items":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.FilledRequirement"
}
}
},
"required":[
"requirements"
],
"title":"UpdateResourceOrderRequest"
},
"c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.UploadDocumentApiDoc":{
"type":"object",
"properties":{
"document":{
"type":"string",
"format":"binary",
"description":"The document file you want to upload. Supported file formats: .doc, .docx, .jpg, .jpeg, .png, .pdf, .xls, .xlsx, .mp4, .avi, .mov, .webm"
}
},
"required":[
"document"
],
"title":"UploadDocumentApiDoc"
},
"c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.UrlRequirementSpec":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.RequirementSpec"
},
{
"type":"object",
"properties":{
"key":{
"type":"string",
"description":"Key of the requirement."
},
"name":{
"type":"string",
"description":"Name of the requirement."
},
"description":{
"type":"string",
"description":"Description of the requirement."
},
"required":{
"type":"boolean",
"description":"Flag that indicates if the requirement is required."
},
"multipleValuesSupported":{
"type":"boolean",
"description":"Flag that indicates if multiple values can be provided."
},
"category":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.Category"
}
}
}
],
"title":"UrlRequirementSpec"
},
"c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.WebhookReminderNotifApiDoc":{
"type":"object",
"description":"Object containing event data.",
"properties":{
"id":{
"type":"string",
"description":"ID of the resource request."
},
"status":{
"type":"string",
"description":"Status of the resource request.",
"enum":[
"UPDATE_REQUESTED",
"UPDATE_REQUESTED_BY_INTERNAL_REVIEWER"
]
},
"type":{
"type":"string",
"description":"Type of resource.",
"enum":[
"ALPHANUMERIC_REGISTRATION",
"NUMBER_PURCHASE",
"RCS_SENDER_LAUNCH"
]
},
"daysUntilRejection":{
"type":"integer",
"format":"int32",
"description":"Number of days remaining before the resource request is automatically rejected due to inactivity."
}
},
"required":[
"daysUntilRejection",
"id",
"status",
"type"
],
"title":"WebhookReminderNotifApiDoc"
},
"c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.WebhookReminderNotifApiDocRequestBody":{
"type":"object",
"properties":{
"results":{
"type":"array",
"description":"List of events provided in a single request.",
"items":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.WebhookReminderNotifApiDocResult"
}
}
},
"title":"WebhookReminderNotifApiDocRequestBody"
},
"c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.WebhookReminderNotifApiDocResult":{
"type":"object",
"description":"List of events provided in a single request.",
"properties":{
"event":{
"type":"string",
"description":"Name of event that is received.",
"enum":[
"RESOURCE_REQUEST_REMINDER"
]
},
"content":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.WebhookReminderNotifApiDoc"
}
},
"required":[
"content",
"event"
],
"title":"WebhookReminderNotifApiDocResult"
},
"c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.WebhookStatusNotifApiDocRequestBody":{
"type":"object",
"properties":{
"results":{
"type":"array",
"description":"List of events provided in a single request.",
"items":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.WebhookStatusNotifApiDocResult"
}
}
},
"title":"WebhookStatusNotifApiDocRequestBody"
},
"c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.WebhookStatusNotifApiDocResult":{
"type":"object",
"description":"List of events provided in a single request.",
"properties":{
"event":{
"type":"string",
"description":"Name of event that is received.",
"enum":[
"RESOURCE_REQUEST_STATUS_UPDATE"
]
},
"receivedAt":{
"type":"string",
"format":"date-time",
"description":"Date and time when the request status was updated."
},
"content":{
"type":"object",
"description":"Object containing event data.",
"oneOf":[
{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.AlphaWebhookStatusNotifApiDoc"
},
{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.NumberWebhookStatusNotifApiDoc"
},
{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.RcsWebhookStatusNotifApiDoc"
}
]
},
"platform":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.Platform"
}
},
"required":[
"content",
"event",
"receivedAt"
],
"title":"WebhookStatusNotifApiDocResult"
}
},
"responses":{
"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":"\n E401\n The request lacks valid authentication credentials for the requested resource.\n Check the resources and adjust authentication credentials.\n \n \n \n API Authentication\n https://www.infobip.com/docs/essentials/api-authentication\n \n \n\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":"\n E403\n Insufficient permissions to access the requested resource.\n Repeat the request with new or different credentials.\n \n \n \n API Scopes\n https://www.infobip.com/docs/essentials/api-essentials/api-authorization#api-scopes\n \n \n\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":"\n E429\n Too many requests sent.\n Check request rate limit specified in the API endpoint documentation resource.\n \n \n \n Throttling handling errors\n https://www.infobip.com/docs/essentials/integration-best-practices#throttling-handling-errors\n \n \n\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":"\n E500\n Something went wrong.\n Contact the support.\n \n \n\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":"\n \n \n BAD_REQUEST\n Bad request\n \n \n\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":"\n \n \n UNAUTHORIZED\n Unauthorized\n \n \n\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":"\n \n \n FORBIDDEN\n Forbidden\n \n \n\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":"\n \n \n TOO_MANY_REQUESTS\n Too many requests\n \n \n\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":"\n \n \n GENERAL_ERROR\n Something went wrong. Please contact support.\n \n \n\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 \n```",
"flows":{
"clientCredentials":{
"tokenUrl":"https://api.infobip.com/auth/1/oauth2/token",
"scopes":{}
}
}
}
},
"links":{},
"callbacks":{}
},
"webhooks":{
"resource-request-status-change-notification":{
"post":{
"tags":[
"platform",
"resources",
"resource-request"
],
"summary":"Receive resource request status update",
"description":"Any time resource request status is changed, an event is sent.\nYou need to subscribe to this event over 'REGISTRATION' channel, and specify the 'RESOURCE_REQUEST_STATUS_UPDATE' event.",
"externalDocs":{
"description":"Learn more about subscription.",
"url":"https://www.infobip.com/docs/api/platform/subscriptions-api/create-subscription"
},
"operationId":"resource-request-status-change-notification",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.WebhookStatusNotifApiDocRequestBody"
},
"examples":{
"Alphanumeric Registration - UPDATE_REQUESTED":{
"summary":"Alphanumeric Registration - UPDATE_REQUESTED",
"value":{
"results":[
{
"event":"RESOURCE_REQUEST_STATUS_UPDATE",
"receivedAt":"2025-03-11T09:22:47.000+0000",
"content":{
"id":"a0c63335-f841-4d43-9ef8-e0765a233f29",
"status":"UPDATE_REQUESTED",
"type":"ALPHANUMERIC_REGISTRATION",
"requirementsFeedback":[
{
"key":"contactPhoneNumber",
"code":"RES_REQ_FEED_REQUIRED",
"feedback":"This field is required and cannot be empty."
},
{
"key":"companyName",
"code":"RES_REQ_FEED_LENGTH_OOR",
"feedback":"Text length must be between 2 and 100."
}
]
},
"platform":{
"applicationId":"application-id",
"entityId":"entity-id"
}
}
]
},
"x-label":{
"type":[
"Alphanumeric Registration"
],
"status":[
"UPDATE_REQUESTED"
]
}
},
"Alphanumeric Registration - UPDATE_REQUESTED_BY_INTERNAL_REVIEWER":{
"summary":"Alphanumeric Registration - UPDATE_REQUESTED_BY_INTERNAL_REVIEWER",
"value":{
"results":[
{
"event":"RESOURCE_REQUEST_STATUS_UPDATE",
"receivedAt":"2025-03-11T09:22:47.000+0000",
"content":{
"id":"a0c63335-f841-4d43-9ef8-e0765a233f29",
"status":"UPDATE_REQUESTED_BY_INTERNAL_REVIEWER",
"type":"ALPHANUMERIC_REGISTRATION",
"requirementsFeedback":[
{
"key":"contactPhoneNumber",
"code":"RES_REQ_FEED_REQUIRED",
"feedback":"This field is required and cannot be empty."
},
{
"key":"companyName",
"code":"RES_REQ_FEED_LENGTH_OOR",
"feedback":"Text length must be between 2 and 100."
}
]
},
"platform":{
"applicationId":"application-id",
"entityId":"entity-id"
}
}
]
},
"x-label":{
"type":[
"Alphanumeric Registration"
],
"status":[
"UPDATE_REQUESTED_BY_INTERNAL_REVIEWER"
]
}
},
"Alphanumeric Registration - COMPLETED":{
"summary":"Alphanumeric Registration - COMPLETED",
"value":{
"results":[
{
"event":"RESOURCE_REQUEST_STATUS_UPDATE",
"receivedAt":"2025-03-11T09:22:47.000+0000",
"content":{
"id":"a0c63335-f841-4d43-9ef8-e0765a233f29",
"status":"COMPLETED",
"type":"ALPHANUMERIC_REGISTRATION",
"requirementsFeedback":[]
},
"platform":{
"applicationId":"application-id",
"entityId":"entity-id"
}
}
]
},
"x-label":{
"type":[
"Alphanumeric Registration"
],
"status":[
"COMPLETED"
]
}
},
"Alphanumeric Registration - REJECTED":{
"summary":"Alphanumeric Registration - REJECTED",
"value":{
"results":[
{
"event":"RESOURCE_REQUEST_STATUS_UPDATE",
"receivedAt":"2025-03-11T09:22:47.000+0000",
"content":{
"id":"a0c63335-f841-4d43-9ef8-e0765a233f29",
"status":"REJECTED",
"type":"ALPHANUMERIC_REGISTRATION",
"requirementsFeedback":[],
"note":"Your request has been rejected because it contains invalid information for the selected destination."
},
"platform":{
"applicationId":"application-id",
"entityId":"entity-id"
}
}
]
},
"x-label":{
"type":[
"Alphanumeric Registration"
],
"status":[
"REJECTED"
]
}
},
"Number Purchase - UPDATE_REQUESTED":{
"summary":"Number Purchase - UPDATE_REQUESTED",
"value":{
"results":[
{
"event":"RESOURCE_REQUEST_STATUS_UPDATE",
"receivedAt":"2025-03-11T09:22:47.000+0000",
"content":{
"id":"b1d74446-f952-4e54-af09-f1876b344f30",
"status":"UPDATE_REQUESTED",
"type":"NUMBER_PURCHASE",
"numbers":[],
"requirementsFeedback":[
{
"key":"contactPhoneNumber",
"code":"RES_REQ_FEED_REQUIRED",
"feedback":"This field is required and cannot be empty."
},
{
"key":"companyName",
"code":"RES_REQ_FEED_LENGTH_OOR",
"feedback":"Text length must be between 2 and 100."
}
]
},
"platform":{
"applicationId":"application-id",
"entityId":"entity-id"
}
}
]
},
"x-label":{
"type":[
"Number Purchase"
],
"status":[
"UPDATE_REQUESTED"
]
}
},
"Number Purchase - UPDATE_REQUESTED_BY_INTERNAL_REVIEWER":{
"summary":"Number Purchase - UPDATE_REQUESTED_BY_INTERNAL_REVIEWER",
"value":{
"results":[
{
"event":"RESOURCE_REQUEST_STATUS_UPDATE",
"receivedAt":"2025-03-11T09:22:47.000+0000",
"content":{
"id":"b1d74446-f952-4e54-af09-f1876b344f30",
"status":"UPDATE_REQUESTED_BY_INTERNAL_REVIEWER",
"type":"NUMBER_PURCHASE",
"numbers":[],
"requirementsFeedback":[
{
"key":"contactPhoneNumber",
"code":"RES_REQ_FEED_REQUIRED",
"feedback":"This field is required and cannot be empty."
},
{
"key":"companyName",
"code":"RES_REQ_FEED_LENGTH_OOR",
"feedback":"Text length must be between 2 and 100."
}
]
},
"platform":{
"applicationId":"application-id",
"entityId":"entity-id"
}
}
]
},
"x-label":{
"type":[
"Number Purchase"
],
"status":[
"UPDATE_REQUESTED_BY_INTERNAL_REVIEWER"
]
}
},
"Number Purchase - COMPLETED":{
"summary":"Number Purchase - COMPLETED",
"value":{
"results":[
{
"event":"RESOURCE_REQUEST_STATUS_UPDATE",
"receivedAt":"2025-03-11T09:22:47.000+0000",
"content":{
"id":"b1d74446-f952-4e54-af09-f1876b344f30",
"status":"COMPLETED",
"type":"NUMBER_PURCHASE",
"numbers":[
{
"number":"+38591234567",
"numberKey":"A3F8C21D04E7B96F2150C8DA3E47B01F",
"status":"SUCCESS"
},
{
"number":"+38591234568",
"numberKey":"D92E4B810FC6A3571E08B29CD54F7A2E",
"status":"SUCCESS"
}
],
"requirementsFeedback":[],
"note":"Only 2 out of 5 requested numbers could be procured."
},
"platform":{
"applicationId":"application-id",
"entityId":"entity-id"
}
}
]
},
"x-label":{
"type":[
"Number Purchase"
],
"status":[
"COMPLETED"
]
}
},
"Number Purchase - REJECTED":{
"summary":"Number Purchase - REJECTED",
"value":{
"results":[
{
"event":"RESOURCE_REQUEST_STATUS_UPDATE",
"receivedAt":"2025-03-11T09:22:47.000+0000",
"content":{
"id":"b1d74446-f952-4e54-af09-f1876b344f30",
"status":"REJECTED",
"type":"NUMBER_PURCHASE",
"numbers":[],
"requirementsFeedback":[],
"note":"Your request has been rejected because it contains invalid information for the selected destination."
},
"platform":{
"applicationId":"application-id",
"entityId":"entity-id"
}
}
]
},
"x-label":{
"type":[
"Number Purchase"
],
"status":[
"REJECTED"
]
}
},
"RCS Sender Launch - UPDATE_REQUESTED":{
"summary":"RCS Sender Launch - UPDATE_REQUESTED",
"value":{
"results":[
{
"event":"RESOURCE_REQUEST_STATUS_UPDATE",
"receivedAt":"2025-11-19T11:45:10.000+0000",
"content":{
"id":"d3f96668-b174-4d76-8b21-b3098d566b52",
"status":"UPDATE_REQUESTED",
"type":"RCS_SENDER_LAUNCH",
"requirementsFeedback":[
{
"key":"contactPhoneNumber",
"code":"RES_REQ_FEED_REQUIRED",
"feedback":"This field is required and cannot be empty."
},
{
"key":"companyName",
"code":"RES_REQ_FEED_LENGTH_OOR",
"feedback":"Text length must be between 2 and 100."
}
]
},
"platform":{
"applicationId":"application-id",
"entityId":"entity-id"
}
}
]
},
"x-label":{
"type":[
"RCS Sender Launch"
],
"status":[
"UPDATE_REQUESTED"
]
}
},
"RCS Sender Launch - UPDATE_REQUESTED_BY_INTERNAL_REVIEWER":{
"summary":"RCS Sender Launch - UPDATE_REQUESTED_BY_INTERNAL_REVIEWER",
"value":{
"results":[
{
"event":"RESOURCE_REQUEST_STATUS_UPDATE",
"receivedAt":"2025-11-19T11:45:10.000+0000",
"content":{
"id":"d3f96668-b174-4d76-8b21-b3098d566b52",
"status":"UPDATE_REQUESTED_BY_INTERNAL_REVIEWER",
"type":"RCS_SENDER_LAUNCH",
"requirementsFeedback":[
{
"key":"contactPhoneNumber",
"code":"RES_REQ_FEED_REQUIRED",
"feedback":"This field is required and cannot be empty."
},
{
"key":"companyName",
"code":"RES_REQ_FEED_LENGTH_OOR",
"feedback":"Text length must be between 2 and 100."
}
]
},
"platform":{
"applicationId":"application-id",
"entityId":"entity-id"
}
}
]
},
"x-label":{
"type":[
"RCS Sender Launch"
],
"status":[
"UPDATE_REQUESTED_BY_INTERNAL_REVIEWER"
]
}
},
"RCS Sender Launch - COMPLETED":{
"summary":"RCS Sender Launch - COMPLETED",
"value":{
"results":[
{
"event":"RESOURCE_REQUEST_STATUS_UPDATE",
"receivedAt":"2025-11-19T11:45:10.000+0000",
"content":{
"id":"d3f96668-b174-4d76-8b21-b3098d566b52",
"status":"COMPLETED",
"type":"RCS_SENDER_LAUNCH",
"requirementsFeedback":[]
},
"platform":{
"applicationId":"application-id",
"entityId":"entity-id"
}
}
]
},
"x-label":{
"type":[
"RCS Sender Launch"
],
"status":[
"COMPLETED"
]
}
},
"RCS Sender Launch - REJECTED":{
"summary":"RCS Sender Launch - REJECTED",
"value":{
"results":[
{
"event":"RESOURCE_REQUEST_STATUS_UPDATE",
"receivedAt":"2025-11-19T11:45:10.000+0000",
"content":{
"id":"d3f96668-b174-4d76-8b21-b3098d566b52",
"status":"REJECTED",
"type":"RCS_SENDER_LAUNCH",
"requirementsFeedback":[],
"note":"Your request has been rejected because it contains invalid information for the selected destination."
},
"platform":{
"applicationId":"application-id",
"entityId":"entity-id"
}
}
]
},
"x-label":{
"type":[
"RCS Sender Launch"
],
"status":[
"REJECTED"
]
}
}
}
}
}
},
"responses":{
"200":{
"description":"Your server returns this code if it accepts the callback."
}
},
"x-is-early-access":true
}
},
"resource-request-reminder-notification":{
"post":{
"tags":[
"platform",
"resources",
"resource-request"
],
"summary":"Receive resource request reminder",
"description":"When a resource request requires an update and remains inactive, reminder events are sent at 3, 15 and 27 days of inactivity. After 30 days, the request is automatically rejected.\nYou need to subscribe to this event over 'REGISTRATION' channel, and specify the 'RESOURCE_REQUEST_REMINDER' event.",
"externalDocs":{
"description":"Learn more about subscription.",
"url":"https://www.infobip.com/docs/api/platform/subscriptions-api/create-subscription"
},
"operationId":"resource-request-reminder-notification",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.WebhookReminderNotifApiDocRequestBody"
},
"examples":{
"Reminder":{
"summary":"Reminder",
"value":{
"results":[
{
"event":"RESOURCE_REQUEST_REMINDER",
"content":{
"id":"a0c63335-f841-4d43-9ef8-e0765a233f29",
"status":"UPDATE_REQUESTED",
"type":"ALPHANUMERIC_REGISTRATION",
"daysUntilRejection":27
}
}
]
}
}
}
}
}
},
"responses":{
"200":{
"description":"Your server returns this code if it accepts the callback."
}
},
"x-is-early-access":true
}
}
}
}