Infobip Platform API
Modular tools to scale and automate your business.
Infobip Platform API is one of 6 APIs that Infobip publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Platform. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 194 operations across 121 paths, and defines 582 schemas. It is described by OpenAPI 3.2.0, at version 3.210.0.
Requests are made against the base URL https://api.infobip.com.
194 operations
121 paths
582 schemas
25 DELETE76 GET5 PATCH67 POST21 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 4
Infobip Platform API declares
4 security schemes
for authenticating requests.
An API key is passed in the header as Authorization (APIKeyHeader).
It accepts HTTP basic authentication (Basic).
An API key is passed in the header as Authorization (IBSSOTokenHeader).
It supports OAuth 2.0 (OAuth2) using the clientCredentials flow.
APIKeyHeader— This is the most secure authorization type and the one with the most flexibility. API keys can be generated by calling the dedicated API method. Furthermore, A…Basic— 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…IBSSOTokenHeader— 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 Infobi…OAuth2— 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 t…
Paths & Operations 194
Across 121 paths, the API surfaces 194 operations — 25 DELETE, 76 GET, 5 PATCH, 67 POST, 21 PUT. Each is listed below with its method, path, parameters, and response codes.
Platform 194
Modular tools to scale and automate your business.
GET
/2fa/2/applications
Get all 2FA applications
POST
/2fa/2/applications
Create 2FA application
GET
/2fa/2/applications/{appId}
Get 2FA application
PUT
/2fa/2/applications/{appId}
Update 2FA application
GET
/2fa/2/applications/{appId}/messages
Get all 2FA message templates
POST
/2fa/2/applications/{appId}/messages
Create 2FA SMS or Voice message template
GET
/2fa/2/applications/{appId}/messages/{msgId}
Get 2FA message template
PUT
/2fa/2/applications/{appId}/messages/{msgId}
Update 2FA SMS or Voice message template
POST
/2fa/2/applications/{appId}/email/messages
Create 2FA Email message template
PUT
/2fa/2/applications/{appId}/email/messages/{msgId}
Update 2FA Email message template
POST
/2fa/2/pin
Send 2FA PIN code over SMS
POST
/2fa/2/pin/{pinId}/resend
Resend 2FA PIN code over SMS
POST
/2fa/2/pin/voice
Send 2FA PIN code over Voice
POST
/2fa/2/pin/{pinId}/resend/voice
Resend 2FA PIN code over Voice
POST
/2fa/2/pin/email
Send 2FA PIN code over Email
POST
/2fa/2/pin/{pinId}/resend/email
Resend 2FA PIN code over Email
POST
/2fa/2/pin/{pinId}/verify
Verify a PIN
GET
/2fa/2/applications/{appId}/verifications
Get 2FA verification status
GET
/account/1/balance
Get current account balance
GET
/account/1/free-messages
Get remaining free messages
GET
/account/1/total-balance
Get account balance with free messages
GET
/settings/1/accounts
Get all sub accounts with filter
PUT
/settings/1/accounts/{accountKey}
Update account
GET
/settings/1/accounts/{accountKey}/api-keysdeprecated
Get API keys by filter
POST
/settings/1/accounts/{accountKey}/api-keysdeprecated
Create API key
GET
/settings/1/accounts/{accountKey}/api-keys/{key}deprecated
Get API key
PUT
/settings/1/accounts/{accountKey}/api-keys/{key}deprecated
Update API key
GET
/settings/2/api-keys
Get API keys by filter
POST
/settings/2/api-keys
Create API key
GET
/settings/2/api-keys/{apiKeyId}
Get API key
PUT
/settings/2/api-keys/{apiKeyId}
Update API key
POST
/auth/1/session
Create session token
DELETE
/auth/1/session
Destroy session token
POST
/auth/1/oauth2/token
Create OAuth2 token
GET
/audit/1/logs/export
Export Audit Logs
GET
/audit/1/logs
Search Audit Logs
GET
/provisioning/1/applications
Get applications
POST
/provisioning/1/applications
Create application
GET
/provisioning/1/applications/{applicationId}
Get application
PUT
/provisioning/1/applications/{applicationId}
Modify application
DELETE
/provisioning/1/applications/{applicationId}
Delete application
GET
/provisioning/1/entities
Get entities
POST
/provisioning/1/entities
Create entity
GET
/provisioning/1/entities/{entityId}
Get entity
PUT
/provisioning/1/entities/{entityId}
Modify entity
DELETE
/provisioning/1/entities/{entityId}
Delete entity
GET
/provisioning/1/associations
Get resource associations
POST
/provisioning/1/associations
Create resource association
DELETE
/provisioning/1/associations
Delete resource association
GET
/provisioning/1/associations/single
Get resource association
GET
/numbers/1/numbers/available
Get available numbers
GET
/numbers/1/numbers
List owned numbers
POST
/numbers/1/numbers
Purchase number
GET
/numbers/1/numbers/{numberKey}
Get single owned number
PUT
/numbers/1/numbers/{numberKey}
Update owned number
DELETE
/numbers/1/numbers/{numberKey}
Cancel number
GET
/numbers/2/numbers/{numberKey}/smsdeprecated
Get all number configurations
PUT
/numbers/2/numbers/{numberKey}/smsdeprecated
Update number configuration
POST
/numbers/2/numbers/{numberKey}/smsdeprecated
Create number configuration
GET
/numbers/2/numbers/{numberKey}/sms/{configurationKey}deprecated
Get single number configuration
DELETE
/numbers/2/numbers/{numberKey}/sms/{configurationKey}deprecated
Delete number configuration
GET
/numbers/2/numbers/{numberKey}/mmsdeprecated
Get all number MMS configurations
POST
/numbers/2/numbers/{numberKey}/mmsdeprecated
Create number MMS configuration
GET
/numbers/2/numbers/{numberKey}/mms/{configurationKey}deprecated
Get number MMS configuration
PUT
/numbers/2/numbers/{numberKey}/mms/{configurationKey}deprecated
Update number MMS configuration
DELETE
/numbers/2/numbers/{numberKey}/mms/{configurationKey}deprecated
Delete number MMS configuration
GET
/numbers/2/numbers/{numberKey}/voice
Get voice setup on number
PUT
/numbers/2/numbers/{numberKey}/voice
Update voice setup on number
POST
/numbers/2/numbers/{numberKey}/voice
Create voice setup on number
DELETE
/numbers/2/numbers/{numberKey}/voice
Delete voice setup on number
GET
/numbers/2/numbers/{numberKey}/voice/cnam
Get CNAM
PUT
/numbers/2/numbers/{numberKey}/voice/cnam
Update CNAM
POST
/numbers/2/numbers/{numberKey}/voice/cnam
Create CNAM
DELETE
/numbers/2/numbers/{numberKey}/voice/cnam
Delete CNAM
GET
/numbers/2/numbers/{numberKey}/voice/cnam/status
Get CNAM status
POST
/numbers/2/numbers/{numberKey}/voice/emergency-service/validate-address
Validate Emergency Service Address
GET
/numbers/2/numbers/{numberKey}/voice/emergency-service
Get Emergency Service Address
PUT
/numbers/2/numbers/{numberKey}/voice/emergency-service
Update Emergency Service Address
POST
/numbers/2/numbers/{numberKey}/voice/emergency-service
Create Emergency Service Address
DELETE
/numbers/2/numbers/{numberKey}/voice/emergency-service
Delete Emergency Service Address
GET
/numbers/2/numbers/{numberKey}/voice/emergency-service/status
Get Emergency Service Address status
GET
/number-registration/1/brands
Get Brands
POST
/number-registration/1/brands
Create Brand
GET
/number-registration/1/brands/{brandId}
Get Brand
PUT
/number-registration/1/brands/{brandId}
Update Brand
DELETE
/number-registration/1/brands/{brandId}
Delete Brand
POST
/number-registration/1/brands/{brandId}/register
Register Brand
GET
/number-registration/1/brands/{brandId}/registrar-statuses
Get Brand Registrar Statuses
POST
/number-registration/1/brands/{brandId}/brand-auth-verification
Request Brand Authentication+ Verification
POST
/number-registration/1/brands/{brandId}/resend2fa
Resend 2FA Email For Brand Authentication
POST
/number-registration/1/brands/{brandId}/appeal
Submit Brand Identity Appeal
GET
/number-registration/1/brands/{brandId}/appeals
Get Brand Appeals
GET
/number-registration/1/brands/{brandId}/vets
Get Brand Vets
POST
/number-registration/1/brands/{brandId}/vets
Vet Brand
GET
/number-registration/1/brands/{brandId}/vets/{vetId}
Get Brand Vet
PUT
/number-registration/1/brands/{brandId}/vets/{vetId}
Update Brand Vet
PUT
/number-registration/1/brands/{brandId}/vets/import
Import Existing Brand Vet
GET
/number-registration/1/brands/{brandId}/vets/{vetId}/report
Get Brand Enhanced Vet Report
GET
/number-registration/1/campaigns
Get Campaigns
POST
/number-registration/1/campaigns
Create Campaign
POST
/number-registration/1/campaigns/toll-free
Create Toll Free Campaign
GET
/number-registration/1/campaigns/{campaignId}
Get Campaign
PUT
/number-registration/1/campaigns/{campaignId}
Update Campaign
DELETE
/number-registration/1/campaigns/{campaignId}
Delete Campaign
POST
/number-registration/1/campaigns/{campaignId}/register
Submit Campaign
GET
/number-registration/1/campaigns/{campaignId}/network-statuses
Get Campaign Network Statuses
POST
/number-registration/1/campaigns/{campaignId}/deregister
Deregister Campaign
POST
/number-registration/1/campaigns/{campaignId}/update-registration
Update Registered Campaign
POST
/number-registration/1/campaigns/{campaignId}/add-numbers
Add Numbers to Registered Campaign
POST
/number-registration/1/campaigns/{campaignId}/remove-numbers
Remove Numbers from Registered Campaign
GET
/number-registration/1/campaigns/{campaignId}/numbers
Get Campaign numbers
POST
/number-registration/1/campaigns/{campaignId}/appeal
Appeal Campaign
GET
/number-registration/1/campaigns/priorities
Get Campaign Priorities
POST
/number-registration/1/campaigns/{campaignId}/number-pool/attach
Attach Number Pool to Campaign
POST
/number-registration/1/campaigns/{campaignId}/number-pool/detach
Detach Number Pool from Campaign
GET
/number-registration/1/number-pools
Get Owned Number Pools
POST
/number-registration/1/documents
Upload Document
GET
/number-registration/1/documents/{documentId}
Download Document
POST
/number-registration/1/automatic-review/campaigns/{campaignUuid}
Submit Existing Campaign for AI Review
POST
/number-registration/1/automatic-review
Submit Campaign Info for AI Review
GET
/number-registration/1/automatic-review/{requestUuid}
Get AI Review Results
POST
/number-registration/1/campaign-builder
Start Campaign Builder
GET
/number-registration/1/campaign-builder/{requestUuid}
Get Campaign Builder Results
GET
/subscriptions/1/subscription/{channel}
Get subscriptions
POST
/subscriptions/1/subscription/{channel}
Create subscription
GET
/subscriptions/1/subscription/{channel}/{subscriptionId}
Get single subscription
PUT
/subscriptions/1/subscription/{channel}/{subscriptionId}
Update subscription
DELETE
/subscriptions/1/subscription/{channel}/{subscriptionId}
Delete subscription
GET
/subscriptions/1/profiles
Get notification profiles
POST
/subscriptions/1/profiles
Create notification profile
GET
/subscriptions/1/profiles/{profileId}
Get single notification profile
PUT
/subscriptions/1/profiles/{profileId}
Update notification profile
DELETE
/subscriptions/1/profiles/{profileId}
Delete notification profile
GET
/subscriptions/1/security
Get security settings
POST
/subscriptions/1/security
Create security settings
GET
/subscriptions/1/security/{authId}
Get single security settings
PUT
/subscriptions/1/security/{authId}
Update security settings
DELETE
/subscriptions/1/security/{authId}
Delete security settings
GET
/subscriptions/1/certificates
Get filtered certificate details page
POST
/subscriptions/1/certificates
Upload certificate
GET
/subscriptions/1/certificates/{certificateId}
Get certificate details by identifier
DELETE
/subscriptions/1/certificates/{certificateId}
Delete certificate
GET
/subscriptions/1/certificates/status
Get filtered certificates statuses page
GET
/subscriptions/1/certificates/status/{certificateId}
Get certificate status by identifier
POST
/subscriptions/1/certificates/test/webhook
Test connection to a webhook
POST
/metrics/1/query-aggregate-data
Query aggregated traffic data
GET
/metrics/1/requests/{requestId}
Get status of query aggregate data request
POST
/billing/1/usage/query
Query billing usage data
GET
/provisioning/2/sending-strategies
Get sending strategies
POST
/provisioning/2/sending-strategies
Create sending strategy
DELETE
/provisioning/2/sending-strategies/{sendingStrategyId}
Delete sending strategy by sending strategy id
GET
/platform/1/blocklists
Get all blocklists
POST
/platform/1/blocklists
Create blocklists
DELETE
/platform/1/blocklists
Delete blocklists
GET
/catalogs/1/catalogs
Get catalogs
POST
/catalogs/1/catalogs
Create catalog
GET
/catalogs/1/catalogs/{id}
Get catalog
DELETE
/catalogs/1/catalogs/{id}
Delete catalog
PATCH
/catalogs/1/catalogs/{id}
Update catalog
GET
/catalogs/1/catalogs/{catalogId}/fields
Get fields
POST
/catalogs/1/catalogs/{catalogId}/fields
Create fields
GET
/catalogs/1/catalogs/{catalogId}/fields/{fieldId}
Get field
DELETE
/catalogs/1/catalogs/{catalogId}/fields/{fieldId}
Delete field
PATCH
/catalogs/1/catalogs/{catalogId}/fields/{fieldId}
Update field
GET
/catalogs/1/catalogs/{catalogId}/items
Get items
POST
/catalogs/1/catalogs/{catalogId}/items
Add items
DELETE
/catalogs/1/catalogs/{catalogId}/items
Delete items
PATCH
/catalogs/1/catalogs/{catalogId}/items
Update items
GET
/catalogs/1/catalogs/{catalogId}/items/{itemId}
Get item
DELETE
/catalogs/1/catalogs/{catalogId}/items/{itemId}
Delete item
PATCH
/catalogs/1/catalogs/{catalogId}/items/{itemId}
Update item
GET
/catalogs/1/catalogs/{catalogId}/items/count
Get item count
POST
/messages-api/1/messages
Send a Messages API message
POST
/messages-api/1/messages/validate
Validate a Messages API message
POST
/messages-api/1/events
Send a Messages API event
GET
/messages-api/1/reports
Get delivery reports
GET
/messages-api/1/inbound
Get inbound messages
POST
/signals/1/trusted-msisdns
Add phone numbers to a list
DELETE
/signals/1/trusted-msisdns
Remove phone numbers from a list
GET
/signals/1/trusted-msisdns/{msisdn}/check
Check for phone numbers on a list
GET
/resource-management/1/inbound-message-configurations
Get inbound configurations
POST
/resource-management/1/inbound-message-configurations
Manage inbound configuration
DELETE
/resource-management/1/inbound-message-configurations/{configurationKey}
Delete inbound configuration
POST
/resources/1/resources
Search resources
POST
/resources/1/coverage-lookup
Lookup coverage for a resource
POST
/resources/1/requirements-lookup
Get resource requirements
GET
/resources/1/requests
Get resource requests
POST
/resources/1/requests
Submit resource request
GET
/resources/1/requests/{id}
Get resource request
PATCH
/resources/1/requests/{id}
Update resource request
POST
/resources/1/requests/{id}/cancel
Cancel resource request
POST
/resources/1/documents
Upload document
GET
/resources/1/documents/{documentId}
Download document
DELETE
/resources/1/documents/{documentId}
Delete document
Schemas 582
The contract defines 582 schemas that model the data the API accepts and returns. The most detailed are 2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TollFreeUnifiedNumberCampaignApiModel (40 properties), 99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.AggregateDataFilter (27 properties), 7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumberResponse (17 properties), 899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiDeliveryResult (17 properties). Each schema is shown below with its type and property counts.
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiToDestination
object
Represents a simple destination.
2 properties
1 required
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoConfigurationResponse
object
Response for configuring MO resource.
10 properties
1 required
e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.CreateCatalogFieldDto
object
3 properties
2 required
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.UpdateOwnedNumberRequest
object
2 properties
1 required
e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.PageResponseDto
object
2 properties
2 required
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleNumberLookupEvents
string
99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.BillingUsageDataFilter
object
A JSON object specifying criteria to filter the results. Each field in the object represents a different filter criterion to enable detailed and complex filter…
13 properties
1 required
5929f45c31f06c29ab1bc6e26caa01575484225e5ef99a2512bee829b646f1c1.Platform
object
Platform options. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
2 properties
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiDelivery
object
Provides options for configuring the delivery report behavior.
3 properties
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandStage
string
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.RcsCoverageInfo
object
Information about the sender coverage.
5 properties
c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.UpdateEmailMessageRequest
object
5 properties
c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.CreateSmsOrVoiceMessageRequest
object
9 properties
2 required
ApiRequestErrorDetails
object
3 properties
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SmsSubscriptionRequest
object
Subscription group.
7 properties
3 required
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessageDestination
object
Array of destination objects for where messages are being sent. A valid destination is required. Channels Destination is required when sending messages with de…
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleAppleMessagesForBusinessEvents
string
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CustomerEngagementSubscriptionRequest
object
Subscription group.
7 properties
3 required
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandRegistrationWebhookMessage
object
Incoming events
4 properties
2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.BlocklistResponse
object
Blocklist response.
7 properties
4 required
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.RegistrationNoIdSubscriptionRequest
object
Subscription group.
6 properties
2 required
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.Channel
string
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.UploadDocumentApiDoc
object
1 property
1 required
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceType
string
Resource type.
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ConfigurationType
string
Channel type.
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleWebPushEvents
string
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.AgentOsNoIdSubscriptionRequest
object
Subscription group.
6 properties
2 required
c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.AlphaWebhookStatusNotifApiDoc
object
5 properties
2 required
2be764ef53499e28cc8da8dff3890f0787860aba10984e520352c73612c0342b.PageInfo
object
4 properties
4 required
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Network
string
The network with which the campaign has been registered.
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandWebhookPlatform
object
Platform properties.
2 properties
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.VettingType
string
The type of vet.
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageButton
object
List of buttons of the message.
1 property
1 required
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.ExternalAutomaticReviewError
object
List of compliance errors found during the AI campaign review. Empty when the review is still processing or the campaign is compliant.
4 properties
c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.FeedbackCode
string
Code of the feedback.
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageOptions
object
Message options.
11 properties
99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.ColumnInfo
object
Information about columns returned in response.
2 properties
2 required
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.RcsSubscriptionRequest
object
Subscription group.
7 properties
3 required
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumberPrice
object
The price object indicating pricing details for the number.
4 properties
bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.Permission
string
List of permissions this API key has granted. This data may be inaccurate. Migrate to new API key management endpoints and use API scopes for fine grained cont…
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.NumberPoolUsageApiPageResponse
object
2 properties
2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.PagingResponse
object
Paging response.
4 properties
4 required
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.DeliveryTime
object
The exact time of the day. The time is expressed in the UTC time zone.
2 properties
2 required
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleZaloEvents
string
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleRegistrationEvents
string
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.Platform
object
Platform options. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
2 properties
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.MobileIdentityNoIdSubscriptionRequest
object
Subscription group.
6 properties
2 required
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Priority
object
4 properties
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SubscriptionRequest
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.MobilePushSubscriptionRequest
object
Subscription group.
7 properties
3 required
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicCnamDeliveryStatus
object
Current status of CNAM Delivery configuration.
2 properties
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceCoverageInfo
object
Information about resource coverage.
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageHeaderType
string
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.UseConversation
object
Used for forwarding messages to Conversations service.
1 property
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoConfigurationRequest
object
4 properties
1 required
c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.WebhookReminderNotifApiDoc
object
Object containing event data.
4 properties
4 required
bc185b494ef7059aff9d68589cd5338df2245f21add51cf1a96e9927af6e30d7.PublicCnamStatus
object
2 properties
c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.PinType
string
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.NetworkStatus
object
5 properties
e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.CatalogFieldDto
object
4 properties
4 required
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiDeliveryResult
object
Incoming Delivery reports.
17 properties
11 required
2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.InboundMessageReference
object
Inbound message reference, if matched by the Infobip platform.
1 property
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceInfo
object
Resource basic info.
2be764ef53499e28cc8da8dff3890f0787860aba10984e520352c73612c0342b.PageEntity
object
2 properties
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignInfoReviewRequest
object
Request to submit a new campaign for AI compliance review
9 properties
7 required
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignStatusWebhookResponse
object
1 property
2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.BlocklistDeleteRequest
object
Blocklist request.
1 property
1 required
99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.AggregateDataFilter
object
A JSON object specifying the criteria to filter the results. Each field in the object represents a different filter criterion, enabling detailed and complex fi…
27 properties
3 required
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.BlocklistSubscriptionRequest
object
Subscription group.
7 properties
3 required
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateBody
object
Body of a template message.
1 property
1 required
66067ae938b1b756af79ad29184e7a22de98929ca991ca01a0c74d258f22a0b6.BalanceInfoResponse
object
6 properties
2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.ViewableChannel
string
Channel used for sending for which blocklist happened.
5929f45c31f06c29ab1bc6e26caa01575484225e5ef99a2512bee829b646f1c1.SssRequestV2
object
6 properties
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CertificateConnectionTestResponse
object
5 properties
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.OptIns
object
4 properties
e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.CreateCatalogItemDto
object
1 property
1 required
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareAppleMessagesForBusinessEvents
object
2 properties
2 required
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.WebPushNoIdSubscriptionRequest
object
Subscription group.
6 properties
2 required
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CredentialsType
string
Credentials type.
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileResponse
object
Notification profile.
13 properties
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandAuthUpdateWebhookResponse
object
1 property
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiBaseMessage
object
Array of message objects of a single message or multiple messages sent under one bulk ID.
c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.WebhookStatusNotifApiDocRequestBody
object
1 property
aa47d40354ee197e21ffad52d2c543bd4f729e250360a844e476aa80deff7b6e.StartAuthenticationRequest
object
6 properties
3 required
e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.CreateCatalogDto
object
3 properties
3 required
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateMessageContent
object
Content of the message.
4 properties
99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.AggregateDataResponse
object
4 properties
4 required
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfilePage
object
2 properties
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.KakaoAlimNoIdSubscriptionRequest
object
Subscription group.
6 properties
2 required
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandAuthUpdateWebhookContent
object
Event content.
2 properties
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumberTypeResourceMoDocs
string
Number type.
c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.WebhookReminderNotifApiDocRequestBody
object
1 property
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiInboundEventType
string
Event type.
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.PageInfo
object
4 properties
4 required
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandRegistrationWebhookResponse
object
1 property
aa47d40354ee197e21ffad52d2c543bd4f729e250360a844e476aa80deff7b6e.StartEmailAuthenticationResponse
object
3 properties
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FacebookSubscriptionRequest
object
Subscription group.
7 properties
3 required
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareMobileIdentityEvents
object
2 properties
2 required
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TollFreeMessageVolume
string
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MmsConfigurations
object
2 properties
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiChannelsDestination
object
Represents a destination which can be specified by a channel. It is required for a message failover.
2 properties
1 required
e35a706fc99c4749296ef942f9e5af764730e23804a8d85886e3d0a3e3fc2340.ApiException
object
1 property
99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.TrafficAggregate
string
c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.RcsSenderResourceOrderApiDoc
object
14 properties
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TenDlcUseCase
string
Campaign use case.
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleBlocklistEvents
string
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.MmsSubscriptionRequest
object
Subscription group.
7 properties
3 required
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.VoiceSetup
object
Voice setup configuration.
3 properties
1 required
99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.ColumnDataType
string
Data type of the values related to a given column. The available data types are: STRING - type used for string values. INTEGER - type used for integral numbers…
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.RegionalOptions
object
Region-specific parameters, often imposed by local laws. Use this, if country or region that you are sending an SMS to requires additional information.
3 properties
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ResourceCapabilityChannel
string
Indicates the channel supported by the resource.
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.NoIdProfileRequest
object
Notification profile.
12 properties
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiBaseFailover
object
Provides options for configuring a message failover. When message fails it will be sent over channels in order specified in an array. It has to contain unique…
c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.Language
string
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.KakaoBrandMessageNoIdSubscriptionRequest
object
Subscription group.
6 properties
2 required
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleMobilePushEvents
string
96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiRequestErrorDetails
object
2 properties
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareMmsEvents
object
2 properties
2 required
5929f45c31f06c29ab1bc6e26caa01575484225e5ef99a2512bee829b646f1c1.SssV2
object
The list of the results for this page.
7 properties
3 required
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleKakaoAlimEvents
string
e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.CreateCatalogValueDto
object
A list of item field values. Maximum 1000 values.
3 properties
1 required
c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.NumberWebhookStatusNotifApiDoc
object
6 properties
2 required
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourcesFilter
object
Filter for resources.
1 property
1 required
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumberResourceInfo
object
Information about the numeric type of resource.
8 properties
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.RegistrationSubscriptionRequest
object
Subscription group.
7 properties
3 required
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.RecipientType
string
Recipient Type must be TACIR or BIREYSEL.
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.ValidityPeriodTimeUnit
string
Message validity period time unit.
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageSenderDisplayInfo
object
Sender display info (name and avatar). Used only for Viber Bot messages.
2 properties
e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.CatalogFieldDataType
string
Field data type. Note: Once created, you cannot change the data type.
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleFacebookEvents
string
40143f8c1273929a779db5eeca48aaeec6583ec5c7f80b29e546fbb75ba02e1d.SearchResult
object
7 properties
99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.GeneralStatus
string
Specifies the general status code groups. For the list of possible values, refer to [general status codes](https://www.infobip.com/docs/essentials/response-sta…
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.OutboundTemplateChannel
string
Messaging channel used for sending a template message.
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.ShortCodeCampaignBuilderRequest
object
Request to start building Short code campaign using AI assistant.
6 required
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumbersResponse
object
2 properties
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.OpenChannelNoIdSubscriptionRequest
object
Subscription group.
6 properties
2 required
7635fa9e013ed171bbe9743a6ca322c3b2b29e7574931e38f0de0bda9687aadf.EmergencyAddress
object
2 properties
2 required
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.WebhookBrandVettingType
string
The type of brand vet.
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SecurityResponse
object
Security configuration.
3 properties
bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.AccountsResponse
object
1 property
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleWhatsappEvents
string
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiIncomingMessage
object
1 property
1 required
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.SpeedLimitTimeUnit
string
The time unit to define when setting a messaging speed limit. Defaults to MINUTE.
c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.RequirementSpecsRequestApiDoc
object
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageButtonType
string
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoNonForwardAction
object
List of other configured actions on this keyword. Ignored in POST/PUT calls.
2 properties
1 required
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.BlocklistNoIdSubscriptionRequest
object
Subscription group.
6 properties
2 required
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandVetStatusWebhookContent
object
Event content.
5 properties
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlySubscriptionResponse
object
Subscription group.
2 properties
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TenDlcCampaignBuilderRequest
object
Request to start building 10DLC campaign using AI assistant.
5 required
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.SouthKoreaOptions
object
Use case dependent parameters for sending SMS to phone numbers registered in South Korea.
2 properties
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleSmsEvents
string
c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.ResourceOrderApiDoc
object
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderOptInMethod
string
Method used to obtain consumer opt-in consent for messaging
c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.ResourceOrderStatus
string
Current status of the resource request.
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleCustomerEngagementEvents
string
aa47d40354ee197e21ffad52d2c543bd4f729e250360a844e476aa80deff7b6e.VerificationResponse
object
1 property
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TenDlcCampaignBuilderResultData
object
Campaign builder result for 10DLC campaigns.
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignType
string
Campaign type.
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumberCoverageInfo
object
Information about the number coverage.
8 properties
e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.Paging
object
Pagination information.
4 properties
4 required
96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiRequestError
object
1 property
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.RequestSchedulingSettings
object
Options for scheduling a message.
3 properties
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PromotionMethodType
string
Call-to-action promotion method type
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.StatusResponse
object
Current status of Emergency Service configuration.
2 properties
c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.UpdateSmsOrVoiceMessageRequest
object
9 properties
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.MobilePushNoIdSubscriptionRequest
object
Subscription group.
6 properties
2 required
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiOutboundEventType
string
Event type.
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageContent
object
Content of the message.
6 properties
1 required
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiSeenResult
object
Collection of reports, one per every message.
11 properties
8 required
99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.QueryAggregateDataResult
object
4 properties
2 required
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.LineSubscriptionRequest
object
Subscription group.
7 properties
3 required
17363474057d152577564d8587b079aa7bdd070a3f49746aea3319eb57a5830c.ApplicationRequest
object
3 properties
1 required
c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.WebhookReminderNotifApiDocResult
object
List of events provided in a single request.
2 properties
2 required
c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.Platform
object
CPaaS X properties.
2 properties
6ac22f6f3346b6db1d4c8464d58b1329c30df516bb4206699a93fd8658df38c7.TrustedMsisdnCheckResponse
object
Trusted MSISDN check response object.
1 property
2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.BlocklistEventRequest
object
Blocklist event request.
1 property
1 required
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandAppealsResponse
object
Response containing the list of all appeals submitted for a brand.
1 property
bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.CreateApiKeyRequest
object
8 properties
1 required
c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.ResourceOrderIdentifier
object
1 property
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleEmailEvents
string
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandRegistrationStatusPublic
string
The state of the registration for this brand.
96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException
object
1 property
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandStatus
object
5 properties
bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.Platform
object
A collection of CPaaS X Applications and Entities that will be linked to the API key. All Applications and Entities will be removed from the api key if an empt…
4 properties
1 required
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderResponse
object
Response containing the request UUID for tracking the started campaign builder
1 property
e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.CatalogDto
object
4 properties
4 required
7635fa9e013ed171bbe9743a6ca322c3b2b29e7574931e38f0de0bda9687aadf.ValidateAddressResponse
object
1 property
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignStatusWebhookMessage
object
Incoming events
4 properties
c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.EmailMessage
object
7 properties
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.LineNoIdSubscriptionRequest
object
Subscription group.
6 properties
2 required
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PageInfo
object
Contains information about the page.
4 properties
4 required
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ViberCoverageInfo
object
Information about the sender coverage.
7 properties
2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.DeletableChannel
string
Channel for which blocklist record/s will be removed.
7635fa9e013ed171bbe9743a6ca322c3b2b29e7574931e38f0de0bda9687aadf.EmergencyAddressStatus
object
1 property
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.RcsNoIdSubscriptionRequest
object
Subscription group.
6 properties
2 required
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CertificateUploadRequest
object
3 properties
2 required
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandAppealResponse
object
Response returned after successfully submitting a brand identity appeal.
1 property
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.RejectionReasonPayload
object
The rejection reasons details. This field is present only when new campaign registration status is 'REJECTED'.
2 properties
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageConfirmationBody
object
Body of the confirmation message.
3 properties
1 required
c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.PageResourceOrderApiDoc
object
2 properties
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.MmsNoIdSubscriptionRequest
object
Subscription group.
6 properties
2 required
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiIncomingMessageResponse
object
3 properties
1 required
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiRequest
object
2 properties
1 required
c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.AlphaResourceOrderApiDoc
object
14 properties
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiDeliveryError
object
Message error if occurred, 0 if there is no error.
6 properties
1 required
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CertificatesSortType
string
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PriorityInfo
object
Priority information used in latest campaign review.
2 properties
c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.NumberResourceOrderRequestApiDoc
object
9 properties
4 required
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateFailover
object
Configuration of a single failover step
5 properties
2 required
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareFacebookEvents
object
2 properties
2 required
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandVet
object
The list of the results for this page.
9 properties
1 required
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.AttachNumberPoolRequest
object
2 properties
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.AgentOsSubscriptionRequest
object
Subscription group.
7 properties
3 required
99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.QueryBillingUsageApiRequest
object
Contains filter criteria, aggregation dimensions, and query options for the billing usage report.
3 properties
2 required
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TenDlcCampaignBuilderResultMessageFlow
object
Campaign message flow for 10DLC campaigns
5 properties
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiSeenReport
object
1 property
1 required
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Address
object
Address of an Emergency Service.
9 properties
7 required
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ViberResourceInfo
object
Information about Viber type of resource.
7 properties
99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.Direction
string
Specifies the direction of traffic, indicating whether the message was sent to the user (OUTBOUND) or received from the user (INBOUND).
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ViberNoIdSubscriptionRequest
object
Subscription group.
6 properties
2 required
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumberType
string
The type of number.
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.VoiceVideoNoIdSubscriptionRequest
object
Subscription group.
6 properties
2 required
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlySecurityResponse
object
Security configuration.
1 property
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.WebhookBrandRegistrationStatus
string
The new brand registration status.
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.HmacAlgorithm
string
HMAC algorithm.
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.UpdateCampaignRegistrationRequest
object
2 properties
c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.RcsSenderResourceOrderRequestApiDoc
object
8 properties
5 required
c477cb65646267e3f350bce7b433e9b56e5c28aa9ef21a75500a1337942923ba.Cnam
object
2 properties
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TollFreeCampaignBuilderResultData
object
Campaign builder result for Toll Free Number campaigns.
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.WhatsappNoIdSubscriptionRequest
object
Subscription group.
6 properties
2 required
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.ValidationOkResponse
object
3 properties
2 required
c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.CreateEmailMessageRequest
object
5 properties
1 required
c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.NumberResourceOrderApiDoc
object
15 properties
c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.PageInfo
object
Contains information about the page.
4 properties
4 required
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.WebhookCampaignNetworkStatus
string
The new campaign registration status for a given network.
c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.AlphaRequirementSpecsRequestApiDoc
object
4 properties
2 required
99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.TimeSpan
object
Represents the time within which a message is opened after the message is delivered using time buckets. For example, you can filter only for messages opened wi…
2 properties
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourcesResponse
object
Response containing information about IB resources.
2 properties
fc7dd544c10bf8ba502ba371088d1382022decf6a1acc2d0fa20f0b7f272047d.ApiException
object
1 property
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareEvent
object
2 properties
2 required
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateButton
object
List of buttons of a template message.
1 property
1 required
aa47d40354ee197e21ffad52d2c543bd4f729e250360a844e476aa80deff7b6e.StartEmailAuthenticationRequest
object
6 properties
3 required
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SubscriptionChannel
string
ApiErrorViolation
object
List of violations that caused the error.
2 properties
17363474057d152577564d8587b079aa7bdd070a3f49746aea3319eb57a5830c.ApplicationResponse
object
4 properties
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignAiFeedbackWebhookMessage
object
Incoming events
4 properties
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessage
object
Represents a single message.
7 properties
3 required
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderResultStatus
string
Current status of the campaign builder job.
5929f45c31f06c29ab1bc6e26caa01575484225e5ef99a2512bee829b646f1c1.Priority
object
Priorities of the senders that can be defined in case there is more than one sender for a destination country.
2 properties
2 required
c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.SmsOrVoiceMessage
object
12 properties
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TollFreeCampaignBuilderResultMessageFlow
object
Campaign message flow for Toll Free Number campaigns
1 property
2be764ef53499e28cc8da8dff3890f0787860aba10984e520352c73612c0342b.Application
object
2 properties
1 required
b1075107f5bba728f6a701eb8a72357dfcf0d9c4405dd06e85e56496153a8d2f.GrantType
string
Grant type as defined by the OAuth framework.
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.EmailSubscriptionRequest
object
Subscription group.
7 properties
3 required
2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.BlocklistDelete
object
Blocklist.
5 properties
1 required
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Direction
string
Emergency Service address direction.
5929f45c31f06c29ab1bc6e26caa01575484225e5ef99a2512bee829b646f1c1.SendingStrategyId
object
1 property
1 required
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CertificateDetailsPage
object
2 properties
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoAction
object
Forward action configuration.
2 properties
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiDeliveryReportResponse
object
1 property
1 required
bad08f31d0530c669218bdbac07f91125fbbb50284a2712ce5d27fb95dd26628.ApiException
object
1 property
2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.SourceType
string
Represents the way blocklist record was created: CUSTOM - blocklist record that was created manually MO - blocklist record automatically created once an end us…
c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.DocumentIdentifier
object
1 property
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlySecurityRequest
object
Security settings object holding authentication settings necessary to access your webhook.
1 property
1 required
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.NumberPoolAvailability
string
c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.UploadDocumentApiDoc
object
1 property
1 required
e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.CatalogTypes
string
Catalog type.
c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.UpdateResourceOrderRequest
object
1 property
1 required
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.IndiaDltOptions
object
Distributed Ledger Technology (DLT) specific parameters required for sending SMS to phone numbers registered in India.
3 properties
1 required
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.KakaoBrandMessageSubscriptionRequest
object
Subscription group.
7 properties
3 required
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.RegisterCampaignRequest
object
1 property
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignFeedback
object
Offers additional information regarding the campaign, includes rejection reason and time.
3 properties
e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.CatalogValueDto
object
A list of item field values. Maximum 1000 values.
3 properties
3 required
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceCapability
object
Coverage by capability.
2 properties
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CertificateConnectionTestRequest
object
2 properties
2 required
ApiRequestError
object
1 property
ApiErrorResource
object
List of available resources to recover from the error.
2 properties
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.ExternalAutomaticReviewResults
object
2 properties
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.OauthCredentialsPayload
object
OAuth credentials.
10 properties
2 required
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.ResponseEnvelopeMessageResponseMessageResponseDetails
object
2 properties
1 required
5929f45c31f06c29ab1bc6e26caa01575484225e5ef99a2512bee829b646f1c1.PageInfo
object
Contains information about the page.
4 properties
4 required
aa47d40354ee197e21ffad52d2c543bd4f729e250360a844e476aa80deff7b6e.EmailStatus
object
2 properties
bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.Session
object
1 property
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoActionDocs
object
Forwarding MO action.
1 property
1 required
c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.IndiaDltOptions
object
3 properties
1 required
2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.BlocklistCreate
object
Blocklist.
4 properties
1 required
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignStage
string
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.WebhookCampaignStage
string
The new campaign registration.
c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.RequirementSpecs
object
1 property
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ZaloSubscriptionRequest
object
Subscription group.
7 properties
3 required
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.OpenChannelCoverageInfo
object
Information about the sender coverage.
4 properties
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.KeywordOptIn
object
The type of opt in that requires a user to type in a keyword.
2 properties
2 required
99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.BillingUsageMetadata
object
Additional billing data metadata included in the response.
2 properties
2 required
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleMobileIdentityEvents
string
c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.NumberOfferClientType
string
Type of client. LOCAL resolves numbers preferring local options, falling back to international if none are available. INTERNATIONAL and null resolve internatio…
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.VettingProvider
string
Provider for imported brand vet.
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.MobileIdentitySubscriptionRequest
object
Subscription group.
7 properties
3 required
c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.ResourceNumberCapability
string
Capabilities of the numbers.
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.PurchaseNumberRequest
object
4 properties
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.UrlOptions
object
Sets up [URL shortening](https://www.infobip.com/docs/url-shortening) and tracking feature. Does not apply to channels that do not support it: Instagram, LINE,…
5 properties
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ViberSubscriptionRequest
object
Subscription group.
7 properties
3 required
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessageGeneralStatus
string
Status group name that describes which category the status code belongs to, i.e., [PENDING](https://www.infobip.com/docs/essentials/response-status-and-error-c…
99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.DateInterval
object
Time period for billing data in UTC. sentSince is inclusive and sentUntil is exclusive. Billing usage data is available for the current month and the previous…
2 properties
2 required
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.ValidationBadResponse
object
4 properties
3 required
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceCoverage
object
Information about the networks configured for the resource.
2 properties
2be764ef53499e28cc8da8dff3890f0787860aba10984e520352c73612c0342b.PageResourceAssociation
object
2 properties
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessageResponseDetails
object
Other details of the message.
2be764ef53499e28cc8da8dff3890f0787860aba10984e520352c73612c0342b.ResourceType
string
The type of resource to be used.
bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.Action
string
An optional action performed for an API request authenticated by this specific API key. The FILL option is used when an API endpoint inserts linked Application…
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiChannelDestination
object
An array of substitute destinations, each associated with a specific channel. Only one substitute destination is allowed per channel. A substitute destination…
3 properties
2 required
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateBodyType
string
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderResult
object
Response containing the campaign builder job status and result.
3 properties
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CertificateStatusResponse
object
2 properties
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiRequestOptions
object
Options applicable to all messages in the request.
3 properties
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandAuthUpdateWebhookMessage
object
Incoming events
4 properties
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignNetworkStatusWebhookMessage
object
Incoming events
4 properties
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessageStatus
object
Indicates the [status](https://www.infobip.com/docs/essentials/response-status-and-error-codesapi-status-codes) of the message and how to recover from an error…
6 properties
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PriorityTimeUnit
string
The unit of time for the priority request.
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignAiFeedbackWebhookContent
object
Event content.
1 property
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Campaign
object
11 properties
1 required
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiDeliveryStatus
object
Messaged status.
5 properties
5 required
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.VerbalOptIn
object
The type of opt in that requires a user to verbally confirm.
1 property
1 required
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignAiBuilderWebhookMessage
object
Incoming events
4 properties
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.AppleResourceInfo
object
Information about Apple type of resource.
6 properties
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareOpenChannelEvents
object
2 properties
2 required
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignNetworkStatusWebhookResponse
object
1 property
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.InboundSeenChannel
string
Messaging channel used for sending an event.
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileResponse
object
Notification profile.
2 properties
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SmsNoIdSubscriptionRequest
object
Subscription group.
6 properties
2 required
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FacebookNoIdSubscriptionRequest
object
Subscription group.
6 properties
2 required
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SecurityPage
object
2 properties
e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.CatalogItemDto
object
2 properties
2 required
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest
object
Notification profile object holding the settings for your webhook URL and a reference to security settings. You can provide full definition of a notification p…
13 properties
1 required
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.ShortCodeCampaignBuilderResultData
object
Campaign builder result for Short Code campaigns.
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BusinessRegistrationType
string
Type of tax identification number provided. Value depend on selected taxId issuing country. For US it can be only EIN. Not required for sole proprietor brands.
aa47d40354ee197e21ffad52d2c543bd4f729e250360a844e476aa80deff7b6e.VerifyPinRequest
object
1 property
1 required
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.DeliveryTimeWindowResponse
object
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.
4 properties
4 required
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandAppealPreview
object
Summary information about a single brand appeal.
4 properties
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.PageInfo
object
Contains information about the page.
4 properties
c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.ProcuredNumber
object
List of numbers linked with the resource.
3 properties
2 required
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SecurityRequest
object
Security settings object holding the authentication settings necessary to access your webhook. Should only be provided if you are creating a new profile and se…
3 properties
1 required
bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.GetApiKeysResponse
object
2 properties
1 required
5929f45c31f06c29ab1bc6e26caa01575484225e5ef99a2512bee829b646f1c1.SenderType
string
Sender type.
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleVoiceVideoEvents
string
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PageResponseCampaign
object
2 properties
99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.AggregateDataRequest
object
3 properties
3 required
b1075107f5bba728f6a701eb8a72357dfcf0d9c4405dd06e85e56496153a8d2f.TokenRequest
object
Request used for creating OAuth2 token.
4 properties
3 required
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderResultOptIn
object
Opt-in suggestion generated by the campaign builder.
5 properties
c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.RegionalOptions
object
1 property
bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.Account
object
4 properties
6ac22f6f3346b6db1d4c8464d58b1329c30df516bb4206699a93fd8658df38c7.ErrorResponse
object
Error response object.
1 property
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTrafficType
string
Traffic type classification for message sending. Supported by Viber for non-template messages only.
e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.CountResponse
object
1 property
1 required
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.KakaoAlimSubscriptionRequest
object
Subscription group.
7 properties
3 required
bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.UpdateAccountRequest
object
2 properties
66067ae938b1b756af79ad29184e7a22de98929ca991ca01a0c74d258f22a0b6.SimpleCurrencyInfo
object
4 properties
2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.EventSourceType
string
Represents the way blocklist record was created: MO - blocklist record automatically created once an end user unsubscribes by replying with a specific keyword…
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiWebhooks
object
Provides options for configuring message webhooks.
4 properties
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.SendingSpeedLimit
object
Limits the send speed when sending messages in bulk to deliver messages over a longer period of time. You may wish to use this to allow your systems or agents…
2 properties
1 required
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyCertificateResponse
object
1 property
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.BlockListConfigurationType
string
The type of block configuration. Defines whether you are configuring blocking (blacklisting) or unblocking (whitelisting) configuration.
99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.QueryAggregateDataStatus
string
Status of the request. If successful, the response will contain aggregated data. If failed, it will contain failure message.
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.VoiceVideoSubscriptionRequest
object
Subscription group.
7 properties
3 required
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.BasicCredentialsPayload
object
Basic credentials.
2 properties
2 required
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.InboundMoGetEndpointChannel
string
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CertificateStatus
string
Certificate status. Represents a certificate state and indicates whether the certificate can be used. PROCESSING means certificate is being synced on Infobip P…
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ZaloNoIdSubscriptionRequest
object
Subscription group.
6 properties
2 required
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SubscriptionResponse
object
Subscription group.
7 properties
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.ValidityPeriod
object
Message validity period. Once expired, the message won't be sent. Validity period longer than 48h is not supported. If exceeded, it will be automatically set t…
2 properties
1 required
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumberCapabilityType
string
An array of communication channels the number can support.
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.WebOptIn
object
The type of opt in that requires a user to follow a URL.
2 properties
1 required
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.DocumentMetadata
object
Preview of the screenshot document. This property is read-only and ignored in POST/PUT calls.
4 properties
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.BlockLevelResponse
string
The level of block configuration. If the value is CUSTOMNOTEDITABLE , then the value is not manageable by API.
17363474057d152577564d8587b079aa7bdd070a3f49746aea3319eb57a5830c.ApplicationConfiguration
object
6 properties
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateMessage
object
Represents a single template message.
8 properties
3 required
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleViberEvents
string
c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.RcsWebhookStatusNotifApiDoc
object
5 properties
2 required
99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.QueryAggregateDataResponse
object
1 property
1 required
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.AppealRequest
object
1 property
1 required
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleRcsEvents
string
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.NumberPoolUsageApiResponse
object
The list of the results for this page.
3 properties
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.OutboundMessageChannel
string
Messaging channel used for sending a message.
c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.NumberRequirementSpecsRequestApiDoc
object
6 properties
4 required
aa47d40354ee197e21ffad52d2c543bd4f729e250360a844e476aa80deff7b6e.ResendPinRequestViaEmail
object
2 properties
8107508a6b6ebe39d7ea5cd4a2338a61e45bf1b939b4ec9bc51846ab35de14ea.ApiException
object
1 property
1 required
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessageOrderingOptions
object
Message ordering options.
2 properties
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CnamStorage
object
CNAM Storage is an up to 15-character name that will identify you to the person that you are calling if they subscribe to caller ID.
2 properties
1 required
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateHeader
object
Header of a template message.
1 property
1 required
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TollFreeUnifiedNumberCampaignApiModel
object
40 properties
16 required
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessageResponseMessageResponseDetails
object
An array of message objects of a single message or multiple messages sent under one bulk ID.
4 properties
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.HmacCredentialsPayload
object
HMAC credentials.
2 properties
2 required
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CnamDelivery
object
CNAM Delivery is enabled on your DID at an additional charge that allows you to see the caller identification of the person calling you.
1 property
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.AutoResponseActionV2Response
object
Auto-response action configuration.
3 properties
1 required
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.ReviewSubmissionResponse
object
Response containing the request UUID for tracking the AI review submission
1 property
e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.UpdateCatalogFieldDto
object
1 property
1 required
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateButtonType
string
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandAppealRequest
object
Request body for submitting a brand appeal.
2 properties
1 required
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.AlphaCoverageInfo
object
Information about the sender coverage.
5 properties
1 required
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageHeader
object
Header of the message.
1 property
1 required
2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.OutboundMessageReference
object
Outbound message reference, if matched by the Infobip platform.
3 properties
c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.FieldType
string
Type of the requirement.
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.NoIdSubscriptionRequest
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ReservationStatus
string
Status of the number reservation.
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TollFreeCampaignBuilderRequest
object
Request to start building Toll free campaign using AI assistant.
5 required
2be764ef53499e28cc8da8dff3890f0787860aba10984e520352c73612c0342b.ModifyEntity
object
1 property
2be764ef53499e28cc8da8dff3890f0787860aba10984e520352c73612c0342b.ResourceAssociationRequest
object
5 properties
5 required
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.OpenChannelSubscriptionRequest
object
Subscription group.
7 properties
3 required
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Brand
object
9 properties
3 required
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair
object
Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.
3 properties
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.BlockListConfigurationResponse
object
Whitelist or blacklist the traffic of MT messages.
2 properties
2 required
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.WebPushSubscriptionRequest
object
Subscription group.
7 properties
3 required
c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.WebhookStatusNotifApiDocResult
object
List of events provided in a single request.
4 properties
3 required
99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.QueryBillingUsageRequest
object
2 properties
2 required
bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.ApiKeyResponse
object
9 properties
1 required
aa47d40354ee197e21ffad52d2c543bd4f729e250360a844e476aa80deff7b6e.Verification
object
4 properties
c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.TrafficOrigin
string
The location from which outbound messages are sent, relative to the country associated with the sender. - LOCAL: Indicates that the business sending the messag…
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.RejectionReason
object
Rejection reasons details.
3 properties
bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.CreateSessionRequest
object
3 properties
2 required
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TenDlcAiReviewRequest
object
Request to submit 10DLC campaign info for AI compliance review with full details
16 required
bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.PagingResponse
object
6 properties
c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.RequirementSpec
object
List of requirements needed for the resource request.
1 property
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.SeenStatusReporting
object
Provides options for configuring the seen report behavior.
1 property
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.WhatsappSubscriptionRequest
object
Subscription group.
7 properties
3 required
c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.JsonNode
object
The value of the requirement. Can be a string, integer, or a list of strings and integers.
99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.BillingUsageMetadataPeriod
object
Metadata for each covered calendar month.
2 properties
2 required
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.NetworkState
string
The state of the campaign's registration with this network.
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.AppealDocument
object
A document attached to a brand identity appeal.
2 properties
1 required
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandVetStatus
string
The status of vet.
66067ae938b1b756af79ad29184e7a22de98929ca991ca01a0c74d258f22a0b6.AccountBalance
object
2 properties
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.FacebookCoverageInfo
object
Information about the sender coverage.
6 properties
c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.ResourceOrderRequestApiDoc
object
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Address
object
The address of the brand.
4 properties
3 required
c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.NumberStatus
string
Status of the number.
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.VoiceActionDetails
object
Voice action configuration.
2 properties
99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.QueryAggregateDataRequest
object
2 properties
2 required
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.NoIdSecurityRequest
object
Security configuration.
2 properties
99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.clientRequestedPeriod
object
Originally requested time period referenced in the response.
2 properties
2 required
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignStatusWebhookContent
object
Event content.
6 properties
e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException
object
1 property
aa47d40354ee197e21ffad52d2c543bd4f729e250360a844e476aa80deff7b6e.VerifyPinResponse
object
5 properties
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignAiBuilderWebhookContent
object
Event content.
1 property
99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.ClientRequestStatus
string
Request processing status.
2be764ef53499e28cc8da8dff3890f0787860aba10984e520352c73612c0342b.ResourceAssociationResponse
object
5 properties
4 required
d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException
object
1 property
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignWebhookPlatform
object
Platform properties.
2 properties
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageBody
object
Body of the message.
1 property
1 required
ApiException
object
1 property
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignAiFeedbackWebhookResponse
object
1 property
bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.ApiKey
object
11 properties
1 required
b1075107f5bba728f6a701eb8a72357dfcf0d9c4405dd06e85e56496153a8d2f.TokenResponse
object
Successful response that indicates OAuth2 token was created.
3 properties
99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.DateTimeInterval
object
2 properties
2 required
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NetworkView
object
Network data.
2 properties
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageBodyType
string
c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.FilledRequirementFeedbackApiDoc
object
Feedback for requirements. Present only for UPDATEREQUESTED and UPDATEREQUESTEDBYINTERNALREVIEWER statuses.
3 properties
40143f8c1273929a779db5eeca48aaeec6583ec5c7f80b29e546fbb75ba02e1d.Item
string
99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.MetricType
string
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PriorityTimeData
object
2 properties
e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.UpdateCatalogDto
object
2 properties
bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.ApiKeys
object
1 property
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.StoredMoConfiguration
object
8 properties
2 required
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PageResponseBrandVet
object
2 properties
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignRegistrar
string
The network a campaign is submitted to.
2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.BlocklistEvent
object
Blocklist event.
4 properties
4 required
6ac22f6f3346b6db1d4c8464d58b1329c30df516bb4206699a93fd8658df38c7.TrustedMsisdnRequest
object
Trusted MSISDN request object.
1 property
1 required
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.ShortCodeUseCase
string
Campaign use case.
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.InteractiveVoiceResponseOptIn
object
The type of opt in that requires a user to record a confirmation.
1 property
1 required
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileRequest
object
Notification profile object holding settings for your webhook URL and a reference to security settings.
1 property
1 required
2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.Content
object
Event content.
7 properties
2 required
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiOutboundEvent
object
Array of event objects of a single event or multiple events sent
1 property
1 required
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandType
string
The type of brand.
99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.TimeBucket
string
c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.TrafficType
string
Type of SMS messages you will send. - TRANSACTIONAL: Messages triggered by user actions or system events, such as one-time passwords (OTP/PIN), transaction ale…
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.UseConversations
object
Used for forwarding messages to Conversations service.
1 property
1 required
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.EmailNoIdSubscriptionRequest
object
Subscription group.
6 properties
2 required
2be764ef53499e28cc8da8dff3890f0787860aba10984e520352c73612c0342b.ModifyApplication
object
1 property
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CertificateDetailsResponse
object
7 properties
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.RcsResourceInfo
object
Information about RCS type of resource.
5 properties
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.OpenChannelResourceInfo
object
Information about Open Channel type of resource.
3 properties
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.NumberPreviews
object
1 property
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.EditPermissions
object
The editPermissions object to indicate editing permissions for the number.
2 properties
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageFooter
object
Footer of the message.
1 property
1 required
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.AppleMessagesForBusinessNoIdSubscriptionRequest
object
Subscription group.
6 properties
2 required
99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.RequestInfo
object
3 properties
2 required
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoActionType
string
Defines action type. It is not possible to create new action type.
2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.ToCreate
object
To.
1 property
1 required
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiEventRequest
object
1 property
1 required
c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.Message
object
15 properties
99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.ErrorCodeGroup
string
Specifies the general error code groups. For the list of possible values, refer to [error codes groups](https://www.infobip.com/docs/essentials/response-status…
8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException
object
1 property
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceCoverageKey
object
1 property
1 required
bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.UpdateApiKeyRequest
object
9 properties
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MmsAction
object
Forward action configuration.
2 properties
99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.BillingUsageAggregate
string
b1075107f5bba728f6a701eb8a72357dfcf0d9c4405dd06e85e56496153a8d2f.OAuthApiException
object
2 properties
bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.UpdateApiKeyRequestV1
object
6 properties
2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.BlocklistEventType
string
Blocklist event type.
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoConfigurations
object
2 properties
99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.ChannelCode
string
Specifies communication channels and/or services. This is a list of available channels/services and their codes: SMS - SMS EMAIL - Email FACEBOOK - Facebook Me…
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleKakaoBrandMessageEvents
string
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.TurkeyIysOptions
object
IYS regulations specific parameters required for sending promotional SMS to phone numbers registered in Turkey.
2 properties
1 required
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandRegistrar
string
The name of the registrar with which the brand has been registered.
40143f8c1273929a779db5eeca48aaeec6583ec5c7f80b29e546fbb75ba02e1d.Action
string
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TollFreeUseCase
string
Campaign use case.
e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.UpdateCatalogValueDto
object
2 properties
2 required
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.UseAnswers
object
Used for forwarding messages to Answers service.
1 property
1 required
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SortDirection
string
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.AppleMessagesForBusinessSubscriptionRequest
object
Subscription group.
7 properties
3 required
c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.RcsRequirementSpecsRequestApiDoc
object
4 properties
3 required
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoConfiguration
object
7 properties
1 required
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SubscriptionPage
object
2 properties
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderResultCta
object
Call-to-action suggestion generated by the campaign builder
2 properties
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.ShortCodeCampaignBuilderResultMessageFlow
object
Campaign message flow for Short Code campaigns
5 properties
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PageResponseBrand
object
2 properties
aa47d40354ee197e21ffad52d2c543bd4f729e250360a844e476aa80deff7b6e.ResendPinRequest
object
2 properties
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.AlphaResourceInfo
object
Information about alphanumeric type of resource.
5 properties
ApiError
object
5 properties
5 required
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ConnectionTestResult
string
Connection test result. Indicates whether the test to connection passed.
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.NumberLookupSubscriptionRequest
object
Subscription group.
7 properties
3 required
2be764ef53499e28cc8da8dff3890f0787860aba10984e520352c73612c0342b.ChannelType
string
The channel for which the resource will be used.
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MmsConfiguration
object
6 properties
1 required
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignAiBuilderWebhookResponse
object
1 property
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderCampaignAttributes
string
Campaign attributes that indicate special content characteristics
5929f45c31f06c29ab1bc6e26caa01575484225e5ef99a2512bee829b646f1c1.PageResponse
object
2 properties
2 required
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CustomerEngagementNoIdSubscriptionRequest
object
Subscription group.
6 properties
2 required
2be764ef53499e28cc8da8dff3890f0787860aba10984e520352c73612c0342b.Entity
object
2 properties
1 required
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PriorityType
string
Type of a priority
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandVetStatusWebhookMessage
object
Incoming events
4 properties
2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.BlocklistCreateRequest
object
Blocklist request.
1 property
1 required
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.DeliveryTimeWindow
object
Sets specific message delivery window outside of which messages won't be delivered. Often, used when there are restrictions on when messages can be sent. The e…
3 properties
1 required
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareBlocklistEvents
object
2 properties
2 required
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SubscriptionEvent
List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for…
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumberResponse
object
17 properties
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.Webhook
object
Webhook configuration.
2 properties
1 required
66067ae938b1b756af79ad29184e7a22de98929ca991ca01a0c74d258f22a0b6.FreeMessagesResponse
object
1 property
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleMmsEvents
string
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiFailover
object
Configuration of a single failover step
4 properties
1 required
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.DeliveryDay
string
Days of the week which are included in the delivery time window. At least one day must be provided. Separate multiple days with a comma.
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.ExternalAutomaticReviewStatus
string
The current status of the AI campaign review.
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareSmsEvents
object
2 properties
2 required
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleOpenChannelEvents
string
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleLineEvents
string
aa47d40354ee197e21ffad52d2c543bd4f729e250360a844e476aa80deff7b6e.StartAuthenticationResponse
object
6 properties
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandRegistrationWebhookContent
object
Event content.
3 properties
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.TransliterationCode
string
The transliteration of your sent message from one script to another. Transliteration is used to replace characters which are not recognized as part of your def…
99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.BillingUsageResult
object
5 properties
2 required
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.InboundDlrChannel
string
Messaging channel used for sending an event. KAKAO, ZALO, VOICE or TELEGRAM can be received with Smart Messaging.
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.VetImportRequest
object
1 property
1 required
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.UnsetOption
string
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…
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.NumberPreview
object
3 properties
c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.AlphaResourceOrderRequestApiDoc
object
8 properties
4 required
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.KakaoCoverageInfo
object
Information about the sender coverage.
6 properties
c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.FilledRequirement
object
List of requirements for the resource.
2 properties
2 required
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.DeliveryTimeZoneResponse
string
Sending time zone. If the value is CUSTOMNOTEDITABLE , then the value is not manageable by API.
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandAppealStatus
string
Current status of the appeal.
bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.CreateApiKeyRequestV1
object
6 properties
1 required
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignNetworkStatusWebhookContent
object
Event content.
3 properties
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CertificateStatusPage
object
2 properties
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.AppleCoverageInfo
object
Information about the sender coverage.
6 properties
c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.ResourceNumberType
string
Type of numbers.
2be764ef53499e28cc8da8dff3890f0787860aba10984e520352c73612c0342b.PageApplication
object
2 properties
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplate
object
Details of the template.
3 properties
1 required
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleAgentOsEvents
string
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Status
string
Current bulk status.
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderRequest
object
Request to start building campaign using AI assistant.
5 properties
5 required
2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.ToDelete
object
To.
1 property
1 required
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.PlatformDocs
object
Platform applicationId and entityId to apply to inbound messages that pair to this configuration. If not provided, or if set to default values (applicationId =…
2 properties
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.NumberLookupNoIdSubscriptionRequest
object
Subscription group.
6 properties
2 required
99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.Platform
object
Specifies the platform object, which is a combination of an applicationId and entityId. These IDs uniquely identify each application and entity configured on t…
2 properties
c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.FilledRequirementFeedback
object
List of feedback for requirements.
3 properties
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiInboundEvent
object
Incoming messages
1 property
1 required
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicCnamStorageStatus
object
Current status of CNAM Storage configuration.
2 properties
2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.BlocklistGetResponse
object
Blocklist get response.
2 properties
2 required
99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.BillingUsageQueryOptions
object
Optional settings that control data completeness, such as whether to include billing data where volumes have not yet been finalized.
1 property
2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.CreatableChannel
string
Channel used for sending for which blocklist happened.
6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CredentialsPayload
object
Webhook security credentials.
899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateHeaderType
string
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderResultData
object
Campaign builder result data. The structure varies based on the campaign type.
4 properties
7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.DayOfWeek
string
Days which are included in the delivery time window.
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.WebhookBrandVetStatus
string
The new brand vet status.
2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.CampaignReference
object
Campaign reference, if matched by the Infobip platform.
3 properties
2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandVetStatusWebhookResponse
object
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Infobip 5
Other APIs Infobip publishes across the network.
Infobip AI Hub API
Infobip Channels API
Infobip Connectivity API
Infobip Customer Engagement API
Infobip Tools API
#Platform
Where this information came from
This is an independent, third-party profile of Infobip Platform API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.