Infobip Channels API
Create a perfect customer experience by using the channels your customer already use and love.
Infobip Channels API is one of 6 APIs that Infobip publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Channels. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 455 operations across 346 paths, and defines 1900 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.
455 operations
346 paths
1900 schemas
46 DELETE180 GET1 HEAD12 PATCH185 POST31 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 4
Infobip Channels 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 455
Across 346 paths, the API surfaces 455 operations — 46 DELETE, 180 GET, 1 HEAD, 12 PATCH, 185 POST, 31 PUT. Each is listed below with its method, path, parameters, and response codes.
channels 455
Create a perfect customer experience by using the channels your customer already use and love.
POST
/sms/3/messages
Send SMS message
GET
/sms/3/text/query
Send SMS message over query parameters
GET
/sms/1/text/querydeprecated
Send SMS message over query parameters
POST
/sms/1/preview
Preview SMS message
POST
/sms/2/text/advanced
Send SMS message
POST
/sms/2/binary/advanced
Send binary SMS message
GET
/sms/1/bulks
Get scheduled SMS messages
PUT
/sms/1/bulks
Reschedule SMS messages
GET
/sms/1/bulks/status
Get scheduled SMS messages status
PUT
/sms/1/bulks/status
Update scheduled SMS messages status
POST
/ct/1/log/end/{messageId}
Confirm conversion
GET
/sms/1/inbox/reports
Get inbound SMS messages
GET
/sms/3/reports
Get outbound SMS message delivery reports
GET
/sms/3/logs
Get outbound SMS message logs
GET
/sms/1/reports
Get outbound SMS message delivery reports
GET
/sms/1/logsdeprecated
Get outbound SMS message logs
POST
/mms/2/messages
Send MMS messages
POST
/mms/1/advanceddeprecated
Send MMS message
POST
/mms/1/content
Upload binary content
GET
/mms/1/inbox/reports
Get inbound MMS messages
GET
/mms/2/reports
Get MMS delivery reports
GET
/mms/1/reportsdeprecated
Get outbound MMS message delivery reports
GET
/mms/2/logs
Get MMS message logs
GET
/mms/1/logsdeprecated
Get outbound MMS message logs
GET
/calls/1/configurations
Get calls configurations
POST
/calls/1/configurations
Create calls configuration
GET
/calls/1/configurations/{callsConfigurationId}
Get calls configuration
PUT
/calls/1/configurations/{callsConfigurationId}
Update calls configuration
DELETE
/calls/1/configurations/{callsConfigurationId}
Delete calls configuration
GET
/calls/1/calls
Get calls
POST
/calls/1/calls
Create call
GET
/calls/1/calls/{callId}
Get call
GET
/calls/1/calls/history
Get calls history
GET
/calls/1/calls/{callId}/history
Get call history
POST
/calls/1/connect
Connect calls
POST
/calls/1/calls/{callId}/connect
Connect with new call
POST
/calls/1/calls/{callId}/send-ringing
Send ringing
POST
/calls/1/calls/{callId}/pre-answer
Pre-answer
POST
/calls/1/calls/{callId}/answer
Answer
POST
/calls/1/calls/{callId}/hangup
Hangup
POST
/calls/1/calls/{callId}/play
Play file
POST
/calls/1/calls/{callId}/stop-play
Stop playing file
POST
/calls/1/calls/{callId}/say
Say text
POST
/calls/1/calls/{callId}/send-dtmf
Send DTMF
POST
/calls/1/calls/{callId}/capture/dtmf
Capture DTMF
POST
/calls/1/calls/{callId}/capture/speech
Capture Speech
POST
/calls/1/calls/{callId}/start-transcription
Start transcription
POST
/calls/1/calls/{callId}/stop-transcription
Stop transcription
POST
/calls/1/calls/{callId}/start-recording
Start recording
POST
/calls/1/calls/{callId}/stop-recording
Stop recording
POST
/calls/1/calls/{callId}/start-media-stream
Start streaming media
POST
/calls/1/calls/{callId}/stop-media-stream
Stop streaming media
POST
/calls/1/calls/{callId}/send-message
Send message
POST
/calls/1/calls/{callId}/application-transfer
Request application transfer
POST
/calls/1/calls/{callId}/application-transfer/{transferId}/accept
Accept application transfer
POST
/calls/1/calls/{callId}/application-transfer/{transferId}/reject
Reject application transfer
GET
/calls/1/conferences
Get conferences
POST
/calls/1/conferences
Create conference
GET
/calls/1/conferences/{conferenceId}
Get conference
PATCH
/calls/1/conferences/{conferenceId}
Update all calls
GET
/calls/1/conferences/history
Get conferences history
GET
/calls/1/conferences/{conferenceId}/history
Get conference history
POST
/calls/1/conferences/{conferenceId}/call
Add new call
PUT
/calls/1/conferences/{conferenceId}/call/{callId}
Add existing call
DELETE
/calls/1/conferences/{conferenceId}/call/{callId}
Remove call
PATCH
/calls/1/conferences/{conferenceId}/call/{callId}
Update call
POST
/calls/1/conferences/{conferenceId}/hangup
Hangup conference
POST
/calls/1/conferences/{conferenceId}/play
Play file
POST
/calls/1/conferences/{conferenceId}/stop-play
Stop playing file
POST
/calls/1/conferences/{conferenceId}/say
Say text
POST
/calls/1/conferences/{conferenceId}/start-recording
Start recording
POST
/calls/1/conferences/{conferenceId}/stop-recording
Stop recording
POST
/calls/1/conferences/{conferenceId}/broadcast-webrtc-textdeprecated
Broadcast text
POST
/calls/1/conferences/{conferenceId}/send-message
Send message
GET
/calls/1/dialogs
Get dialogs
POST
/calls/1/dialogs
Create dialog
POST
/calls/1/dialogs/parent-call/{parentCallId}/child-call/{childCallId}
Create dialog with existing calls
GET
/calls/1/dialogs/{dialogId}
Get dialog
GET
/calls/1/dialogs/history
Get dialogs history
GET
/calls/1/dialogs/{dialogId}/history
Get dialog history
POST
/calls/1/dialogs/{dialogId}/hangup
Hangup dialog
POST
/calls/1/dialogs/{dialogId}/play
Play file
POST
/calls/1/dialogs/{dialogId}/say
Say text
POST
/calls/1/dialogs/{dialogId}/stop-play
Stop playing file
POST
/calls/1/dialogs/{dialogId}/start-recording
Start recording
POST
/calls/1/dialogs/{dialogId}/stop-recording
Stop recording
POST
/calls/1/dialogs/{dialogId}/broadcast-webrtc-textdeprecated
Broadcast text
POST
/calls/1/dialogs/{dialogId}/send-message
Send message
POST
/calls/1/dialogs/{dialogId}/transfer/accept
Dialog transfer accept
POST
/calls/1/dialogs/{dialogId}/transfer/reject
Dialog transfer reject
GET
/calls/1/sip-trunks
Get SIP trunks
POST
/calls/1/sip-trunks
Create SIP trunk
GET
/calls/1/sip-trunks/{sipTrunkId}
Get SIP trunk
PUT
/calls/1/sip-trunks/{sipTrunkId}
Update SIP trunk
DELETE
/calls/1/sip-trunks/{sipTrunkId}
Delete SIP trunk
POST
/calls/1/sip-trunks/{sipTrunkId}/reset-password
Reset SIP trunk credentials
GET
/calls/1/sip-trunks/{sipTrunkId}/status
Get SIP trunk status
POST
/calls/1/sip-trunks/{sipTrunkId}/status
Set SIP trunk status
GET
/calls/1/sip-trunks/service-addresses
Get SIP trunk service addresses
POST
/calls/1/sip-trunks/service-addresses
Create SIP trunk service address
GET
/calls/1/sip-trunks/service-addresses/{sipTrunkServiceAddressId}
Get SIP trunk service address
PUT
/calls/1/sip-trunks/service-addresses/{sipTrunkServiceAddressId}
Update SIP trunk service address
DELETE
/calls/1/sip-trunks/service-addresses/{sipTrunkServiceAddressId}
Delete SIP trunk service address
GET
/calls/1/sip-trunks/service-addresses/countries
Get countries
GET
/calls/1/sip-trunks/service-addresses/countries/regions
Get regions
GET
/calls/1/files
Get files
POST
/calls/1/files
Upload audio file
GET
/calls/1/files/{fileId}
Get file
DELETE
/calls/1/files/{fileId}
Delete file
GET
/calls/1/recordings/calls
Get calls recordings
GET
/calls/1/recordings/calls/{callId}
Get call recordings
DELETE
/calls/1/recordings/calls/{callId}
Delete call recordings
GET
/calls/1/recordings/conferences
Get conferences recordings
GET
/calls/1/recordings/conferences/{conferenceId}
Get conference recordings
DELETE
/calls/1/recordings/conferences/{conferenceId}
Delete conference recordings
POST
/calls/1/recordings/conferences/{conferenceId}/compose
Compose conference recording on calls
GET
/calls/1/recordings/dialogs
Get dialogs recordings
GET
/calls/1/recordings/dialogs/{dialogId}
Get dialog recordings
DELETE
/calls/1/recordings/dialogs/{dialogId}
Delete dialog recordings
POST
/calls/1/recordings/dialogs/{dialogId}/compose
Compose dialog recording on calls
GET
/calls/1/recordings/files/{fileId}
Download recording file
DELETE
/calls/1/recordings/files/{fileId}
Delete recording file
GET
/calls/1/media-stream-configs
Get media-stream configs
POST
/calls/1/media-stream-configs
Create a media-stream configuration
GET
/calls/1/media-stream-configs/{mediaStreamConfigId}
Get media-stream configuration
PUT
/calls/1/media-stream-configs/{mediaStreamConfigId}
Update a media-stream configuration
DELETE
/calls/1/media-stream-configs/{mediaStreamConfigId}
Delete a media-stream configuration
POST
/calls/1/bulks
Create bulk of calls
GET
/calls/1/bulks/{bulkId}
Get bulk status
POST
/calls/1/bulks/{bulkId}/reschedule
Reschedule
POST
/calls/1/bulks/{bulkId}/pause
Pause
POST
/calls/1/bulks/{bulkId}/resume
Resume
POST
/calls/1/bulks/{bulkId}/cancel
Cancel
POST
/markuplanguage/1/create
Create markup language call.
GET
/markuplanguage/1/config
Get markup language configurations
POST
/markuplanguage/1/config
Create a markup language configuration
GET
/markuplanguage/1/config/{configId}
Get a markup language configuration
PUT
/markuplanguage/1/config/{configId}
Update a markup language configuration
DELETE
/markuplanguage/1/config/{configId}
Delete a markup language configuration
POST
/tts/3/single
Send single voice message
POST
/tts/3/multi
Send multiple voice messages
POST
/tts/3/advanced
Send advanced voice message
GET
/tts/3/voices/{language}
Get Voices
GET
/tts/3/bulks
Get sent bulks
PUT
/tts/3/bulks
Reschedule sent bulk
GET
/tts/3/bulks/status
Get sent bulk's status
PUT
/tts/3/bulks/status
Manage sent bulk's status
GET
/voice/ivr/1/scenarios
Search Voice IVR Scenarios
POST
/voice/ivr/1/scenarios
Create Voice IVR Scenarios
GET
/voice/ivr/1/scenarios/{id}
Get a Voice IVR Scenario
PUT
/voice/ivr/1/scenarios/{id}
Update Voice IVR Scenarios
DELETE
/voice/ivr/1/scenarios/{id}
Delete Voice IVR Scenarios
POST
/voice/ivr/1/messages
Launch IVR Scenario
GET
/voice/ivr/1/files
Search Voice IVR Recorded Files
GET
/voice/ivr/1/files/{id}
Download Voice IVR Recorded File.
GET
/voice/ivr/1/uploads
Get files
POST
/voice/ivr/1/uploads
Upload file
POST
/voice/ctc/1/send
Send click-to-call message
GET
/voice/1/reports
Get Voice Delivery Reports
GET
/tts/3/reportsdeprecated
Get Voice Delivery Reports
GET
/tts/3/logs
Get sent Voice logs
GET
/voice/masking/2/config
Get number masking configurations
POST
/voice/masking/2/config
Create number masking configuration
GET
/voice/masking/2/config/{key}
Get number masking configuration
PUT
/voice/masking/2/config/{key}
Update number masking configuration
DELETE
/voice/masking/2/config/{key}
Delete number masking configuration
POST
/voice/masking/1/upload
Upload audio files
GET
/voice/masking/2/credentials
Get number masking credentials
PUT
/voice/masking/2/credentials
Update number masking credentials
POST
/voice/masking/2/credentials
Create number masking credentials
DELETE
/voice/masking/2/credentials
Delete number masking credentials
GET
/callrouting/1/routes
Get call routes
POST
/callrouting/1/routes
Create a call route
GET
/callrouting/1/routes/{routeId}
Get a call route
PUT
/callrouting/1/routes/{routeId}
Update a call route
DELETE
/callrouting/1/routes/{routeId}
Delete a call route
PATCH
/callrouting/1/routes/{routeId}
Set order on call route
GET
/callrouting/1/recordings
Get recordings
DELETE
/callrouting/1/recordings
Delete by correlation ID
GET
/callrouting/1/recordings/files/{fileId}
Download recording file
POST
/callrouting/1/routes/{routeId}/status
Update route status
POST
/callrouting/1/routes/simulate
Simulate route selection
POST
/webrtc/1/token
Generate WebRTC Token
GET
/webrtc/1/webrtc-push-config
Get WebRTC push configurations
POST
/webrtc/1/webrtc-push-config
Create WebRTC push configuration
GET
/webrtc/1/webrtc-push-config/{id}
Get WebRTC push configuration
PUT
/webrtc/1/webrtc-push-config/{id}
Update WebRTC push configuration
DELETE
/webrtc/1/webrtc-push-config/{id}
Delete WebRTC push configuration
PATCH
/webrtc/1/webrtc-push-config/{id}
Patch WebRTC push configuration
GET
/webrtc/1/files
Get files
GET
/webrtc/1/files/{id}
Get file
DELETE
/webrtc/1/files/{id}
Delete file
GET
/webrtc/1/files/{id}/download
Download file
GET
/webrtc/1/user-activity
Get WebRTC user activity
GET
/webrtc/1/recordings
Get WebRTC recordings
DELETE
/webrtc/1/recordings/{id}
Delete WebRTC recording by ID
GET
/webrtc/1/recordings/{id}/download
Download WebRTC recording file
GET
/call-link/1/links
Get call links
POST
/call-link/1/links
Create call link
GET
/call-link/1/links/{id}
Get call link
DELETE
/call-link/1/links/{id}
Delete call link
GET
/call-link/1/configs
Get configurations
POST
/call-link/1/configs
Create configuration
GET
/call-link/1/configs/{id}
Get configuration
PUT
/call-link/1/configs/{id}
Update a configuration
DELETE
/call-link/1/configs/{id}
Delete configuration
PATCH
/call-link/1/configs/{id}
Partial configuration update
GET
/call-link/1/images
Get images
POST
/call-link/1/images/upload/{type}
Upload image
GET
/call-link/1/images/{id}
Get image
DELETE
/call-link/1/images/{id}
Delete image
GET
/call-link/1/subdomains
Get subdomains
POST
/call-link/1/subdomains
Create subdomain
DELETE
/call-link/1/subdomains/{id}
Delete subdomain
GET
/call-link/1/recordings
Get call link recordings
DELETE
/call-link/1/recordings/{id}
Delete call link recording
GET
/call-link/1/recordings/files/{fileId}
Download a recording file
POST
/email/4/messages
Send email messages
POST
/email/1/content
Upload binary content
POST
/email/3/send
Send fully featured email
POST
/email/4/mime
Send MIME email
GET
/email/1/bulks
Get scheduled bulks
PUT
/email/1/bulks
Reschedule messages
GET
/email/1/bulks/status
Get scheduled bulk statuses
PUT
/email/1/bulks/status
Update scheduled message statuses
GET
/email/4/logs
Get email message logs
GET
/email/4/reports
Get email delivery reports
GET
/email/1/logs
Get email message logs
GET
/email/1/reports
Get email delivery reports
POST
/email/2/validation
Validate email address
GET
/email/2/validations
Get email validations
POST
/email/2/validations
Validate email addresses
GET
/email/1/domains
Get domains
POST
/email/1/domains
Add domain
GET
/email/1/domains/{domainName}
Get domain details
DELETE
/email/1/domains/{domainName}
Delete domain
PUT
/email/1/domains/{domainName}/tracking
Update domain tracking events
POST
/email/1/domains/{domainName}/verify
Verify domain
GET
/email/1/suppressions
Get suppressions
POST
/email/1/suppressions
Add suppressions
DELETE
/email/1/suppressions
Delete suppressions
GET
/email/1/suppressions/domains
Get suppression domains
GET
/email/1/ip-management/ips
Get IPs
POST
/email/1/ip-management/ips/commission
Commission IP
GET
/email/1/ip-management/ips/{ipId}
Get IP
DELETE
/email/1/ip-management/ips/{ipId}
Decommission IP
GET
/email/1/ip-management/pools
Get IP pools
POST
/email/1/ip-management/pools
Create IP pool
GET
/email/1/ip-management/pools/{poolId}
Get IP pool
PUT
/email/1/ip-management/pools/{poolId}
Update IP pool
DELETE
/email/1/ip-management/pools/{poolId}
Delete IP pool
POST
/email/1/ip-management/pools/{poolId}/ips
Assign IP to pool
DELETE
/email/1/ip-management/pools/{poolId}/ips/{ipId}
Unassign IP from pool
GET
/email/1/ip-management/paginated/ips
Get IPs (paginated)
GET
/email/1/ip-management/paginated/pools
Get IP pools (paginated)
GET
/email/1/ip-management/domains/{domainId}
Get domain
POST
/email/1/ip-management/domains/{domainId}/pools
Assign IP pool to domain
PUT
/email/1/ip-management/domains/{domainId}/pools/{poolId}
Update IP pool sending priority
DELETE
/email/1/ip-management/domains/{domainId}/pools/{poolId}
Unassign IP pool from domain
GET
/email/1/templates
Get email templates
POST
/email/1/templates
Create email template
GET
/email/1/templates/{templateId}
Get email template
PUT
/email/1/templates/{templateId}
Update email template
DELETE
/email/1/templates/{templateId}
Delete email template
PATCH
/email/1/templates/{templateId}
Patch email template
POST
/email/1/templates/{templateId}/preview
Generate email template preview
GET
/email/1/templates/{templateId}/attachments
Get email template attachments
POST
/email/1/templates/{templateId}/attachments
Upload email template attachment
DELETE
/email/1/templates/{templateId}/attachments/{attachmentId}
Delete email template attachment
POST
/whatsapp/1/message/template
Send WhatsApp template message
POST
/whatsapp/1/message/text
Send WhatsApp text message
POST
/whatsapp/1/message/document
Send WhatsApp document message
POST
/whatsapp/1/message/image
Send WhatsApp image message
POST
/whatsapp/1/message/audio
Send WhatsApp audio message
POST
/whatsapp/1/message/video
Send WhatsApp video message
POST
/whatsapp/1/message/sticker
Send WhatsApp sticker message
POST
/whatsapp/1/message/location
Send WhatsApp location message
POST
/whatsapp/1/message/contact
Send WhatsApp contact message
POST
/whatsapp/1/message/interactive/buttons
Send WhatsApp interactive buttons message
POST
/whatsapp/1/message/interactive/list
Send WhatsApp interactive list message
POST
/whatsapp/1/message/interactive/media-carousel
Send WhatsApp interactive media carousel message
POST
/whatsapp/1/message/interactive/location-request
Send WhatsApp interactive location request message
POST
/whatsapp/1/message/interactive/product
Send WhatsApp interactive product message
POST
/whatsapp/1/message/interactive/multi-product
Send WhatsApp interactive multi-product message
POST
/whatsapp/1/message/interactive/order-details
Send WhatsApp interactive order-details message
POST
/whatsapp/1/message/interactive/order-status
Send WhatsApp interactive order-status message
POST
/whatsapp/1/message/interactive/flow
Send WhatsApp interactive flow message
POST
/whatsapp/1/message/interactive/url-button
Send WhatsApp interactive url button message
POST
/whatsapp/1/message/interactive/call-permission-request
Send WhatsApp interactive call permission request message
POST
/whatsapp/1/message/interactive/voice-button
Send WhatsApp interactive voice button message
POST
/whatsapp/1/message/interactive/in-thread-authentication-request
Send WhatsApp interactive in-thread authentication request message
POST
/whatsapp/1/message/interactive/request-contact-info
Send WhatsApp interactive request contact info message
POST
/whatsapp/1/events
Send WhatsApp events
GET
/whatsapp/1/senders/{sender}/media/{mediaId}
Download inbound media
HEAD
/whatsapp/1/senders/{sender}/media/{mediaId}
Get media metadata
POST
/whatsapp/1/senders/{sender}/message/{messageId}/read
Mark as read
GET
/whatsapp/1/senders/{sender}/payments/upi/payu/{paymentId}
Get India UPI PayU payment status
GET
/whatsapp/1/senders/{sender}/payments/br/{paymentId}
Get Brazil payment status
GET
/whatsapp/1/senders/{sender}/payments/upi/{paymentId}
Get India UPI PayU/Razorpay payment status
GET
/whatsapp/2/senders/{sender}/templates
Get WhatsApp Templates
POST
/whatsapp/2/senders/{sender}/templates
Create WhatsApp Template
DELETE
/whatsapp/2/senders/{sender}/templates/{templateName}
Delete WhatsApp Template
GET
/whatsapp/2/senders/{sender}/templates/{id}
Get WhatsApp Template
PATCH
/whatsapp/2/senders/{sender}/templates/{id}
Edit WhatsApp Template
GET
/whatsapp/1/senders/{sender}/templatesdeprecated
Get WhatsApp Templates
POST
/whatsapp/1/senders/{sender}/templatesdeprecated
Create WhatsApp Template
GET
/whatsapp/1/templates
Get account WhatsApp templates
GET
/whatsapp/1/senders/{sender}/flows
Get WhatsApp Flows
POST
/whatsapp/1/senders/{sender}/flows
Create WhatsApp Flow
DELETE
/whatsapp/1/senders/{sender}/flows/{flowId}
Delete WhatsApp Flow
PATCH
/whatsapp/1/senders/{sender}/flows/{flowId}
Update WhatsApp Flow
POST
/whatsapp/1/senders/{sender}/flows/{flowId}/publish
Publish WhatsApp Flow
GET
/whatsapp/1/senders/{sender}/flows/{flowId}/json
Get WhatsApp Flow JSON
PUT
/whatsapp/1/senders/{sender}/flows/{flowId}/json
Add WhatsApp Flow JSON
POST
/whatsapp/1/senders/{sender}/flows/{flowId}/deprecate
Deprecate WhatsApp Flow
GET
/whatsapp/1/senders/{sender}/flows/{flowId}/preview
Get WhatsApp Flow's preview
POST
/whatsapp/1/senders/{sender}/flows/generate
Generate WhatsApp Flow
DELETE
/whatsapp/1/senders/{sender}/media
Delete media
GET
/whatsapp/1/senders/quality
Get quality information of WhatsApp senders
GET
/whatsapp/1/senders/{sender}/business-info
Get business info of WhatsApp sender
PATCH
/whatsapp/1/senders/{sender}/business-info
Update business info of WhatsApp sender
GET
/whatsapp/1/senders/{sender}/business-info/logo
Download business logo of WhatsApp sender
GET
/whatsapp/1/senders/{sender}/calls/{userNumber}/permissions
Get calling permission
GET
/whatsapp/1/senders/{sender}/public-key
Get WhatsApp sender public key
POST
/whatsapp/1/senders/{sender}/public-key
Upload WhatsApp sender public key
POST
/whatsapp/1/embedded-signup/registrations/business-account/{businessAccountId}/senders
Add WhatsApp sender
PUT
/whatsapp/1/embedded-signup/registrations/senders/{sender}/verification
Retry WhatsApp sender verification
POST
/whatsapp/1/embedded-signup/registrations/senders/{sender}/verification
Verify WhatsApp sender
GET
/whatsapp/1/{sender}/contacts/{userNumber}/identity
Get identity
PUT
/whatsapp/1/{sender}/contacts/{userNumber}/identity
Confirm identity
DELETE
/whatsapp/1/{sender}/contacts/{userNumber}/identity
Delete identity
POST
/whatsapp/1/conversions
Submit conversions
POST
/whatsapp/1/conversions/waba
Submit WABA conversions
POST
/viber/2/messages
Send Viber messages
POST
/viber/1/message/textdeprecated
Send Viber text message(s)
POST
/viber/1/message/imagedeprecated
Send Viber image message
POST
/viber/1/message/filedeprecated
Send Viber file message
POST
/viber/1/message/videodeprecated
Send Viber video message
GET
/viber/2/reports
Get Viber delivery reports
GET
/viber/2/logs
Get Viber message logs
GET
/viber/1/senders/{sender}/templates
Get Viber templates
POST
/viber/1/senders/{sender}/templates
Create Viber template
GET
/viber/1/senders/{sender}/templates/{templateId}
Get Viber template
DELETE
/viber/1/senders/{sender}/templates/{templateId}
Delete Viber template
POST
/viber-bot/1/messages
Send a Viber Bot message
GET
/viber-bot/1/logs
Get outbound Viber bot message logs
GET
/viber-bot/1/reports
Get Viber Bot delivery reports
POST
/line/1/messages
Send a LINE message
GET
/line/1/reports
Get LON delivery reports
POST
/zalo/2/messages
Send Zalo messages
GET
/zalo/1/logs
Get Zalo logs
GET
/zalo/1/sender/{sender}/templates
Get Zalo templates
GET
/zalo/1/sender/{sender}/templates/{templateName}
Get Zalo template
PUT
/zalo/2/sender/{sender}/templates
Edit Zalo template
POST
/zalo/2/sender/{sender}/templates
Create Zalo template
POST
/zalo/1/sender/{sender}/media
Upload Zalo media
GET
/zalo/1/sender/{sender}/quota
Get Zalo quota
GET
/zalo/1/sender/{sender}/public-key
Get Zalo sender public key
POST
/zalo/1/sender/{sender}/public-key
Create Zalo sender public key
POST
/push/2/message/singledeprecated
Send single Push notification
POST
/push/2/message/multideprecated
Send multiple Push notifications
POST
/push/3/messages
Send Push notifications
GET
/push/1/applications
Get push applications
GET
/push/1/applications/{applicationCode}
Get push Application by applicationCode
GET
/push/1/statistics
Get Push statistics
GET
/push/1/reports
Get Push reports
GET
/push/1/inbox/reports
Receive MO Push messages
GET
/push/3/reports
Get Push delivery reports
GET
/push/3/logs
Get Push message logs
GET
/push/1/applications/{applicationCode}/configurations
List all configurations
POST
/push/1/applications/{applicationCode}/configurations
Create a new configuration
GET
/push/1/applications/{applicationCode}/configurations/{configurationKey}
Get a single configuration
DELETE
/push/1/applications/{applicationCode}/configurations/{configurationKey}
Delete the configuration
GET
/push/1/applications/{applicationCode}/configurations/{configurationKey}/actions
List all actions
POST
/push/1/applications/{applicationCode}/configurations/{configurationKey}/actions
Create new action
DELETE
/push/1/applications/{applicationCode}/configurations/{configurationKey}/actions/{actionKey}
Delete action
DELETE
/push/1/inbox/messages
Delete Push Inbox messages
DELETE
/push/1/user/{externalUserId}/inbox/messages
Delete Push Inbox message for a specific user
POST
/rcs/2/messages
Send RCS messages
POST
/ott/rcs/1/messagedeprecated
Send RCS message
POST
/ott/rcs/1/message/bulkdeprecated
Send bulk RCS message
POST
/ott/rcs/1/message/templatedeprecated
Send RCS template message
POST
/ott/rcs/1/message/template/bulkdeprecated
Send bulk RCS template message
POST
/rcs/1/events
Send RCS events
GET
/rcs/2/reports
Get RCS delivery reports
GET
/rcs/2/logs
Get RCS message logs
POST
/rcs/2/capability-check/query
Check RCS capability
POST
/rcs/2/capability-check/notify
Check RCS capability (async)
GET
/rcs/1/senders
Get RCS senders
POST
/rcs/1/senders
Create an RCS sender
GET
/rcs/1/senders/{senderName}
Get RCS sender
PUT
/rcs/1/senders/{senderName}
Update an RCS sender
PATCH
/rcs/1/senders/{senderName}/platform-parameters
Update RCS sender platform parameters
GET
/rcs/1/senders/{senderName}/launch-status
Get RCS sender launch status
GET
/rcs/1/senders/providers
Get RCS available providers
GET
/rcs/1/senders/{senderName}/test-numbers
Get RCS test numbers
POST
/rcs/1/senders/{senderName}/test-numbers
Add RCS test number
GET
/rcs/1/senders/{senderName}/test-numbers/{testNumber}
Get RCS test number
PATCH
/rcs/1/senders/{senderName}/test-numbers/{testNumber}
Update primary flag of RCS test number
PUT
/rcs/1/senders/{senderName}/test-numbers/{testNumber}/refresh
Refresh RCS test number
GET
/rcs/1/senders/{sender}/templates
Get RCS templates
POST
/rcs/1/senders/{sender}/templates
Create an RCS template
GET
/rcs/1/senders/{sender}/templates/{templateName}
Get RCS template
PUT
/rcs/1/senders/{sender}/templates/{templateName}
Edit an RCS template
POST
/rcs/1/senders/{sender}/templates/{templateName}deprecated
Create an RCS template
DELETE
/rcs/1/senders/{sender}/templates/{templateName}
Delete an RCS template
GET
/rcs/1/senders/{sender}/templates/{templateName}/status
Get RCS template status
PATCH
/rcs/1/senders/{sender}/templates/{templateName}/register
Register an RCS template
GET
/rcs/1/templates/template-providers
Get RCS template providers
GET
/omni/1/scenarios
List all OMNI failover scenarios
POST
/omni/1/scenarios
Create new OMNI failover scenario
GET
/omni/1/scenarios/{scenarioKey}
Get specific OMNI failover scenario
PUT
/omni/1/scenarios/{scenarioKey}
Update OMNI failover scenario
POST
/omni/1/advanced
Send OMNI failover message
GET
/omni/1/reports
Get OMNI failover delivery reports
GET
/omni/1/logs
Get OMNI failover message logs
DELETE
/livechat/1/widgets/{widgetId}/sessions/{sessionId}
Invalidate customer session
POST
/apple-mfb/1/messages
Send Apple Messages for Business
POST
/apple-mfb/1/events
Send Apple Events
GET
/apple-mfb/1/reports
Get Apple Messages for Business delivery reports
GET
/apple-mfb/1/logs
Get message logs
POST
/instagram/1/messages
Send a Instagram message
GET
/instagram/1/reports
Get Instagram delivery reports
GET
/instagram/1/logs
Get outbound Instagram message logs
POST
/messenger/1/messages
Send a Messenger message
GET
/messenger/1/reports
Get Messenger delivery reports
GET
/messenger/1/logs
Get outbound Messenger message logs
GET
/messenger/1/pages/{pageId}/subscriptions
Get marketing subscriptions
GET
/messenger/1/campaigns
Get campaigns
POST
/messenger/1/campaigns
Create campaign
DELETE
/messenger/1/campaigns/{campaignId}
Delete campaign
GET
/messenger/1/ad-accounts
Get ad accounts
GET
/messenger/1/audiences
Get audiences
POST
/messenger/1/audiences
Create custom audience
DELETE
/messenger/1/audiences/{audienceId}
Delete audience
POST
/messenger/1/audiences/{audienceId}/users
Upload users to audience
DELETE
/messenger/1/audiences/{audienceId}/users/{hashedPhoneNumber}
Remove user from audience
POST
/kakao-alim/1/messages
Send a Kakao Alim message
GET
/kakao-alim/1/reports
Get Kakao Alim delivery reports
GET
/kakao-alim/1/logs
Get outbound Kakao Alim message logs
POST
/kakao-sangdam/1/messages
Send a Kakao Sangdam message
GET
/kakao-sangdam/1/reports
Get Kakao Sangdam delivery reports
GET
/kakao-sangdam/1/logs
Get outbound Kakao Sangdam message logs
POST
/kakao-chingu/1/messages
Send a brand message
GET
/kakao-chingu/1/reports
Get brand message delivery reports
GET
/kakao-chingu/1/logs
Get message logs
GET
/kakao-brand-messages/1/templates
Get Brand Message templates
POST
/kakao-brand-messages/1/templates
Create Brand Message template
GET
/kakao-brand-messages/1/templates/single
Get Brand Message template
PUT
/kakao-brand-messages/1/templates/{templateCode}
Update Brand Message template
POST
/open-channel/1/messages/inbound
Send Open Channel inbound message
POST
/tiktok/1/messages
Send TikTok messages
POST
/tiktok/1/events
Send TikTok events
GET
/tiktok/1/reports
Get TikTok delivery reports
GET
/tiktok/1/logs
Get TikTok message logs
Schemas 1900
The contract defines 1900 schemas that model the data the API accepts and returns. The most detailed are 34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.SendRequestSchema (37 properties), 431fb79b0e816230968e14ba1e1c6fadb75cfde9cb3c381f4217b2777f48153f.CallLog (24 properties), 287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.AdvancedTtsApiMessage (24 properties), be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushUnificationMessageOptions (23 properties). Each schema is shown below with its type and property counts.
0a37b8c521b3309d1bbd0669d19fc7f2f157d68a68747b5e7ad23e5b0f5e47e8.OpenChannelMessageBodyType
string
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ImageContent
object
The content object to build a message that will be sent.
2 properties
1 required
14b5f31f4f292db4a32c4e61928f9a47f8ff4c0a1c06a38af2c29ef9ca05095d.DialogBroadcastWebrtcTextRequest
object
1 property
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.TransliterationCode
string
The transliteration of your sent message from one script to another. [Transliteration](https://www.infobip.com/docs/sms/languagesms-transliteration) is used to…
1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.SpeedLimitTimeUnit
string
The time unit to define when setting a messaging speed limit. Defaults to MINUTE.
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.RecipientType
string
Recipient Type must be TACIR or BIREYSEL.
255235e6822dc92d5cc7957b8b662dded0a769ad7b7082a765f4f30895636e11.ApiException
object
1 property
8cb345d2b2e2a0cd5a7383bf2012768938eaa465c6e4f6554958ac7f4a58aa3f.V1TemplatePublicApiRequest
object
4 properties
4 required
7916e19109f991cfe966f390ef0d36117967291fa90eff57d8c8cb768f38352e.Direction
string
Call direction.
382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.CursorPageInfo
object
Cursor information.
2 properties
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsWebhookDeliveryReports
object
1 property
e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Status
object
Indicates whether the message is successfully sent, not sent, delivered, not delivered, waiting for delivery or any other possible status.
6 properties
382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.DeliveryTime
object
The exact time of the day. The time is expressed in the UTC time zone.
2 properties
2 required
0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.Context
object
Information about the message to which the end user responded.
3 properties
3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.CursorPageInfo
object
Cursor information.
2 properties
46339420b556d1893a150250c0e3220eb8057cd2fc4110e601753f705fc1f8c4.MoReport
object
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ValidityPeriodTimeUnit
string
Message validity period time unit.
382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.RecipientType
string
Recipient Type must be TACIR or BIREYSEL.
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsMessage
object
An array of message objects of a single message or multiple messages sent under one bulk ID.
5 properties
2 required
e7089e7463ca9bbf5ccd1fc35b7db93dfead631972de2930bb5def17a2b45bf6.ApiException
object
1 property
58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.CreateTemplateRequest
object
5 properties
2 required
c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderPageResponse
object
2 properties
2 required
91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.ResponseEnvelopeMessageResponseMessageResponseDetails
object
2 properties
1 required
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.SeenReport
object
Collection of reports, one per every message.
8 properties
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BillingPackage
object
Billing package.
3 properties
1 required
e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.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
94dad8b938c4159f751dc1ff0b70e7beab7409955ce0b31399dbe9488973d3a6.DtmfSendRequest
object
2 properties
1 required
60d0e6d5cbcf8382b5a6bad1f38781f71991c7ea63dad2e6ec22ddc8893af51c.DialCallbackRequest
object
Markup Language dial callback request object. Sent to the callback URL configured on the Dial instruction once the dial endpoint has been processed. Extends th…
7 properties
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingLocation
string
e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.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
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Role
object
Represents the role of the call inside the conference.
1 property
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.DeliveryReports
object
1 property
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsMessageContent
object
Message content.
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsImporterAddress
object
Importer address. Required when catalogId is not provided. It's supported only for UPI PayU payments.
6 properties
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MediaStream
object
1 property
8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.MessageDeliveryReporting
object
Provides options for configuring the delivery report behavior.
3 properties
91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.DeliveryReport
object
Collection of reports, one per every message.
14 properties
e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.MediaTemplateHeaderContent
object
Media template header. Required for media templates which contain headers
7 properties
7 required
f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.TemplatePushEventChange
object
Change that has been applied to template.
1 property
1 required
0e82c38c2cac57841ec8a3a6ca825965cdf7afbcdea80ae147c9d99f5ab3a8c3.WebhookEventPayload
object
6 properties
f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.editValidityPeriod
object
Template validity period in which WhatsApp will try to deliver template message to end user. Validity period can be customized between 30 seconds and 15 minute…
2 properties
1 required
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateOrderStatusContent
object
Template order status. Should be defined, only if template contains order status.
1 property
1 required
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFlowHeaderContent
object
Header of a message containing one or more [interactive elements](https://www.infobip.com/docs/whatsapp/message-types-and-templates/free-form-messagesavailable…
1 property
1 required
2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.ValidityWindow
object
Description of a call link validation period and the number of times it can be used within the range.
5 properties
8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.DeliveryReports
object
1 property
91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.MessageError
object
Indicates whether an [error](https://www.infobip.com/docs/essentials/response-status-and-error-codeserror-codes) occurred during the query execution.
6 properties
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MachineDetectionRequest
object
3 properties
1 required
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ButtonWithAction
object
Button with action.
2 properties
2 required
2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.FileRecording
object
List of call recordings.
2 properties
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SpeechOptions
object
3 properties
2 required
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZaloInboundContentType
string
f6fe07754dbab8be58eaa18cf7a5d306bd0a320e1642529931d05084863a1fb3.GetViberTemplatesResponse
object
List of templates per page.
2 properties
1 required
fccfa6f52b47dd30d36e2c1fad9bb5d494251b453352b21aeb7a407c6f1eeb5c.ApiReportsResponse
object
1 property
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Voice
object
Used to define voice in which text would be synthesized. It has two parameters: name and gender. When only name is provided, then that exact voice with that na…
2 properties
74d8b21d2b740d37eba3fa2f7296b180343b1bcffffec58c82756c7c83775e15.PublicHangupRequest
object
Hangup request.
1 property
477ea179b1fa759a5e4ddd5edaa6af94d896d40bcb5c4181a042ac252296aece.MoMessage
object
1 property
14b5f31f4f292db4a32c4e61928f9a47f8ff4c0a1c06a38af2c29ef9ca05095d.DialogPlayRequest
object
2 properties
1 required
cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.MessengerConsentUpdate
object
1 property
1 required
4f883ab7a2c1db442b6865996e0e9f08b46ee1927d7a2c7d45b090008604a1ec.PushConfigurationPageResponse
object
2 properties
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveButtonsContent
object
The content object to build a message that will be sent.
4 properties
2 required
6a67def771061fe877b7bafa26c22e83ef5c7b44e2a298a70b54e0ed657fe102.Recording
object
Recording metadata
2 properties
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PageInfo
object
Contains information about the page.
4 properties
4 required
d32f709b8e696d073f5212b1e1d90721a8fd1118bf2c8abce078bf2baf7d1707.CallLinkConfigPage
object
2 properties
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveInThreadAuthenticationRequestMessage
object
9 properties
2 required
6665694460cb56ab854a173ada36805c85c7ec55584901d2f06225baf9b586cb.PublicPreAnswerRequest
object
2 properties
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingStatus
string
Status of call recording.
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.ApplicationType
string
f0c12807aec90d20a332deb5d4c4ff89651a8119eb6a5fa7e1d6e803f3c0e71b.MediaStreamConfigPage
object
2 properties
1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.NonMsisdnSmsFailover
object
Failover SMS message to be sent if the original message could not be delivered.
5 properties
1 required
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SchedulingOptions
object
Scheduling object that allows setting up detailed time windows within which calls can be established. Note that calling time window is set in UTC timezone.
2 properties
f0c12807aec90d20a332deb5d4c4ff89651a8119eb6a5fa7e1d6e803f3c0e71b.CallsConfigurationPage
object
2 properties
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallDirection
string
The direction of the call. Possible values are: INBOUND, OUTBOUND.
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZaloInboundResponse
object
3 properties
52c80a2bd29a734b52d9eb3ddb9b5d8ef0cb7c55640245f275763458f4c36a60.ConversionDetails
object
Details should contain value and currency information indicating exact value of the conversion that happened.
2 properties
2 required
f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.BodyApiData
object
Template body.
2 properties
1 required
e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.SouthKoreaOptions
object
Use case dependent parameters for sending SMS to phone numbers registered in South Korea.
2 properties
e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException
object
1 property
747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.DeliveryTime
object
The exact time of the day. The time is expressed in the UTC time zone.
2 properties
2 required
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.UrlDestinationHttpRequest
object
6 properties
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.VoiceData
object
Fields representing details specific for voice messages.
12 properties
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CriteriaType
string
e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TikTokMessageOptions
object
Message options.
5 properties
e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TikTokInboundMessage
object
3 properties
8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.ResponseEnvelopeMessageResponseMessageResponseDetails
object
2 properties
1 required
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.CursorPageInfo
object
Cursor information.
2 properties
91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.ValidityPeriodTimeUnit
string
Message validity period time unit.
6ee61eb40f9e4619d309dfe8df9b479488b43bcde7df95f6a044b2e14abf591e.RecordedFile
object
Recorded file.
10 properties
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallEndpointType
string
be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.InAppStyle
string
Set to MODAL to use in app dialog for actionable message or BANNER to show a standard banner view. MODAL is supported on iOS from [3.6.0](https://github.com/in…
61cea6785aa06882a92b0d6cc8c922ce1d44b92bfbdfd6cde0df0f73fb2499d6.Envelope
object
The values of the envelope-from and envelope-to headers of the inbound email.
2 properties
2 required
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ToDestination
object
An array of destination objects for where messages are being sent. A valid destination is required.
2 properties
1 required
999e23a63911c41e6f288f288564c4bc2e6a35a6f2a9edba53ecac8c52fe9339.OMNIChannel
string
OMNI Channel.
e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.InboundMessageTikTokInboundContent
object
Collection of mobile originated messages.
12 properties
7 required
be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.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.
ac429fcfd24f9a7e1a25e07a88be90c98df1692e2811a989e35dc3301ebb4715.ApiException
object
1 property
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.MoPrice
object
A price object showing currency and a price per each message.
2 properties
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.RepeatWhile
object
Repeat-While action is a control flow statement that repeatedly executes a block of code, as long as the boolean condition in the while field is true. Comparis…
2 properties
2 required
f0c12807aec90d20a332deb5d4c4ff89651a8119eb6a5fa7e1d6e803f3c0e71b.DialogRecordingPage
object
2 properties
267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.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
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsEventInteractionType
string
The interaction type of the message that was sent. Note: this describes the message structure, not the billing category, which may differ.
747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.ToDestination
object
An array of destination objects for where messages are being sent. A valid destination is required.
2 properties
1 required
30350ea3b42c85fe379e7561e2b43510ecd150d18a85f55710d4f6347f698f75.NumberType
string
Type of the phone number. It specifies verification type.
267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.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
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveVoiceButtonMessage
object
9 properties
3 required
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.DefaultMessageRequestOptions
object
Options applicable to all messages in the request.
2 properties
8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.MessageErrorGroup
string
Error group name that describes which category the error code belongs to.
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.VoiceReport
object
Arrays of delivery reports, one object for every message.
19 properties
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveMultiProductMessage
object
10 properties
3 required
3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.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
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.DeliveryDay
string
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.LocationContent
object
The content object to build a message that will be sent.
4 properties
2 required
f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.WhatsAppCategory
string
Category of the template.
382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.MessageResponseMessageResponseDetails
object
An array of message objects of a single message or multiple messages sent under one bulk ID.
4 properties
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Say
object
Say action converts text to speech and plays it to the caller.
6 properties
2 required
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsMoReport
object
An array of result objects.
13 properties
91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.UrlOptions
object
Sets up [URL shortening](https://www.infobip.com/docs/url-shortening) and tracking feature. Available only for linkUrl field of RICHLINK.
5 properties
1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.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
43838506232bad6c43fa70e5764e200c02c98fad735eeaad33d3b47abc8da5d2.PaymentStatus
string
Status of the payment.
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailGroupDestination
object
An array of destination objects for where messages are being sent. A valid destination is required. Note: Maximum number of recipients is 1000 overall includin…
5 properties
1 required
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.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.
3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.MessageError
object
Indicates whether an [error](https://www.infobip.com/docs/essentials/response-status-and-error-codeserror-codes) occurred during the query execution.
6 properties
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsAdvancedMessageSegmentLink
object
3 properties
1 required
be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.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…
c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderRequestAcceptedResponse
object
2 properties
2 required
3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.DefaultMessageRequestOptions
object
Options applicable to all messages in the request.
2 properties
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Platform
object
Platform options. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
2 properties
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.PageTemplate
object
2 properties
2 required
e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TikTokInboundContentType
string
4811a3a9108d5f90b8934012403f954f20270c436bdecbc318a80214cf54fc02.ConferenceRecordingRequest
object
4 properties
1 required
747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.LogFacebookOutboundContent
object
An array of message log results, one object per each message log entry.
13 properties
8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.InstagramDmInboundResponse
object
3 properties
2f1f086f3fbc952749e03dadc7759cfc932ca2898a0c5e5b77a8bc2d84bd5c48.BulkResponse
object
2 properties
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Failover
object
SMS message to be sent if the WhatsApp template message could not be delivered.
2 properties
2 required
be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushDestination
object
Recipient destination address. [Check examples](https://www.infobip.com/docs/mobile-push/mobile-push-over-api) how to work with recipients
1 property
1 required
e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.LogResponseLogTikTokOutboundMessageContent
object
2 properties
2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.FileFormat
string
Format of the file.
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.UpdateScenarioRequest
object
6 properties
2 required
382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.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…
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.Price
object
Sent email price.
2 properties
49bee00604d221bf98890cc8ca36403a588d28255383650998e0c4df2f9a5b4f.GeoLocation
object
Geolocation data such as Country and City. This data will be available only for opens, clicks and unsubscribes.
2 properties
382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.LogResponseLogKakaoAlimOutboundContent
object
2 properties
747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.TurkeyIysOptions
object
IYS regulations specific parameters required for sending promotional SMS to phone numbers registered in Turkey.
2 properties
1 required
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.DeliveryTimeFrom
object
The exact time of day to start sending messages. Time is expressed in the UTC time zone. If set, use it together with the to property with minimum 1 hour diffe…
2 properties
2 required
c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.Phone
object
List of phone contacts associated with the sender and displayed to the user on mobile device. Required if email and website are not provided. Currently, only o…
2 properties
2 required
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.BulkMessageInfo
object
2 properties
8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.SpeedLimitTimeUnit
string
The time unit to define when setting a messaging speed limit. Defaults to MINUTE.
6423f137d264daaaab4ca521d6dfeb19cab29b6b25c3d2da0c1c3fb475a5e829.SipTrunkRequest
object
6 properties
3 required
2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.SubdomainResponse
object
2 properties
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CaptureSayInstruction
object
Text-to-speech content to say before capturing DTMF input.
4 properties
1 required
e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TikTokRequest
object
2 properties
1 required
267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.MsisdnMessageFailoverOptions
object
Message options.
5 properties
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MediaProperties
object
2 properties
3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoMessageOptions
object
Message options.
6 properties
3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.Platform
object
Platform options. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
2 properties
08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779e.PublicSayRequest
object
Call say request.
7 properties
2 required
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.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
2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.ImageType
string
Image type.
267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.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
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.Log
object
Collection of logs.
12 properties
45c843446703ba5f4438a6f721c629420452796de20bd3dd9adfccde3ed2ffff.ApiRisk
string
Indicates the risk status of email addresses. High-risk addresses have a very high chance of bouncing and potentially damaging the sender's reputation. Low-ris…
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event
object
8 properties
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.AnsweringMachineDetectionOptions
object
2 properties
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailResponse
object
2 properties
1 required
2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.AcceptableHours
object
Specify time range within a day when a link can be used. It is 00:00 - 23:59, by default. UTC timezone is used.
2 properties
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberInboundMessages
object
3 properties
91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundResponse
object
3 properties
0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.PaymentTransactionNotification
object
5 properties
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.LogViberOutboundContent
object
An array of message log results, one object per each message log entry.
13 properties
91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.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
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundMessages
object
3 properties
3 required
7e9cb629dd52a85ce6e062228c85b37a768e3c9da7cd3bd0d9451171d2b14262.ApiException
object
1 property
2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.CallLinkDestination
string
Destination type.
e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.ViberData
object
Viber-specific data used if the message is sent through a Viber channel. Must be one of: text, image, file, text with button or text with image and button.
12 properties
14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.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.
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.Price
object
MMS price.
2 properties
747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.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
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.IndiaDltOptions
object
Distributed Ledger Technology (DLT) specific parameters required for sending SMS to phone numbers registered in India.
3 properties
1 required
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.MachineDetectionModeType
string
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.DeliveryTimeWindow
object
Set specific scheduling options to send a message within daily or hourly intervals.
3 properties
1 required
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsMessage
object
An array of message objects of a single message or multiple messages sent under one bulk ID.
5 properties
2 required
08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779e.SpeechCaptureRequest
object
7 properties
2 required
f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.editSubCategory
string
Sub category of template. It is required only if edited template has already sub category.
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.DeliveryTime
object
2 properties
2 required
60d0e6d5cbcf8382b5a6bad1f38781f71991c7ea63dad2e6ec22ddc8893af51c.CaptureDtmfCallbackRequest
object
Markup Language captureDtmf callback request object. Sent to the callback URL configured on the CaptureDtmf instruction after the caller has finished entering…
7 properties
43838506232bad6c43fa70e5764e200c02c98fad735eeaad33d3b47abc8da5d2.PaymentTransactionStatus
string
Status of the transaction.
14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOutboundContentType
string
f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.V1HeaderApiData
object
Template header. Can be image, document, video, location or text.
1 property
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsOutboundMessageContentType
string
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundEvents
object
3 properties
3 required
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.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
45c843446703ba5f4438a6f721c629420452796de20bd3dd9adfccde3ed2ffff.BulkResponse
object
Validations response
1 property
1 required
676955110d1a0dfd70a111f0d54754844fb76cec84585649da79c94c1af5f6bc.ApiException
object
1 property
8a2ea8872469b182f7474a94d4bf931da42a6e2a1d1ba07898b1bc7dcdc85cd2.SeenReports
object
1 property
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.Destination
object
An array of destination objects for where messages are being sent. Each object in array can be one of available options. A valid destination is required.
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.FailoverMessage
object
An array of messages being sent.
11 properties
3 required
be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushOutboundContentOptionsInAppStyle
string
Set to MODAL to show mirrored push notification in app as a dialog for actionable message or BANNER to show a standard banner view. MODAL is supported on iOS f…
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.AdvancedWebhooksWithSeen
object
Provides options for configuring message webhooks.
4 properties
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RecordingNotFoundException
object
5 properties
91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.MessageDeliveryReporting
object
Provides options for configuring the delivery report behavior.
3 properties
e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.RegionalData
object
Region specific parameters, often specified by local laws. Use this if country or region that you are sending SMS to requires some extra parameters.
2 properties
e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.ClientPriority
string
Client priority set on request. Must be 'HIGH', 'STANDARD' or 'LOW'.
2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.Localization
object
If the localization object is not defined, English will be used. If the localization type is set to PRESET, the language code is mandatory to be defined to one…
1 property
0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.DeliveryResult
object
1 property
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SMSBinaryMessage
object
An array of message objects of a single message or multiple messages sent under one bulk ID.
15 properties
1 required
3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguRequest
object
2 properties
1 required
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZaloReportSingle
object
14 properties
4 required
be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.SpeedLimitTimeUnit
string
The time unit to define when setting a messaging speed limit. Defaults to MINUTE.
ae8a6eecccfb565f1840ac10e7bfb960a35d1e256ae31abf1bdea45a1d2f5557.CallLink
object
Use the call link feature to enable calls between users that have an Infobip account and users that don't.
9 properties
2 required
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CursorPageInfo
object
Cursor information.
2 properties
6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.UploadKeyApiDoc
object
1 property
1 required
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.Template
object
ZNS message template.
4 properties
a8c993b4bcabd2960dfaf3986394e0fe85cd1c09dc98b0a81b51403a00c8f97c.PublicConferenceRecording
object
8 properties
14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.NonMsisdnSmsFailover
object
Failover SMS message to be sent if the original message could not be delivered.
5 properties
1 required
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SortDirection
string
be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushUnificationMessageOptions
object
Message options.
23 properties
0ea963ede06ee99578911cc0068f7474598729635091b55d2985483fad214d7b.MachineDetectionResult
string
Result of Answering Machine Detection. Possible values are HUMAN and MACHINE.
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.GetVoicesResponse
object
1 property
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.DeliveryReport
object
Collection of reports, one per every message.
14 properties
c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.CreateRcsTestNumberApiRequest
object
2 properties
1 required
8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.LogResponseLogInstagramDmOutboundContent
object
2 properties
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ResponseEnvelopeMessageResponseMessageResponseDetails
object
2 properties
1 required
faa1195a85d1a730663c8d9058f7685a3760136466d26134605b0efcc286bec7.MultiTtsApiRequest
object
Multiple voice messages request object.
1 property
1 required
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveListMessage
object
10 properties
3 required
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveListHeaderContent
object
Header of a message containing one or more [interactive elements](https://www.infobip.com/docs/whatsapp/message-types-and-templates/free-form-messagesavailable…
1 property
1 required
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InboundMessagePushko
object
Collection of mobile originated messages.
14 properties
8 required
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailDeliveryReport
object
Collection of email delivery reports, one per every message.
15 properties
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundEventContentType
string
267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.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
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.GoToOptions
object
2 properties
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicTermination
object
Indicates when to stop the action. The action can be interrupted at any time by the end user when they press any DTMF key.
1 property
6ee61eb40f9e4619d309dfe8df9b479488b43bcde7df95f6a044b2e14abf591e.RecordingApiResponse
object
Recording API response.
2 properties
2 required
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.File
object
7 properties
2 required
382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.Platform
object
Platform options. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
2 properties
e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.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
60d0e6d5cbcf8382b5a6bad1f38781f71991c7ea63dad2e6ec22ddc8893af51c.ErrorCallbackRequest
object
Markup Language error callback request object. Sent to the configured errorUrl when the platform fails to retrieve or execute a Markup Language script. Extends…
8 properties
eaaf11bb9830fc826a8597df01bea6f2a14ef6d1ed129a4f6623981d52827778.MarkupResponse
object
Markup language response object.
4 properties
382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.KakaoAlimMessageRequestOptions
object
Options applicable to all messages in the request.
2 properties
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.PlayFromUpload
object
Play From Upload action performs playback of uploaded audio file. Not available in inbound IVR at the moment.
3 properties
1 required
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.Error
object
6 properties
91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbEventOptions
object
Event options.
2 properties
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsTextMessageContent
object
1 required
91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.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
5305ca722d832817d411146f95eba84c3530f174d0fd6b1f72c09c5c2fbb1063.Application
object
Application data for the recording.
1 property
1 required
74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.CreateSipTrunkResponse
object
8 properties
14b5f31f4f292db4a32c4e61928f9a47f8ff4c0a1c06a38af2c29ef9ca05095d.DialogSendMessageRequest
object
1 property
1 required
0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.GenerateFlowResponseApiData
object
3 properties
3 required
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsPlatformInfo
object
Platform information associated with the message.
2 properties
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ValidityPeriodTimeUnit
string
Message validity period time unit.
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.SpeedLimitTimeUnit
string
The time unit to define when setting a messaging speed limit. Defaults to MINUTE.
43838506232bad6c43fa70e5764e200c02c98fad735eeaad33d3b47abc8da5d2.PaymentCurrency
string
Currency of the payment.
382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.KakaoAlimOutboundContentType
string
14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.NonMsisdnMessageFailoverOptions
object
Message options.
5 properties
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.File
object
The list of the results for this page.
7 properties
2 required
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsLogsMessageSegment
object
Content of the message being sent.
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Destination
object
Array of message destination addresses. Maximum number of destination addresses is 20k.
2 properties
1 required
c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsCountryProvidersPageResponse
object
2 properties
2 required
91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.LogAppleMfbOutboundContent
object
An array of message log results, one object per each message log entry.
13 properties
14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.DeliveryTime
object
The exact time of the day. The time is expressed in the UTC time zone.
2 properties
2 required
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SMSResponseDetails
object
An array of message objects of a single message or multiple messages sent under one bulk ID.
4 properties
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveListSectionContent
object
Array of sections in the list.
2 properties
1 required
033803db88cada38464c4e86c919c67cee20aa369072ec632b1c62ea0cc27514.ReferredProduct
object
Product information included in the incoming message.
2 properties
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.SingleMessageStatus
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
3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.UrlOptions
object
Sets up [URL shortening](https://www.infobip.com/docs/url-shortening) and tracking feature.
5 properties
267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.MessageErrorGroup
string
Error group name that describes which category the error code belongs to.
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsConversationStartedInfo
object
Conversation details including type, ID, and time window.
4 properties
4 required
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveProductActionContent
object
Allows you to specify catalog and product details sent in the product message.
2 properties
2 required
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.IpCoreGeneralStatus
string
Sent Message status.
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.SmtpInfo
object
SMTP details for the sent email.
1 property
1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamInboundContentType
string
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Retry
object
Used to define if the delivery of the Voice messages should be retried in case the first try doesn't succeed. Additional retries will be made according to the…
3 properties
3 required
c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.TemplateStatus
string
Updated status of the template.
ab7498b77a5058e37557279988a806092938b5b30ecbfd39229d94cbcf4bdc07.IdentityInfo
object
3 properties
3 required
747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.InboundMessageFacebookInboundContent
object
Collection of mobile originated messages.
12 properties
7 required
c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsBrand
object
Brand for which sender is created.
1 property
1 required
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MediaCarouselActionType
string
c8cb45a488f0d2ea03cc082d0f61afb1c3b35cdd297a9f7abb6df8ac5619a483.MoReportResult
object
List of MO report results.
14 properties
7 required
747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.AdvancedWebhooksWithSeen
object
Provides options for configuring message webhooks.
4 properties
6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.CallingPermissionActionLimit
object
A list of time-bound restrictions for the given action.
4 properties
3 required
61cea6785aa06882a92b0d6cc8c922ce1d44b92bfbdfd6cde0df0f73fb2499d6.IpResponse
object
Dedicated IPs assigned to the IP pool.
3 properties
3 required
53ea038e2044401649ce25e79296cd97fe7d6f7f97d15a035e41419183f810a1.ApiSuppressionType
string
Type of suppression.
0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.CreateFlowRequest
object
3 properties
2 required
5cb8669321a9b28a95445a23a292423b19c28f831eda62032aef9c6b53da7813.RouteResponsePage
object
Routes response object.
2 properties
18564d7c4791a7efa60d2b6c8cb85f3f93b60abdd39e67aaeb1d653e4aff3ecd.V1TemplatesApiResponse
object
1 property
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsUnificationSmsFailover
object
MMS to be sent in case a message could not be delivered through the main channel.
4 properties
1 required
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.FaxType
string
Fax type.
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallLogPage
object
2 properties
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.MessageResponseDetails
object
Other details of the message.
5fc49137a7b003ca1d8c4957601417b8ed884356b7fbc49afe416dd5c098a0bd.DialogResponse
object
9 properties
87fdb606ad2c440ed89e04f515deb90150ccd79b7e43f8b50549f5895d6c3429.CallsConfigurationCreateRequest
object
2 properties
91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.MessageErrorGroup
string
Error group name that describes which category the error code belongs to.
747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.RequestSchedulingSettings
object
Options for scheduling a message.
3 properties
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.RecipientType
string
Recipient Type must be TACIR or BIREYSEL.
cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.CampaignResponse
object
4 properties
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.ApiReport
object
13 properties
53ea038e2044401649ce25e79296cd97fe7d6f7f97d15a035e41419183f810a1.AddSuppressionRequest
object
Suppressions request.
1 property
1 required
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.SmsFailoverRequest
object
Sms failover message contents.
5 properties
2 required
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsAdvancedMessageSegmentText
object
2 properties
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.DestinationType
string
8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.LogInstagramDmOutboundContent
object
An array of message log results, one object per each message log entry.
13 properties
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.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
3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.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
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckRequestState
object
The sync response from the RCS capability checker for the specified phone numbers. Represents the current status of the requests.
3 properties
3 required
c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderBaseData
object
13 properties
12 required
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.RequestSchedulingSettings
object
Options for scheduling a message.
3 properties
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveListActionContent
object
Allows you to specify the title of the list and its sections. Each section can have a title and multiple rows to select.
2 properties
2 required
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.DestinationTo
object
2 properties
1 required
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppEventRequest
object
2 properties
1 required
2f772c02a4c3391667bfa54680f8db54477fb2b9100309bf0d515e4ee848facc.SetupResponse
object
9 properties
cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.GetAdAccountsResponse
object
1 property
30350ea3b42c85fe379e7561e2b43510ecd150d18a85f55710d4f6347f698f75.OtpRequest
object
2 properties
2 required
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.DefaultMessageRequestOptions
object
Options applicable to all messages in the request.
2 properties
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BillingPackageType
string
Billing package type.
1612e6f124bb6c5b1f4f7b12ca64104d59fdfdf779c97454e478b219583b9d48.SMSAdvancedTextualRequest
object
6 properties
1 required
5fc49137a7b003ca1d8c4957601417b8ed884356b7fbc49afe416dd5c098a0bd.DialogLogResponse
object
13 properties
1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.IndiaDltOptions
object
Distributed Ledger Technology (DLT) specific parameters required for sending SMS to phone numbers registered in India.
3 properties
1 required
3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.MessagePrice
object
Sent message price.
2 properties
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsSouthKoreaOptions
object
Use case dependent parameters for sending MMS to phone numbers registered in South Korea.
1 property
91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.FailoverDestinationPair
object
The SMS failover destination matching.
2 properties
2 required
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MessageDeliveryReporting
object
Provides options for configuring the delivery report behavior.
3 properties
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.EditTemplateRequest
object
6 properties
5 required
1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamInboundContent
object
Message content.
1 property
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallPage
object
2 properties
91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.InboundMessageAppleMfbInboundContent
object
Collection of mobile originated messages.
12 properties
7 required
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ButtonType
string
Type of button action.
febbeec59369f28c0a6e3ddd1a2666aea9869953e0893914d340d35c6901410c.SubdomainRequest
object
1 property
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.ApiErrorResponse
object
1 property
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateBodyContent
object
Template body.
1 property
1 required
e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.ContainerType
string
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.PlayContent
Polymorphic content played to the caller.
e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.To
object
The message destination address.
4 properties
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.DialRecording
object
Recording configuration for dial actions.
4 properties
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.DeliveryReport
object
Collection of reports, one per every message.
14 properties
8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.Platform
object
Platform options. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
2 properties
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.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
6665694460cb56ab854a173ada36805c85c7ec55584901d2f06225baf9b586cb.PublicStopPlayRequest
object
1 property
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CaptureDtmf
object
CaptureDtmf action collects DTMF input from the caller.
7 properties
2 required
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.MessageResponseMessageResponseDetails
object
An array of message objects of a single message or multiple messages sent under one bulk ID.
4 properties
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MessageResponseMessageResponseDetails
object
An array of message objects of a single message or multiple messages sent under one bulk ID.
4 properties
cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.CreateAudienceResponse
object
5 properties
f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.LimitedTimeOfferApiData
object
Limited time offer.
2 properties
1 required
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.PhoneContent
object
Array of phones information.
3 properties
5fc49137a7b003ca1d8c4957601417b8ed884356b7fbc49afe416dd5c098a0bd.DialogPropagationOptions
object
3 properties
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsDiscount
object
Discount of the order.
2 properties
1 required
53ea038e2044401649ce25e79296cd97fe7d6f7f97d15a035e41419183f810a1.DomainInfoPageResponse
object
Domain get response.
2 properties
2 required
0a37b8c521b3309d1bbd0669d19fc7f2f157d68a68747b5e7ad23e5b0f5e47e8.OpenChannelMessageBody
object
Body of the message.
1 property
f0c12807aec90d20a332deb5d4c4ff89651a8119eb6a5fa7e1d6e803f3c0e71b.CallRecordingPage
object
2 properties
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingType
string
Recording type.
45c843446703ba5f4438a6f721c629420452796de20bd3dd9adfccde3ed2ffff.CursorPageInfo
object
Paging response.
3 properties
3 required
477ea179b1fa759a5e4ddd5edaa6af94d896d40bcb5c4181a042ac252296aece.MoReport
object
87cf6d665490382407be009353007f071b1d6d4a375e96d31d3bf0b04b7fb3c7.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
3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.RequestSchedulingSettings
object
Options for scheduling a message.
3 properties
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.LogRcsOutboundMessageContent
object
An array of message log results, one object per each message log entry.
13 properties
2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.File
object
Recording file.
3 properties
267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.LineOnOutboundContent
object
Message content.
1 property
91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.SpeedLimitTimeUnit
string
The time unit to define when setting a messaging speed limit. Defaults to MINUTE.
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.Error
object
6 properties
91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.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.
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Script
array
Array of IVR actions defining scenario. NOTE: Answering Machine Detection, Call Recording and Speech Recognition (used for Capture action) are add-on features.…
14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotInboundContent
object
Message content.
1 property
8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.Webhooks
object
Provides options for configuring message webhooks.
3 properties
2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.CallDetails
object
Call details.
1 property
747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.Platform
object
Platform options. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
2 properties
e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.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
6a67def771061fe877b7bafa26c22e83ef5c7b44e2a298a70b54e0ed657fe102.RecordingResponse
object
2 properties
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.CursorPageInfo
object
Cursor information.
2 properties
30350ea3b42c85fe379e7561e2b43510ecd150d18a85f55710d4f6347f698f75.WhatsAppSenderRegistrationResponse
object
1 property
1 required
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SearchCriteria
object
List of criteria that should match route. For a route to match, any criterion should be met.
2 properties
91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.RecipientType
string
Recipient Type must be TACIR or BIREYSEL.
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppEvent
object
An array of event objects of the events to be sent.
4 properties
3 required
18564d7c4791a7efa60d2b6c8cb85f3f93b60abdd39e67aaeb1d653e4aff3ecd.V1TemplateApiResponse
object
List of all templates for given sender.
7 properties
aa157138bc28697f89db8325cc3d3ce20c0f3c72c30b6831a5435f3f2d211cfe.CallRoutingRecordingPage
object
2 properties
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.TemplateParameterType
string
Type of the parameter.
58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.BrandMessagesTemplateContent
object
Template content details.
1 property
1 required
6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.BusinessInfoRequest
object
7 properties
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicErrorCode
string
Error code to hang up with. There are rules for using error codes. NORMALHANGUP - Call needs to be established. MACHINEDETECTED - Call needs to be established…
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.ResponseDetails
object
Array of sent messages, one object per every message.
3 properties
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SendSmsData
object
3 properties
3 required
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.TemplateInfo
object
Information about a ZNS message template.
8 properties
382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.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
c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsProviderTemplateApiStatus
string
Template status for this specific provider. Possible values: PENDING: Status indicating that the template has been submitted to the provider and is being under…
e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.VoiceData
object
Voice-specific data used if the message is sent through a voice channel.
4 properties
0a37b8c521b3309d1bbd0669d19fc7f2f157d68a68747b5e7ad23e5b0f5e47e8.OpenChannelWebhookData
object
Response webhook data.
2 properties
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.DeliveryTime
object
The exact time of the day. The time is expressed in the UTC time zone.
2 properties
2 required
1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.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
267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.DeliveryReports
object
1 property
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.IvrMessage
object
Array of IVR messages to be sent, one object per every message.
16 properties
2 required
8a486cb9d74b424a2d3be79e8747a253b2d16548f487145eca2db9192c11dbe8.OmniResponse
object
2 properties
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsUnificationFailoverRegionalOptions
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.
1 property
747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.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
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ImageMessage
object
10 properties
3 required
5fc49137a7b003ca1d8c4957601417b8ed884356b7fbc49afe416dd5c098a0bd.DialogCallRequest
object
6 properties
c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.CountryCoverage
object
Coverage information by country showing launch status for each provider.
2 properties
2 required
b5f674fb4d8d190ed269baf3b9aaf29827a4d03ec2de31bb6b608809be9a182b.VoiceReportsResponse
object
1 property
08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779e.PublicVoicePreferences
object
Voice preferences.
2 properties
0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundMessageData
f6fe07754dbab8be58eaa18cf7a5d306bd0a320e1642529931d05084863a1fb3.TemplateCategory
string
Business category of the template, used for classification and approval routing.
fc58971973975508c3c8fc4221c7201147a075acf31dce7331f3a874d9fc423d.GcmData
object
GCM data.
1 property
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveProductMessage
object
10 properties
3 required
cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.GetCampaignResponse
object
List of campaigns.
8 properties
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ResponseEnvelopeMessageResponseMessageResponseDetails
object
2 properties
1 required
6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.WhatsAppSenderQuality
object
List of the quality information related to specific senders.
5 properties
4 required
2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.TimeOfDay
object
2 properties
707907921d4508c2925eddc2449f10db322ecc083be424f87c50fe97ccd8be40.ActionConferenceRequest
object
3 properties
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicPlayContentType
string
1a32a5811401e5289f9edb3a3b051fee21e1ffff7ad179f3aead79d4a871821d.ApiException
object
1 property
7916e19109f991cfe966f390ef0d36117967291fa90eff57d8c8cb768f38352e.FileFormat
string
File format.
e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.MessageResponseMessageResponseDetails
object
An array of message objects of a single message or multiple messages sent under one bulk ID.
4 properties
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RecordingStatusEvent
string
Recording status delivered with the record callback.
d787c8758e54290e2bc82a005b86f9050517ec4ab2e17f0a4cc0942f51132c33.ConversionEventModel
object
Conversion events collection.
4 properties
2 required
4811a3a9108d5f90b8934012403f954f20270c436bdecbc318a80214cf54fc02.ConferenceSayRequest
object
5 properties
2 required
91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Platform
object
Platform options. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
2 properties
747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundContentType
string
0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.PaymentNotification
object
10 properties
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallRate
object
Call rate defined in number of calls created per second, minute, hour, or day.
2 properties
91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbMessage
object
An array of message objects of a single message or multiple messages sent under one bulk ID.
5 properties
3 required
5fc49137a7b003ca1d8c4957601417b8ed884356b7fbc49afe416dd5c098a0bd.DialogRequest
object
5 properties
1 required
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.AudioMediaProperties
object
Audio media properties.
3 properties
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateCardContent
object
Carousel cards. Should be defined in the correct order. It can have between one and ten cards.
3 properties
1 required
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.IvrData
object
Fields representing details about IVR, if outbound IVR is being used. If the call was not IVR, the field will be null.
6 properties
60d0e6d5cbcf8382b5a6bad1f38781f71991c7ea63dad2e6ec22ddc8893af51c.MachineDetectionCallbackRequest
object
Markup Language machine detection callback request object. Sent to the callback URL configured on the Markup Language configuration (markupUrl) once machine de…
8 properties
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlOptions
object
Sets up [URL shortening](https://www.infobip.com/docs/url-shortening) and tracking feature.
5 properties
747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.CursorPageInfo
object
Cursor information.
2 properties
1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.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
c8cb45a488f0d2ea03cc082d0f61afb1c3b35cdd297a9f7abb6df8ac5619a483.ConfigurationResponse
object
List of configurations.
1 property
1 required
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RouteStatus
string
Indicates whether the route is enabled or not.
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderStatusMessage
object
10 properties
3 required
be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.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
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MMSMoWebhookResult
object
12 properties
f0c12807aec90d20a332deb5d4c4ff89651a8119eb6a5fa7e1d6e803f3c0e71b.DialogPage
object
2 properties
d787c8758e54290e2bc82a005b86f9050517ec4ab2e17f0a4cc0942f51132c33.ConversionEventRequest
object
2 properties
1 required
1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.LogResponseLogKakaoSangdamOutboundContent
object
2 properties
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.PlayFromRecording
object
Play from Recording Action plays audio recorded from the current or some other call.
2 properties
1 required
87fdb606ad2c440ed89e04f515deb90150ccd79b7e43f8b50549f5895d6c3429.CallsConfigurationUpdateRequest
object
1 property
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SMSTextualMessage
object
An array of message objects of a single message or multiple messages sent under one bulk ID.
17 properties
1 required
5cec81334b90b810e64e8923d2a0d906614be46012f19935bf49fd13e921d8b2.PublicSipTrunkServiceAddressRequest
object
SIP trunk service address request.
7 properties
5 required
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Dial
object
Dial action connects the call to one or more endpoints.
12 properties
2 required
f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.FooterApiData
object
Template footer.
1 property
1 required
14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotInboundContentType
string
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RetryOptions
object
Used to determine whether to retry the delivery of a bulk call if the initial attempt fails. Additional retries will occur based on the schedule defined by the…
3 properties
f6fe07754dbab8be58eaa18cf7a5d306bd0a320e1642529931d05084863a1fb3.TemplateLang
string
Language code for the template body.
6ee61eb40f9e4619d309dfe8df9b479488b43bcde7df95f6a044b2e14abf591e.CallRecording
object
Call recording metadata.
6 properties
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.QuotaInfo
object
Information about ZNS message quotas.
5 properties
a012797e45a148c14a09b350fd3670874eb3f365931c630a0c2efc32c7293ff3.TokenRequestModel
object
3 properties
1 required
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.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.
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.BulkRescheduleResponse
object
2 properties
2 required
5e0af18dea7a9fe7fc7475b275c0dd721ec8be9556c5d111334ce121ba3ef90a.EndTagResponse
object
1 property
382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.RequestSchedulingSettings
object
Options for scheduling a message.
3 properties
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.SingleMessageInfo
object
4 properties
6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.WhatsAppSenderQualityResponse
object
1 property
1 required
f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.V1TemplateStructureApiData
object
Template structure.
5 properties
1 required
1a371cd8f3283b37bf4803906b01cdcf51f31ded659ebcfe44c8dbb3c4785a4e.ApiException
object
1 property
1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.DeliveryTime
object
The exact time of the day. The time is expressed in the UTC time zone.
2 properties
2 required
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.AdvancedMessageDeliveryReporting
object
Provides options for configuring the delivery report behavior.
4 properties
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.MessagePrice
object
Sent message price.
2 properties
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderStatusActionContent
object
Allows you to specify order status.
3 properties
2 required
73e6f414ccb2e1e41274c061b50cf5765f69b642a3e0cca54b0248eb3baf086d.RecordingResponse
object
2 properties
2 required
747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.MessageError
object
Indicates whether an [error](https://www.infobip.com/docs/essentials/response-status-and-error-codeserror-codes) occurred during the query execution.
6 properties
1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.ToDestination
object
An array of destination objects for where messages are being sent. A valid destination is required.
2 properties
1 required
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberMessage
object
An array of message objects of a single message or multiple messages sent under one bulk ID.
5 properties
3 required
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SpeedLimitTimeUnit
string
The time unit to define when setting a messaging speed limit. Defaults to MINUTE.
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.CustomRingback
object
Custom ringback tones configuration. Allows specifying different audio files to play during ringing and when the call fails.
2 properties
1 required
cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.AudienceUsersRequest
object
1 property
1 required
4f883ab7a2c1db442b6865996e0e9f08b46ee1927d7a2c7d45b090008604a1ec.IosPushNotificationConfig
object
Optional. Required if android is not set. Configuration used to enable iOS push notifications.
3 properties
2 required
270617dafe939f994767f4b01223addd34979b1c67bb145186dac4c5c875ab19.Price
object
Message price.
2 properties
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveButtonsMessage
object
10 properties
3 required
747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookRequest
object
2 properties
1 required
2e05f28ea1ad0c8ab6683b6adca8c2dc53bf0d4883946379aef59ba8417e5029.BulkResponse
object
2 properties
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.IndiaDlt
object
Distributed Ledger Technology (DLT) specific parameters required for sending SMS to phone numbers registered in India.
2 properties
1 required
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlContent
object
Array of urls information.
2 properties
ffb4c29a0ab7c4ca15544ca9d6ceffaf3e8b394d7fc1a53728ba61496b4513fc.FileResponse
object
5 properties
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.EditTemplateResponse
object
Response from Zalo API after editing a ZBS template.
9 properties
1 required
f6fe07754dbab8be58eaa18cf7a5d306bd0a320e1642529931d05084863a1fb3.TemplateParam
object
Variable parameter definition for template placeholders.
3 properties
3 required
c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.UpdateRcsTestNumberPrimaryApiRequest
object
1 property
1 required
e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TikTokOutboundContentType
string
c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderUpdateWebhookResponse
object
Webhook response containing RCS sender update events
1 property
1 required
747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.LogResponseLogFacebookOutboundContent
object
2 properties
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.Status
object
6 properties
be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.LogPushOutboundContent
object
An array of message log results, one object per each message log entry.
13 properties
747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.AdvancedMessageDeliveryReporting
object
Provides options for configuring the delivery report behavior.
4 properties
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.DnsRecordResponse
object
Records for the domain.
4 properties
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppEventOptions
object
Event options.
2 properties
382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.DefaultSmsFailover
object
Failover SMS message to be sent if the original message could not be delivered.
4 properties
1 required
267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.SouthKoreaOptions
object
Use case dependent parameters for sending SMS to phone numbers registered in South Korea.
2 properties
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.UrlPlayContent
object
Plays an audio file fetched from a remote URL.
3 properties
2 required
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.DeliveryDay
string
Days of the week which are included in the delivery time window. At least one day must be provided.
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsReport
object
14 properties
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.LogResponseLogRcsOutboundMessageContent
object
2 properties
61cea6785aa06882a92b0d6cc8c922ce1d44b92bfbdfd6cde0df0f73fb2499d6.IpPoolResponse
object
2 properties
2 required
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.TemplateRcsApiMtContent
object
Rcs message contents.
2 properties
1 required
0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.FlowPreview
object
2 properties
2 required
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.BlocklistConfigurationLevel
string
Defines the level at which Infobip stores unsubscribe preferences. Note: When you change the unsubscribe configuration from a more global level (such as FROMDO…
14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.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
be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushRequestMulti
object
1 property
1 required
0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.FlowDataResponse
object
List of found flows.
6 properties
5 required
267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.RequestSchedulingSettings
object
Options for scheduling a message.
3 properties
c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateApiDetailedStatusResponse
object
3 properties
3 required
39bb6975d36d214ea076d974c69ec0b82edda805f4c6bf36a3f6f7d154c98fa0.EmailTemplate
object
13 properties
3 required
e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.WhatsAppData
object
WhatsApp-specific data used if the message is sent through a WhatsApp channel.
18 properties
2 required
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.MessageDetection
object
Message detection configuration
1 property
2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.CallRecording
object
List of call recordings.
6 properties
e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TikTokMessage
object
An array of message objects of a single message or multiple messages sent under one bulk ID.
5 properties
3 required
6a67def771061fe877b7bafa26c22e83ef5c7b44e2a298a70b54e0ed657fe102.RecordingFile
object
Recorded file.
10 properties
30350ea3b42c85fe379e7561e2b43510ecd150d18a85f55710d4f6347f698f75.PhoneNumberRequest
object
5 properties
5 required
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.DeliveryReports
object
1 property
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TextMessage
object
10 properties
3 required
be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.LogResponseLogPushOutboundContent
object
2 properties
c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.ProviderSenderLaunchStatus
object
List of providers in the country and their launch status.
4 properties
3 required
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Numbers
object
1 property
1 required
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SendingSpeed
object
Sending rate defined in number of messages sent per second, minute, hour or day. You may wish to use this to allow your systems or agents to handle large amoun…
2 properties
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsReport
object
15 properties
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackEndpoint
object
Endpoint involved in the call delivered to the Markup Language callback.
1 property
1 required
1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.MessageDeliveryReporting
object
Provides options for configuring the delivery report behavior.
3 properties
be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.MessageResponseDetails
object
Other details of the message.
91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.ToDestination
object
An array of destination objects for where messages are being sent. A valid destination is required.
2 properties
1 required
c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.CreateRcsSenderApiRequest
object
16 properties
12 required
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Fetch
object
Fetch action retrieves markup instructions from a URL at runtime.
3 properties
2 required
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.TagIdentifierType
string
Defines which identifier will be provided in the tags field. Possible values are ID and NAME. If not provided, default value of NAME is used.
39bb6975d36d214ea076d974c69ec0b82edda805f4c6bf36a3f6f7d154c98fa0.Attachment
object
5 properties
1 required
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MessageError
object
Indicates whether an [error](https://www.infobip.com/docs/essentials/response-status-and-error-codeserror-codes) occurred during the query execution.
6 properties
382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.IndiaDltOptions
object
Distributed Ledger Technology (DLT) specific parameters required for sending SMS to phone numbers registered in India.
3 properties
1 required
e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.SeenReports
object
1 property
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.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
3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.SouthKoreaOptions
object
Use case dependent parameters for sending SMS to phone numbers registered in South Korea.
2 properties
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SouthKoreaOptions
object
Use case dependent parameters for sending SMS to phone numbers registered in South Korea.
2 properties
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckResult
object
4 properties
4 required
17bf4973053f0fd3d8ac737d4e4f0aca51beba611d8f8dda63e2fbc35b478ef9.ScenariosResponse
object
1 property
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.ResponseDetails
object
List of message response details.
3 properties
3 required
45c843446703ba5f4438a6f721c629420452796de20bd3dd9adfccde3ed2ffff.ValidationResponse
object
Validation response
10 properties
7 required
9ac20aaa973a4193ff0ca88a25f8778624dcef15967a470e5d05a9222eb15517.Scenario
object
4 properties
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.LogError
object
6 properties
0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.Referral
object
Information about the referral which is either a Facebook ad or a post that triggered the message.
7 properties
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.RecipientType
string
Recipient Type must be TACIR or BIREYSEL.
56fc13d85fd8c7d40ac0157103bb5ccebc0bb2862850603cc2c5a808276f4742.CredentialsResponse
object
2 properties
3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguMessage
object
An array of message objects of a single message or multiple messages sent under one bulk ID.
5 properties
3 required
8c0d480c425c41d88986e9a339e209ff8333292c731a8b410c00a517bc3a95fb.ApiException
object
1 property
cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.UserTokenStatus
string
Status of user token.
febb9d147c03fd2fbfd3c2210892c186364d60568040914121c07343344b284b.ApiException
object
1 property
e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Step
object
Sender used in OMNI scenario’s step for sending message.
2 properties
1 required
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveProductContent
object
The content object to build a message that will be sent.
3 properties
1 required
cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.GetAudiencesResponse
object
1 property
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsOutboundSegmentType
string
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.MessagePrice
object
Sent message price.
2 properties
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Callback
object
Clients callback where markup language is hosted.
3 properties
3 required
14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.RecipientType
string
Recipient Type must be TACIR or BIREYSEL.
e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.LanguageCode
string
Code for language character set of a message text.
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallEndpoint
object
Call endpoint. Represents a caller for the inbound calls and a callee for the outbound calls.
1 property
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.PublicKeyResponse
object
1 property
1 required
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DayOfWeek
string
Days when scheduling call establishment will be attempted.
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.SpeedLimitTimeUnit
string
The time unit to define when setting a messaging speed limit. Defaults to MINUTE.
45c843446703ba5f4438a6f721c629420452796de20bd3dd9adfccde3ed2ffff.GetValidation
object
Validation get response.
12 properties
8 required
d1778b306237beb41d9922fd3fd38c085ddcf463c618d1f8ceed148892c3020d.SystemEventResponse
object
3 properties
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.StopRecording
object
StopRecording action stops an ongoing recording.
2 properties
2 required
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ParticipantSession
object
List of participant sessions.
3 properties
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BulkStatus
object
3 properties
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailMediaAttachment
object
File attachments.
1 property
1 required
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberTextMessage
object
An array of messages being sent.
14 properties
3 required
2f772c02a4c3391667bfa54680f8db54477fb2b9100309bf0d515e4ee848facc.SetupBody
object
6 properties
2 required
1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.CursorPageInfo
object
Cursor information.
2 properties
382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.LogKakaoAlimOutboundContent
object
An array of message log results, one object per each message log entry.
13 properties
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFooterContent
object
Footer of a message containing one or more [interactive elements](https://www.infobip.com/docs/whatsapp/message-types-and-templates/free-form-messagesavailable…
1 property
1 required
382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.Webhooks
object
Provides options for configuring message webhooks.
3 properties
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.ValidityPeriodTimeUnit
string
Message validity period time unit.
77db2635bc301813b34d9bf25b46b5eb0b93ccf4142ac82fa2d80980d0455beb.ApiException
object
1 property
61cea6785aa06882a92b0d6cc8c922ce1d44b92bfbdfd6cde0df0f73fb2499d6.IpPoolCreateApiRequest
object
1 property
1 required
6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.WhatsAppSenderLimit
string
Current limit of the Business Portfolio.
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Collect
object
Collect action reads the DTMF input from the user’s phone and saves it into a variable. Saved variable can be used within the IVR in any other action that allo…
3 properties
1 required
9ecece8e0bfcbe5cd4fc1dd17fb7c9f9ae92bd39a74bbe56daee9e0629666e59.UploadResponse
object
1 property
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ResponseEnvelopeMessageResponseMessageResponseDetails
object
2 properties
1 required
e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TikTokOutboundMessageContent
object
Message content.
1 property
1 required
e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KoreaOptions
object
Specific parameters required for sending SMS to phone numbers registered in Korea.
1 property
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateCarouselContent
object
Template carousel. Should be defined only when template contains carousel.
1 property
1 required
14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ValidityPeriodTimeUnit
string
Message validity period time unit.
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Gender
string
Voice gender in which text would be synthesized.
fccfa6f52b47dd30d36e2c1fad9bb5d494251b453352b21aeb7a407c6f1eeb5c.ApiReport
object
List of API reports
12 properties
14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.AdvancedWebhooksWithSeen
object
Provides options for configuring message webhooks.
4 properties
2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.Colors
object
Colors settings. If not specified, the default colors will be used.
3 properties
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsMessageRequest
object
2 properties
1 required
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.WebhookDLRPayload
object
1 property
91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.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
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.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
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckResponseCodeV2
string
The result of the RCS capability check for the specified phone number. Following codes are available: ENABLED: The number can receive RCS messages from the spe…
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.Webhooks
object
Provides options for configuring message webhooks.
3 properties
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.TemplateTag
string
Template tag for classification.
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.IndiaDltOptions
object
Distributed Ledger Technology (DLT) specific parameters required for sending SMS to phone numbers registered in India.
3 properties
1 required
0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.DlrContact
object
5 properties
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberOutboundContentType
string
42b3068683a04f02f0303cd880adeb4415571c6aad33d9a3c6850123c94c9889.VoiceReportsResponse
object
1 property
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.DeliveryReport
object
Collection of reports, one per every message.
14 properties
7916e19109f991cfe966f390ef0d36117967291fa90eff57d8c8cb768f38352e.ApplicationType
string
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.GroupDestination
object
1 property
1 required
747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.DeliveryReport
object
Collection of reports, one per every message.
14 properties
32babbebe659b3766e613639af834c2c8d0ef32612ea561cefb60f69be9f25b9.MoReportBase
object
7 properties
7916e19109f991cfe966f390ef0d36117967291fa90eff57d8c8cb768f38352e.RecordingLocation
string
be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.MessagePrice
object
Sent message price.
2 properties
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.InboundMessageViberInboundMessageContent
object
Collection of mobile originated messages.
12 properties
7 required
f0c12807aec90d20a332deb5d4c4ff89651a8119eb6a5fa7e1d6e803f3c0e71b.DialogLogPage
object
2 properties
3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.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…
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.AllDomainsResponse
object
2 properties
fccfa6f52b47dd30d36e2c1fad9bb5d494251b453352b21aeb7a407c6f1eeb5c.Error
object
Indicates whether the error occurred during the query execution.
6 properties
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.BulkStatusInfo
object
2 properties
2 required
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.StartRecording
object
StartRecording action starts recording the call.
4 properties
1 required
c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderLaunchStatusWebhookResponse
object
Webhook response containing RCS sender launch status update events
1 property
1 required
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.BulkUpdateStatusResponse
object
2 properties
2 required
8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.DeliveryTime
object
The exact time of the day. The time is expressed in the UTC time zone.
2 properties
2 required
be917819c3f3f7072f44fe3d7909e7b833fe4857710e7f5ab585df108ef1ed5b.ApplicationTransferRequest
object
5 properties
1 required
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsReportSingle
object
13 properties
6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.CallingPermissionStatus
string
The current status of sender's calling permission. NOPERMISSION - The end user has not granted calling permission to the sender. TEMPORARY - The end user has g…
8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.InstagramDmOutboundContent
object
Message content.
1 property
382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.MsisdnMessageFailoverOptions
object
Message options.
5 properties
382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.SpeedLimitTimeUnit
string
The time unit to define when setting a messaging speed limit. Defaults to MINUTE.
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.AddressType
string
Type of the address. Can be HOME or WORK.
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.LocationMessage
object
9 properties
3 required
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.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
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsRequestEnvelope
object
2 properties
1 required
808c7c71509cd326700719db91283dfccde220d396434fc49825c692ac7499fd.RcsBulkSendRequest
object
1 property
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.DeliveryTime
object
The exact time of the day. The time is expressed in the UTC time zone.
2 properties
2 required
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckOptions
object
1 property
267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.ValidityPeriodTimeUnit
string
Message validity period time unit.
be917819c3f3f7072f44fe3d7909e7b833fe4857710e7f5ab585df108ef1ed5b.ApplicationTransferPropagationOptions
object
Options that should be propagated while transferring the call.
1 property
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.TemplateParameter
object
Template parameters for dynamic content.
3 properties
3 required
3307df001c42dd833d79f33c79b6946b4d01c30ce33030254141df9a2298b3c8.Error
object
6 properties
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsUnificationRequest
object
2 properties
1 required
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsActionContent
object
Allows you to specify order details.
6 properties
5 required
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsConversationStartedEvents
object
3 properties
3 required
91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.MessageResponseDetails
object
Other details of the message.
91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.DeliveryReports
object
1 property
cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.AdAccountResponse
object
List of ad accounts.
4 properties
58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.ModifiedTemplateResponse
object
1 property
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.FilePlayContent
object
Plays an audio file previously uploaded to Infobip storage.
2 properties
2 required
e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.DeliveryReport
object
Collection of reports, one per every message.
14 properties
c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateApiStatus
string
The status of a specified RCS template. Possible values: PENDING: Status indicating that the template has still not been approved by any provider and that ther…
e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.MediaTemplateBodyContent
object
Media template body
1 property
1 required
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.Platform
object
Platform options. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
2 properties
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.MessageResponseDetails
object
Other details of the message.
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Pause
object
Pause action pauses execution of the IVR scenario for the provided duration.
2 properties
1 required
91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.DefaultEventRequestOptions
object
Options applicable to all events in the request.
1 property
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsOrderItem
object
An array of items in the order.
8 properties
4 required
3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.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
c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.EditRcsSenderApiRequest
object
13 properties
9 required
747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookMessage
object
An array of message objects of a single message or multiple messages sent under one bulk ID.
6 properties
3 required
14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.SpeedLimitTimeUnit
string
The time unit to define when setting a messaging speed limit. Defaults to MINUTE.
267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.IndiaDltOptions
object
Distributed Ledger Technology (DLT) specific parameters required for sending SMS to phone numbers registered in India.
3 properties
1 required
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailToDestination
object
List of BCC recipient email addresses.
3 properties
1 required
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MultiChannel
object
Multi-channel configuration. If enabled, audio of each participant will be in a separate channel in the composed file. Otherwise, audio of all participants wil…
1 property
1 required
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.CollectOptions
object
4 properties
91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbEvent
object
An array of event objects of the events to be sent.
4 properties
2 required
2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.SecurityConfig
object
Security settings object holding the authentication settings necessary to access your webhook.
1 property
382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.MessageError
object
Indicates whether an [error](https://www.infobip.com/docs/essentials/response-status-and-error-codeserror-codes) occurred during the query execution.
6 properties
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberFileMessage
object
13 properties
3 required
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.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
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.TemplateCategory
string
Business category of the template, used for classification and approval routing.
0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.FlowCategory
string
Categories of the flow.
b28487c847ed2327e816f04e75efdaf507ffcf1d938d91963e2ce7298453183f.BulkStatusResponse
object
2 properties
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.MessageError
object
Indicates whether an [error](https://www.infobip.com/docs/essentials/response-status-and-error-codeserror-codes) occurred during the query execution.
6 properties
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.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…
53ea038e2044401649ce25e79296cd97fe7d6f7f97d15a035e41419183f810a1.ApiAddSuppressionType
string
Type of suppression.
382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.MessagePrice
object
Sent message price.
2 properties
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.TurkeyIysOptions
object
IYS regulations specific parameters required for sending promotional SMS to phone numbers registered in Turkey.
2 properties
1 required
747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.MessageResponseMessageResponseDetails
object
An array of message objects of a single message or multiple messages sent under one bulk ID.
4 properties
977e3573b6848c404863a30ecae06e08186a75a9070af48acc4b4f99a371a9b7.ClickToCallApiRequest
object
Click-to-call request object.
2 properties
1 required
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MessageResult
object
Array of sent message objects, one object per every message.
1 property
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.StandardVoiceResponse
object
2 properties
747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.SouthKoreaOptions
object
Use case dependent parameters for sending SMS to phone numbers registered in South Korea.
2 properties
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.OrderStatusContent
object
Array of order statuses information.
1 property
1 required
91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundContent
object
Content of the message.
1 property
747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.IndiaDltOptions
object
Distributed Ledger Technology (DLT) specific parameters required for sending SMS to phone numbers registered in India.
3 properties
1 required
e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.InAppStyle
string
Set to MODAL to use in app dialog for actionable message, or BANNER to show a standard banner view. MODAL is supported on iOS from 3.6.0, on Android from 1.13.…
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveButtonsActionContent
object
Allows you to specify buttons sent in the message.
1 property
1 required
60d0e6d5cbcf8382b5a6bad1f38781f71991c7ea63dad2e6ec22ddc8893af51c.RecordCallbackRequest
object
Markup Language record callback request object. Sent to the callback URL configured on the Record instruction when a recording is started, stopped, or fully pr…
8 properties
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.EmailType
string
Type of the email. Can be HOME or WORK.
14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.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
c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderStatus
string
Status of the sender. It'll be updated by Infobip platform automatically and notification about sender status update will be sent to client's webhook. Followin…
6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.SenderPublicKeyResponse
object
WhatsApp sender public key information
2 properties
2 required
267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.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
4f883ab7a2c1db442b6865996e0e9f08b46ee1927d7a2c7d45b090008604a1ec.AndroidPushNotificationConfig
object
Optional. Required if ios is not set. Configuration used to enable Android push notifications.
1 property
1 required
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RecordingServiceException
object
5 properties
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.SendRequestSchema
object
37 properties
1 required
74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.ExtendedSipTrunkStatusResponse
object
4 properties
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.CaseObject
object
1 property
3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.LogKakaoChinguOutboundContent
object
An array of message log results, one object per each message log entry.
13 properties
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.PlaceholderMasking
object
Options to full or partially mask placeholders.
6 properties
1 required
2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.DayOfWeek
string
Specify the days a link can be used. It is every day of the week, by default.
382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.ValidityPeriodTimeUnit
string
Message validity period time unit.
0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.AddFlowJson
object
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.SpeedLimitTimeUnit
string
The time unit to define when setting a messaging speed limit. Defaults to MINUTE.
49bee00604d221bf98890cc8ca36403a588d28255383650998e0c4df2f9a5b4f.WebhookTrackingPayload
object
15 properties
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallState
string
Call state.
ApiException
object
1 property
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.SingleMessageStatus
object
Indicates the message status.
5 properties
5 required
e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.TimeUnit
string
The message validity period time unit, allowing finer time granulation.
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveListContent
object
The content object to build a message that will be sent.
4 properties
2 required
be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushUnificationResponse
object
2 properties
1 required
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipTrunkActionStatusResponse
object
SIP trunk action status.
2 properties
4171c7b532e904c90fa2d755f583a0120bed3adbb383ab2309fddb57ee41f476.SingleTtsApiRequest
object
Single voice message request object.
6 properties
2 required
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Error
object
Indicates whether an error occurred during the query execution.
6 properties
02ec6d748bd9b366e5aeae1eaf03d6007ae57830d7d55344122f68a2478c9f84.UpdateCallRequest
object
4 properties
be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.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
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveButtonsHeaderContent
object
Header of a message containing one or more [interactive elements](https://www.infobip.com/docs/whatsapp/message-types-and-templates/free-form-messagesavailable…
1 property
1 required
61cea6785aa06882a92b0d6cc8c922ce1d44b92bfbdfd6cde0df0f73fb2499d6.DomainIpPoolUpdateApiRequest
object
1 property
1 required
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ContactContent
object
An array of contacts sent in a WhatsApp message.
7 properties
1 required
14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.SeenStatusReporting
object
Provides options for configuring the seen report behavior.
1 property
f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.CardApiData
object
List of cards.
3 properties
3 required
be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushOutboundContentOptionsInAppExpirationTimeUnit
string
Time unit mirrored push notification expiration.
2f1f086f3fbc952749e03dadc7759cfc932ca2898a0c5e5b77a8bc2d84bd5c48.BulkRequest
object
4 properties
2 required
f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.DefaultTemplateStructureApiData
object
Structure of the created template. Can consist of body (mandatory), header, footer, buttons, carousel, limited time offer, call permission request and shorteni…
9 properties
1 required
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.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
d32f709b8e696d073f5212b1e1d90721a8fd1118bf2c8abce078bf2baf7d1707.CallLinkPage
object
2 properties
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.PlayTtyOptions
object
1 property
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Capture
object
Capture action performs speech recognition of a specified duration. The recognized text can be used in other actions of the scenario. Speech capture will start…
7 properties
3 required
f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.CarouselApiData
object
Template carousel. Applicable only for MARKETING category.
1 property
1 required
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.TimeWindowPoint
object
Call establishment attempt end time.
2 properties
2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.LocalizationType
string
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.BulkTextMessage
object
2 properties
1 required
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.UrlOptions
object
Sets up [URL shortening](https://www.infobip.com/docs/url-shortening) and tracking feature.
5 properties
747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.MessagePrice
object
Sent message price.
2 properties
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ContactsMessage
object
9 properties
3 required
afc47ed3ecce0d042db7648b2699b209de7fd712b3df90ffbf75e4058f683890.ApiRequestError
object
1 property
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.OrderCurrency
string
Order currency.
267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.DefaultSmsFailover
object
Failover SMS message to be sent if the original message could not be delivered.
4 properties
1 required
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.AudioMessage
object
9 properties
3 required
e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Language
object
By setting the languageCode parameter you can send your language specific characters
1 property
2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.ErrorCode
object
Error code.
3 properties
e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.SeenStatusReporting
object
Provides options for configuring the seen report behavior.
1 property
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.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
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.LogResponseEmailUnificationLog
object
2 properties
eaaf11bb9830fc826a8597df01bea6f2a14ef6d1ed129a4f6623981d52827778.WebhookCallbackResponse
object
Response from the markup language callback containing instructions to execute.
1 property
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.MessageDeliveryReporting
object
Provides options for configuring the delivery report behavior.
3 properties
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsLogsMessageSegmentText
object
2 properties
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveRequestContactInfoMessage
object
10 properties
3 required
e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.MediaTemplateButtonContent
object
Media template buttons
2 properties
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.PlayTty
object
Play TTY action converts the provided text into Baudot tones and plays the generated audio, enabling the message to be displayed on a connected TTY device. Thi…
3 properties
1 required
c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.PageInfo
object
4 properties
4 required
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.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
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.BulkStatus
string
The status of the message(s).
18a8b746d2b3a8fcfed338bade07f6facb992e3867826d141a0e0ae5a3ba5642.ApiException
object
1 property
42b3068683a04f02f0303cd880adeb4415571c6aad33d9a3c6850123c94c9889.VoiceReport
object
20 properties
f6fe07754dbab8be58eaa18cf7a5d306bd0a320e1642529931d05084863a1fb3.Paging
object
Contains information about the page.
4 properties
4 required
1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.DeliveryReport
object
Collection of reports, one per every message.
14 properties
ab7498b77a5058e37557279988a806092938b5b30ecbfd39229d94cbcf4bdc07.IdentityConfirmation
object
1 property
1 required
f7a48ff9966e7ac9fef5292e0b74f7ccc796492cacffd985bfded901992c414b.TemplateEditPublicApiRequest
object
5 properties
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZaloMessageOptions
object
Message options.
7 properties
be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushOutboundContent
object
Message content.
1 property
1 required
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.OrderDetailsType
string
A quick payment option bypassing the review step. Applicable for PG PayU and PG Razorpay.
87cf6d665490382407be009353007f071b1d6d4a375e96d31d3bf0b04b7fb3c7.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
f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.HeaderApiData
object
Template header. Can be image, document, video, location or text.
1 property
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.HttpMethod
string
Http method
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.SingleMessageInfo
object
4 properties
7916e19109f991cfe966f390ef0d36117967291fa90eff57d8c8cb768f38352e.Status
string
Status of the call recording.
267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.TurkeyIysOptions
object
IYS regulations specific parameters required for sending promotional SMS to phone numbers registered in Turkey.
2 properties
1 required
43838506232bad6c43fa70e5764e200c02c98fad735eeaad33d3b47abc8da5d2.UrlDeletionRequest
object
1 property
1 required
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundMessageContentType
string
14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.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
afc47ed3ecce0d042db7648b2699b209de7fd712b3df90ffbf75e4058f683890.ApiException
object
1 property
1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.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
87cf6d665490382407be009353007f071b1d6d4a375e96d31d3bf0b04b7fb3c7.IndiaDltOptions
object
Distributed Ledger Technology (DLT) specific parameters required for sending SMS to phone numbers registered in India.
3 properties
1 required
be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushRequest
object
List of push requests
12 properties
3 required
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.DialToConversations
object
Dial to Conversations action performs a call redirection to the [Infobip Conversations platform](https://www.infobip.com/docs/conversations), joining the user’…
1 property
1 required
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MessageResponseDetails
object
Other details of the message.
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.LogsReport
object
Array of voice message logs, one object per each message.
12 properties
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicTerminationType
string
a4e0c51a24a360282e1a40c61554d239555404b786d84603912030fc4cdbb512.ReferralMediaImage
object
2 properties
e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TikTokEvent
object
An array of event objects of the events to be sent.
4 properties
3 required
3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoTargeting
string
Sets the target audience that will receive the message. Targeting types: ALLCONSENT is for messages to marketing-opted users with opt-out notice to non-friends…
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MessageErrorGroup
string
Error group name that describes which category the error code belongs to.
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFlowMessage
object
10 properties
3 required
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsMessageOrderingOptions
object
2 properties
f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.Platform
object
Platform options. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
2 properties
267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.MessageError
object
Indicates whether an [error](https://www.infobip.com/docs/essentials/response-status-and-error-codeserror-codes) occurred during the query execution.
6 properties
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.DeliveryReport
object
Collection of reports, one per every message.
14 properties
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsAdvancedMessageSegmentBinary
object
3 properties
1 required
3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.DeliveryReports
object
1 property
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RoleType
string
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Record
object
Record action records audio from the call.
8 properties
2 required
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SftpUploadStatus
string
Indicates current status of the recording file being uploaded via SFTP.
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MessageResultCc
object
1 required
b5f674fb4d8d190ed269baf3b9aaf29827a4d03ec2de31bb6b608809be9a182b.VoiceData
object
12 properties
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailMessageOptions
object
Message options.
4 properties
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.IndiaDltOptions
object
Distributed Ledger Technology (DLT) specific parameters required for sending SMS to phone numbers registered in India.
3 properties
1 required
e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.AdvancedWebhooksWithSeen
object
Provides options for configuring message webhooks.
4 properties
7916e19109f991cfe966f390ef0d36117967291fa90eff57d8c8cb768f38352e.CallType
string
Call type of the recorded call.
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.DialToConversationsOptions
object
2 properties
1 required
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsOutboundMessageContent
object
Message content.
1 property
1 required
b41d7b140d24800c94ddcc7df92e32ab37fc7d5f310ce1050b04561c5e59a3b7.LogsResponse
object
1 property
1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.InboundMessageKakaoSangdamInboundContent
object
Collection of mobile originated messages.
12 properties
7 required
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingFileLocation
string
Location of recording file after processing.
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.MachineDetection
string
Machine Detection action detects answering machines at the beginning of the call. This action sets machineAnswered variable upon completion to true or false. M…
1 required
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberTemplateResponse
object
Viber message template response containing template details and current status.
9 properties
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.AudioContentType
string
Type of audio content
382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.ToDestination
object
An array of destination objects for where messages are being sent. A valid destination is required.
2 properties
1 required
2e05f28ea1ad0c8ab6683b6adca8c2dc53bf0d4883946379aef59ba8417e5029.BulkRequest
object
1 property
1 required
f7a48ff9966e7ac9fef5292e0b74f7ccc796492cacffd985bfded901992c414b.TemplatesApiResponse
object
1 property
04790a6ae08cb63186016b6e4b8eb1c003a31d6a3227220686470a5721dc2d02.OmniAdvancedRequest
object
19 properties
dc38425c131b95e4c45181495294ce145519edf2a5db70e09ac8bc816d8bceba.UserActivityPageResponse
object
3 properties
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsOrder
object
The order details.
8 properties
3 required
0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.SeenReport
object
8 properties
e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.MessagePrice
object
Sent message price.
2 properties
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ErrorReport
object
Indicates whether the error occurred during the query execution.
6 properties
6 required
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckAsyncRequest
object
5 properties
2 required
e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoChinguData
object
Kakao ChinguTalk-specific data used if the message is sent through a Kakao ChinguTalk channel.
7 properties
2 required
8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.DefaultMessageOptions
object
Message options.
4 properties
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.ToDestination
object
An array of destination objects for where messages are being sent. A valid destination is required.
2 properties
1 required
31df1a57142f86aa8caefaa914e5a897a1c5c119e96ae8d3d5f19b12a525e2b7.Report
object
10 properties
3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundContent
object
Message content.
1 property
1 required
e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.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
e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.MessageError
object
Indicates whether an [error](https://www.infobip.com/docs/essentials/response-status-and-error-codeserror-codes) occurred during the query execution.
6 properties
c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateContentType
string
Template content type.
2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.SortDirection
string
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZaloInboundContent
object
Message content.
1 property
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.BulkStatus
string
New status of the bulk.
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.ApiReportsResponse
object
1 property
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberInboundMessageContentType
string
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsOrderExpiration
object
Expiration of the order.
2 properties
2 required
a8c993b4bcabd2960dfaf3986394e0fe85cd1c09dc98b0a81b51403a00c8f97c.PublicRecordingFile
object
11 properties
2 required
0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.AddFlowJsonValidationError
object
Errors found during validation of the uploaded file.
7 properties
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.MessageError
object
Indicates whether an [error](https://www.infobip.com/docs/essentials/response-status-and-error-codeserror-codes) occurred during the query execution.
6 properties
e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.DeliveryReport
object
Collection of reports.
13 properties
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SingleMessageInfo
object
4 properties
f6fe07754dbab8be58eaa18cf7a5d306bd0a320e1642529931d05084863a1fb3.TemplateBody
object
Template body containing the actual message text for a specific language.
2 properties
2 required
87fdb606ad2c440ed89e04f515deb90150ccd79b7e43f8b50549f5895d6c3429.CallsConfigurationResponse
object
2 properties
f0c12807aec90d20a332deb5d4c4ff89651a8119eb6a5fa7e1d6e803f3c0e71b.SipTrunkServiceAddressPage
object
2 properties
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.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
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsMessageOptions
object
Message options.
6 properties
c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTestNumber
object
4 properties
4 required
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallEndpoint
object
Call endpoint. Represents a caller for the inbound calls and a callee for the outbound calls.
1 property
7916e19109f991cfe966f390ef0d36117967291fa90eff57d8c8cb768f38352e.PageInfo
object
Information about the page.
4 properties
4 required
a09fd2f38320e8e77c07ff55b0f3c0f934582962897bb3b86f1a032582a1cc60.RcsSendRequest
object
11 properties
2 required
2d9ba0ce97cbc02fae57e41d1bc0e149a861cca6355f94de8d80841221b66e06.ApiException
object
1 property
267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.Platform
object
Platform options. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
2 properties
53ea038e2044401649ce25e79296cd97fe7d6f7f97d15a035e41419183f810a1.SuppressionInfoPageResponse
object
Suppression get response.
2 properties
2 required
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsAdvancedMessageSegmentUploadReference
object
2 properties
1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.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
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlType
string
Type of the url. Can be HOME or WORK.
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsIsTypingEvent
object
Collection of typing indicator events.
6 properties
4 required
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ImageContent
object
The content object to build a message that will be sent.
3 properties
1 required
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.VoiceOptions
object
2 properties
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Provider
string
Speech-to-text provider to use. Defaults to AZURE.
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.Status
object
Indicates whether the initiated email has been successfully sent, not sent, delivered, not delivered, waiting for delivery or any other possible status.
6 properties
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsMmsFailover
object
Failover MMS message to be sent if the original message could not be delivered. Please note that either SMS failover or MMS failover can be set, but not both.
3 properties
1 required
ce93fb2fe51c89086b5064c5562c417f51be44b14f40606d3932f527a3fd02d9.MmsAdvancedRequest
object
2 properties
1 required
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.TurkeyIysOptions
object
IYS regulations specific parameters required for sending promotional SMS to phone numbers registered in Turkey.
2 properties
1 required
e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.MessageErrorGroup
string
Error group name that describes which category the error code belongs to.
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsToDestination
object
An array of destination objects for where messages are being sent. A valid destination is required.
3 properties
1 required
7c9f96abfad3f4dcf2c0a97ec8d627a73c6fe4ecaf776deaddf2ab2888baddbf.InstagramDmRequest
object
2 properties
1 required
747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.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
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BulkCallRequest
object
Call request list.
2 properties
1 required
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.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…
14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.MessageResponseMessageResponseDetails
object
An array of message objects of a single message or multiple messages sent under one bulk ID.
4 properties
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveMultiProductHeaderContent
object
Header of a message containing one or more [interactive elements](https://www.infobip.com/docs/whatsapp/message-types-and-templates/free-form-messagesavailable…
1 property
1 required
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberOutboundContent
object
Message content.
1 property
1 required
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.LogsResponse
object
1 property
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.UploadBinaryResult
object
1 property
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.DocumentMessage
object
10 properties
3 required
61cea6785aa06882a92b0d6cc8c922ce1d44b92bfbdfd6cde0df0f73fb2499d6.IpPoolDetailResponse
object
3 properties
3 required
91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.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
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MessageResponseDetails
object
Other details of the message.
91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundContentType
string
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.EmailContent
object
Array of emails information.
2 properties
61cea6785aa06882a92b0d6cc8c922ce1d44b92bfbdfd6cde0df0f73fb2499d6.DomainIpPoolAssignApiRequest
object
2 properties
2 required
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.TemplateRequest
object
Request to create or register a new Viber message template.
3 properties
2 required
c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.EditPlatformParametersApiRequest
object
1 property
1 required
ae8a6eecccfb565f1840ac10e7bfb960a35d1e256ae31abf1bdea45a1d2f5557.CallLinkRequest
object
Enable calls between users that have an Infobip account and users that don't.
7 properties
1 required
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Platform
object
Platform options. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
2 properties
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsAdvancedMessageSegmentSmil
object
3 properties
1 required
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveMediaCarouselContent
object
The content object to build a message that will be sent.
2 properties
2 required
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.OrderStatus
string
Status of the order.
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.AudioContent
object
The content object to build a message that will be sent.
2 properties
1 required
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MessageResultBcc
object
1 required
0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.UpdateFlowRequest
object
2 properties
2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.RecordingLocation
string
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.UrlOptions
object
Sets up [URL shortening](https://www.infobip.com/docs/url-shortening) and tracking feature.
5 properties
c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.TemplateUpdateEvent
object
4 properties
4 required
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.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
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailStatus
object
Indicates whether the email is successfully sent, not sent, delivered, not delivered, waiting for delivery or any other possible status.
5 properties
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TextContent
object
The content object to build a message that will be sent.
2 properties
1 required
c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.TermsWebAddress
object
Terms and conditions associated with the sender.
2 properties
1 required
14b5f31f4f292db4a32c4e61928f9a47f8ff4c0a1c06a38af2c29ef9ca05095d.DialogSayRequest
object
5 properties
2 required
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveMediaCarouselAction
object
Allows you to specify cards of the carousel.
1 property
1 required
14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotInboundResponse
object
3 properties
382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.DeliveryReports
object
1 property
b2a108c706e7d46b95495b161a8c99f5751c046c5e419f6f0780788488a1af14.CallLinkConfig
object
Call link configuration.
8 properties
56fc13d85fd8c7d40ac0157103bb5ccebc0bb2862850603cc2c5a808276f4742.CredentialsBody
object
2 properties
2 required
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingRequest
object
6 properties
1 required
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.DefaultMessageRequestOptions
object
Options applicable to all messages in the request.
2 properties
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.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
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.MessageDeliveryReporting
object
Provides options for configuring the delivery report behavior.
3 properties
267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.LineOnOutboundContentType
string
0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.Type
string
Type of the message content. Select the type from the dropbox to view their parameters.
c18e27d419b307552daa9403b0085ee796da1a5e57e2a4e6fb73f406471574fc.Conference
object
5 properties
87cf6d665490382407be009353007f071b1d6d4a375e96d31d3bf0b04b7fb3c7.Tracking
object
Sets up tracking parameters to track conversion metrics and type. This is a legacy feature not compatible with the tracking feature in latest [Send SMS message…
4 properties
91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.DeliveryTime
object
The exact time of the day. The time is expressed in the UTC time zone.
2 properties
2 required
ff7f7515e81995b140ab1c879b88d9d297a14922c035a187e237cd81e7c216a0.EventDetails
object
Email platform event data.
1 property
1 required
450b8e1c5aa2576ea4225d97920eb07c6a588176f5f842cc401b6c579419dc38.Type
string
1e938b22275568ebc747d21724b50c9be18ff5770eb33c37b76fda4633c14bde.RouteOrderRequest
object
Route request object.
1 property
1 required
3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.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
1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.FailoverDestinationPair
object
The SMS failover destination matching.
2 properties
2 required
747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.NonMsisdnMessageFailoverOptions
object
Message options.
5 properties
1bf84e5ebfeebf0839825dcb3ba7bdfe29e9008eef02919c0c668629628db19e.OmniLogsResponse
object
1 property
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsOutboundEventContentType
string
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.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
14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.FailoverDestinationPair
object
The SMS failover destination matching.
2 properties
2 required
329f726ae6e36d1a92786c502bebf028e5aa08cc32a3a8e9f0bed0d82dbc7157.AdvancedTtsApiRequest
object
Advanced voice message request object.
2 properties
1 required
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.FileContent
object
The content object to build a message that will be sent.
2 properties
2 required
27eaa09c2aeef6932f3271ca5bde4158d33d6ab404b64c38db12c844a2084089.RingbackGeneration
object
Option to generate a consistent local ringback tone, overriding remote ringing tones. If enabled, the ringback will be generated for existing conference partic…
1 property
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.FailoverDestinationPair
object
The SMS failover destination matching.
2 properties
2 required
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackEndpointType
string
f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.ValidityPeriodTimeUnit
string
Message template validity period time unit.
1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamRequest
object
2 properties
1 required
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsLogsMessageSegmentLink
object
3 properties
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Play
object
Play action plays an audio file or stream to the caller.
3 properties
2 required
be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.MessageErrorGroup
string
Error group name that describes which category the error code belongs to.
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.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
a4e0c51a24a360282e1a40c61554d239555404b786d84603912030fc4cdbb512.ReferralMediaVideo
object
2 properties
999e23a63911c41e6f288f288564c4bc2e6a35a6f2a9edba53ecac8c52fe9339.DeliveryInfo
object
Delivery information about the bulk sending of messages.
2 properties
2 required
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.LogResponseLogViberOutboundContent
object
2 properties
53ea038e2044401649ce25e79296cd97fe7d6f7f97d15a035e41419183f810a1.DeleteSuppression
object
Suppression.
3 properties
3 required
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailMediaInlineImage
object
Allows for inserting an image file inside the HTML code of the email by using cid:FILENAME instead of providing an external link to the image.
1 property
1 required
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.PhoneType
string
Type of the phone number. Can be CELL, MAIN, IPHONE, HOME or WORK.
a09fd2f38320e8e77c07ff55b0f3c0f934582962897bb3b86f1a032582a1cc60.RcsSendTemplateRequest
object
11 properties
2 required
3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.RecipientType
string
Recipient Type must be TACIR or BIREYSEL.
46339420b556d1893a150250c0e3220eb8057cd2fc4110e601753f705fc1f8c4.SimpleReport
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsIsTypingEventContent
object
Event content.
1 property
1 required
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.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
be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushBulkResponse
object
Array of push bulk responses
4 properties
4 required
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.Status
object
Indicates whether the message is successfully sent, not sent, delivered, not delivered, waiting for delivery, or any other possible status.
5 properties
5 required
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.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…
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.SmsFailover
object
SMS message to be sent if the Viber message could not be delivered.
4 properties
2 required
73f6910bb0f0a3f1f6a9e6796ff94e4b37e388cd86d56d7e974197854e7020f7.ApiException
object
1 property
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Price
object
Sent voice message price.
2 properties
14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.MessageErrorGroup
string
Error group name that describes which category the error code belongs to.
61cea6785aa06882a92b0d6cc8c922ce1d44b92bfbdfd6cde0df0f73fb2499d6.DomainIpApiPool
object
IP pools assigned to the domain. Assigned IP pools with the lowest priority value have the highest sending precedence.
4 properties
4 required
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageResponseDetails
object
Other details of the message.
bced1b5de5a3082b5f8ce3c272029f66a05beaf3b2db4fdc852bd1a5393c0582.ImageResponse
object
4 properties
e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.DeliveryReports
object
1 property
2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.Layout
string
Represents layout during the call.When GRID layout is selected, multiple video streams are displayed simultaneously and user can spotlight specific video strea…
91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.IndiaDltOptions
object
Distributed Ledger Technology (DLT) specific parameters required for sending SMS to phone numbers registered in India.
3 properties
1 required
91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.MessagePrice
object
Sent message price.
2 properties
e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.MessageResponseDetails
object
Other details of the message.
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.SeenStatusReporting
object
Provides options for configuring the seen report behavior.
1 property
ApiErrorViolation
object
List of violations that caused the error.
2 properties
e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.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…
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.GeneralStatus
string
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.VideoMediaProperties
object
Video media properties.
3 properties
14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.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
ApiError
object
5 properties
5 required
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ConferenceComposition
object
1 property
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.TurkeyIysOptions
object
IYS regulations specific parameters required for sending promotional SMS to phone numbers registered in Turkey.
2 properties
1 required
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.TemplateBody
object
Template body containing the actual message text for a specific language.
2 properties
2 required
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsIsTypingEvents
object
3 properties
3 required
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZaloReportRequest
object
1 property
1 required
245a74e48cd7ce0a3e2f108689f6fc8d5a08a4d75c5aeb1883fc983443d62958.LiveChatInboundUserData
object
Data about the user who sent the message.
2 properties
1 required
1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamMessageRequestOptions
object
Options applicable to all messages in the request.
1 property
f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.V1ButtonApiData
object
Template buttons. Can be either up to 3 quick reply buttons or up to 2 call to action buttons. Call to action buttons must be unique in type.
2 properties
1 required
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MessagePrice
object
Sent message price.
2 properties
61cea6785aa06882a92b0d6cc8c922ce1d44b92bfbdfd6cde0df0f73fb2499d6.IpDomainResponse
object
3 properties
3 required
267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.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…
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MoDestinationCc
object
1 property
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.StatusReason
string
[The status](https://www.infobip.com/docs/essentials/api-essentials/response-status-and-error-codes) of RCS capability check request for the specified phone nu…
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveMediaCarouselMessage
object
10 properties
3 required
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberMessageOptions
object
Message options.
10 properties
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RequestSchedulingSettings
object
Options for scheduling a message.
3 properties
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.WaitForEom
string
Indicates whether end of the message detection is enabled for the call. ALWAYS specifies that after detection of MACHINE the script will always wait for the en…
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SayOptions
object
3 properties
f6fe07754dbab8be58eaa18cf7a5d306bd0a320e1642529931d05084863a1fb3.TemplateStatus
string
Current approval status of the template in the review process.
6ee61eb40f9e4619d309dfe8df9b479488b43bcde7df95f6a044b2e14abf591e.RecordingApplication
object
Recording application metadata
1 property
1 required
e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TurkeyIysOptions
object
IYS regulations specific parameters required for sending promotional SMS to phone numbers registered in Turkey.
2 properties
1 required
31756dca18d13ab491063defb0eba5e91f72bccd700f710f44794c6f1df9c9ea.ApiException
object
1 property
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.DeliveryTimeWindow
object
Scheduling object that allows setting up detailed time windows in which the message can be sent. Consists of from, to and days properties. Days property is man…
3 properties
2 required
382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.SouthKoreaOptions
object
Use case dependent parameters for sending SMS to phone numbers registered in South Korea.
2 properties
91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.CursorPageInfo
object
Cursor information.
2 properties
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberImageMessage
object
13 properties
3 required
39bb6975d36d214ea076d974c69ec0b82edda805f4c6bf36a3f6f7d154c98fa0.Base64EncodedFile
object
3 properties
3 required
394de68b2af4916e47f48a4cc3026c2ec4c22342d1304c00a584d14a92a333c1.ApiException
object
1 property
74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.SipTrunkStatusResponse
object
1 property
be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.MessageError
object
Indicates whether an [error](https://www.infobip.com/docs/essentials/response-status-and-error-codeserror-codes) occurred during the query execution.
6 properties
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RescheduleRequest
object
1 property
1 required
be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.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
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.RecipientInfo
object
Recipient information such as device type, OS, device name.
3 properties
e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.TransliterationCode
string
Conversion of a message text from one script to another.
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BulkItem
object
Bulk item list.
11 properties
1 required
747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.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
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.GeoLocationInfoWrapper
object
Geolocation data such as Country and City.
2 properties
c5d63eb36983d8ea1e54e74166c0e08ea636cff38a55aa9570bd7ba615a520a0.RouteSimulatorRequest
object
Route simulator request object.
3 properties
2 required
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckSyncResult
object
The result of the RCS capability check for the specified phone numbers.
3 properties
3 required
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MessageErrorGroup
string
Error group name that describes which category the error code belongs to.
f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.TemplateUpdatePushEvent
object
7 properties
5 required
0ea963ede06ee99578911cc0068f7474598729635091b55d2985483fad214d7b.StatusResponse
object
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsMessageResponseDetails
object
Other details of the message.
1 property
0a37b8c521b3309d1bbd0669d19fc7f2f157d68a68747b5e7ad23e5b0f5e47e8.OpenChannelMessageContent
object
Content of the message.
1 property
1 required
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsOutboundContent
object
Message content.
2 properties
1 required
e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Url
object
Url information.
2 properties
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.Platform
object
Platform options. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
2 properties
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.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
4f883ab7a2c1db442b6865996e0e9f08b46ee1927d7a2c7d45b090008604a1ec.PushConfigurationRequest
object
3 properties
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Price
object
Sent SMS price.
2 properties
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SingleMessageStatus
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
cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.AudienceUsersResponse
object
4 properties
c8cb45a488f0d2ea03cc082d0f61afb1c3b35cdd297a9f7abb6df8ac5619a483.ConfigurationsResponse
object
1 property
1 required
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BulkCall
object
Bulk call list.
8 properties
1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.Webhooks
object
Provides options for configuring message webhooks.
3 properties
52c80a2bd29a734b52d9eb3ddb9b5d8ef0cb7c55640245f275763458f4c36a60.MetaConversionType
string
Type of the conversion. Can be PURCHASE or LEADSUBMITTED.
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailIps
object
IP options per message.
1 property
14b5f31f4f292db4a32c4e61928f9a47f8ff4c0a1c06a38af2c29ef9ca05095d.DialogAcceptTransferRequest
object
1 property
1 required
59ad711434aad6c39708ffc0bab084b409f8c1de0ab1fd0cfa66aa965f740ee4.CallbackRequest
object
Callback request.
5 properties
cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.GetAudienceResponse
object
List of custom audiences.
5 properties
e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.OmniLog
object
Collection of logs.
12 properties
2dac378b25c8dcf450b0618ee8c5fb6fb461154cc6b53aedfd327a01e576875e.RingbackGeneration
object
Option to generate a consistent local ringback tone, overriding remote ringing tones. If enabled, the ringback will be generated for the existing call, provide…
1 property
1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.ResponseEnvelopeMessageResponseMessageResponseDetails
object
2 properties
1 required
747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.SpeedLimitTimeUnit
string
The time unit to define when setting a messaging speed limit. Defaults to MINUTE.
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveAllowedOrderPaymentDetails
object
Payment of the order.
1 property
1 required
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsUnificationDestinationSingle
object
---
2 properties
1 required
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.BulkStatusResponse
object
2 properties
2 required
2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.PageInfo
object
Contains information about the page.
4 properties
4 required
1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.RequestSchedulingSettings
object
Options for scheduling a message.
3 properties
578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException
object
1 property
3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.MessageErrorGroup
string
Error group name that describes which category the error code belongs to.
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFlowContent
object
The content object to build a message that will be sent.
4 properties
2 required
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.OnDemandComposition
object
Composition request.
2 properties
2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.Destination
object
Description of who or what is going to receive a call.
1 property
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckAsyncResponse
object
2 properties
2 required
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingChannels
string
Audio channel mode. If set to STEREO, incoming audio from the endpoint is recorded on the left channel and outgoing audio on the right channel.
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberInboundMessageContent
object
Message content.
1 property
1 required
fc58971973975508c3c8fc4221c7201147a075acf31dce7331f3a874d9fc423d.ApnsData
object
APNs data.
1 property
97cb4ba23432eb0e600ef0617ae1982d499839ef41226973c71dfb335b3071b8.StandardVoiceResponse
object
Voice response object
2 properties
1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.MessageErrorGroup
string
Error group name that describes which category the error code belongs to.
be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.DeliveryTime
object
The exact time of the day. The time is expressed in the UTC time zone.
2 properties
2 required
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsDescriptiveAmount
object
2 properties
1 required
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailLogResponse
object
1 property
8ea2c7a3b5efbaf9015a5275da389c3449f0ab4f7dfbf8f3f925836e68df04d6.ApiException
object
1 property
be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushStatusResponse
object
Message status.
5 properties
4 required
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailMessageRequestOptions
object
Options applicable to all messages in the request.
3 properties
c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTestNumberPageResponse
object
2 properties
2 required
e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.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.
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.RecordOptions
object
4 properties
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.VideoMessage
object
10 properties
3 required
747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.SeenStatusReporting
object
Provides options for configuring the seen report behavior.
1 property
245a74e48cd7ce0a3e2f108689f6fc8d5a08a4d75c5aeb1883fc983443d62958.LiveChatInboundContent
object
Message content.
1 property
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.NonMsisdnSmsFailover
object
Failover SMS message to be sent if the original message could not be delivered.
5 properties
1 required
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZaloOutboundContentType
string
be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.DeliveryReport
object
Collection of reports, one per every message.
14 properties
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsAdvancedMessageSegment
object
Content of the message being sent.
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.BulkRescheduleRequest
object
1 property
1 required
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckSyncResponse
object
2 properties
1 required
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MediaStreamMultiChannel
object
Multi-channel streaming configuration. When enabled, streams both directions as interleaved stereo (left=caller's voice, right=what caller hears). Disabled by…
1 property
1 required
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Log
object
Collection of logs.
15 properties
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.DialData
object
The data related to the dial instruction.
4 properties
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateHeaderContent
object
Template header. Should be defined, only if placeholders or media have been registered in the template's header.
1 property
1 required
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsResponseEnvelope
object
2 properties
1 required
53ea038e2044401649ce25e79296cd97fe7d6f7f97d15a035e41419183f810a1.ApiDomainAccess
string
Represents the access level for the domain. Domain can be either owned or have granted permissions.
267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.RecipientType
string
Recipient Type must be TACIR or BIREYSEL.
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFlowActionPayload
object
Required when flowAction is set to 'NAVIGATE. Should be omitted otherwise.
2 properties
1 required
dc38425c131b95e4c45181495294ce145519edf2a5db70e09ac8bc816d8bceba.UserActivityResponse
object
List of results for the requested page.
3 properties
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.UrlTrackingWebhook
object
11 properties
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsUnificationMessageOptions
object
Message options.
6 properties
e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoAlimButton
object
Buttons to include in the message. Optional value. Max 5 buttons.
2 properties
1 required
cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.PageMarketingSubscriptionResponse
object
9 properties
9 required
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SynthesisVoiceResponse
object
Array of voices belonging to the specified language.
8 properties
1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.MessagePrice
object
Sent message price.
2 properties
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.MessagePrice
object
Sent message price.
2 properties
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CapturePlayInstruction
object
Audio content to play before capturing DTMF input.
1 property
1 required
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ToDestination
object
An array of destination objects for where messages are being sent. A valid destination is required.
2 properties
1 required
32babbebe659b3766e613639af834c2c8d0ef32612ea561cefb60f69be9f25b9.IntegrationType
object
1 property
3307df001c42dd833d79f33c79b6946b4d01c30ce33030254141df9a2298b3c8.Status
object
6 properties
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.DeliveryTime
object
The exact time of the day. The time is expressed in the UTC time zone.
2 properties
2 required
f9f4d06aa76c139ea87428e14c99b11f79a0ab9b330e26afc80d0c5a5ff1acbb.RingbackGeneration
object
Option to generate a consistent local ringback tone, overriding remote ringing tones. It applies only to INBOUND parent calls in the CALLING state; otherwise,…
1 property
53ea038e2044401649ce25e79296cd97fe7d6f7f97d15a035e41419183f810a1.SuppressionInfo
object
Suppression get response.
5 properties
5 required
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.ResponseEnvelopeMessageResponseMessageResponseDetails
object
2 properties
1 required
1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.NonMsisdnMessageFailoverOptions
object
Message options.
5 properties
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.DeliveryReports
object
1 property
c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.CreateRcsTemplateRequest
object
3 properties
3 required
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZaloOutboundContent
object
Message content.
1 property
1 required
e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.ValidityPeriodTimeUnit
string
Message validity period time unit.
eaaf11bb9830fc826a8597df01bea6f2a14ef6d1ed129a4f6623981d52827778.MarkupLanguageConfigResponse
object
Markup language configuration response object.
8 properties
3 required
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.TemplateProperty
object
List of template properties.
6 properties
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.MarkupHttpMethod
string
Allowed markup HTTP method.
c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplate
object
5 properties
5 required
02ec6d748bd9b366e5aeae1eaf03d6007ae57830d7d55344122f68a2478c9f84.UpdateRequest
object
3 properties
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.LanguageCode
string
[Language code](https://www.infobip.com/docs/sms/languagenational-language-identifier) for the correct character set. AUTODETECT lets the platform select the c…
8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.DeliveryReport
object
Collection of reports, one per every message.
14 properties
c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTestNumberUpdateEvent
object
Collection of RCS test number update events
8 properties
6 required
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsUnificationSouthKoreaOptions
object
Use case dependent parameters for sending MMS to phone numbers registered in South Korea.
1 property
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.VoiceReportResponse
object
1 property
f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.TemplateStructureApiData
object
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateDataContent
object
Template data. Values have to be set as registered in the template.
6 properties
1 required
267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.DeliveryTime
object
The exact time of the day. The time is expressed in the UTC time zone.
2 properties
2 required
9ecece8e0bfcbe5cd4fc1dd17fb7c9f9ae92bd39a74bbe56daee9e0629666e59.UploadBody
object
2 properties
60d0e6d5cbcf8382b5a6bad1f38781f71991c7ea63dad2e6ec22ddc8893af51c.WebhookCallbackRequest
object
Markup language callback request object.
6 properties
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Webhooks
object
Provides options for configuring message webhooks.
3 properties
3307df001c42dd833d79f33c79b6946b4d01c30ce33030254141df9a2298b3c8.Price
object
2 properties
f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.ShorteningOptionsApiData
object
URL shortening options. Applicable only if at least one dynamic URL button is present. Modifying this provided URL outside of our company's services may lead t…
1 property
1 required
be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushOutboundContentOptionsInboxMessageExpirationTimeUnit
string
Time unit for inbox message expiration. Only applicable when inboxTopic is present.
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveMultiProductContent
object
The content object to build a message that will be sent.
4 properties
3 required
e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.DeliveryTime
object
The exact time of the day. The time is expressed in the UTC time zone.
2 properties
2 required
f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.TemplatesApiResponsePaginated
object
2 properties
2 required
14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotMessageRequestOptions
object
Options applicable to all messages in the request.
1 property
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Say
object
Say action converts provided text into an audio file which is played during the call based on the provided parameters. Message text can be up to 1400 character…
3 properties
1 required
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.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
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.RecordedAudioFilesResponse
object
1 property
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Identity
object
3 properties
3 required
04790a6ae08cb63186016b6e4b8eb1c003a31d6a3227220686470a5721dc2d02.CreateOrUpdateScenarioRequest
object
3 properties
1 required
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.CursorPageInfo
object
Cursor information.
2 properties
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsContent
object
The content object to build a message that will be sent.
4 properties
2 required
c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateContent
object
Template content.
1 property
1 required
c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.CountryProviders
object
2 properties
2 required
be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushMessageRequestOptions
object
Options applicable to all messages in the request.
1 property
3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.AdvancedMessageDeliveryReporting
object
Provides options for configuring the delivery report behavior.
4 properties
245a74e48cd7ce0a3e2f108689f6fc8d5a08a4d75c5aeb1883fc983443d62958.LivechatInboundMessages
object
3 properties
3 required
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderPaymentStatus
object
Payment of the order.
1 property
1 required
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFlowAction
string
Action of the flow, can be either 'NAVIGATE' or 'DATAEXCHANGE'.
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundMessageContent
object
Message content.
1 property
1 required
e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Phone
object
Phone information.
3 properties
91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.NonMsisdnMessageFailoverOptions
object
Message options.
5 properties
cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.MessengerConsentChannelData
object
Messenger-specific subscription data.
6 properties
1 required
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateContent
object
The content object to build a message that will be sent.
3 properties
3 required
be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.MessageDeliveryReporting
object
Provides options for configuring the delivery report behavior.
3 properties
382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.TurkeyIysOptions
object
IYS regulations specific parameters required for sending promotional SMS to phone numbers registered in Turkey.
2 properties
1 required
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.DeliveryTimeWindow
object
Scheduling object that allows setting up detailed time windows in which the message can be sent. Consists of from, to and days properties. Days in the week are…
3 properties
3 required
267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.MessagePrice
object
Sent message price.
2 properties
14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.LogResponseLogViberBotOutboundContent
object
2 properties
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.HangupSource
string
Hangup source.
1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.SouthKoreaOptions
object
Use case dependent parameters for sending SMS to phone numbers registered in South Korea.
2 properties
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Report
object
Arrays of delivery reports, one object for every message.
11 properties
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.LanguageConfiguration
object
Sets up additional configuration that changes the original message content you can preview with this call.
2 properties
1fab3d191d736425211a5879d4b2241fa0e80b8ab68239ab74531b9b6408a7a8.DeletionAcceptedResponse
object
Response to an accepted request.
4 properties
1 required
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.ClientPriority
string
Client priority set on request. Must be 'HIGH', 'STANDARD' or 'LOW'.
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallRecordingRequest
object
4 properties
1 required
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.RequestSchedulingSettings
object
Options for scheduling a message.
3 properties
cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.GetCampaignsResponse
object
1 property
f6fe07754dbab8be58eaa18cf7a5d306bd0a320e1642529931d05084863a1fb3.ViberTemplateResponseNoDates
object
Viber message template response containing template details and current status.
7 properties
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SearchResponse
object
10 properties
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailDeliveryReports
object
2 properties
1 required
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipTrunkAdminStatus
string
SIP trunk admin status.
14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.RequestSchedulingSettings
object
Options for scheduling a message.
3 properties
3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.SpeedLimitTimeUnit
string
The time unit to define when setting a messaging speed limit. Defaults to MINUTE.
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.MessageResponseDetails
object
Other details of the message.
ce93fb2fe51c89086b5064c5562c417f51be44b14f40606d3932f527a3fd02d9.SendResult
object
3 properties
1 required
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Status
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
43838506232bad6c43fa70e5764e200c02c98fad735eeaad33d3b47abc8da5d2.MarkAsReadErrorResponse
object
1 property
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Retry
object
Used to define if the delivery of the Voice messages should be retried in case the first try doesn't succeed. Additional retries will be made according to the…
3 properties
3 required
8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.InstagramDmOutboundContentType
string
cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.ConsentEvent
string
Subscription event type.
d32f709b8e696d073f5212b1e1d90721a8fd1118bf2c8abce078bf2baf7d1707.RecordingPage
object
2 properties
267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.DeliveryReport
object
Collection of reports, one per every message.
14 properties
8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.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.
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CmlScript
array
Array of markup language instructions defining the call flow.
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.AudioContent
object
1 property
1 required
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.WhileDo
object
While-Do action executes the do field block of code as long as a specified condition is true in the while field. As with Repeat-While, comparison is done using…
2 properties
2 required
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsApiResponse
object
1 property
1 required
f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.Language
string
Template language, one template with same name can have multiple transliterations.
747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.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
267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.ToDestination
object
An array of destination objects for where messages are being sent. A valid destination is required.
2 properties
1 required
be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushUnificationRequest
object
2 properties
1 required
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogHangupSource
string
0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.GetSenderFlowsResponse
object
1 property
1 required
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.FilePage
object
2 properties
2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.RecordingFile
object
Recording files.
10 properties
f6fe07754dbab8be58eaa18cf7a5d306bd0a320e1642529931d05084863a1fb3.TemplateParamType
string
Type of template parameter.
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.DefaultEventRequestOptions
object
Options applicable to all events in the request.
1 property
30350ea3b42c85fe379e7561e2b43510ecd150d18a85f55710d4f6347f698f75.WhatsAppSenderRegistrationStatus
string
Add phone number status.
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipOptions
object
SIP Options.
1 property
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.CreateTemplateResponse
object
Response from Zalo API after creating a ZBS template.
9 properties
1 required
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MediaStreamAudioProperties
object
3 properties
1 required
0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundMessageBase
object
5 properties
e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.SeenReport
object
Collection of reports, one per every received message.
6 properties
747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.RecipientType
string
Recipient Type must be TACIR or BIREYSEL.
1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.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…
e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Email
object
Email information.
2 properties
d1778b306237beb41d9922fd3fd38c085ddcf463c618d1f8ceed148892c3020d.SystemEvent
object
5 properties
91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.LogResponseLogAppleMfbOutboundContent
object
2 properties
6665694460cb56ab854a173ada36805c85c7ec55584901d2f06225baf9b586cb.CallSendMessageRequest
object
1 property
1 required
e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.RequestSchedulingSettings
object
Options for scheduling a message.
3 properties
2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.Recording
object
Recording metadata.
2 properties
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.BulkMessage
object
2 properties
1 required
14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.SouthKoreaOptions
object
Use case dependent parameters for sending SMS to phone numbers registered in South Korea.
2 properties
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveUrlButtonMessage
object
10 properties
3 required
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.SouthKoreaOptions
object
Use case dependent parameters for sending SMS to phone numbers registered in South Korea.
2 properties
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.StickerContent
object
The content object to build a message that will be sent.
1 property
1 required
f7a48ff9966e7ac9fef5292e0b74f7ccc796492cacffd985bfded901992c414b.TemplatePublicApiRequest
object
5 properties
4 required
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.VoiceResponseDetails
object
Array of sent messages, one object per every message.
3 properties
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.BulkStatus
string
Status of scheduled email messages.
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Hangup
string
Hangup action marks the end of the IVR flow execution, leading to the call actually being hung up.
1 required
a22294a21e0a6f95f3711ca1f29de62bd2ce6d8bf890b9e41dadab263638faaf.Price
object
2 properties
14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.DeliveryReport
object
Collection of reports, one per every message.
14 properties
8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.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
245a74e48cd7ce0a3e2f108689f6fc8d5a08a4d75c5aeb1883fc983443d62958.LiveChatInboundUserIdentityType
string
Unique Person identifier type.
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailStorage
object
[Email storage options](https://www.infobip.com/docs/email/email-storage-and-retrieval) per message.
2 properties
245a74e48cd7ce0a3e2f108689f6fc8d5a08a4d75c5aeb1883fc983443d62958.MessagePrice
object
Sent message price.
2 properties
d32f709b8e696d073f5212b1e1d90721a8fd1118bf2c8abce078bf2baf7d1707.ImagePage
object
2 properties
14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ResponseEnvelopeMessageResponseMessageResponseDetails
object
2 properties
1 required
f0c12807aec90d20a332deb5d4c4ff89651a8119eb6a5fa7e1d6e803f3c0e71b.ConferenceRecordingPage
object
2 properties
4f883ab7a2c1db442b6865996e0e9f08b46ee1927d7a2c7d45b090008604a1ec.PushConfigurationResponse
object
4 properties
e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.RecipientType
string
Recipient Type must be TACIR or BIREYSEL.
382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.MessageResponseDetails
object
Other details of the message.
1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamOutboundContent
object
Message content.
1 property
245a74e48cd7ce0a3e2f108689f6fc8d5a08a4d75c5aeb1883fc983443d62958.LiveChatInboundContentType
string
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberRequest
object
2 properties
1 required
b5f674fb4d8d190ed269baf3b9aaf29827a4d03ec2de31bb6b608809be9a182b.VoiceReport
object
11 properties
707907921d4508c2925eddc2449f10db322ecc083be424f87c50fe97ccd8be40.AddNewCallRequest
object
4 properties
1 required
b2a108c706e7d46b95495b161a8c99f5751c046c5e419f6f0780788488a1af14.CallLinkConfigRequest
object
Call link configuration.
7 properties
1 required
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.SeenStatusReporting
object
Provides options for configuring the seen report behavior.
1 property
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SendingSpeed
object
Sending rate defined in number of messages sent per second, minute, hour or day. You may wish to use this to allow your systems or agents to handle large amoun…
2 properties
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Destination
object
An array of destination objects for where messages are being sent. A valid destination is required.
2 properties
1 required
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckAsyncResult
object
2 properties
1 required
14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.DeliveryReports
object
1 property
431fb79b0e816230968e14ba1e1c6fadb75cfde9cb3c381f4217b2777f48153f.Call
object
19 properties
1 required
747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.MessageResponseDetails
object
Other details of the message.
1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamInboundResponse
object
3 properties
a22294a21e0a6f95f3711ca1f29de62bd2ce6d8bf890b9e41dadab263638faaf.Error
object
6 properties
747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.SeenReports
object
1 property
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Pause
object
Pause action waits for a specified duration before executing the next instruction.
2 properties
2 required
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateButtonContent
object
Template buttons. Should be defined in the correct order, only if quick reply or dynamic URL buttons have been registered. It can have up to ten buttons includ…
1 property
1 required
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.MessagePrice
object
Sent message price.
2 properties
382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.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
382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.MessageErrorGroup
string
Error group name that describes which category the error code belongs to.
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallTransfer
object
Call transfers object enables transferring the ongoing call to another recipient(s) and establish a communication between your original recipient and additiona…
4 properties
2 required
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.Price
object
2 properties
cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.CampaignRequest
object
5 properties
3 required
c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.PrivacyWebAddress
object
Privacy policy associated with the sender.
2 properties
1 required
14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.IndiaDltOptions
object
Distributed Ledger Technology (DLT) specific parameters required for sending SMS to phone numbers registered in India.
3 properties
1 required
1e938b22275568ebc747d21724b50c9be18ff5770eb33c37b76fda4633c14bde.RouteResponse
object
Route response object.
7 properties
4 required
cb1ef9a380a46bb9d49281818dd22b206a7f89260670bd103daadd3abc4386a3.QuerySmsResponse
object
2 properties
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RecordingPlayContent
object
Plays a previously recorded call file.
2 properties
2 required
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.AdvancedWebhooksWithSeen
object
Provides options for configuring message webhooks.
4 properties
382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.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
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.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
747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookMtQuickReply
object
1 property
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.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…
8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.InstagramDmMessage
object
An array of message objects of a single message or multiple messages sent under one bulk ID.
5 properties
3 required
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.InboundMessageZaloInboundContent
object
Collection of mobile originated messages.
12 properties
7 required
1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.MessageResponseMessageResponseDetails
object
An array of message objects of a single message or multiple messages sent under one bulk ID.
4 properties
1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.MessageResponseDetails
object
Other details of the message.
14b5f31f4f292db4a32c4e61928f9a47f8ff4c0a1c06a38af2c29ef9ca05095d.DialogRecordingRequest
object
4 properties
1 required
6a67def771061fe877b7bafa26c22e83ef5c7b44e2a298a70b54e0ed657fe102.CallRecording
object
Call recording metadata.
6 properties
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Play
object
Play action performs playback of audio provided by the client’s URL. Supported formats of the provided file are aac, aiff, m4a, mp2, mp3, mp4 (audio only), ogg…
3 properties
1 required
2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.CallOptions
object
User options available during a call. Depending on the fields, certain options for a call will be shown to a user.
8 properties
e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.LineDataType
string
0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundMessage
object
4 properties
61cea6785aa06882a92b0d6cc8c922ce1d44b92bfbdfd6cde0df0f73fb2499d6.DKIMCheck
object
The result of a check of the DKIM authentication record of the inbound email.
2 properties
2 required
e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.NotificationOptions
object
Options on how to alert the user when the Push message is received.
11 properties
e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.IpCoreGeneralStatus
string
3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.DeliveryTime
object
The exact time of the day. The time is expressed in the UTC time zone.
2 properties
2 required
08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779e.CallRequest
object
Outbound call request.
12 properties
2 required
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailLog
object
Array of email logs, one object per each email request.
13 properties
91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.SouthKoreaOptions
object
Use case dependent parameters for sending SMS to phone numbers registered in South Korea.
2 properties
707907921d4508c2925eddc2449f10db322ecc083be424f87c50fe97ccd8be40.ConnectRequest
object
2 properties
1 required
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipTrunkActionStatus
string
Status of the last action performed on the SIP trunk configuration.
74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.SipTrunkResetPasswordResponse
object
1 property
7916e19109f991cfe966f390ef0d36117967291fa90eff57d8c8cb768f38352e.SortDirection
string
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.TimeUnit
string
Defines a time unit used for calculating call creation rate.
f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.CallPermissionRequestApiData
object
Call permission request. Presence of this object enables a call permission request feature, no fields are required. When header is media type call permission r…
267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.LineMessage
object
An array of message objects of a single message or multiple messages sent under one bulk ID.
5 properties
3 required
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveBodyWhatsAppContent
object
Body of a message containing text only.
1 property
1 required
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsConversationStartedEvent
object
Collection of conversation started events.
5 properties
4 required
1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.RecipientType
string
Recipient Type must be TACIR or BIREYSEL.
0ea963ede06ee99578911cc0068f7474598729635091b55d2985483fad214d7b.RecordingStatus
string
Recording status provided if recording was attempted.
efc1265916a727aef4eb46ff2e01c3e0ad0c1ad70cf38d568ed99c04a9a73fa0.RingbackGeneration
object
Option to generate a consistent local ringback tone, overriding remote ringing tones. If enabled, the ringback will be generated for existing conference partic…
1 property
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.SendMimeRequestSchema
object
13 properties
1 required
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MoDestination
object
Recipients of group MMS.
e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.LineData
object
Line-specific data used if the message is sent through a Line channel.
11 properties
7 required
39bb6975d36d214ea076d974c69ec0b82edda805f4c6bf36a3f6f7d154c98fa0.EmailTemplateListItem
object
5 properties
1 required
9ddf5548c4806a579a37575477f73704a9d1f23ccda5d683f70483437522f25d.StatusRequest
object
Status request.
21 properties
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SingleMessageStatus
object
Indicates whether the message has been successfully sent, not sent, delivered, not delivered, waiting for delivery or any other possible status.
5 properties
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundMessage
object
Collection of mobile originated messages.
15 properties
11 required
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.StickerMessage
object
9 properties
3 required
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.CallApi
object
Call API Action performs an HTTP request to a client’s endpoint, and (if told to) processes the response data. If collectResponse is set, the system will attem…
3 properties
2 required
4811a3a9108d5f90b8934012403f954f20270c436bdecbc318a80214cf54fc02.ConferencePlayRequest
object
2 properties
1 required
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MMSMtLog
object
Results.
15 properties
1e938b22275568ebc747d21724b50c9be18ff5770eb33c37b76fda4633c14bde.RouteRequest
object
Route request object.
4 properties
2 required
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundContentType
string
1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.LogKakaoSangdamOutboundContent
object
An array of message log results, one object per each message log entry.
13 properties
0a37b8c521b3309d1bbd0669d19fc7f2f157d68a68747b5e7ad23e5b0f5e47e8.OpenChannelMessageResponse
object
1 property
87cf6d665490382407be009353007f071b1d6d4a375e96d31d3bf0b04b7fb3c7.TurkeyIysOptions
object
IYS regulations specific parameters required for sending promotional SMS to phone numbers registered in Turkey.
2 properties
1 required
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Dial
object
Dial action performs a call redirection, joining the user's call with another destination. Dial must be the last action.
3 properties
1 required
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.UrlOptions
object
Sets up [URL shortening](https://www.infobip.com/docs/url-shortening) and tracking feature.
5 properties
d32f709b8e696d073f5212b1e1d90721a8fd1118bf2c8abce078bf2baf7d1707.SubdomainPage
array
3 properties
f7a48ff9966e7ac9fef5292e0b74f7ccc796492cacffd985bfded901992c414b.TemplateApiResponse
object
The list of the results for this page.
12 properties
1 required
8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.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…
6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.BusinessInfoResponse
object
7 properties
7 required
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ContactsContent
object
The content object to build a message that will be sent.
1 property
1 required
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsUnificationDestinationGroup
object
---
1 property
1 required
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CaptureDtmfCallbackUrl
object
Callback URL configuration for captureDtmf action.
3 properties
1 required
be917819c3f3f7072f44fe3d7909e7b833fe4857710e7f5ab585df108ef1ed5b.RecordingTransferOptions
object
Options that control how call recording should behave after the application transfer.
1 property
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsEventRequest
object
1 property
1 required
5fc49137a7b003ca1d8c4957601417b8ed884356b7fbc49afe416dd5c098a0bd.DialogWithExistingCallsRequest
object
3 properties
39bb6975d36d214ea076d974c69ec0b82edda805f4c6bf36a3f6f7d154c98fa0.EmailTemplateListPage
object
2 properties
2 required
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveUrlButtonContent
object
The content object to build a message that will be sent.
4 properties
2 required
1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.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.
2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.ApplicationType
string
a15a35d4e9d79ecb7047887a88973e9a539c66701b3c993c3c3be69782dd8aba.BulkStatusRequest
object
Bulk status request object.
1 property
1 required
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.SeenReport
object
Collection of reports, one per every message.
8 properties
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.Regional
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.
1 property
c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderLaunchStatusEvent
object
Launch status information for the sender including coverage details by country and provider.
6 properties
5 required
43838506232bad6c43fa70e5764e200c02c98fad735eeaad33d3b47abc8da5d2.PaymentTransaction
object
Transactions of the payment.
5 properties
5 required
fccfa6f52b47dd30d36e2c1fad9bb5d494251b453352b21aeb7a407c6f1eeb5c.Status
object
Indicates whether the message is successfully sent, not sent, delivered, not delivered, waiting for delivery or any other possible status.
6 properties
14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOutboundContent
object
Message content.
1 property
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundEvent
object
Collection of mobile originated events.
14 properties
10 required
245a74e48cd7ce0a3e2f108689f6fc8d5a08a4d75c5aeb1883fc983443d62958.LivechatInboundMessage
object
Incoming messages.
11 properties
7 required
e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.EmailData
object
Email-specific data used if the message is sent through an email channel.
4 properties
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.DeliveryTimeTo
object
The exact time of day to end sending messages. Time is expressed in the UTC time zone. If set, use it together with the from property with minimum 1 hour diffe…
2 properties
2 required
c8006fe0d154740d4f3e0ed89b54c9c54d35edf85894782dbfe7d9ae0ea23725.UpdateStatusRequest
object
1 property
1 required
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.AnonymizationType
string
Preferred presentation of anonymized calls.
87cf6d665490382407be009353007f071b1d6d4a375e96d31d3bf0b04b7fb3c7.DeliveryTimeWindow
object
Sets specific SMS delivery window outside of which messages won't be delivered. Often, used when there are restrictions on when messages can be sent.
3 properties
1 required
e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.MediaTemplateData
object
Media template definitions
3 properties
1 required
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.Error
object
Indicates whether the error occurred during the query execution.
5 properties
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveButtonContent
object
An array of buttons sent in a message. It can have up to three buttons.
1 property
1 required
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveMultiProductActionContent
object
Allows you to specify catalog and product details sent in the multi-product message.
2 properties
2 required
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.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
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.PageInfo
object
Contains information about the page.
4 properties
4 required
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicDialogState
string
Dialog state.
999e23a63911c41e6f288f288564c4bc2e6a35a6f2a9edba53ecac8c52fe9339.ErrorInfo
object
Messages not delivered to users.
3 properties
3 required
e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TikTokOutboundEventContentType
string
91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Webhooks
object
Provides options for configuring message webhooks.
3 properties
14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.Platform
object
Platform options. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
2 properties
c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateListItem
object
4 properties
4 required
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.EventType
string
Type determining content of received event.
c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateApiCountryCoverage
object
Coverage information by country showing template status for each provider.
2 properties
2 required
8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.ValidityPeriodTimeUnit
string
Message validity period time unit.
3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.MessageResponseMessageResponseDetails
object
An array of message objects of a single message or multiple messages sent under one bulk ID.
4 properties
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsMoTextSegment
object
2 properties
6423f137d264daaaab4ca521d6dfeb19cab29b6b25c3d2da0c1c3fb475a5e829.SipTrunkUpdateRequest
object
4 properties
1 required
4811a3a9108d5f90b8934012403f954f20270c436bdecbc318a80214cf54fc02.ConferenceBroadcastWebrtcTextRequest
object
1 property
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveCallPermissionRequestMessage
object
9 properties
2 required
87cf6d665490382407be009353007f071b1d6d4a375e96d31d3bf0b04b7fb3c7.SouthKoreaOptions
object
Use case dependent parameters for sending SMS to phone numbers registered in South Korea.
2 properties
91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.DefaultMessageRequestOptions
object
Options applicable to all messages in the request.
2 properties
be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushUnificationMessage
object
An array of message objects of a single message or multiple messages sent under one bulk ID.
5 properties
3 required
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.MessageResponseMessageResponseDetails
object
An array of message objects of a single message or multiple messages sent under one bulk ID.
4 properties
2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.Webhook
object
Webhook triggered when there is a call event.
2 properties
1 required
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.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
3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.MessageResponseDetails
object
Other details of the message.
790123005ad6e23bd7e4622ede8f0ed5301700e1d8b1837e5f4cdfdda800eaa2.ApiException
object
1 property
f0c12807aec90d20a332deb5d4c4ff89651a8119eb6a5fa7e1d6e803f3c0e71b.SipTrunkPage
object
2 properties
ff7f7515e81995b140ab1c879b88d9d297a14922c035a187e237cd81e7c216a0.Payload
object
3 properties
3 required
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsMessageRequestOptions
object
3 properties
14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.TurkeyIysOptions
object
IYS regulations specific parameters required for sending promotional SMS to phone numbers registered in Turkey.
2 properties
1 required
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsConversationStartedEventType
string
Conversation started event type.
8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.ToDestination
object
An array of destination objects for where messages are being sent. A valid destination is required.
2 properties
1 required
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.CreateTemplateRequest
object
Request to create a new ZBS template in Zalo.
5 properties
4 required
a15a35d4e9d79ecb7047887a88973e9a539c66701b3c993c3c3be69782dd8aba.BulkRequest
object
Bulk request object.
1 property
1 required
0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.MarketingUpdateNotification
object
4 properties
60d0e6d5cbcf8382b5a6bad1f38781f71991c7ea63dad2e6ec22ddc8893af51c.MachineMessageDetectionCallbackRequest
object
Markup Language machine message detection callback request object. Sent to the callback URL configured on the Markup Language configuration (markupUrl) once ma…
7 properties
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsEvent
object
An array of event objects of the events to be sent.
4 properties
3 required
5c2cf40bcaa0da78551dad80ceca0bb519c9f9fe84d6b1fad64401849b63d9ac.ApplicationsResponse
object
1 property
1 required
52c80a2bd29a734b52d9eb3ddb9b5d8ef0cb7c55640245f275763458f4c36a60.WABAConversionEventRequest
object
2 properties
2 required
45c843446703ba5f4438a6f721c629420452796de20bd3dd9adfccde3ed2ffff.ApiBulkRequest
object
Validations request
2 properties
1 required
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SendToReports
string
Choose if you want to show DTMF inputs in Voice reports and logs. Options are: ALWAYS (always send - default value), MASKED (send masked - xxxx will be shown i…
f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.Status
string
Status of the template.
be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.Platform
object
Platform options. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
2 properties
fccfa6f52b47dd30d36e2c1fad9bb5d494251b453352b21aeb7a407c6f1eeb5c.Price
object
Sent message price.
2 properties
8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.RequestSchedulingSettings
object
Options for scheduling a message.
3 properties
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsUnificationRegionalOptions
object
Region-specific parameters, often imposed by local laws. Use this, if country or region that you are sending an MMS to requires additional information.
1 property
382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.ClientPriority
string
Client priority set on request. Must be 'HIGH', 'STANDARD' or 'LOW'.
a8c993b4bcabd2960dfaf3986394e0fe85cd1c09dc98b0a81b51403a00c8f97c.PublicDialogRecording
object
7 properties
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.SeenReports
object
1 property
39bb6975d36d214ea076d974c69ec0b82edda805f4c6bf36a3f6f7d154c98fa0.AttachmentList
array
4 properties
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.DialToConversationsData
object
1 property
1 required
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsOutboundEventContent
object
Event content.
1 property
1 required
8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.CursorPageInfo
object
Cursor information.
2 properties
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveRequestContactInfoContent
object
The content object to build a message that will be sent.
1 property
1 required
be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushDestinationType
string
91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.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
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MmsOutboundSegmentType
string
91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbEventRequest
object
2 properties
1 required
747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.NonMsisdnSmsFailover
object
Failover SMS message to be sent if the original message could not be delivered.
5 properties
1 required
747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookMtQuickReplyContentType
string
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.FileFormat
string
File format.
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.DeliveryTime
object
The exact time of the day. The time is expressed in the UTC time zone.
2 properties
2 required
e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.CursorPageInfo
object
Cursor information.
2 properties
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.AddDomainRequest
object
5 properties
2 required
c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTestNumberRequestAcceptedResponse
object
3 properties
3 required
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessagePrice
object
Sent message price.
2 properties
ffb4c29a0ab7c4ca15544ca9d6ceffaf3e8b394d7fc1a53728ba61496b4513fc.FilePageResponse
object
2 properties
49bee00604d221bf98890cc8ca36403a588d28255383650998e0c4df2f9a5b4f.RecipientInfo
object
Recipient information such as device type, OS, device name.
3 properties
1705572441d20bbbfe49765ca2bed87cd314f9c5c501048d5a9494385ff9f223.SMSReportResponse
object
1 property
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.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
6a67def771061fe877b7bafa26c22e83ef5c7b44e2a298a70b54e0ed657fe102.WebrtcRecordingPageResponse
object
2 properties
e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Price
object
Sent message price.
2 properties
49f1996e051117ce119ddfc3e07857856b24a0d3f7351242fd9c4615508a2845.VoicePreferences
object
Voice preferences for text-to-speech.
2 properties
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.ReportResponse
object
1 property
4811a3a9108d5f90b8934012403f954f20270c436bdecbc318a80214cf54fc02.ConferenceSendMessageRequest
object
1 property
1 required
0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.PaymentNotificationResponse
object
3 properties
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsReportResponse
object
1 property
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.OrderType
string
Type of the goods offered in the order.
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SetVariable
object
Set variable action makes it possible to set a variable defined inside the IVR scenario to a specified value.
2 properties
2 required
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.BinaryContent
object
3 properties
1 required
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicPlayContent
object
Audio content to play. It can either be previously uploaded file or a file from a URL.
1 property
747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.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…
c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderUpdateEvent
object
Collection of RCS sender update events
6 properties
4 required
8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.InstagramDmMessageRequestOptions
object
Options applicable to all messages in the request.
1 property
c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.PlatformParameters
object
Platform parameters that would be associated with the sender. Please note that platform parameters must be created before they can be associated with the sende…
2 properties
f0c12807aec90d20a332deb5d4c4ff89651a8119eb6a5fa7e1d6e803f3c0e71b.ConferenceLogPage
object
2 properties
747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.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.
2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.InitialOptions
object
User options available when a user opens a call link page before initiating the call. Depending on the fields, certain options for the call will be shown to a…
5 properties
61cea6785aa06882a92b0d6cc8c922ce1d44b92bfbdfd6cde0df0f73fb2499d6.WebhookPayload
object
12 properties
12 required
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsBinaryMessageContent
object
1 required
39bb6975d36d214ea076d974c69ec0b82edda805f4c6bf36a3f6f7d154c98fa0.CreateEmailTemplateRequest
object
8 properties
1 required
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsWebhookDeliveryReport
object
Collection of reports, one per every message.
17 properties
e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.SmsData
object
SMS-specific data used if the message is sent through an SMS channel.
6 properties
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.PlayFromUploadOptions
object
1 property
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.UrlOptions
object
Sets up [URL shortening](https://www.infobip.com/docs/url-shortening) and tracking feature.
5 properties
f0c12807aec90d20a332deb5d4c4ff89651a8119eb6a5fa7e1d6e803f3c0e71b.ConferencePage
object
2 properties
be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.CursorPageInfo
object
Cursor information.
2 properties
45c843446703ba5f4438a6f721c629420452796de20bd3dd9adfccde3ed2ffff.ValidationDestination
object
Array of email addresses to be validated.
1 property
1 required
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.RecipientInfo
object
Recipient information such as device type, OS, device name.
3 properties
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.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…
245a74e48cd7ce0a3e2f108689f6fc8d5a08a4d75c5aeb1883fc983443d62958.LiveChatInboundUserIdentity
object
Information about the user who sent the message.
3 properties
2 required
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.Webhooks
object
Provides options for configuring message webhooks.
3 properties
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MmsOutboundSegment
object
Content of the message being sent.
1 property
1 required
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailUrlOptions
object
Sets up [URL shortening](https://www.infobip.com/docs/url-shortening) and tracking feature.
5 properties
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.BulkMessageInfo
object
2 properties
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.MessageDeliveryReporting
object
Provides options for configuring the delivery report behavior.
3 properties
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.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
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsOutboundSegment
object
Content of the message being sent.
1 property
1 required
58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.CreateTemplateResponse
object
1 property
1 required
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.DefaultSmsFailover
object
Failover SMS message to be sent if the original message could not be delivered.
4 properties
1 required
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.Result
object
18 properties
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RequestMediaStreamConfigType
string
Media stream configuration type.
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsAmount
object
1 property
1 required
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.LaunchScenarioRequest
object
2 properties
1 required
afc47ed3ecce0d042db7648b2699b209de7fd712b3df90ffbf75e4058f683890.ApiRequestErrorDetails
object
2 properties
2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.SecurityConfigType
string
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.Paging
object
Pagination details like page number, page size,etc.
4 properties
c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateProvidersResponse
object
1 property
1 required
08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779e.StartMediaStreamRequest
object
1 property
1 required
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipTrunkLocation
string
SIP trunk location.
91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundMessageContent
object
Message content.
1 property
1 required
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.ValidityPeriodTimeUnit
string
Message validity period time unit.
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsMessage
object
10 properties
3 required
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.IndiaDltOptions
object
Distributed Ledger Technology (DLT) specific parameters required for sending SMS to phone numbers registered in India.
3 properties
1 required
270617dafe939f994767f4b01223addd34979b1c67bb145186dac4c5c875ab19.Status
object
Indicates whether the message is successfully sent, not sent, delivered, not delivered, waiting for delivery, or any other possible status.
5 properties
5 required
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsConversationInfo
object
Conversation information associated with the message.
2 properties
1 required
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailRequest
object
2 properties
1 required
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.SeenReports
object
1 property
8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.InstagramDmInboundContentType
string
382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.DeliveryReport
object
Collection of reports, one per every message.
14 properties
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.Regional
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.
1 property
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.LogResponseSmsLogSmsMessageContent
object
2 properties
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.AdvancedTtsApiMessage
object
Array of messages to be sent, one object per every message
24 properties
1 required
3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.TurkeyIysOptions
object
IYS regulations specific parameters required for sending promotional SMS to phone numbers registered in Turkey.
2 properties
1 required
267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.MessageDeliveryReporting
object
Provides options for configuring the delivery report behavior.
3 properties
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ParticipantState
string
Participant state.
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse
object
1 property
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFlowActionContent
object
Allows you to specify flow message details.
7 properties
3 required
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.DialOptions
object
3 properties
91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.RequestSchedulingSettings
object
Options for scheduling a message.
3 properties
60d0e6d5cbcf8382b5a6bad1f38781f71991c7ea63dad2e6ec22ddc8893af51c.RecordingStatusCallbackRequest
object
Markup Language recording status callback request object. Sent to the callback URL configured on the Record or StartRecording instruction once the recording ha…
8 properties
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SimulatorCallEndpoint
object
Simulator endpoint to be used for the simulation.
1 property
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsConversationType
string
Conversation type (Application to Person/Person to Application/Interactive session).
f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.PageInfo
object
Contains information about the page.
4 properties
4 required
14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.InboundMessageViberBotInboundContent
object
Collection of mobile originated messages.
12 properties
7 required
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MMSMoReport
object
Results.
11 properties
d787c8758e54290e2bc82a005b86f9050517ec4ab2e17f0a4cc0942f51132c33.ConversionType
string
Type of the conversion. Can be PURCHASE or LEADSUBMITTED.
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.ErrorInfo
object
Indicates whether the error occurred during the query execution.
6 properties
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.PageInfo
object
Contains information about the page.
4 properties
4 required
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.AddressContent
object
Array of addresses information.
7 properties
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsMoEventMessagePrice
object
Price object with traffic type information.
3 properties
3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.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.
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.TurkeyIysOptions
object
IYS regulations specific parameters required for sending promotional SMS to phone numbers registered in Turkey.
2 properties
1 required
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.MessageResponseMessageResponseDetails
object
An array of message objects of a single message or multiple messages sent under one bulk ID.
4 properties
91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundMessageContentType
string
2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.DestinationType
string
6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.CallingPermissionAction
object
A list of actions a sender may undertake to facilitate a call permission or a business initiated call.
3 properties
3 required
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BulkEndpointType
string
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.AdvancedMessageDeliveryReporting
object
Provides options for configuring the delivery report behavior.
4 properties
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZaloMessage
object
An array of message objects of a single message or multiple messages sent under one bulk ID.
5 properties
3 required
e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.OmniChannel
string
Channel that was used for message delivering.
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogRecordingComposition
object
1 property
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MessageResultTo
object
1 required
e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.DefaultSmsFailover
object
Failover SMS message to be sent if the original message could not be delivered.
4 properties
1 required
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MessageResponseMessageResponseDetails
object
An array of message objects of a single message or multiple messages sent under one bulk ID.
4 properties
febbeec59369f28c0a6e3ddd1a2666aea9869953e0893914d340d35c6901410c.Subdomain
object
2 properties
bed2167e3f739c7f0ded9831d75a7a93f11864f45170ef7c0c6b02ad17bd1a97.ApiException
object
1 property
3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundContentType
string
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.SouthKoreaOptions
object
Use case dependent parameters for sending SMS to phone numbers registered in South Korea.
2 properties
382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.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
e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.Platform
object
Platform options. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
2 properties
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.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.
267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.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.
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ValidityPeriodTimeUnit
string
Message validity period time unit.
cd5e571e477c0b81ca50ad592cf9f67cc32feded2012ec26d7fae09c0c2d5108.SmsMoReportResponse
object
3 properties
53ea038e2044401649ce25e79296cd97fe7d6f7f97d15a035e41419183f810a1.AddSuppression
object
Suppression.
3 properties
3 required
e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TikTokEventOptions
object
Event options.
2 properties
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZbsTemplateType
string
3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.ResponseEnvelopeMessageResponseMessageResponseDetails
object
2 properties
1 required
14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ToDestination
object
An array of destination objects for where messages are being sent. A valid destination is required.
2 properties
1 required
74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.SipTrunkResponse
object
15 properties
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Gender
string
Voice gender in which text would be synthesized.
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.SouthKoreaOptions
object
Use case dependent parameters for sending SMS to phone numbers registered in South Korea.
2 properties
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveVoiceButtonMessageActionWhatsAppContent
object
Allows you to specify message details.
3 properties
a0adf300db6deef82e7c0136cd925a42b10c902181badc6843c98dba155015cc.ApiException
object
1 property
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.MessageError
object
Indicates whether an [error](https://www.infobip.com/docs/essentials/response-status-and-error-codeserror-codes) occurred during the query execution.
6 properties
be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.Webhooks
object
Provides options for configuring message webhooks.
3 properties
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MachineDetectionProperties
object
Properties of the events that provide Answering Machine Detection result.
3 properties
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundContent
object
Message content.
1 property
1 required
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.OrganizationContent
object
Contains information about contact's company.
3 properties
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.TemplateStatus
string
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.MachineDetection
object
Machine detection configuration for the dial.
3 properties
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.MultiTtsApiMessage
object
Array of messages to be sent, one per every message.
6 properties
1 required
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.GoTo
object
Go-To action is used to go back to some specified action that was already executed in the scenario and continue the execution from that point.
2 properties
1 required
ApiRequestErrorDetails
object
3 properties
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateLimitedTimeOfferContent
object
Template limited-time offer. Should be defined, only if template contains limited-time offer.
1 property
1 required
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.CallDirection
string
Call direction.
61cea6785aa06882a92b0d6cc8c922ce1d44b92bfbdfd6cde0df0f73fb2499d6.IpPoolAssignIpApiRequest
object
1 property
1 required
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailMessage
object
An array of message objects of a single message or multiple messages sent under one bulk ID.
8 properties
2 required
2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.Theme
object
Call link theme-specific configuration settings. Use it to add image, color, and text selections to customize a call link page.
5 properties
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsDlrTrafficType
string
Traffic type applied to the RCS message that the delivery report refers to. Null for not chargeable RCS messages.
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.UrlOptions
object
Sets up [URL shortening](https://www.infobip.com/docs/url-shortening) and tracking feature.
5 properties
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.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.
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallDirection
string
Call direction.
be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.ValidityPeriodTimeUnit
string
Time unit for validity period. Defaults to hours.
2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.CallLinkRecordingApplication
object
Recording application metadata
1 property
1 required
c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.Email
object
List of email contacts associated with the sender and displayed to the user on mobile device. Required if phone and website are not provided. Currently, only o…
2 properties
2 required
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SendSms
object
Send SMS action creates and sends a text message from the scenario.
2 properties
1 required
a22294a21e0a6f95f3711ca1f29de62bd2ce6d8bf890b9e41dadab263638faaf.Status
object
5 properties
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DetectionResult
string
Detected class during analysis of the call. Always returns either HUMAN or MACHINE. Use confidenceRating for a finer grained analysis result
e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.ToDestination
object
An array of destination objects for where messages are being sent. A valid destination is required.
2 properties
1 required
39bb6975d36d214ea076d974c69ec0b82edda805f4c6bf36a3f6f7d154c98fa0.EmailTemplatePreviewRequest
object
1 property
382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.KakaoAlimRequest
object
2 properties
1 required
e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TikTokOutboundEventContent
object
Event content.
1 property
1 required
c8cb45a488f0d2ea03cc082d0f61afb1c3b35cdd297a9f7abb6df8ac5619a483.ActionType
string
Action type.
f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.ButtonApiData
object
Template buttons. Can contain 1 to 10 buttons which include up to 2 URL buttons, one phone number button, one copy code button and one flow button. quick reply…
1 property
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZaloRequest
object
2 properties
1 required
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.SingleMessageStatus
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
6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.WhatsAppCallingPermissionResponse
object
3 properties
2 required
08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779e.ConnectWithNewCallRequest
object
4 properties
1 required
e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.AdvancedMessageDeliveryReporting
object
Provides options for configuring the delivery report behavior.
4 properties
91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.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…
382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.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
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundMessages
object
3 properties
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.UploadBinaryResult
object
1 property
0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.SeenResult
object
1 property
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.DomainResponse
object
Detailed domain information.
8 properties
8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.MessageResponseMessageResponseDetails
object
An array of message objects of a single message or multiple messages sent under one bulk ID.
4 properties
267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.ResponseEnvelopeMessageResponseMessageResponseDetails
object
2 properties
1 required
91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundEventContentType
string
747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundContent
object
Message content.
1 property
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsAdvancedMessage
object
An array of message objects of a single message or multiple messages sent under one bulk ID.
13 properties
2 required
5cec81334b90b810e64e8923d2a0d906614be46012f19935bf49fd13e921d8b2.PublicCountry
object
SIP trunk service address country.
2 properties
267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.LineRequest
object
2 properties
1 required
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.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
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailRequestSchedulingSettings
object
Options for scheduling a message.
2 properties
c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsRegisterTemplateRequest
object
1 property
1 required
747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundContentType
string
30350ea3b42c85fe379e7561e2b43510ecd150d18a85f55710d4f6347f698f75.VerifyCodeRequest
object
1 property
1 required
e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoAlimButtonType
string
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Criteria
object
Criteria type.
1 property
1 required
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.MessageErrorGroup
string
Error group name that describes which category the error code belongs to.
707907921d4508c2925eddc2449f10db322ecc083be424f87c50fe97ccd8be40.ConferenceRequest
object
5 properties
1 required
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Destination
object
List of destinations. First destination in the list is the first one to be executed. Subsequent destinations are executed only if the previous one fails.
3 properties
1 required
46339420b556d1893a150250c0e3220eb8057cd2fc4110e601753f705fc1f8c4.ottReportResponse
object
14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.MessageResponseDetails
object
Other details of the message.
526c8fd5dbec2ed6659284b76850ff4085b7915f78d3266fedb5e0b5300d882a.MarkupLanguageConfigResponsePage
object
Markup language configurations response object.
2 properties
be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.MessageResponseMessageResponseDetails
object
An array of message objects of a single message or multiple messages sent under one bulk ID.
4 properties
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsHeaderContent
object
Header of a message containing one or more [interactive elements](https://www.infobip.com/docs/whatsapp/message-types-and-templates/free-form-messagesavailable…
1 property
1 required
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.ResponseEnvelopeMessageResponseMessageResponseDetails
object
2 properties
1 required
e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.ResponseEnvelopeMessageResponseMessageResponseDetails
object
2 properties
1 required
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PegasusSipTrunkType
string
SIP trunk type.
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.MessageResponseSmsMessageResponseDetails
object
An array of message objects of a single message or multiple messages sent under one bulk ID.
4 properties
be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.InAppExpirationTimeUnit
string
Time unit for in-app expiration.
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsConvStartedTrafficType
string
Traffic type applied to the inbound or outbound RCS message. Null for non chargeable RCS messages.
0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.GenerateFlowRequestApiData
object
2 properties
1 required
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.CallApiOptions
object
4 properties
2 required
08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779e.ActionCallRequest
object
8 properties
1 required
eaaf11bb9830fc826a8597df01bea6f2a14ef6d1ed129a4f6623981d52827778.MarkupLanguageConfigRequest
object
Markup language configuration request object.
5 properties
3 required
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Status
string
Current bulk status.
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsIsTypingEventType
string
Type of received event.
cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.SubscriptionInfo
object
Messenger subscription info.
2 properties
5c2cf40bcaa0da78551dad80ceca0bb519c9f9fe84d6b1fad64401849b63d9ac.ApplicationResponse
object
7 properties
7 required
ae8a6eecccfb565f1840ac10e7bfb960a35d1e256ae31abf1bdea45a1d2f5557.CallLinkResponse
object
2 properties
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Preview
object
Allows for previewing the original message content once additional language configuration has been applied to it.
4 properties
c18e27d419b307552daa9403b0085ee796da1a5e57e2a4e6fb73f406471574fc.ConferenceAndCall
object
2 properties
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZbsTemplateContent
object
Template content.
1 property
1 required
45c843446703ba5f4438a6f721c629420452796de20bd3dd9adfccde3ed2ffff.GetValidationPageResponse
object
Validation get page response.
2 properties
2 required
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.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…
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.TimeWindow
object
Defines a scheduling object that allows setting up a detailed time window in which calls can be established. Consists of from, to and days properties. Days pro…
3 properties
1 required
c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateProviderStatusDetails
object
List of template providers in the country and their template registration status.
3 properties
2 required
33e5f9b198702dad16ca1f81c1bb567a11b08d145013a25f78031b56a52d656b.SMSResponse
object
2 properties
431fb79b0e816230968e14ba1e1c6fadb75cfde9cb3c381f4217b2777f48153f.CallLog
object
24 properties
1 required
747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.SeenReport
object
Collection of reports, one per every message.
8 properties
382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.KakaoAlimMessage
object
An array of message objects of a single message or multiple messages sent under one bulk ID.
5 properties
3 required
a4e0c51a24a360282e1a40c61554d239555404b786d84603912030fc4cdbb512.ReferralMedia
object
Media information of included referral.
1 property
e2e56e613b621c92a292daf20c76b6dbff0520ca1b47769205b02fa7192a30b4.ApiException
object
1 property
382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.MessageDeliveryReporting
object
Provides options for configuring the delivery report behavior.
3 properties
c8cb45a488f0d2ea03cc082d0f61afb1c3b35cdd297a9f7abb6df8ac5619a483.MoReportsResponse
object
3 properties
3 required
6423f137d264daaaab4ca521d6dfeb19cab29b6b25c3d2da0c1c3fb475a5e829.SipTrunkStatusRequest
object
SIP trunk status request.
1 property
1 required
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Language
object
1 property
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackUrl
object
Callback URL configuration.
2 properties
1 required
1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.MessageError
object
Indicates whether an [error](https://www.infobip.com/docs/essentials/response-status-and-error-codeserror-codes) occurred during the query execution.
6 properties
61cea6785aa06882a92b0d6cc8c922ce1d44b92bfbdfd6cde0df0f73fb2499d6.PageInfo
object
4 properties
4 required
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.VoiceError
object
Indicates whether the error occurred during the query execution.
6 properties
a8c993b4bcabd2960dfaf3986394e0fe85cd1c09dc98b0a81b51403a00c8f97c.PublicCallRecording
object
10 properties
1 required
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsFailoverOptions
object
Message options.
6 properties
0a37b8c521b3309d1bbd0669d19fc7f2f157d68a68747b5e7ad23e5b0f5e47e8.OpenChannelMessageResponseStatus
string
Message processing status.
cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.AdAccountStatus
string
Ad account status.
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Hangup
object
Hangup action terminates the call.
2 properties
1 required
e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.DefaultEventRequestOptions
object
Options applicable to all events in the request.
1 property
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsLanguage
object
Sets the language parameters for the message being sent.
3 properties
747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundRequest
object
3 properties
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveVoiceButtonContent
object
The content object to build a message that will be sent.
2 properties
1 required
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsDlrMessagePrice
object
Price object with traffic type information.
3 properties
91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.TurkeyIysOptions
object
IYS regulations specific parameters required for sending promotional SMS to phone numbers registered in Turkey.
2 properties
1 required
0ea963ede06ee99578911cc0068f7474598729635091b55d2985483fad214d7b.CallbackResponse
object
1 property
1 required
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ConferenceRecordingLog
object
Conference recordings.
2 properties
c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderBillingCategory
string
Billing category for the sender. Following billing categories are available: NONCONVERSATIONAL: Messages billed as standard RCS message that allows richer mess…
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.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
5cec81334b90b810e64e8923d2a0d906614be46012f19935bf49fd13e921d8b2.PublicSipTrunkServiceAddress
object
8 properties
3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.DeliveryReport
object
Collection of reports, one per every message.
14 properties
be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PrimaryButtonActionType
string
WEBVIEWURL - opening of the external web content in webView, OPENURLINBROWSER - opening of the external web content in device browser, DEEPLINK - opening of pa…
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RecordingLocation
string
cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.UserTokenRefreshStatus
string
Status of notification. This field is present only when the user stops or resumes Marketing Messages.
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SwitchCase
object
Switch-Case action takes a saved variable (obtained via either a Collect, Call API action or scenario parameters) and performs flow control based on it. It wor…
3 properties
2 required
01b456ee89723218fe6e9044f9e602d2dda7aa7bf5bc0607681dd5bae7f811b9.ApiException
object
1 property
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.BulkScheduleResponse
object
2 properties
2 required
1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamMessage
object
An array of message objects of a single message or multiple messages sent under one bulk ID.
5 properties
3 required
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckSyncRequest
object
3 properties
2 required
655eaf80f7479f4a18447865649b33bdb754aaa97779726ffb72592cb1ac3ce5.MediaStreamConfigResponse
object
4 properties
2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.Images
object
Enumerate images shown on a call link page. Once an image is uploaded (by using the image upload API) a unique ID returned in that response can be used to add…
2 properties
ApiErrorResource
object
List of available resources to recover from the error.
2 properties
e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoChinguButtonType
string
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.MediaUploadResponse
object
1 property
1 required
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.DeliveryTime
object
2 properties
6665694460cb56ab854a173ada36805c85c7ec55584901d2f06225baf9b586cb.PublicPlayRequest
object
Call play request.
6 properties
1 required
be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.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
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundContactProfile
object
5 properties
c8cb45a488f0d2ea03cc082d0f61afb1c3b35cdd297a9f7abb6df8ac5619a483.ActionResponse
object
List of actions.
4 properties
2 required
6665694460cb56ab854a173ada36805c85c7ec55584901d2f06225baf9b586cb.CallRecordingRequest
object
4 properties
1 required
1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamOutboundContentType
string
c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.HostingRegion
string
RBM agents can be hosted in one of three regions: North America, Europe, or Asia Pacific, to help businesses comply with regional and regulatory requirements.…
be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushResponse
object
1 property
1 required
747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.ResponseEnvelopeMessageResponseMessageResponseDetails
object
2 properties
1 required
cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.MarketingMessageClick
object
6 properties
6 required
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsMoTrafficType
string
Traffic type applied to the MO message. Null for not chargeable messages.
0a37b8c521b3309d1bbd0669d19fc7f2f157d68a68747b5e7ad23e5b0f5e47e8.WebhookRequest
object
4 properties
3 required
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsMessageInteractionType
string
The interaction type of the message that was sent. Note: this describes the message structure, not the billing category, which may differ.
808c7c71509cd326700719db91283dfccde220d396434fc49825c692ac7499fd.RcsBulkSendTemplateRequest
object
1 property
1 required
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailMessageContent
object
Message content.
12 properties
53ea038e2044401649ce25e79296cd97fe7d6f7f97d15a035e41419183f810a1.ApiPageDetails
object
Paging response.
2 properties
2 required
58f57942de1c194257c321b1824e5d3941d9e9f538a9f08ddcb73e6025439f43.MediaStreamConfigRequest
object
3 properties
3 required
e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.SpeedLimitTimeUnit
string
The time unit to define when setting a messaging speed limit. Defaults to MINUTE.
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SimulatorCallEndpointType
string
a012797e45a148c14a09b350fd3670874eb3f365931c630a0c2efc32c7293ff3.TokenResponseModel
object
2 properties
eaaf11bb9830fc826a8597df01bea6f2a14ef6d1ed129a4f6623981d52827778.MarkupRequest
object
Markup language request object.
6 properties
3 required
267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.SpeedLimitTimeUnit
string
The time unit to define when setting a messaging speed limit. Defaults to MINUTE.
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.ValidityPeriodTimeUnit
string
Message validity period time unit.
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallEndpointType
string
39bb6975d36d214ea076d974c69ec0b82edda805f4c6bf36a3f6f7d154c98fa0.PageInfo
object
4 properties
4 required
267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.MessageResponseMessageResponseDetails
object
An array of message objects of a single message or multiple messages sent under one bulk ID.
4 properties
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SingleMessageStatus
object
Indicates whether the message is successfully sent, not sent, delivered, not delivered, waiting for delivery or any other possible status.
5 properties
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SpeedLimitTimeUnit
string
The time unit to define when setting a messaging speed limit. Defaults to MINUTE.
14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.AdvancedMessageDeliveryReporting
object
Provides options for configuring the delivery report behavior.
4 properties
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveLocationRequestContent
object
The content object to build a message that will be sent.
1 property
1 required
0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.DeliveryReport
object
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppOutboundEventContent
object
Event content.
1 property
91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.MessageResponseMessageResponseDetails
object
An array of message objects of a single message or multiple messages sent under one bulk ID.
4 properties
58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.GetTemplateResponse
object
2 properties
2 required
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.DocumentContent
object
The content object to build a message that will be sent.
3 properties
1 required
e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.FlexContainer
object
1 property
58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.TemplateResult
object
1 property
1 required
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.MessageErrorGroup
string
Error group name that describes which category the error code belongs to.
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DtmfType
string
DTMF type.
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveLocationRequestMessage
object
10 properties
3 required
e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TikTokEventRequest
object
2 properties
1 required
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.VideoContent
object
The content object to build a message that will be sent.
2 properties
1 required
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.IpCoreGeneralStatus
string
14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotMessage
object
An array of message objects of a single message or multiple messages sent under one bulk ID.
5 properties
3 required
b888d833f5e2077036527211f9d9a5502285e1c742cd8459a9d3ad85cb1fa1f5.PreviewResponse
object
2 properties
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.TrackingEventRequest
object
3 properties
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ResponseMediaStreamConfigType
string
Media stream configuration type.
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageContext
object
Context object to define WhatsApp-specific metadata about a message.
1 property
1 required
e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TikTokMessageRequestOptions
object
Options applicable to all messages in the request.
2 properties
0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.Identity
object
Information about the identity of the end user.
3 properties
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.Webhooks
object
Provides options for configuring message webhooks.
3 properties
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.DtmfOptions
object
2 properties
1 required
91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.NonMsisdnSmsFailover
object
Failover SMS message to be sent if the original message could not be delivered.
5 properties
1 required
08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779e.DtmfCaptureRequest
object
6 properties
2 required
be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.DeliveryReports
object
1 property
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveMultiProductSectionContent
object
An array of multi product sections.
2 properties
1 required
8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.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
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.TimeUnitValueRange
string
Message failover validity period time unit.
267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.MessageResponseDetails
object
Other details of the message.
c8cb45a488f0d2ea03cc082d0f61afb1c3b35cdd297a9f7abb6df8ac5619a483.ActionsResponse
object
1 property
1 required
3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.AdvancedWebhooks
object
Provides options for configuring message webhooks.
3 properties
5cec81334b90b810e64e8923d2a0d906614be46012f19935bf49fd13e921d8b2.PublicRegion
object
SIP trunk service address region.
3 properties
8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.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
e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Destination
object
Destinations to which you are sending a message, such as phone number, email address, or unique ID.
2 properties
a15a35d4e9d79ecb7047887a88973e9a539c66701b3c993c3c3be69782dd8aba.BulkStatusResponse
object
Bulk status response object.
2 properties
1 required
3307df001c42dd833d79f33c79b6946b4d01c30ce33030254141df9a2298b3c8.MessageCount
object
2 properties
7b23cc7ec456214e90b61e3d5abd3aaf7422ea4b20f1cdd2d4e9c44fbceaf035.SMSAdvancedBinaryRequest
object
3 properties
1 required
91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundEventContent
object
Event content.
1 property
1 required
7916e19109f991cfe966f390ef0d36117967291fa90eff57d8c8cb768f38352e.ProcessedLocation
string
Location of recording file after processing.
6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.WhatsAppSenderStatus
string
Status of the sender.
be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushRequestNotificationOptions
object
JSON object that contains notification options.
16 properties
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.AmdStatus
string
The result of the machine detection process.
8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.InboundMessageInstagramDmInboundContent
object
Collection of mobile originated messages.
12 properties
7 required
0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.ContactName
object
5 properties
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MoDestinationTo
object
1 property
52c80a2bd29a734b52d9eb3ddb9b5d8ef0cb7c55640245f275763458f4c36a60.MetaConversionModel
object
Conversions collection.
4 properties
2 required
14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.CursorPageInfo
object
Cursor information.
2 properties
e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.SeenReport
object
Collection of reports, one per every message.
8 properties
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.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.
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.IfThenElse
object
If-Then-Else action provides simple branching based on a condition. If the condition evaluates to true, the then block is executed, otherwise the else block is…
4 properties
1 required
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberVideoMessage
object
11 properties
3 required
53ea038e2044401649ce25e79296cd97fe7d6f7f97d15a035e41419183f810a1.DomainInfo
object
Domain get response.
10 properties
10 required
1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.Platform
object
Platform options. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
2 properties
e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TikTokInboundContent
object
Message content.
1 property
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.TextContent
object
The content object to build a message that will be sent.
2 properties
1 required
450b8e1c5aa2576ea4225d97920eb07c6a588176f5f842cc401b6c579419dc38.IntegrationType
object
1 property
3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.DefaultSmsFailover
object
Failover SMS message to be sent if the original message could not be delivered.
4 properties
1 required
e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.IndiaDltOptions
object
Distributed Ledger Technology (DLT) specific parameters required for sending SMS to phone numbers registered in India.
3 properties
1 required
3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.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
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.UrlDestinationResponse
object
1 property
1 required
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Transcription
object
5 properties
1 required
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.TemplateButton
object
List of template buttons.
3 properties
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.TemplateStatus
string
Current approval status of the template in the review process.
8a2ea8872469b182f7474a94d4bf931da42a6e2a1d1ba07898b1bc7dcdc85cd2.DeliveryReports
object
1 property
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.LogsResponse
object
1 property
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.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…
e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Address
object
Address information.
7 properties
58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.BrandMessagesTemplateTypes
string
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.SpeedLimitTimeUnit
string
The time unit to define when setting a messaging speed limit. Defaults to MINUTE.
91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundContent
object
Message content.
1 property
1 required
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.ValidityPeriodTimeUnit
string
Message validity period time unit.
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.ForEach
object
For-each action is a control statement that executes a block of code for each of the values within the supplied list. The Supplied list of values can be static…
4 properties
3 required
be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PrimaryButtonAction
object
Defines which action to perform on notification tap or on in-app notification primary button tap. More information for [Android](https://github.com/infobip/mob…
2 properties
61cea6785aa06882a92b0d6cc8c922ce1d44b92bfbdfd6cde0df0f73fb2499d6.IpDetailResponse
object
4 properties
4 required
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveRowContent
object
An array of rows sent within a section. Section must contain at least one row. Message can have up to ten rows.
3 properties
2 required
cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.MessengerConsentUpdateResult
object
List of consent update results.
6 properties
6 required
8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.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
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageResponseMessageResponseDetails
object
An array of message objects of a single message or multiple messages sent under one bulk ID.
4 properties
01e84c3b4dd6fb6c49761ac60f0bbc50e5117905a6beb7547645113e59aaeb46.PreviewRequest
object
3 properties
1 required
2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.WebhookRecording
object
Recording of the call.
2 properties
3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.IndiaDltOptions
object
Distributed Ledger Technology (DLT) specific parameters required for sending SMS to phone numbers registered in India.
3 properties
1 required
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.VideoContent
object
The content object to build a message that will be sent.
5 properties
3 required
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.DefaultSmsFailover
object
Failover SMS message to be sent if the original message could not be delivered. Please note that either SMS failover or MMS failover can be set, but not both.
4 properties
1 required
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Platform
object
Platform options. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
2 properties
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.TemplateLang
string
Language code for the template body.
cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.CreateAudienceRequest
object
4 properties
3 required
3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.ValidityPeriodTimeUnit
string
Message validity period time unit.
1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.TurkeyIysOptions
object
IYS regulations specific parameters required for sending promotional SMS to phone numbers registered in Turkey.
2 properties
1 required
a381f86553e288851808282b347a5f8bd7ba34b9b6feb33f5946feb4892476be.StatisticsResponse
object
5 properties
5 required
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.GeoLocationInfoWrapper
object
Geolocation data such as Country and City.
2 properties
a4e0c51a24a360282e1a40c61554d239555404b786d84603912030fc4cdbb512.MediaType
string
747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.ValidityPeriodTimeUnit
string
Message validity period time unit.
747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.DeliveryReports
object
1 property
0a37b8c521b3309d1bbd0669d19fc7f2f157d68a68747b5e7ad23e5b0f5e47e8.OpenChannelMessageRequest
object
5 properties
3 required
6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.WhatsAppSenderQualityRating
string
Quality of the sender.
c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.ProviderLaunchStatus
string
Launch status for this specific provider. Possible values: PENDING: Status returned when the launch request has not yet been submitted to the provider. INPROGR…
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BulkEndpoint
object
Call endpoint. Represents the callee for a call.
1 property
c18e27d419b307552daa9403b0085ee796da1a5e57e2a4e6fb73f406471574fc.Participant
object
7 properties
1 required
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsLogSmsMessageContent
object
An array of message log results, one object per each message log entry.
14 properties
e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.VKontakteData
object
VKontakte-specific data used if the message is sent through a VKontakte channel.
5 properties
be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.RequestSchedulingSettings
object
Options for scheduling a message.
3 properties
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.CardAllowedTemplateButtonContent
object
Card buttons. Define buttons only for quick reply or dynamic URL buttons (in the required order). For static URL button, omit the buttons section.
1 property
1 required
e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.LogTikTokOutboundMessageContent
object
An array of message log results, one object per each message log entry.
13 properties
62b589527d7474f21f086ddb07e8698e9fcfbbe16400c91718f1ab58d998c3f1.MMSMoReportResponse
object
1 property
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.LogPrice
object
2 properties
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogRecordingLog
object
Dialog recordings.
2 properties
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MessageError
object
Indicates whether an [error](https://www.infobip.com/docs/essentials/response-status-and-error-codeserror-codes) occurred during the query execution.
6 properties
0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.MarketingUpdateNotificationResponse
object
3 properties
2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.CameraFacingMode
string
In the case of a video call on mobile phones camera will be back or front depending on this value. It is 'FRONT' by default.
c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTestDeviceStatus
string
Status of the test number. It'll be updated by Infobip platform automatically and notification about test number status update will be sent to client's webhook…
c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsUseCase
string
Use case for the sender. Following use cases are available: OTP: Used for senders that only send one time passwords. TRANSACTIONAL: Used for senders that send…
8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.MessageError
object
Indicates whether an [error](https://www.infobip.com/docs/essentials/response-status-and-error-codeserror-codes) occurred during the query execution.
6 properties
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Tracking
object
Allows you to set up tracking parameters to track conversion metrics. For more details, see: [SMS with conversion tracking](https://www.infobip.com/docs/sms/sm…
2 properties
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsConversationStartedEventContent
object
Conversation Started event details.
1 property
1 required
747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FailoverDestinationPair
object
The SMS failover destination matching.
2 properties
2 required
14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.LogViberBotOutboundContent
object
An array of message log results, one object per each message log entry.
13 properties
1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.ValidityPeriodTimeUnit
string
Message validity period time unit.
e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.PushData
object
Push-specific data used if the message is sent through a Push channel.
9 properties
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.TemplateParam
object
Variable parameter definition for template placeholders.
3 properties
3 required
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsEventOptions
object
Event options.
2 properties
8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.InstagramDmInboundContent
object
Message content.
1 property
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.UrlTrackingWebhook
object
11 properties
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsUnificationMessage
object
An array of message objects of a single message or multiple messages sent under one bulk ID.
5 properties
2 required
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.RequestSchedulingSettings
object
Options for scheduling a message.
3 properties
e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.IndiaDltOptions
object
Distributed Ledger Technology (DLT) specific parameters required for sending SMS to phone numbers registered in India.
3 properties
1 required
cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.NotificationMessageReoptin
string
Is Reoptin ENABLED or DISABLED.
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Record
object
Record action records a portion of the call. The recording starts at the moment where the Record action is added in the IVR.
3 properties
1 required
e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Name
object
Contains information about the name and last of a contact.
6 properties
2 required
267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.LineMessageRequestOptions
object
Options applicable to all messages in the request.
1 property
6ee61eb40f9e4619d309dfe8df9b479488b43bcde7df95f6a044b2e14abf591e.RecordingMetadata
object
Recording metadata
2 properties
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MmsOutboundContent
object
Content of the failover message being sent.
2 properties
1 required
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.DialToManyOptions
object
3 properties
747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.MessageErrorGroup
string
Error group name that describes which category the error code belongs to.
be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushOutboundContentType
string
08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779e.PublicStartTranscriptionRequest
object
1 property
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsMessageRequestOptions
object
Options applicable to all messages in the request.
4 properties
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.PlayOptions
object
1 property
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SbcHosts
object
Infobip SBC (Session Border Controller) hosts.
3 properties
53ea038e2044401649ce25e79296cd97fe7d6f7f97d15a035e41419183f810a1.DeleteSuppressionRequest
object
Suppressions request.
1 property
1 required
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.DialToMany
object
Dial to Many action performs a call redirection to multiple destinations, joining the user’s call only with the destination that answered the call first. After…
3 properties
2 required
243664b2993460e9e9a3aa6c63ab422a58e22db15efe4cb007ed315aff543dd9.MmsReportRequest
object
1 property
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.BulkUpdateStatusRequest
object
1 property
1 required
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.IysRecipientType
string
Recipient Type must be TACIR or BIREYSEL.
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ToDestination
object
An array of destination objects for where messages are being sent. A valid destination is required.
2 properties
1 required
8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.MessageResponseDetails
object
Other details of the message.
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MessagePrice
object
Sent message price.
2 properties
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsMoMessageSegment
object
All parts of the received message.
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveUrlButtonHeaderContent
object
Header of a message containing one or more [interactive elements](https://www.infobip.com/docs/whatsapp/message-types-and-templates/free-form-messagesavailable…
1 property
1 required
61f95109c33ad36c729390593c474a655f9ca0e00403d6dbc107cf0f6c5cf04b.Language
string
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.Label
string
Indicates character of the content.
747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookMessageRequestOptions
object
Options applicable to all messages in the request.
1 property
707907921d4508c2925eddc2449f10db322ecc083be424f87c50fe97ccd8be40.AddExistingCallRequest
object
4 properties
2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.RecordingSortColumn
string
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.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
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderStatusContent
object
The content object to build a message that will be sent.
3 properties
1 required
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.LogResponseMmsUnificationLogMmsOutboundContent
object
2 properties
c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.WebsiteWebAddress
object
List of websites associated with the sender and displayed to the user on mobile device. Required if phone and email are not provided. Currently, only one entry…
2 properties
2 required
08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779e.RecordingStartRequest
object
1 property
c8cb45a488f0d2ea03cc082d0f61afb1c3b35cdd297a9f7abb6df8ac5619a483.ActionRequest
object
3 properties
1 required
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveBodyContent
object
Body of a message containing one or more [interactive elements](https://www.infobip.com/docs/whatsapp/message-types-and-templates/free-form-messagesavailable-i…
1 property
1 required
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.AudioCodec
string
Audio codec.
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.DeliveryTime
object
The exact time of the day. The time is expressed in the UTC time zone.
2 properties
2 required
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.FreeFormRcsApiMtContentType
string
Message type, describing type of message which is going to be sent over RCS
14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.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…
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFlowActionMode
string
Mode of the flow, can be either 'DRAFT' or 'PUBLISHED'. If mode is 'DRAFT' header, body, footer and callToActionButton data will be not shown for end user.
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.DestinationSingle
object
267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.Webhooks
object
Provides options for configuring message webhooks.
3 properties
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveUrlButtonActionContent
object
Allows you to specify the content of the button and its URL.
2 properties
2 required
6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.CallingPermissionActionName
string
Name of calling permission related action. STARTCALL - The action of establishing a new call with the end user. SENDCALLPERMISSIONREQUEST - The action of sendi…
7916e19109f991cfe966f390ef0d36117967291fa90eff57d8c8cb768f38352e.ActivityType
string
Type of activity that occurred.
43838506232bad6c43fa70e5764e200c02c98fad735eeaad33d3b47abc8da5d2.PaymentTransactionType
string
Type of the transaction.
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipTrunkRegistrationStatus
string
SIP trunk registration status.
e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoChinguButton
object
Buttons to include in the message. Optional value. Max 5 buttons.
2 properties
1 required
c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTestNumberUpdateWebhookResponse
object
Webhook response containing RCS test number update events
1 property
1 required
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.BulkInfo
object
2 properties
2 required
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RecipientType
string
Recipient Type must be TACIR or BIREYSEL.
747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundContent
object
Message content.
1 property
1 required
14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.MessagePrice
object
Sent message price.
2 properties
62b589527d7474f21f086ddb07e8698e9fcfbbe16400c91718f1ab58d998c3f1.MMSMoWebhookRequest
object
3 properties
3c57fc8acf96933d1896c672a41450fccb946974464fd5e3ce94ed2b207c06af.Payment
object
8 properties
6 required
3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.LogResponseLogKakaoChinguOutboundContent
object
2 properties
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.ClickToCallApiMessage
object
Array of click to call messages to be sent.
18 properties
3 required
14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotRequest
object
2 properties
1 required
0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.AddFlowJsonResponse
object
1 property
1 required
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppOutboundEventContentType
string
e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.OmniResponseDetails
object
Array of sent message objects, one object per every message.
3 properties
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.MessageErrorGroup
string
Error group name that describes which category the error code belongs to.
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.SendResponse
object
2 properties
1 required
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsMoMessagePrice
object
Price object with traffic type information.
3 properties
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.TemplateParamType
string
Type of template parameter.
e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Organization
object
Company information.
3 properties
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.DeliveryTime
object
Exact time of day in which the sending ends. Time is expressed in the UTC time zone. If set, use it together with the from property with minimum 1 hour differe…
2 properties
e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Error
object
Indicates whether the error occurred during the query execution.
6 properties
45c843446703ba5f4438a6f721c629420452796de20bd3dd9adfccde3ed2ffff.ValidationReason
string
Reason is provided when validMailbox status is unknown. 1. INBOXFULL - The user quota exceeded / The user inbox is full / The user doesn't accept any more requ…
9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.Platform
object
Platform options. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
2 properties
7916e19109f991cfe966f390ef0d36117967291fa90eff57d8c8cb768f38352e.RecordingSortColumn
string
3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.ToDestination
object
An array of destination objects for where messages are being sent. A valid destination is required.
2 properties
1 required
1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.DeliveryReports
object
1 property
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.RecordedIvrFile
object
Array of recorded files metadata, one for each recorded file.
7 properties
e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoAlimData
object
Kakao AlimTalk-specific data used if the message is sent through a Kakao AlimTalk channel.
7 properties
8a2ea8872469b182f7474a94d4bf931da42a6e2a1d1ba07898b1bc7dcdc85cd2.Contact
object
Contact information. Exists in case of WhatsApp Message.
5 properties
ff7f7515e81995b140ab1c879b88d9d297a14922c035a187e237cd81e7c216a0.WebhookNotificationType
string
Type of the email platform event.
e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Contact
object
7 properties
1 required
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.AnswerRequest
object
2 properties
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.AnsweringMachineDetection
object
This action detects answering machines at the beginning of a call. It allows for detailed configuration of actions to be executed at various stages of the dete…
6 properties
2 required
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsUnificationDestination
object
---
0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.GetFlowJsonResponse
object
1 property
1 required
6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.BusinessVertical
string
Business vertical.
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.PriceInfo
object
Sent email price.
2 properties
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.CursorPageInfo
object
Cursor information.
2 properties
382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.ResponseEnvelopeMessageResponseMessageResponseDetails
object
2 properties
1 required
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.NumberPresentationFormat
string
Format in which numbers are sent to a SIP trunk.
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.MachineDetectionMode
object
Machine detection mode configuration
1 property
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RecordingSortColumn
string
14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.MessageError
object
Indicates whether an [error](https://www.infobip.com/docs/essentials/response-status-and-error-codeserror-codes) occurred during the query execution.
6 properties
ApiRequestError
object
1 property
91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbRequest
object
2 properties
1 required
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ErrorCodeInfo
object
Reason why the call has finished.
3 properties
4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionStatus
string
Action status.
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundEventContent
object
Message content.
1 property
1 required
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.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
f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.editStructure
object
Template structure. Format depends on the template category.
707907921d4508c2925eddc2449f10db322ecc083be424f87c50fe97ccd8be40.ConferenceLogResponse
object
9 properties
14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.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
1e938b22275568ebc747d21724b50c9be18ff5770eb33c37b76fda4633c14bde.RouteStatusRequest
object
Route status request object.
1 property
1 required
97cb4ba23432eb0e600ef0617ae1982d499839ef41226973c71dfb335b3071b8.Destination
object
Array of message destination addresses. Maximum number of destination addresses is 20k.
2 properties
1 required
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MMSMtLogsResponse
object
1 property
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.Platform
object
Platform options. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
2 properties
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.DeliveryReports
object
1 property
2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.Messages
object
Call link messaging settings.
3 properties
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.LogStatus
object
6 properties
382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.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.
a15a35d4e9d79ecb7047887a88973e9a539c66701b3c993c3c3be69782dd8aba.BulkResponse
object
Bulk response object.
2 properties
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsMoLinkSegment
object
2 properties
287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.DeliveryDay
string
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.Platform
object
Platform options. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
2 properties
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsUnificationLogMmsOutboundContent
object
An array of message log results, one object per each message log entry.
15 properties
f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.NameContent
object
Contains information about contact's name.
6 properties
2 required
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailUnificationLog
object
An array of message log results, one object per each message log entry.
13 properties
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.RequestSchedulingSettings
object
Options for scheduling a message.
3 properties
c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSender
object
19 properties
14 required
8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.MessagePrice
object
Sent message price.
2 properties
b5f674fb4d8d190ed269baf3b9aaf29827a4d03ec2de31bb6b608809be9a182b.IvrData
object
6 properties
45c843446703ba5f4438a6f721c629420452796de20bd3dd9adfccde3ed2ffff.ValidationRequest
object
Validation request
1 property
1 required
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.RequestSchedulingSettings
object
Options for scheduling a message.
3 properties
382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.KakaoAlimOutboundContent
object
Message content.
1 property
b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.FreeFormRcsApiMtContent
object
Rcs message contents.
1 property
6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.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
faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.ErrorMmsReport
object
Indicates whether the error occurred during the query execution.
6 properties
13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.UpdateScenarioResponse
object
10 properties
34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.TrackingResponse
object
Tracking details of the domain.
3 properties
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 Connectivity API
Infobip Customer Engagement API
Infobip Platform API
Infobip Tools API
#Channels
Where this information came from
This is an independent, third-party profile of Infobip Channels 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.