Navigators
Navigator behaviour may vary according to the country you are sending to and the message type. You can see the preferred kind of SMS channels for each scenario here and check any existing navigator in your workspace via the Navigator TAB in the developer dashboard
Navigators route over SMS, and over the OTT channels you enrol — RCS and WhatsApp. Enrolled OTT channels are attempted ahead of SMS, so a message falls back to SMS when an OTT attempt fails. See OTT channels and fallback.
List Available Navigators
GET
/workspaces/{workspaceId}/navigators
Get list of the navigators configured for a workspace. Navigators are used to select a channel for a message based on its content, type, recipient, etc. The type of the navigator defines how the channel will be selected.
Parametri di query
limit
integer
Limits the number of results to return.
pageToken
string
The cursor that keeps track of the current position in the results.
reverse
boolean
Reverses the order in which the results are returned.
type
string
Possible values: messaging, use-case-messaging, otp
useCaseType
string
Possible values: otp, transactional, marketing, conversation
Payload della risposta
results
array of object
Mostra attributi secondari
results.navigatorId
string
obbligatorio
results.workspaceId
string
obbligatorio
results.name
string
obbligatorio
The name of the navigator.
results.type
string
obbligatorio
The type of navigator defines how the navigator selects a channel for a message. * messaging - navigator configured with a pool of channels and performs channel selection based on channel availability and best originator type for a recipient country. The best originator type for a recipient country is determined by the strategy - prioritized list of originator types for each country. At this moment, the default pre-configured strategy (set of country policies) is used see https://docs.bird.com/applications/channels/channels/supported-channels/sms/concepts/choosing-the-right-sender-availability-and-restrictions-by-country
Possible values: messaging, use-case-messaging, otp
results.settings
object
obbligatorio
Mostra attributi secondari
results.settings.channels
array of object
obbligatorio
List of channels to be used
Mostra attributi secondari
results.settings.channels.channelId
string
obbligatorio
results.settings.channels.countries
array of string
ISO 3166-1 alpha-2 codes this channel may be used for. Omit or leave empty to allow every country. RCS availability is granted per carrier per country, so an RCS channel should always name the countries it covers.
results.settings.preferredChannels
array of object
Channels attempted in this order ahead of anything the country policy yields. Listing a channel here is the opt-in; a channel present only in channels stays policy-gated however its platform routes.
Mostra attributi secondari
results.settings.preferredChannels.channelId
string
obbligatorio
results.settings.preferredChannels.countries
array of string
ISO 3166-1 alpha-2 codes this channel may be used for. Omit or leave empty to allow every country. RCS availability is granted per carrier per country, so an RCS channel should always name the countries it covers.
results.settings.useCaseType
string
obbligatorio
Possible values: otp, transactional, marketing, conversation
results.settings.ottChannels
array of object
OTT channels the navigator attempts before SMS, in order. Each entry may be scoped to the countries where its sender is launched.
Mostra attributi secondari
results.settings.ottChannels.channelId
string
obbligatorio
results.settings.ottChannels.countries
array of string
ISO 3166-1 alpha-2 codes this channel may be used for. Omit or leave empty to allow every country. RCS availability is granted per carrier per country, so an RCS channel should always name the countries it covers.
results.settings.ottChannelsIds
object
Enrols one OTT channel per platform key. Channels enrolled this way join the navigator's pool without being preferred, so the country policy decides whether they are used. Use ottChannels to attempt them ahead of SMS, in a chosen order, and to scope them by country.
Mostra attributi secondari
results.settings.ottChannelsIds.whatsapp
string
Channel for WA
results.settings.ottChannelsIds.rcs
string
Channel for RCS
results.createdAt
string
obbligatorio
results.updatedAt
string
nextPageToken
string
The token that can be passed as pageToken in URL to retrieve the next set of results. If missing, no more results to display.
Esempio di codice
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/navigators' \
-H 'Authorization: AccessKey YOUR_ACCESS_KEY'By default, each workspace will have 4 navigators.
Please contact our support team if you need a customized navigator added to your workspace. One of our support support agents will coordinate its provisioning
- Marketing: The primary objective of marketing navigators is to send bulk traffic. They will only attempt delivery via PROMOTIONAL channels, adhering to strict compliance checks, including quiet hours and Opt-Out regulations.
- Conversation: Conversational navigators consider only two-way CONVERSATIONAL channels, ignoring any one-way channels (such as those using Alphanumeric senders).
- Transactional: The transactional navigator prioritizes high-quality routes when applying only the minimum required compline check. Transactional navigators will only send traffic from TRANSACTIONAL channels to ensure the best possible Quality of Service.
- OTP: The 2FA navigator prioritizes deliverability above all. It attempts to send messages via 2FA channels first but will use TRANSACTIONAL channels if none are available, and as a last resort, it will utilize PROMOTIONAL channels.
When sending OTPs, ensure you have either 2FA or transactional channels in your workspace. OTP messages delivered through promotional channels during quiet hours may be delayed until the following day.
Inspect a Navigator
GET
/workspaces/{workspaceId}/navigators/{navigatorId}
Get the navigator by ID
Payload della risposta
navigatorId
string
obbligatorio
workspaceId
string
obbligatorio
name
string
obbligatorio
The name of the navigator.
type
string
obbligatorio
The type of navigator defines how the navigator selects a channel for a message. * messaging - navigator configured with a pool of channels and performs channel selection based on channel availability and best originator type for a recipient country. The best originator type for a recipient country is determined by the strategy - prioritized list of originator types for each country. At this moment, the default pre-configured strategy (set of country policies) is used see https://docs.bird.com/applications/channels/channels/supported-channels/sms/concepts/choosing-the-right-sender-availability-and-restrictions-by-country
Possible values: messaging, use-case-messaging, otp
settings
object
obbligatorio
Mostra attributi secondari
settings.channels
array of object
obbligatorio
List of channels to be used
Mostra attributi secondari
settings.channels.channelId
string
obbligatorio
settings.channels.countries
array of string
ISO 3166-1 alpha-2 codes this channel may be used for. Omit or leave empty to allow every country. RCS availability is granted per carrier per country, so an RCS channel should always name the countries it covers.
settings.preferredChannels
array of object
Channels attempted in this order ahead of anything the country policy yields. Listing a channel here is the opt-in; a channel present only in channels stays policy-gated however its platform routes.
Mostra attributi secondari
settings.preferredChannels.channelId
string
obbligatorio
settings.preferredChannels.countries
array of string
ISO 3166-1 alpha-2 codes this channel may be used for. Omit or leave empty to allow every country. RCS availability is granted per carrier per country, so an RCS channel should always name the countries it covers.
settings.useCaseType
string
obbligatorio
Possible values: otp, transactional, marketing, conversation
settings.ottChannels
array of object
OTT channels the navigator attempts before SMS, in order. Each entry may be scoped to the countries where its sender is launched.
Mostra attributi secondari
settings.ottChannels.channelId
string
obbligatorio
settings.ottChannels.countries
array of string
ISO 3166-1 alpha-2 codes this channel may be used for. Omit or leave empty to allow every country. RCS availability is granted per carrier per country, so an RCS channel should always name the countries it covers.
settings.ottChannelsIds
object
Enrols one OTT channel per platform key. Channels enrolled this way join the navigator's pool without being preferred, so the country policy decides whether they are used. Use ottChannels to attempt them ahead of SMS, in a chosen order, and to scope them by country.
Mostra attributi secondari
settings.ottChannelsIds.whatsapp
string
Channel for WA
settings.ottChannelsIds.rcs
string
Channel for RCS
createdAt
string
obbligatorio
updatedAt
string
Esempio di codice
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/navigators/{navigatorId}' \
-H 'Authorization: AccessKey YOUR_ACCESS_KEY'Coverage
Navigators can access as many countries as there are channels available to them. Coverage may vary over time based on channel availability and health.
You can check a navigator coverage and the channel it will use for each country by clicking on it in the navigator set up page
GET
/workspaces/{workspaceId}/navigators/{navigatorId}/coverage
Get the navigator coverage by ID configured for a workspace
Esempio di codice
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/navigators/{navigatorId}/coverage' \
-H 'Authorization: AccessKey YOUR_ACCESS_KEY'Sending messages
A-Sync : this will start a background process that may require some time to complete. A Get call may be required to to retrieve the final result .
The Navigators POST request follows the same schema and requires the same body as the channels POST request
POST
/workspaces/{workspaceId}/navigators/{navigatorId}/messages
Send a message to a channel using the navigator. Channel webhooks will provide status updates, so each channel the navigator uses should have webhooks configured. Data returned via webhooks will have navigator metadata, including navigator ID and navigator message ID.
Payload della richiesta
sender
object
Mostra parametri secondari
sender.connector
object
obbligatorio
The sender of the message. For email messages, the sender is used to override the default sender username.
Mostra parametri secondari
sender.connector.identifierValue
string
obbligatorio
The identifier value of the sender.
sender.connector.annotations
object
Annotations are used to add additional information to a message.
For email messages, it can be used to specify a custom sender name.
Mostra parametri secondari
sender.connector.annotations.name
string
receiver
object
obbligatorio
Mostra parametri secondari
receiver.contacts
array of object
Mostra parametri secondari
receiver.contacts.id
string
The ID of the receiver. This is a reference to a contact.
receiver.contacts.identifierKey
string
The identifier key for finding the contact.
For WhatsApp channels with BSUID support, use whatsappbsuid to send
to a contact by their Business-Scoped User ID without needing to know
the channel's portfolio ID.
receiver.contacts.identifierValue
string
The identifier value for finding the contact.
receiver.contacts.type
string
The type of the receiver.
Possible values: cc, bcc, to
receiver.contacts.identifiers
array of object
Mostra parametri secondari
receiver.contacts.identifiers.identifierKey
string
obbligatorio
The identifier key for finding the contact.
receiver.contacts.identifiers.identifierValue
string
obbligatorio
The identifier value for finding the contact.
receiver.contacts.platformAddress
string
The value that is used to send the message to the platform.
receiver.contacts.platformAddressSelector
string
An expression that defines how we resolve the platform address (e.g. phone number or email address) from a contact.
This is an optional override for the default resolution logic (i.e. sending to the first
identifier key-value pair for the relevant platform).
reference
string
A reference to the message. This can be used to identify the message in the channel.
template
object
obbligatorio
Mostra parametri secondari
template.name
string
The platform name of the template.
template.projectId
string
the ID of the project from the project from Studio
template.version
string
The version of the template.
template.locale
string
template.attachments
array of object
Mostra parametri secondari
template.attachments.mediaUrl
string
obbligatorio
The URL of the attachment.
template.attachments.filename
string
obbligatorio
The filename of the attachment.
template.attachments.inline
boolean
template.shortLinks
object
SMS link shortening options.
Mostra parametri secondari
template.shortLinks.enabled
boolean
Enables link shortening for SMS messages.
template.shortLinks.domain
string
The domain to use when shortening links. When set to default,
uses the default link shortening domain for the workspace.
template.variables
object
Deprecated: Use parameters instead (string parameter for variables). This property is maintained for backward compatibility but will be removed in a future version.
Mostra parametri secondari
template.variables.default
string
template.utmParameters
array of object
The list of UTM parameters.
Mostra parametri secondari
template.utmParameters.key
string
obbligatorio
The name of the parameter in the query string.
template.utmParameters.value
string
obbligatorio
The static value of the parameter. Mutually exclusive with Reference.
template.utmParameters.key
string
obbligatorio
The name of the parameter in the query string.
template.utmParameters.reference
string
obbligatorio
The reference to a dynamic value. Mutually exclusive with Value.
Possible values: platform_name, channel_name
template.parameters
array of object
Mostra parametri secondari
template.parameters.type
string
obbligatorio
Possible values: string
template.parameters.key
string
obbligatorio
template.parameters.value
string
template.parameters.type
string
obbligatorio
Possible values: number
template.parameters.key
string
obbligatorio
template.parameters.value
number
template.parameters.type
string
obbligatorio
Possible values: boolean
template.parameters.key
string
obbligatorio
template.parameters.value
boolean
template.parameters.type
string
obbligatorio
Possible values: object
template.parameters.key
string
obbligatorio
template.parameters.value
object
template.parameters.type
string
obbligatorio
Possible values: sectionList
template.parameters.key
string
obbligatorio
template.parameters.value
object
Mostra parametri secondari
template.parameters.value.sections
array of object
obbligatorio
Mostra parametri secondari
template.parameters.value.sections.id
string
template.parameters.value.sections.multipleSelection
boolean
template.parameters.value.sections.title
string
obbligatorio
template.parameters.value.sections.items
array of object
obbligatorio
Mostra parametri secondari
template.parameters.value.sections.items.id
string
template.parameters.value.sections.items.type
string
obbligatorio
Possible values: reply-action
template.parameters.value.sections.items.reference
string
template.parameters.value.sections.items.role
string
template.parameters.value.sections.items.hidden
boolean
template.parameters.value.sections.items.replyAction
object
obbligatorio
Mostra parametri secondari
template.parameters.value.sections.items.replyAction.text
string
obbligatorio
template.parameters.value.sections.items.replyAction.imageUrl
string
template.parameters.value.sections.items.replyAction.payload
string
template.parameters.value.sections.items.replyAction.subTitle
string
template.parameters.type
string
obbligatorio
Possible values: timeslotList
template.parameters.key
string
obbligatorio
template.parameters.value
object
Mostra parametri secondari
template.parameters.value.timeslots
array of object
obbligatorio
Mostra parametri secondari
template.parameters.value.timeslots.id
string
template.parameters.value.timeslots.startTime
string
obbligatorio
template.parameters.value.timeslots.duration
number
obbligatorio
template.parameters.type
string
obbligatorio
Possible values: productSections
template.parameters.key
string
obbligatorio
template.parameters.value
object
Mostra parametri secondari
template.parameters.value.productSections
array of object
obbligatorio
Mostra parametri secondari
template.parameters.value.productSections.title
string
obbligatorio
template.parameters.value.productSections.products
array of object
obbligatorio
Mostra parametri secondari
template.parameters.value.productSections.products.externalProductId
string
obbligatorio
template.parameters.value.productSections.products.amount
string
template.parameters.value.productSections.products.text
string
template.parameters.type
string
obbligatorio
Possible values: productList
template.parameters.key
string
obbligatorio
template.parameters.value
object
Mostra parametri secondari
template.parameters.value.products
array of object
obbligatorio
Mostra parametri secondari
template.parameters.value.products.type
string
obbligatorio
Possible values: product
template.parameters.value.products.product
object
obbligatorio
Mostra parametri secondari
template.parameters.value.products.product.externalProductId
string
obbligatorio
template.parameters.value.products.product.amount
string
template.parameters.value.products.product.text
string
template.parameters.type
string
obbligatorio
Possible values: shippingMethodList
template.parameters.key
string
obbligatorio
template.parameters.value
object
Mostra parametri secondari
template.parameters.value.shippingMethods
array of object
obbligatorio
Mostra parametri secondari
template.parameters.value.shippingMethods.amount
string
obbligatorio
template.parameters.value.shippingMethods.label
string
obbligatorio
template.parameters.value.shippingMethods.identifier
string
obbligatorio
template.parameters.value.shippingMethods.detail
string
obbligatorio
template.parameters.type
string
obbligatorio
Possible values: lineItemList
template.parameters.key
string
obbligatorio
template.parameters.value
object
Mostra parametri secondari
template.parameters.value.lineItems
array of object
obbligatorio
Mostra parametri secondari
template.parameters.value.lineItems.amount
string
obbligatorio
template.parameters.value.lineItems.text
string
obbligatorio
template.parameters.value.lineItems.type
string
Possible values: pending, final
template.parameters.type
string
obbligatorio
Possible values: whatsappProductSections
template.parameters.key
string
obbligatorio
template.parameters.value
object
Mostra parametri secondari
template.parameters.value.sections
array of object
obbligatorio
Mostra parametri secondari
template.parameters.value.sections.id
string
template.parameters.value.sections.type
string
obbligatorio
Possible values: whatsapp-product-section
template.parameters.value.sections.reference
string
template.parameters.value.sections.role
string
template.parameters.value.sections.hidden
boolean
template.parameters.value.sections.whatsappProductSection
object
obbligatorio
Mostra parametri secondari
template.parameters.value.sections.whatsappProductSection.title
string
obbligatorio
template.parameters.value.sections.whatsappProductSection.products
array of object
obbligatorio
Mostra parametri secondari
template.parameters.value.sections.whatsappProductSection.products.id
string
template.parameters.value.sections.whatsappProductSection.products.type
string
obbligatorio
Possible values: whatsapp-product-item
template.parameters.value.sections.whatsappProductSection.products.reference
string
template.parameters.value.sections.whatsappProductSection.products.role
string
template.parameters.value.sections.whatsappProductSection.products.hidden
boolean
template.parameters.value.sections.whatsappProductSection.products.whatsappProductItem
object
obbligatorio
Mostra parametri secondari
template.parameters.value.sections.whatsappProductSection.products.whatsappProductItem.externalProductId
string
obbligatorio
template.parameters.type
string
obbligatorio
Possible values: whatsappProductItems
template.parameters.key
string
obbligatorio
template.parameters.value
object
Mostra parametri secondari
template.parameters.value.products
array of object
obbligatorio
Mostra parametri secondari
template.parameters.value.products.id
string
template.parameters.value.products.type
string
obbligatorio
Possible values: whatsapp-product-item
template.parameters.value.products.reference
string
template.parameters.value.products.role
string
template.parameters.value.products.hidden
boolean
template.parameters.value.products.whatsappProductItem
object
obbligatorio
Mostra parametri secondari
template.parameters.value.products.whatsappProductItem.externalProductId
string
obbligatorio
template.parameters.type
string
obbligatorio
Possible values: carouselCards
template.parameters.key
string
obbligatorio
template.parameters.value
object
Mostra parametri secondari
template.parameters.value.cards
array of object
obbligatorio
Mostra parametri secondari
template.parameters.value.cards.id
string
template.parameters.value.cards.type
string
obbligatorio
Possible values: whatsapp-carousel-card
template.parameters.value.cards.reference
string
template.parameters.value.cards.role
string
template.parameters.value.cards.hidden
boolean
template.parameters.value.cards.whatsappCarouselCard
object
obbligatorio
Mostra parametri secondari
template.parameters.value.cards.whatsappCarouselCard.header
object
obbligatorio
Mostra parametri secondari
template.parameters.value.cards.whatsappCarouselCard.header.type
string
obbligatorio
Possible values: image
template.parameters.value.cards.whatsappCarouselCard.header.image
object
obbligatorio
Mostra parametri secondari
template.parameters.value.cards.whatsappCarouselCard.header.image.mediaUrl
string
obbligatorio
template.parameters.value.cards.whatsappCarouselCard.header.image.altText
string
template.parameters.value.cards.whatsappCarouselCard.header.type
string
obbligatorio
Possible values: file
template.parameters.value.cards.whatsappCarouselCard.header.file
object
obbligatorio
Mostra parametri secondari
template.parameters.value.cards.whatsappCarouselCard.header.file.mediaUrl
string
obbligatorio
template.parameters.value.cards.whatsappCarouselCard.header.file.contentType
string
template.parameters.value.cards.whatsappCarouselCard.body
object
obbligatorio
Mostra parametri secondari
template.parameters.value.cards.whatsappCarouselCard.body.type
string
obbligatorio
Possible values: text
template.parameters.value.cards.whatsappCarouselCard.body.text
object
obbligatorio
Mostra parametri secondari
template.parameters.value.cards.whatsappCarouselCard.body.text.text
string
obbligatorio
template.parameters.value.cards.whatsappCarouselCard.actions
array of object
obbligatorio
Session carousels only support one link action per card.
Mostra parametri secondari
template.parameters.value.cards.whatsappCarouselCard.actions.type
string
obbligatorio
Possible values: link-action
template.parameters.value.cards.whatsappCarouselCard.actions.linkAction
object
obbligatorio
Mostra parametri secondari
template.parameters.value.cards.whatsappCarouselCard.actions.linkAction.text
string
obbligatorio
template.parameters.value.cards.whatsappCarouselCard.actions.linkAction.url
string
obbligatorio
template.parameters.type
string
obbligatorio
Possible values: appleFormPageItems
template.parameters.key
string
obbligatorio
template.parameters.value
object
Mostra parametri secondari
template.parameters.value.items
array of object
obbligatorio
Mostra parametri secondari
template.parameters.value.items.identifier
string
obbligatorio
Unique identifier for the item
template.parameters.value.items.title
string
obbligatorio
Display text shown to the user
template.parameters.value.items.value
string
obbligatorio
Value submitted when the item is selected
template.parameters.value.items.imageUrl
string
Optional URL of an image to display alongside the item title
template.parameters.value.items.nextPageIdentifier
string
Identifier of the next page to navigate to when this item is selected
template.settings
object
Mostra parametri secondari
template.settings.disallowMmLite
boolean
This is specific for WhatsApp marketing templates and requires MM Lite to be disabled for the WABAID.
meta
object
Mostra parametri secondari
meta.extraInformation
object
Free-form metadata. The useCase key (marketing, otp, transactional, or conversation) classifies the message and affects handling such as routing, frequency capping, email deliverability, and the messaging type/tag used on Meta channels (Messenger, Instagram).
meta.referral
object
Mostra parametri secondari
meta.referral.source
string
meta.referral.title
string
meta.referral.text
string
meta.referral.group
string
meta.referral.metadata
object
Mostra parametri secondari
meta.referral.metadata.source_id
string
meta.referral.metadata.source_url
string
meta.referral.metadata.media_url
string
meta.referral.metadata.tracking_id
string
meta.order
object
The order object contains information about the purchase order.
Mostra parametri secondari
meta.order.products
array of object
Mostra parametri secondari
meta.order.products.externalCatalogId
string
The platform-specific catalog ID of the product.
meta.order.products.externalProductId
string
The platform-specific product ID.
meta.order.products.quantity
integer
The number of items purchased.
meta.order.products.price
object
The price of the product.
Mostra parametri secondari
meta.order.products.price.amount
integer
meta.order.products.price.exponent
integer
meta.order.products.price.currencyCode
string
meta.referredProduct
object
Referred product in an incoming message.
Mostra parametri secondari
meta.referredProduct.externalCatalogId
string
The platform-specific catalog ID of the product.
meta.referredProduct.externalProductId
string
The platform-specific product ID.
meta.email
object
Mostra parametri secondari
meta.email.subject
string
meta.email.headers
object
meta.email.from
object
Mostra parametri secondari
meta.email.from.username
string
meta.email.from.displayName
string
meta.sms
object
Mostra parametri secondari
meta.sms.smartEncoding
boolean
When enabled, attempts to transliterate Unicode characters to GSM-7 equivalents.
If the resulting text is fully GSM-7 compatible, fewer message segments may be required.
The original message body is preserved; transliteration is only applied when sending.
meta.pushNotifications
object
Mostra parametri secondari
meta.pushNotifications.gatewayTypeOverride
string
Possible values: apns, firebase, web
meta.navigatorId
string
meta.navigatorMessageId
string
meta.flow
object
Mostra parametri secondari
meta.flow.id
string
meta.flow.name
string
meta.flow.stepId
string
meta.flow.runId
string
meta.journey
object
Mostra parametri secondari
meta.journey.id
string
meta.journey.name
string
meta.journey.stepId
string
meta.journey.runId
string
meta.campaign
object
Mostra parametri secondari
meta.campaign.id
string
meta.campaign.name
string
replyTo
object
Mostra parametri secondari
replyTo.id
string
obbligatorio
The ID of the message that is being replied to.
replyTo.order
integer
The order of the message in the conversation.
replyTo.type
string
obbligatorio
Possible values: message, click, referrals
notification
object
Mostra parametri secondari
notification.url
string
A custom webhook url to send events to. Note: you should have a created webhook subscription.
Refer to the Notifications API to learn how to create a webhook subscription.
capFrequency
boolean
If set to true, the frequency capping settings of the platform will be used
to either allow or reject the message to a contact. Can only be set to true
if the message is sent to a contact and .meta.extraInformation.useCase is marketing.
enableLinkTracking
boolean
If set to true and message is a test/campaign message, web tracking parameters will be appended to the links in the message.
ignoreQuietHours
boolean
If set to true, quiet hours settings will be ignored and the message will be sent as soon as possible.
ignoreGlobalHoldout
boolean
Do not check if the recipient is part of global holdout. To be used to send transactional messages.
tags
array of string
Tags to associate with the message. Tags are converted to lower case and tags
that do not exist are automatically created. You can view your created tags
in the UI. You can specify up to 10 tags per message.
shortLinks
object
SMS link shortening options. Must be included in the request for SMS channels
when enableLinkTracking is set to true. When using templates, please refer
to the template level shortLinks instead.
Mostra parametri secondari
shortLinks.domain
string
obbligatorio
The domain to use when shortening links. When set to default,
uses the default link shortening domain for the workspace.
scheduledFor
string
Scheduled time to send message at. Must be formated as RFC3339 timestamp. When
set, the message status will be scheduled until it's sent. Messages scheduled
for a time in the past or within 10 minutes of the request may be sent
immediately. Messages scheduled farther than 35 days will be rejected.
validity
integer
Validity determines for how many seconds a message is valid. If none is provided, the channel message type will be used to determine it.
A promotional, conversational or transactional channel message is valid for 36 hours (129600 seconds). A message sent from a 2FA channel is valid for 10 minutes (600 seconds).
sender
object
Mostra parametri secondari
sender.connector
object
obbligatorio
The sender of the message. For email messages, the sender is used to override the default sender username.
Mostra parametri secondari
sender.connector.identifierValue
string
obbligatorio
The identifier value of the sender.
sender.connector.annotations
object
Annotations are used to add additional information to a message.
For email messages, it can be used to specify a custom sender name.
Mostra parametri secondari
sender.connector.annotations.name
string
receiver
object
obbligatorio
Mostra parametri secondari
receiver.contacts
array of object
Mostra parametri secondari
receiver.contacts.id
string
The ID of the receiver. This is a reference to a contact.
receiver.contacts.identifierKey
string
The identifier key for finding the contact.
For WhatsApp channels with BSUID support, use whatsappbsuid to send
to a contact by their Business-Scoped User ID without needing to know
the channel's portfolio ID.
receiver.contacts.identifierValue
string
The identifier value for finding the contact.
receiver.contacts.type
string
The type of the receiver.
Possible values: cc, bcc, to
receiver.contacts.identifiers
array of object
Mostra parametri secondari
receiver.contacts.identifiers.identifierKey
string
obbligatorio
The identifier key for finding the contact.
receiver.contacts.identifiers.identifierValue
string
obbligatorio
The identifier value for finding the contact.
receiver.contacts.platformAddress
string
The value that is used to send the message to the platform.
receiver.contacts.platformAddressSelector
string
An expression that defines how we resolve the platform address (e.g. phone number or email address) from a contact.
This is an optional override for the default resolution logic (i.e. sending to the first
identifier key-value pair for the relevant platform).
reference
string
A reference to the message. This can be used to identify the message in the channel.
meta
object
Mostra parametri secondari
meta.extraInformation
object
Free-form metadata. The useCase key (marketing, otp, transactional, or conversation) classifies the message and affects handling such as routing, frequency capping, email deliverability, and the messaging type/tag used on Meta channels (Messenger, Instagram).
meta.referral
object
Mostra parametri secondari
meta.referral.source
string
meta.referral.title
string
meta.referral.text
string
meta.referral.group
string
meta.referral.metadata
object
Mostra parametri secondari
meta.referral.metadata.source_id
string
meta.referral.metadata.source_url
string
meta.referral.metadata.media_url
string
meta.referral.metadata.tracking_id
string
meta.order
object
The order object contains information about the purchase order.
Mostra parametri secondari
meta.order.products
array of object
Mostra parametri secondari
meta.order.products.externalCatalogId
string
The platform-specific catalog ID of the product.
meta.order.products.externalProductId
string
The platform-specific product ID.
meta.order.products.quantity
integer
The number of items purchased.
meta.order.products.price
object
The price of the product.
Mostra parametri secondari
meta.order.products.price.amount
integer
meta.order.products.price.exponent
integer
meta.order.products.price.currencyCode
string
meta.referredProduct
object
Referred product in an incoming message.
Mostra parametri secondari
meta.referredProduct.externalCatalogId
string
The platform-specific catalog ID of the product.
meta.referredProduct.externalProductId
string
The platform-specific product ID.
meta.email
object
Mostra parametri secondari
meta.email.subject
string
meta.email.headers
object
meta.email.from
object
Mostra parametri secondari
meta.email.from.username
string
meta.email.from.displayName
string
meta.sms
object
Mostra parametri secondari
meta.sms.smartEncoding
boolean
When enabled, attempts to transliterate Unicode characters to GSM-7 equivalents.
If the resulting text is fully GSM-7 compatible, fewer message segments may be required.
The original message body is preserved; transliteration is only applied when sending.
meta.pushNotifications
object
Mostra parametri secondari
meta.pushNotifications.gatewayTypeOverride
string
Possible values: apns, firebase, web
meta.navigatorId
string
meta.navigatorMessageId
string
meta.flow
object
Mostra parametri secondari
meta.flow.id
string
meta.flow.name
string
meta.flow.stepId
string
meta.flow.runId
string
meta.journey
object
Mostra parametri secondari
meta.journey.id
string
meta.journey.name
string
meta.journey.stepId
string
meta.journey.runId
string
meta.campaign
object
Mostra parametri secondari
meta.campaign.id
string
meta.campaign.name
string
replyTo
object
Mostra parametri secondari
replyTo.id
string
obbligatorio
The ID of the message that is being replied to.
replyTo.order
integer
The order of the message in the conversation.
replyTo.type
string
obbligatorio
Possible values: message, click, referrals
body
object
obbligatorio
Mostra parametri secondari
body.type
string
obbligatorio
Possible values: text
body.text
object
obbligatorio
Mostra parametri secondari
body.text.text
string
obbligatorio
body.text.attachments
array of object
Mostra parametri secondari
body.text.attachments.mediaUrl
string
obbligatorio
body.text.attachments.filename
string
obbligatorio
body.text.attachments.inline
boolean
body.text.attachments.contentId
string
body.text.actions
array of object
Mostra parametri secondari
body.text.actions.type
string
obbligatorio
Possible values: link
body.text.actions.link
object
obbligatorio
Mostra parametri secondari
body.text.actions.link.text
string
obbligatorio
body.text.actions.link.url
string
obbligatorio
body.text.actions.locationRequest
object
Mostra parametri secondari
body.text.actions.locationRequest.text
string
body.text.actions.type
string
obbligatorio
Possible values: reply
body.text.actions.reply
object
obbligatorio
Mostra parametri secondari
body.text.actions.reply.text
string
obbligatorio
body.text.actions.reply.imageUrl
string
body.text.actions.reply.metadata
object
Mostra parametri secondari
body.text.actions.reply.metadata.description
object
Sets the description in the row objects for Whatsapp list messages. Only available usage for Whatsapp platform
Mostra parametri secondari
body.text.actions.reply.metadata.description.label
string
body.text.actions.locationRequest
object
Mostra parametri secondari
body.text.actions.locationRequest.text
string
body.text.actions.type
string
obbligatorio
Possible values: locationRequest
body.text.actions.locationRequest
object
Mostra parametri secondari
body.text.actions.locationRequest.text
string
body.text.actions.type
string
obbligatorio
Possible values: buy
body.text.actions.locationRequest
object
Mostra parametri secondari
body.text.actions.locationRequest.text
string
body.text.actions.buy
object
obbligatorio
Mostra parametri secondari
body.text.actions.buy.text
string
obbligatorio
body.text.actions.buy.amountCents
integer
obbligatorio
body.text.actions.buy.currency
string
obbligatorio
body.text.actions.type
string
obbligatorio
Possible values: postback
body.text.actions.locationRequest
object
Mostra parametri secondari
body.text.actions.locationRequest.text
string
body.text.actions.postback
object
obbligatorio
Mostra parametri secondari
body.text.actions.postback.text
string
obbligatorio
body.text.actions.postback.payload
string
body.text.actions.postback.imageUrl
string
body.text.actions.postback.metadata
object
Mostra parametri secondari
body.text.actions.postback.metadata.description
object
Sets the description in the row objects for Whatsapp list messages. Only available usage for Whatsapp platform
Mostra parametri secondari
body.text.actions.postback.metadata.description.label
string
body.text.metadata
object
Mostra parametri secondari
body.text.metadata.subject
string
body.text.metadata.headers
object
body.text.metadata.whatsapp
object
Mostra parametri secondari
body.text.metadata.whatsapp.previewUrl
boolean
When set to true, preview will be displayed within whatsapp chat.
body.text.metadata.whatsapp.sharedContacts
array of object
Contact cards the recipient shared, from a REQUEST_CONTACT_INFO button tap or a direct contact share.
Mostra parametri secondari
body.text.metadata.whatsapp.sharedContacts.origin
string
obbligatorio
How the contact was shared. contact_request for a REQUEST_CONTACT_INFO button tap, other for a direct share.
body.text.metadata.whatsapp.sharedContacts.vcard
string
body.text.metadata.whatsapp.sharedContacts.phones
array of object
Mostra parametri secondari
body.text.metadata.whatsapp.sharedContacts.phones.phone
string
body.text.metadata.whatsapp.sharedContacts.phones.waId
string
body.text.metadata.whatsapp.sharedContacts.phones.type
string
body.text.metadata.line
object
Mostra parametri secondari
body.text.metadata.line.emoji
object
Mostra parametri secondari
body.text.metadata.line.emoji.items
array of object
Mostra parametri secondari
body.text.metadata.line.emoji.items.index
integer
obbligatorio
body.text.metadata.line.emoji.items.productId
string
obbligatorio
body.text.metadata.line.emoji.items.emojiId
string
obbligatorio
body.text.metadata.line.emoji.items.length
integer
body.text.metadata.telegram
object
The property is specific to Telegram, indicating the markup type to be used for message formatting
Mostra parametri secondari
body.text.metadata.telegram.parseMode
string
Possible values: Markdown, MarkdownV2
body.text.metadata.apple
object
The property is specific to Apple Business Chat, containing Apple-specific metadata
Mostra parametri secondari
body.text.metadata.apple.summaryText
string
Summary text for Apple Business Chat messages
body.text.metadata.apple.appClipPreview
boolean
Indicates if the message includes an App Clip link
body.text.metadata.apple.appClipRegion
string
AppClipRegion is the ISO 3166 alpha-2 country code for the App Store region.
body.permission_request
object
Mostra parametri secondari
body.permission_request.resource
string
obbligatorio
Possible values: call
body.type
string
obbligatorio
Possible values: html
body.html
obbligatorio
Mostra parametri secondari
body.html.text
string
obbligatorio
body.html.attachments
array
Mostra parametri secondari
body.html.attachments.mediaUrl
string
obbligatorio
body.html.attachments.filename
string
obbligatorio
body.html.attachments.inline
boolean
body.html.attachments.contentId
string
body.html.attachments.filename
string
obbligatorio
body.html.attachments.inline
boolean
body.html.attachments.content
string
obbligatorio
Base64-encoded attachment content. Mutually exclusive with mediaUrl; for larger files, upload the media and reference it with mediaUrl instead.
body.html.attachments.contentType
string
obbligatorio
body.html.attachments.contentId
string
body.html.actions
array of object
Mostra parametri secondari
body.html.actions.type
string
obbligatorio
Possible values: link
body.html.actions.link
object
obbligatorio
Mostra parametri secondari
body.html.actions.link.text
string
obbligatorio
body.html.actions.link.url
string
obbligatorio
body.html.actions.locationRequest
object
Mostra parametri secondari
body.html.actions.locationRequest.text
string
body.html.actions.type
string
obbligatorio
Possible values: reply
body.html.actions.reply
object
obbligatorio
Mostra parametri secondari
body.html.actions.reply.text
string
obbligatorio
body.html.actions.reply.imageUrl
string
body.html.actions.reply.metadata
object
Mostra parametri secondari
body.html.actions.reply.metadata.description
object
Sets the description in the row objects for Whatsapp list messages. Only available usage for Whatsapp platform
Mostra parametri secondari
body.html.actions.reply.metadata.description.label
string
body.html.actions.locationRequest
object
Mostra parametri secondari
body.html.actions.locationRequest.text
string
body.html.actions.type
string
obbligatorio
Possible values: locationRequest
body.html.actions.locationRequest
object
Mostra parametri secondari
body.html.actions.locationRequest.text
string
body.html.actions.type
string
obbligatorio
Possible values: buy
body.html.actions.locationRequest
object
Mostra parametri secondari
body.html.actions.locationRequest.text
string
body.html.actions.buy
object
obbligatorio
Mostra parametri secondari
body.html.actions.buy.text
string
obbligatorio
body.html.actions.buy.amountCents
integer
obbligatorio
body.html.actions.buy.currency
string
obbligatorio
body.html.actions.type
string
obbligatorio
Possible values: postback
body.html.actions.locationRequest
object
Mostra parametri secondari
body.html.actions.locationRequest.text
string
body.html.actions.postback
object
obbligatorio
Mostra parametri secondari
body.html.actions.postback.text
string
obbligatorio
body.html.actions.postback.payload
string
body.html.actions.postback.imageUrl
string
body.html.actions.postback.metadata
object
Mostra parametri secondari
body.html.actions.postback.metadata.description
object
Sets the description in the row objects for Whatsapp list messages. Only available usage for Whatsapp platform
Mostra parametri secondari
body.html.actions.postback.metadata.description.label
string
body.html.metadata
object
Mostra parametri secondari
body.html.metadata.subject
string
body.html.metadata.emailFrom
object
Mostra parametri secondari
body.html.metadata.emailFrom.username
string
body.html.metadata.emailFrom.displayName
string
body.html.metadata.headers
object
body.html.metadata.initialOpenTracking
boolean
body.html.metadata.clickTracking
boolean
body.html.metadata.openTracking
boolean
body.html.html
string
obbligatorio
body.html.attachments
array
Mostra parametri secondari
body.html.attachments.mediaUrl
string
obbligatorio
body.html.attachments.filename
string
obbligatorio
body.html.attachments.inline
boolean
body.html.attachments.contentId
string
body.html.attachments.filename
string
obbligatorio
body.html.attachments.inline
boolean
body.html.attachments.content
string
obbligatorio
Base64-encoded attachment content. Mutually exclusive with mediaUrl; for larger files, upload the media and reference it with mediaUrl instead.
body.html.attachments.contentType
string
obbligatorio
body.html.attachments.contentId
string
body.html.actions
array of object
Mostra parametri secondari
body.html.actions.type
string
obbligatorio
Possible values: link
body.html.actions.link
object
obbligatorio
Mostra parametri secondari
body.html.actions.link.text
string
obbligatorio
body.html.actions.link.url
string
obbligatorio
body.html.actions.locationRequest
object
Mostra parametri secondari
body.html.actions.locationRequest.text
string
body.html.actions.type
string
obbligatorio
Possible values: reply
body.html.actions.reply
object
obbligatorio
Mostra parametri secondari
body.html.actions.reply.text
string
obbligatorio
body.html.actions.reply.imageUrl
string
body.html.actions.reply.metadata
object
Mostra parametri secondari
body.html.actions.reply.metadata.description
object
Sets the description in the row objects for Whatsapp list messages. Only available usage for Whatsapp platform
Mostra parametri secondari
body.html.actions.reply.metadata.description.label
string
body.html.actions.locationRequest
object
Mostra parametri secondari
body.html.actions.locationRequest.text
string
body.html.actions.type
string
obbligatorio
Possible values: locationRequest
body.html.actions.locationRequest
object
Mostra parametri secondari
body.html.actions.locationRequest.text
string
body.html.actions.type
string
obbligatorio
Possible values: buy
body.html.actions.locationRequest
object
Mostra parametri secondari
body.html.actions.locationRequest.text
string
body.html.actions.buy
object
obbligatorio
Mostra parametri secondari
body.html.actions.buy.text
string
obbligatorio
body.html.actions.buy.amountCents
integer
obbligatorio
body.html.actions.buy.currency
string
obbligatorio
body.html.actions.type
string
obbligatorio
Possible values: postback
body.html.actions.locationRequest
object
Mostra parametri secondari
body.html.actions.locationRequest.text
string
body.html.actions.postback
object
obbligatorio
Mostra parametri secondari
body.html.actions.postback.text
string
obbligatorio
body.html.actions.postback.payload
string
body.html.actions.postback.imageUrl
string
body.html.actions.postback.metadata
object
Mostra parametri secondari
body.html.actions.postback.metadata.description
object
Sets the description in the row objects for Whatsapp list messages. Only available usage for Whatsapp platform
Mostra parametri secondari
body.html.actions.postback.metadata.description.label
string
body.html.metadata
object
Mostra parametri secondari
body.html.metadata.subject
string
body.html.metadata.emailFrom
object
Mostra parametri secondari
body.html.metadata.emailFrom.username
string
body.html.metadata.emailFrom.displayName
string
body.html.metadata.headers
object
body.html.metadata.initialOpenTracking
boolean
body.html.metadata.clickTracking
boolean
body.html.metadata.openTracking
boolean
body.permission_request
object
Mostra parametri secondari
body.permission_request.resource
string
obbligatorio
Possible values: call
body.type
string
obbligatorio
Possible values: image
body.image
object
obbligatorio
Mostra parametri secondari
body.image.text
string
body.image.images
array of object
obbligatorio
Mostra parametri secondari
body.image.images.mediaUrl
string
obbligatorio
body.image.images.altText
string
body.image.metadata
object
Mostra parametri secondari
body.image.metadata.subject
string
The property is specific mms file, shows the subject of the mms.
body.image.metadata.fallbackText
string
The property is specific mms file, when a mms is not supported, it will fallback to show content with the fallbackText.
body.image.metadata.storyType
string
The property is specific instagram file, shows the story type.
body.image.metadata.telegram
object
The property is specific to Telegram, indicating the markup type to be used for message formatting
Mostra parametri secondari
body.image.metadata.telegram.parseMode
string
Possible values: Markdown, MarkdownV2
body.image.actions
array of object
Mostra parametri secondari
body.image.actions.type
string
obbligatorio
Possible values: link
body.image.actions.link
object
obbligatorio
Mostra parametri secondari
body.image.actions.link.text
string
obbligatorio
body.image.actions.link.url
string
obbligatorio
body.image.actions.locationRequest
object
Mostra parametri secondari
body.image.actions.locationRequest.text
string
body.image.actions.type
string
obbligatorio
Possible values: reply
body.image.actions.reply
object
obbligatorio
Mostra parametri secondari
body.image.actions.reply.text
string
obbligatorio
body.image.actions.reply.imageUrl
string
body.image.actions.reply.metadata
object
Mostra parametri secondari
body.image.actions.reply.metadata.description
object
Sets the description in the row objects for Whatsapp list messages. Only available usage for Whatsapp platform
Mostra parametri secondari
body.image.actions.reply.metadata.description.label
string
body.image.actions.locationRequest
object
Mostra parametri secondari
body.image.actions.locationRequest.text
string
body.image.actions.type
string
obbligatorio
Possible values: locationRequest
body.image.actions.locationRequest
object
Mostra parametri secondari
body.image.actions.locationRequest.text
string
body.image.actions.type
string
obbligatorio
Possible values: buy
body.image.actions.locationRequest
object
Mostra parametri secondari
body.image.actions.locationRequest.text
string
body.image.actions.buy
object
obbligatorio
Mostra parametri secondari
body.image.actions.buy.text
string
obbligatorio
body.image.actions.buy.amountCents
integer
obbligatorio
body.image.actions.buy.currency
string
obbligatorio
body.image.actions.type
string
obbligatorio
Possible values: postback
body.image.actions.locationRequest
object
Mostra parametri secondari
body.image.actions.locationRequest.text
string
body.image.actions.postback
object
obbligatorio
Mostra parametri secondari
body.image.actions.postback.text
string
obbligatorio
body.image.actions.postback.payload
string
body.image.actions.postback.imageUrl
string
body.image.actions.postback.metadata
object
Mostra parametri secondari
body.image.actions.postback.metadata.description
object
Sets the description in the row objects for Whatsapp list messages. Only available usage for Whatsapp platform
Mostra parametri secondari
body.image.actions.postback.metadata.description.label
string
body.permission_request
object
Mostra parametri secondari
body.permission_request.resource
string
obbligatorio
Possible values: call
body.type
string
obbligatorio
Possible values: file
body.file
object
obbligatorio
Mostra parametri secondari
body.file.text
string
body.file.files
array of object
obbligatorio
Mostra parametri secondari
body.file.files.mediaUrl
string
obbligatorio
body.file.files.contentType
string
obbligatorio
body.file.files.filename
string
body.file.files.altText
string
body.file.files.metadata
object
Mostra parametri secondari
body.file.files.metadata.isAnimated
boolean
The property is specific the sticker file, shows that if the sticker is animated or not.
body.file.metadata
object
Mostra parametri secondari
body.file.metadata.subject
string
The property is specific mms file, shows the subject of the mms.
body.file.metadata.fallbackText
string
The property is specific mms file, when a mms is not supported, it will fallback to show content with the fallbackText.
body.file.metadata.storyType
string
The property is specific instagram file, shows the story type.
body.file.metadata.telegram
object
The property is specific to Telegram, indicating the markup type to be used for message formatting
Mostra parametri secondari
body.file.metadata.telegram.parseMode
string
Possible values: Markdown, MarkdownV2
body.file.actions
array of object
Mostra parametri secondari
body.file.actions.type
string
obbligatorio
Possible values: link
body.file.actions.link
object
obbligatorio
Mostra parametri secondari
body.file.actions.link.text
string
obbligatorio
body.file.actions.link.url
string
obbligatorio
body.file.actions.locationRequest
object
Mostra parametri secondari
body.file.actions.locationRequest.text
string
body.file.actions.type
string
obbligatorio
Possible values: reply
body.file.actions.reply
object
obbligatorio
Mostra parametri secondari
body.file.actions.reply.text
string
obbligatorio
body.file.actions.reply.imageUrl
string
body.file.actions.reply.metadata
object
Mostra parametri secondari
body.file.actions.reply.metadata.description
object
Sets the description in the row objects for Whatsapp list messages. Only available usage for Whatsapp platform
Mostra parametri secondari
body.file.actions.reply.metadata.description.label
string
body.file.actions.locationRequest
object
Mostra parametri secondari
body.file.actions.locationRequest.text
string
body.file.actions.type
string
obbligatorio
Possible values: locationRequest
body.file.actions.locationRequest
object
Mostra parametri secondari
body.file.actions.locationRequest.text
string
body.file.actions.type
string
obbligatorio
Possible values: buy
body.file.actions.locationRequest
object
Mostra parametri secondari
body.file.actions.locationRequest.text
string
body.file.actions.buy
object
obbligatorio
Mostra parametri secondari
body.file.actions.buy.text
string
obbligatorio
body.file.actions.buy.amountCents
integer
obbligatorio
body.file.actions.buy.currency
string
obbligatorio
body.file.actions.type
string
obbligatorio
Possible values: postback
body.file.actions.locationRequest
object
Mostra parametri secondari
body.file.actions.locationRequest.text
string
body.file.actions.postback
object
obbligatorio
Mostra parametri secondari
body.file.actions.postback.text
string
obbligatorio
body.file.actions.postback.payload
string
body.file.actions.postback.imageUrl
string
body.file.actions.postback.metadata
object
Mostra parametri secondari
body.file.actions.postback.metadata.description
object
Sets the description in the row objects for Whatsapp list messages. Only available usage for Whatsapp platform
Mostra parametri secondari
body.file.actions.postback.metadata.description.label
string
body.permission_request
object
Mostra parametri secondari
body.permission_request.resource
string
obbligatorio
Possible values: call
body.type
string
obbligatorio
Possible values: gif
body.gif
object
obbligatorio
Mostra parametri secondari
body.gif.text
string
body.gif.mediaUrl
string
obbligatorio
body.gif.altText
string
body.gif.actions
array of object
Mostra parametri secondari
body.gif.actions.type
string
obbligatorio
Possible values: link
body.gif.actions.link
object
obbligatorio
Mostra parametri secondari
body.gif.actions.link.text
string
obbligatorio
body.gif.actions.link.url
string
obbligatorio
body.gif.actions.locationRequest
object
Mostra parametri secondari
body.gif.actions.locationRequest.text
string
body.gif.actions.type
string
obbligatorio
Possible values: reply
body.gif.actions.reply
object
obbligatorio
Mostra parametri secondari
body.gif.actions.reply.text
string
obbligatorio
body.gif.actions.reply.imageUrl
string
body.gif.actions.reply.metadata
object
Mostra parametri secondari
body.gif.actions.reply.metadata.description
object
Sets the description in the row objects for Whatsapp list messages. Only available usage for Whatsapp platform
Mostra parametri secondari
body.gif.actions.reply.metadata.description.label
string
body.gif.actions.locationRequest
object
Mostra parametri secondari
body.gif.actions.locationRequest.text
string
body.gif.actions.type
string
obbligatorio
Possible values: locationRequest
body.gif.actions.locationRequest
object
Mostra parametri secondari
body.gif.actions.locationRequest.text
string
body.gif.actions.type
string
obbligatorio
Possible values: buy
body.gif.actions.locationRequest
object
Mostra parametri secondari
body.gif.actions.locationRequest.text
string
body.gif.actions.buy
object
obbligatorio
Mostra parametri secondari
body.gif.actions.buy.text
string
obbligatorio
body.gif.actions.buy.amountCents
integer
obbligatorio
body.gif.actions.buy.currency
string
obbligatorio
body.gif.actions.type
string
obbligatorio
Possible values: postback
body.gif.actions.locationRequest
object
Mostra parametri secondari
body.gif.actions.locationRequest.text
string
body.gif.actions.postback
object
obbligatorio
Mostra parametri secondari
body.gif.actions.postback.text
string
obbligatorio
body.gif.actions.postback.payload
string
body.gif.actions.postback.imageUrl
string
body.gif.actions.postback.metadata
object
Mostra parametri secondari
body.gif.actions.postback.metadata.description
object
Sets the description in the row objects for Whatsapp list messages. Only available usage for Whatsapp platform
Mostra parametri secondari
body.gif.actions.postback.metadata.description.label
string
body.gif.metadata
object
Mostra parametri secondari
body.gif.metadata.telegram
object
The property is specific to Telegram, indicating the markup type to be used for message formatting
Mostra parametri secondari
body.gif.metadata.telegram.parseMode
string
Possible values: Markdown, MarkdownV2
body.permission_request
object
Mostra parametri secondari
body.permission_request.resource
string
obbligatorio
Possible values: call
body.type
string
obbligatorio
Possible values: location
body.location
object
obbligatorio
Mostra parametri secondari
body.location.coordinates
object
obbligatorio
Mostra parametri secondari
body.location.coordinates.latitude
number
body.location.coordinates.longitude
number
body.location.location
object
Mostra parametri secondari
body.location.location.address
string
body.location.location.label
string
body.permission_request
object
Mostra parametri secondari
body.permission_request.resource
string
obbligatorio
Possible values: call
body.type
string
obbligatorio
Possible values: carousel
body.carousel
object
obbligatorio
Mostra parametri secondari
body.carousel.text
string
Optional text displayed above the carousel cards
body.carousel.items
array of object
obbligatorio
Mostra parametri secondari
body.carousel.items.title
string
body.carousel.items.mediaUrl
string
body.carousel.items.description
string
body.carousel.items.altText
string
body.carousel.items.actions
array of object
Mostra parametri secondari
body.carousel.items.actions.type
string
obbligatorio
Possible values: link
body.carousel.items.actions.link
object
obbligatorio
Mostra parametri secondari
body.carousel.items.actions.link.text
string
obbligatorio
body.carousel.items.actions.link.url
string
obbligatorio
body.carousel.items.actions.locationRequest
object
Mostra parametri secondari
body.carousel.items.actions.locationRequest.text
string
body.carousel.items.actions.type
string
obbligatorio
Possible values: reply
body.carousel.items.actions.reply
object
obbligatorio
Mostra parametri secondari
body.carousel.items.actions.reply.text
string
obbligatorio
body.carousel.items.actions.reply.imageUrl
string
body.carousel.items.actions.reply.metadata
object
Mostra parametri secondari
body.carousel.items.actions.reply.metadata.description
object
Sets the description in the row objects for Whatsapp list messages. Only available usage for Whatsapp platform
Mostra parametri secondari
body.carousel.items.actions.reply.metadata.description.label
string
body.carousel.items.actions.locationRequest
object
Mostra parametri secondari
body.carousel.items.actions.locationRequest.text
string
body.carousel.items.actions.type
string
obbligatorio
Possible values: locationRequest
body.carousel.items.actions.locationRequest
object
Mostra parametri secondari
body.carousel.items.actions.locationRequest.text
string
body.carousel.items.actions.type
string
obbligatorio
Possible values: buy
body.carousel.items.actions.locationRequest
object
Mostra parametri secondari
body.carousel.items.actions.locationRequest.text
string
body.carousel.items.actions.buy
object
obbligatorio
Mostra parametri secondari
body.carousel.items.actions.buy.text
string
obbligatorio
body.carousel.items.actions.buy.amountCents
integer
obbligatorio
body.carousel.items.actions.buy.currency
string
obbligatorio
body.carousel.items.actions.type
string
obbligatorio
Possible values: postback
body.carousel.items.actions.locationRequest
object
Mostra parametri secondari
body.carousel.items.actions.locationRequest.text
string
body.carousel.items.actions.postback
object
obbligatorio
Mostra parametri secondari
body.carousel.items.actions.postback.text
string
obbligatorio
body.carousel.items.actions.postback.payload
string
body.carousel.items.actions.postback.imageUrl
string
body.carousel.items.actions.postback.metadata
object
Mostra parametri secondari
body.carousel.items.actions.postback.metadata.description
object
Sets the description in the row objects for Whatsapp list messages. Only available usage for Whatsapp platform
Mostra parametri secondari
body.carousel.items.actions.postback.metadata.description.label
string
body.permission_request
object
Mostra parametri secondari
body.permission_request.resource
string
obbligatorio
Possible values: call
body.type
string
obbligatorio
Possible values: list
body.list
object
obbligatorio
Mostra parametri secondari
body.list.title
string
body.list.text
string
obbligatorio
body.list.altText
string
body.list.items
array of object
Mostra parametri secondari
body.list.items.title
string
body.list.items.mediaUrl
string
body.list.items.description
string
body.list.items.altText
string
body.list.items.actions
array of object
Mostra parametri secondari
body.list.items.actions.type
string
obbligatorio
Possible values: link
body.list.items.actions.link
object
obbligatorio
Mostra parametri secondari
body.list.items.actions.link.text
string
obbligatorio
body.list.items.actions.link.url
string
obbligatorio
body.list.items.actions.locationRequest
object
Mostra parametri secondari
body.list.items.actions.locationRequest.text
string
body.list.items.actions.type
string
obbligatorio
Possible values: reply
body.list.items.actions.reply
object
obbligatorio
Mostra parametri secondari
body.list.items.actions.reply.text
string
obbligatorio
body.list.items.actions.reply.imageUrl
string
body.list.items.actions.reply.metadata
object
Mostra parametri secondari
body.list.items.actions.reply.metadata.description
object
Sets the description in the row objects for Whatsapp list messages. Only available usage for Whatsapp platform
Mostra parametri secondari
body.list.items.actions.reply.metadata.description.label
string
body.list.items.actions.locationRequest
object
Mostra parametri secondari
body.list.items.actions.locationRequest.text
string
body.list.items.actions.type
string
obbligatorio
Possible values: locationRequest
body.list.items.actions.locationRequest
object
Mostra parametri secondari
body.list.items.actions.locationRequest.text
string
body.list.items.actions.type
string
obbligatorio
Possible values: buy
body.list.items.actions.locationRequest
object
Mostra parametri secondari
body.list.items.actions.locationRequest.text
string
body.list.items.actions.buy
object
obbligatorio
Mostra parametri secondari
body.list.items.actions.buy.text
string
obbligatorio
body.list.items.actions.buy.amountCents
integer
obbligatorio
body.list.items.actions.buy.currency
string
obbligatorio
body.list.items.actions.type
string
obbligatorio
Possible values: postback
body.list.items.actions.locationRequest
object
Mostra parametri secondari
body.list.items.actions.locationRequest.text
string
body.list.items.actions.postback
object
obbligatorio
Mostra parametri secondari
body.list.items.actions.postback.text
string
obbligatorio
body.list.items.actions.postback.payload
string
body.list.items.actions.postback.imageUrl
string
body.list.items.actions.postback.metadata
object
Mostra parametri secondari
body.list.items.actions.postback.metadata.description
object
Sets the description in the row objects for Whatsapp list messages. Only available usage for Whatsapp platform
Mostra parametri secondari
body.list.items.actions.postback.metadata.description.label
string
body.list.actions
array of object
Mostra parametri secondari
body.list.actions.type
string
obbligatorio
Possible values: link
body.list.actions.link
object
obbligatorio
Mostra parametri secondari
body.list.actions.link.text
string
obbligatorio
body.list.actions.link.url
string
obbligatorio
body.list.actions.locationRequest
object
Mostra parametri secondari
body.list.actions.locationRequest.text
string
body.list.actions.type
string
obbligatorio
Possible values: reply
body.list.actions.reply
object
obbligatorio
Mostra parametri secondari
body.list.actions.reply.text
string
obbligatorio
body.list.actions.reply.imageUrl
string
body.list.actions.reply.metadata
object
Mostra parametri secondari
body.list.actions.reply.metadata.description
object
Sets the description in the row objects for Whatsapp list messages. Only available usage for Whatsapp platform
Mostra parametri secondari
body.list.actions.reply.metadata.description.label
string
body.list.actions.locationRequest
object
Mostra parametri secondari
body.list.actions.locationRequest.text
string
body.list.actions.type
string
obbligatorio
Possible values: locationRequest
body.list.actions.locationRequest
object
Mostra parametri secondari
body.list.actions.locationRequest.text
string
body.list.actions.type
string
obbligatorio
Possible values: buy
body.list.actions.locationRequest
object
Mostra parametri secondari
body.list.actions.locationRequest.text
string
body.list.actions.buy
object
obbligatorio
Mostra parametri secondari
body.list.actions.buy.text
string
obbligatorio
body.list.actions.buy.amountCents
integer
obbligatorio
body.list.actions.buy.currency
string
obbligatorio
body.list.actions.type
string
obbligatorio
Possible values: postback
body.list.actions.locationRequest
object
Mostra parametri secondari
body.list.actions.locationRequest.text
string
body.list.actions.postback
object
obbligatorio
Mostra parametri secondari
body.list.actions.postback.text
string
obbligatorio
body.list.actions.postback.payload
string
body.list.actions.postback.imageUrl
string
body.list.actions.postback.metadata
object
Mostra parametri secondari
body.list.actions.postback.metadata.description
object
Sets the description in the row objects for Whatsapp list messages. Only available usage for Whatsapp platform
Mostra parametri secondari
body.list.actions.postback.metadata.description.label
string
body.list.metadata
object
Mostra parametri secondari
body.list.metadata.button
object
Sets a button name for whatsapp list messages. Only available usage for Whatsapp platform
Mostra parametri secondari
body.list.metadata.button.label
string
body.list.metadata.replyMessage
object
Sets the reply message to be used when a list item is picked. Used for Apple Business Chat.
Mostra parametri secondari
body.list.metadata.replyMessage.title
string
body.list.metadata.replyMessage.text
string
body.permission_request
object
Mostra parametri secondari
body.permission_request.resource
string
obbligatorio
Possible values: call
body.type
string
obbligatorio
Possible values: section
body.section
object
obbligatorio
Mostra parametri secondari
body.section.items
array of object
Mostra parametri secondari
body.section.items.type
string
obbligatorio
Possible values: text
body.section.items.text
object
obbligatorio
Mostra parametri secondari
body.section.items.text.text
string
obbligatorio
body.section.items.text.attachments
array of object
Mostra parametri secondari
body.section.items.text.attachments.mediaUrl
string
obbligatorio
body.section.items.text.attachments.filename
string
obbligatorio
body.section.items.text.attachments.inline
boolean
body.section.items.text.attachments.contentId
string
body.section.items.text.actions
array of object
Mostra parametri secondari
body.section.items.text.actions.type
string
obbligatorio
Possible values: link
body.section.items.text.actions.link
object
obbligatorio
Mostra parametri secondari
body.section.items.text.actions.link.text
string
obbligatorio
body.section.items.text.actions.link.url
string
obbligatorio
body.section.items.text.actions.locationRequest
object
Mostra parametri secondari
body.section.items.text.actions.locationRequest.text
string
body.section.items.text.actions.type
string
obbligatorio
Possible values: reply
body.section.items.text.actions.reply
object
obbligatorio
Mostra parametri secondari
body.section.items.text.actions.reply.text
string
obbligatorio
body.section.items.text.actions.reply.imageUrl
string
body.section.items.text.actions.reply.metadata
object
Mostra parametri secondari
body.section.items.text.actions.reply.metadata.description
object
Sets the description in the row objects for Whatsapp list messages. Only available usage for Whatsapp platform
Mostra parametri secondari
body.section.items.text.actions.reply.metadata.description.label
string
body.section.items.text.actions.locationRequest
object
Mostra parametri secondari
body.section.items.text.actions.locationRequest.text
string
body.section.items.text.actions.type
string
obbligatorio
Possible values: locationRequest
body.section.items.text.actions.locationRequest
object
Mostra parametri secondari
body.section.items.text.actions.locationRequest.text
string
body.section.items.text.actions.type
string
obbligatorio
Possible values: buy
body.section.items.text.actions.locationRequest
object
Mostra parametri secondari
body.section.items.text.actions.locationRequest.text
string
body.section.items.text.actions.buy
object
obbligatorio
Mostra parametri secondari
body.section.items.text.actions.buy.text
string
obbligatorio
body.section.items.text.actions.buy.amountCents
integer
obbligatorio
body.section.items.text.actions.buy.currency
string
obbligatorio
body.section.items.text.actions.type
string
obbligatorio
Possible values: postback
body.section.items.text.actions.locationRequest
object
Mostra parametri secondari
body.section.items.text.actions.locationRequest.text
string
body.section.items.text.actions.postback
object
obbligatorio
Mostra parametri secondari
body.section.items.text.actions.postback.text
string
obbligatorio
body.section.items.text.actions.postback.payload
string
body.section.items.text.actions.postback.imageUrl
string
body.section.items.text.actions.postback.metadata
object
Mostra parametri secondari
body.section.items.text.actions.postback.metadata.description
object
Sets the description in the row objects for Whatsapp list messages. Only available usage for Whatsapp platform
Mostra parametri secondari
body.section.items.text.actions.postback.metadata.description.label
string
body.section.items.text.metadata
object
Mostra parametri secondari
body.section.items.text.metadata.subject
string
body.section.items.text.metadata.headers
object
body.section.items.text.metadata.whatsapp
object
Mostra parametri secondari
body.section.items.text.metadata.whatsapp.previewUrl
boolean
When set to true, preview will be displayed within whatsapp chat.
body.section.items.text.metadata.whatsapp.sharedContacts
array of object
Contact cards the recipient shared, from a REQUEST_CONTACT_INFO button tap or a direct contact share.
Mostra parametri secondari
body.section.items.text.metadata.whatsapp.sharedContacts.origin
string
obbligatorio
How the contact was shared. contact_request for a REQUEST_CONTACT_INFO button tap, other for a direct share.
body.section.items.text.metadata.whatsapp.sharedContacts.vcard
string
body.section.items.text.metadata.whatsapp.sharedContacts.phones
array of object
Mostra parametri secondari
body.section.items.text.metadata.whatsapp.sharedContacts.phones.phone
string
body.section.items.text.metadata.whatsapp.sharedContacts.phones.waId
string
body.section.items.text.metadata.whatsapp.sharedContacts.phones.type
string
body.section.items.text.metadata.line
object
Mostra parametri secondari
body.section.items.text.metadata.line.emoji
object
Mostra parametri secondari
body.section.items.text.metadata.line.emoji.items
array of object
Mostra parametri secondari
body.section.items.text.metadata.line.emoji.items.index
integer
obbligatorio
body.section.items.text.metadata.line.emoji.items.productId
string
obbligatorio
body.section.items.text.metadata.line.emoji.items.emojiId
string
obbligatorio
body.section.items.text.metadata.line.emoji.items.length
integer
body.section.items.text.metadata.telegram
object
The property is specific to Telegram, indicating the markup type to be used for message formatting
Mostra parametri secondari
body.section.items.text.metadata.telegram.parseMode
string
Possible values: Markdown, MarkdownV2
body.section.items.text.metadata.apple
object
The property is specific to Apple Business Chat, containing Apple-specific metadata
Mostra parametri secondari
body.section.items.text.metadata.apple.summaryText
string
Summary text for Apple Business Chat messages
body.section.items.text.metadata.apple.appClipPreview
boolean
Indicates if the message includes an App Clip link
body.section.items.text.metadata.apple.appClipRegion
string
AppClipRegion is the ISO 3166 alpha-2 country code for the App Store region.
body.section.items.type
string
obbligatorio
Possible values: image
body.section.items.image
object
obbligatorio
Mostra parametri secondari
body.section.items.image.text
string
body.section.items.image.images
array of object
obbligatorio
Mostra parametri secondari
body.section.items.image.images.mediaUrl
string
obbligatorio
body.section.items.image.images.altText
string
body.section.items.image.metadata
object
Mostra parametri secondari
body.section.items.image.metadata.subject
string
The property is specific mms file, shows the subject of the mms.
body.section.items.image.metadata.fallbackText
string
The property is specific mms file, when a mms is not supported, it will fallback to show content with the fallbackText.
body.section.items.image.metadata.storyType
string
The property is specific instagram file, shows the story type.
body.section.items.image.metadata.telegram
object
The property is specific to Telegram, indicating the markup type to be used for message formatting
Mostra parametri secondari
body.section.items.image.metadata.telegram.parseMode
string
Possible values: Markdown, MarkdownV2
body.section.items.image.actions
array of object
Mostra parametri secondari
body.section.items.image.actions.type
string
obbligatorio
Possible values: link
body.section.items.image.actions.link
object
obbligatorio
Mostra parametri secondari
body.section.items.image.actions.link.text
string
obbligatorio
body.section.items.image.actions.link.url
string
obbligatorio
body.section.items.image.actions.locationRequest
object
Mostra parametri secondari
body.section.items.image.actions.locationRequest.text
string
body.section.items.image.actions.type
string
obbligatorio
Possible values: reply
body.section.items.image.actions.reply
object
obbligatorio
Mostra parametri secondari
body.section.items.image.actions.reply.text
string
obbligatorio
body.section.items.image.actions.reply.imageUrl
string
body.section.items.image.actions.reply.metadata
object
Mostra parametri secondari
body.section.items.image.actions.reply.metadata.description
object
Sets the description in the row objects for Whatsapp list messages. Only available usage for Whatsapp platform
Mostra parametri secondari
body.section.items.image.actions.reply.metadata.description.label
string
body.section.items.image.actions.locationRequest
object
Mostra parametri secondari
body.section.items.image.actions.locationRequest.text
string
body.section.items.image.actions.type
string
obbligatorio
Possible values: locationRequest
body.section.items.image.actions.locationRequest
object
Mostra parametri secondari
body.section.items.image.actions.locationRequest.text
string
body.section.items.image.actions.type
string
obbligatorio
Possible values: buy
body.section.items.image.actions.locationRequest
object
Mostra parametri secondari
body.section.items.image.actions.locationRequest.text
string
body.section.items.image.actions.buy
object
obbligatorio
Mostra parametri secondari
body.section.items.image.actions.buy.text
string
obbligatorio
body.section.items.image.actions.buy.amountCents
integer
obbligatorio
body.section.items.image.actions.buy.currency
string
obbligatorio
body.section.items.image.actions.type
string
obbligatorio
Possible values: postback
body.section.items.image.actions.locationRequest
object
Mostra parametri secondari
body.section.items.image.actions.locationRequest.text
string
body.section.items.image.actions.postback
object
obbligatorio
Mostra parametri secondari
body.section.items.image.actions.postback.text
string
obbligatorio
body.section.items.image.actions.postback.payload
string
body.section.items.image.actions.postback.imageUrl
string
body.section.items.image.actions.postback.metadata
object
Mostra parametri secondari
body.section.items.image.actions.postback.metadata.description
object
Sets the description in the row objects for Whatsapp list messages. Only available usage for Whatsapp platform
Mostra parametri secondari
body.section.items.image.actions.postback.metadata.description.label
string
body.section.items.type
string
obbligatorio
Possible values: file
body.section.items.file
object
obbligatorio
Mostra parametri secondari
body.section.items.file.text
string
body.section.items.file.files
array of object
obbligatorio
Mostra parametri secondari
body.section.items.file.files.mediaUrl
string
obbligatorio
body.section.items.file.files.contentType
string
obbligatorio
body.section.items.file.files.filename
string
body.section.items.file.files.altText
string
body.section.items.file.files.metadata
object
Mostra parametri secondari
body.section.items.file.files.metadata.isAnimated
boolean
The property is specific the sticker file, shows that if the sticker is animated or not.
body.section.items.file.metadata
object
Mostra parametri secondari
body.section.items.file.metadata.subject
string
The property is specific mms file, shows the subject of the mms.
body.section.items.file.metadata.fallbackText
string
The property is specific mms file, when a mms is not supported, it will fallback to show content with the fallbackText.
body.section.items.file.metadata.storyType
string
The property is specific instagram file, shows the story type.
body.section.items.file.metadata.telegram
object
The property is specific to Telegram, indicating the markup type to be used for message formatting
Mostra parametri secondari
body.section.items.file.metadata.telegram.parseMode
string
Possible values: Markdown, MarkdownV2
body.section.items.file.actions
array of object
Mostra parametri secondari
body.section.items.file.actions.type
string
obbligatorio
Possible values: link
body.section.items.file.actions.link
object
obbligatorio
Mostra parametri secondari
body.section.items.file.actions.link.text
string
obbligatorio
body.section.items.file.actions.link.url
string
obbligatorio
body.section.items.file.actions.locationRequest
object
Mostra parametri secondari
body.section.items.file.actions.locationRequest.text
string
body.section.items.file.actions.type
string
obbligatorio
Possible values: reply
body.section.items.file.actions.reply
object
obbligatorio
Mostra parametri secondari
body.section.items.file.actions.reply.text
string
obbligatorio
body.section.items.file.actions.reply.imageUrl
string
body.section.items.file.actions.reply.metadata
object
Mostra parametri secondari
body.section.items.file.actions.reply.metadata.description
object
Sets the description in the row objects for Whatsapp list messages. Only available usage for Whatsapp platform
Mostra parametri secondari
body.section.items.file.actions.reply.metadata.description.label
string
body.section.items.file.actions.locationRequest
object
Mostra parametri secondari
body.section.items.file.actions.locationRequest.text
string
body.section.items.file.actions.type
string
obbligatorio
Possible values: locationRequest
body.section.items.file.actions.locationRequest
object
Mostra parametri secondari
body.section.items.file.actions.locationRequest.text
string
body.section.items.file.actions.type
string
obbligatorio
Possible values: buy
body.section.items.file.actions.locationRequest
object
Mostra parametri secondari
body.section.items.file.actions.locationRequest.text
string
body.section.items.file.actions.buy
object
obbligatorio
Mostra parametri secondari
body.section.items.file.actions.buy.text
string
obbligatorio
body.section.items.file.actions.buy.amountCents
integer
obbligatorio
body.section.items.file.actions.buy.currency
string
obbligatorio
body.section.items.file.actions.type
string
obbligatorio
Possible values: postback
body.section.items.file.actions.locationRequest
object
Mostra parametri secondari
body.section.items.file.actions.locationRequest.text
string
body.section.items.file.actions.postback
object
obbligatorio
Mostra parametri secondari
body.section.items.file.actions.postback.text
string
obbligatorio
body.section.items.file.actions.postback.payload
string
body.section.items.file.actions.postback.imageUrl
string
body.section.items.file.actions.postback.metadata
object
Mostra parametri secondari
body.section.items.file.actions.postback.metadata.description
object
Sets the description in the row objects for Whatsapp list messages. Only available usage for Whatsapp platform
Mostra parametri secondari
body.section.items.file.actions.postback.metadata.description.label
string
body.section.items.type
string
obbligatorio
Possible values: gif
body.section.items.gif
object
obbligatorio
Mostra parametri secondari
body.section.items.gif.text
string
body.section.items.gif.mediaUrl
string
obbligatorio
body.section.items.gif.altText
string
body.section.items.gif.actions
array of object
Mostra parametri secondari
body.section.items.gif.actions.type
string
obbligatorio
Possible values: link
body.section.items.gif.actions.link
object
obbligatorio
Mostra parametri secondari
body.section.items.gif.actions.link.text
string
obbligatorio
body.section.items.gif.actions.link.url
string
obbligatorio
body.section.items.gif.actions.locationRequest
object
Mostra parametri secondari
body.section.items.gif.actions.locationRequest.text
string
body.section.items.gif.actions.type
string
obbligatorio
Possible values: reply
body.section.items.gif.actions.reply
object
obbligatorio
Mostra parametri secondari
body.section.items.gif.actions.reply.text
string
obbligatorio
body.section.items.gif.actions.reply.imageUrl
string
body.section.items.gif.actions.reply.metadata
object
Mostra parametri secondari
body.section.items.gif.actions.reply.metadata.description
object
Sets the description in the row objects for Whatsapp list messages. Only available usage for Whatsapp platform
Mostra parametri secondari
body.section.items.gif.actions.reply.metadata.description.label
string
body.section.items.gif.actions.locationRequest
object
Mostra parametri secondari
body.section.items.gif.actions.locationRequest.text
string
body.section.items.gif.actions.type
string
obbligatorio
Possible values: locationRequest
body.section.items.gif.actions.locationRequest
object
Mostra parametri secondari
body.section.items.gif.actions.locationRequest.text
string
body.section.items.gif.actions.type
string
obbligatorio
Possible values: buy
body.section.items.gif.actions.locationRequest
object
Mostra parametri secondari
body.section.items.gif.actions.locationRequest.text
string
body.section.items.gif.actions.buy
object
obbligatorio
Mostra parametri secondari
body.section.items.gif.actions.buy.text
string
obbligatorio
body.section.items.gif.actions.buy.amountCents
integer
obbligatorio
body.section.items.gif.actions.buy.currency
string
obbligatorio
body.section.items.gif.actions.type
string
obbligatorio
Possible values: postback
body.section.items.gif.actions.locationRequest
object
Mostra parametri secondari
body.section.items.gif.actions.locationRequest.text
string
body.section.items.gif.actions.postback
object
obbligatorio
Mostra parametri secondari
body.section.items.gif.actions.postback.text
string
obbligatorio
body.section.items.gif.actions.postback.payload
string
body.section.items.gif.actions.postback.imageUrl
string
body.section.items.gif.actions.postback.metadata
object
Mostra parametri secondari
body.section.items.gif.actions.postback.metadata.description
object
Sets the description in the row objects for Whatsapp list messages. Only available usage for Whatsapp platform
Mostra parametri secondari
body.section.items.gif.actions.postback.metadata.description.label
string
body.section.items.gif.metadata
object
Mostra parametri secondari
body.section.items.gif.metadata.telegram
object
The property is specific to Telegram, indicating the markup type to be used for message formatting
Mostra parametri secondari
body.section.items.gif.metadata.telegram.parseMode
string
Possible values: Markdown, MarkdownV2
body.section.items.type
string
obbligatorio
Possible values: location
body.section.items.location
object
obbligatorio
Mostra parametri secondari
body.section.items.location.coordinates
object
obbligatorio
Mostra parametri secondari
body.section.items.location.coordinates.latitude
number
body.section.items.location.coordinates.longitude
number
body.section.items.location.location
object
Mostra parametri secondari
body.section.items.location.location.address
string
body.section.items.location.location.label
string
body.section.items.type
string
obbligatorio
Possible values: carousel
body.section.items.carousel
object
obbligatorio
Mostra parametri secondari
body.section.items.carousel.text
string
Optional text displayed above the carousel cards
body.section.items.carousel.items
array of object
obbligatorio
Mostra parametri secondari
body.section.items.carousel.items.title
string
body.section.items.carousel.items.mediaUrl
string
body.section.items.carousel.items.description
string
body.section.items.carousel.items.altText
string
body.section.items.carousel.items.actions
array of object
Mostra parametri secondari
body.section.items.carousel.items.actions.type
string
obbligatorio
Possible values: link
body.section.items.carousel.items.actions.link
object
obbligatorio
Mostra parametri secondari
body.section.items.carousel.items.actions.link.text
string
obbligatorio
body.section.items.carousel.items.actions.link.url
string
obbligatorio
body.section.items.carousel.items.actions.locationRequest
object
Mostra parametri secondari
body.section.items.carousel.items.actions.locationRequest.text
string
body.section.items.carousel.items.actions.type
string
obbligatorio
Possible values: reply
body.section.items.carousel.items.actions.reply
object
obbligatorio
Mostra parametri secondari
body.section.items.carousel.items.actions.reply.text
string
obbligatorio
body.section.items.carousel.items.actions.reply.imageUrl
string
body.section.items.carousel.items.actions.reply.metadata
object
Mostra parametri secondari
body.section.items.carousel.items.actions.reply.metadata.description
object
Sets the description in the row objects for Whatsapp list messages. Only available usage for Whatsapp platform
Mostra parametri secondari
body.section.items.carousel.items.actions.reply.metadata.description.label
string
body.section.items.carousel.items.actions.locationRequest
object
Mostra parametri secondari
body.section.items.carousel.items.actions.locationRequest.text
string
body.section.items.carousel.items.actions.type
string
obbligatorio
Possible values: locationRequest
body.section.items.carousel.items.actions.locationRequest
object
Mostra parametri secondari
body.section.items.carousel.items.actions.locationRequest.text
string
body.section.items.carousel.items.actions.type
string
obbligatorio
Possible values: buy
body.section.items.carousel.items.actions.locationRequest
object
Mostra parametri secondari
body.section.items.carousel.items.actions.locationRequest.text
string
body.section.items.carousel.items.actions.buy
object
obbligatorio
Mostra parametri secondari
body.section.items.carousel.items.actions.buy.text
string
obbligatorio
body.section.items.carousel.items.actions.buy.amountCents
integer
obbligatorio
body.section.items.carousel.items.actions.buy.currency
string
obbligatorio
body.section.items.carousel.items.actions.type
string
obbligatorio
Possible values: postback
body.section.items.carousel.items.actions.locationRequest
object
Mostra parametri secondari
body.section.items.carousel.items.actions.locationRequest.text
string
body.section.items.carousel.items.actions.postback
object
obbligatorio
Mostra parametri secondari
body.section.items.carousel.items.actions.postback.text
string
obbligatorio
body.section.items.carousel.items.actions.postback.payload
string
body.section.items.carousel.items.actions.postback.imageUrl
string
body.section.items.carousel.items.actions.postback.metadata
object
Mostra parametri secondari
body.section.items.carousel.items.actions.postback.metadata.description
object
Sets the description in the row objects for Whatsapp list messages. Only available usage for Whatsapp platform
Mostra parametri secondari
body.section.items.carousel.items.actions.postback.metadata.description.label
string
body.section.items.type
string
obbligatorio
Possible values: list
body.section.items.list
object
obbligatorio
Mostra parametri secondari
body.section.items.list.title
string
body.section.items.list.text
string
obbligatorio
body.section.items.list.altText
string
body.section.items.list.items
array of object
Mostra parametri secondari
body.section.items.list.items.title
string
body.section.items.list.items.mediaUrl
string
body.section.items.list.items.description
string
body.section.items.list.items.altText
string
body.section.items.list.items.actions
array of object
Mostra parametri secondari
body.section.items.list.items.actions.type
string
obbligatorio
Possible values: link
body.section.items.list.items.actions.link
object
obbligatorio
Mostra parametri secondari
body.section.items.list.items.actions.link.text
string
obbligatorio
body.section.items.list.items.actions.link.url
string
obbligatorio
body.section.items.list.items.actions.locationRequest
object
Mostra parametri secondari
body.section.items.list.items.actions.locationRequest.text
string
body.section.items.list.items.actions.type
string
obbligatorio
Possible values: reply
body.section.items.list.items.actions.reply
object
obbligatorio
Mostra parametri secondari
body.section.items.list.items.actions.reply.text
string
obbligatorio
body.section.items.list.items.actions.reply.imageUrl
string
body.section.items.list.items.actions.reply.metadata
object
Mostra parametri secondari
body.section.items.list.items.actions.reply.metadata.description
object
Sets the description in the row objects for Whatsapp list messages. Only available usage for Whatsapp platform
Mostra parametri secondari
body.section.items.list.items.actions.reply.metadata.description.label
string
body.section.items.list.items.actions.locationRequest
object
Mostra parametri secondari
body.section.items.list.items.actions.locationRequest.text
string
body.section.items.list.items.actions.type
string
obbligatorio
Possible values: locationRequest
body.section.items.list.items.actions.locationRequest
object
Mostra parametri secondari
body.section.items.list.items.actions.locationRequest.text
string
body.section.items.list.items.actions.type
string
obbligatorio
Possible values: buy
body.section.items.list.items.actions.locationRequest
object
Mostra parametri secondari
body.section.items.list.items.actions.locationRequest.text
string
body.section.items.list.items.actions.buy
object
obbligatorio
Mostra parametri secondari
body.section.items.list.items.actions.buy.text
string
obbligatorio
body.section.items.list.items.actions.buy.amountCents
integer
obbligatorio
body.section.items.list.items.actions.buy.currency
string
obbligatorio
body.section.items.list.items.actions.type
string
obbligatorio
Possible values: postback
body.section.items.list.items.actions.locationRequest
object
Mostra parametri secondari
body.section.items.list.items.actions.locationRequest.text
string
body.section.items.list.items.actions.postback
object
obbligatorio
Mostra parametri secondari
body.section.items.list.items.actions.postback.text
string
obbligatorio
body.section.items.list.items.actions.postback.payload
string
body.section.items.list.items.actions.postback.imageUrl
string
body.section.items.list.items.actions.postback.metadata
object
Mostra parametri secondari
body.section.items.list.items.actions.postback.metadata.description
object
Sets the description in the row objects for Whatsapp list messages. Only available usage for Whatsapp platform
Mostra parametri secondari
body.section.items.list.items.actions.postback.metadata.description.label
string
body.section.items.list.actions
array of object
Mostra parametri secondari
body.section.items.list.actions.type
string
obbligatorio
Possible values: link
body.section.items.list.actions.link
object
obbligatorio
Mostra parametri secondari
body.section.items.list.actions.link.text
string
obbligatorio
body.section.items.list.actions.link.url
string
obbligatorio
body.section.items.list.actions.locationRequest
object
Mostra parametri secondari
body.section.items.list.actions.locationRequest.text
string
body.section.items.list.actions.type
string
obbligatorio
Possible values: reply
body.section.items.list.actions.reply
object
obbligatorio
Mostra parametri secondari
body.section.items.list.actions.reply.text
string
obbligatorio
body.section.items.list.actions.reply.imageUrl
string
body.section.items.list.actions.reply.metadata
object
Mostra parametri secondari
body.section.items.list.actions.reply.metadata.description
object
Sets the description in the row objects for Whatsapp list messages. Only available usage for Whatsapp platform
Mostra parametri secondari
body.section.items.list.actions.reply.metadata.description.label
string
body.section.items.list.actions.locationRequest
object
Mostra parametri secondari
body.section.items.list.actions.locationRequest.text
string
body.section.items.list.actions.type
string
obbligatorio
Possible values: locationRequest
body.section.items.list.actions.locationRequest
object
Mostra parametri secondari
body.section.items.list.actions.locationRequest.text
string
body.section.items.list.actions.type
string
obbligatorio
Possible values: buy
body.section.items.list.actions.locationRequest
object
Mostra parametri secondari
body.section.items.list.actions.locationRequest.text
string
body.section.items.list.actions.buy
object
obbligatorio
Mostra parametri secondari
body.section.items.list.actions.buy.text
string
obbligatorio
body.section.items.list.actions.buy.amountCents
integer
obbligatorio
body.section.items.list.actions.buy.currency
string
obbligatorio
body.section.items.list.actions.type
string
obbligatorio
Possible values: postback
body.section.items.list.actions.locationRequest
object
Mostra parametri secondari
body.section.items.list.actions.locationRequest.text
string
body.section.items.list.actions.postback
object
obbligatorio
Mostra parametri secondari
body.section.items.list.actions.postback.text
string
obbligatorio
body.section.items.list.actions.postback.payload
string
body.section.items.list.actions.postback.imageUrl
string
body.section.items.list.actions.postback.metadata
object
Mostra parametri secondari
body.section.items.list.actions.postback.metadata.description
object
Sets the description in the row objects for Whatsapp list messages. Only available usage for Whatsapp platform
Mostra parametri secondari
body.section.items.list.actions.postback.metadata.description.label
string
body.section.items.list.metadata
object
Mostra parametri secondari
body.section.items.list.metadata.button
object
Sets a button name for whatsapp list messages. Only available usage for Whatsapp platform
Mostra parametri secondari
body.section.items.list.metadata.button.label
string
body.section.items.list.metadata.replyMessage
object
Sets the reply message to be used when a list item is picked. Used for Apple Business Chat.
Mostra parametri secondari
body.section.items.list.metadata.replyMessage.title
string
body.section.items.list.metadata.replyMessage.text
string
body.section.items.type
string
obbligatorio
Possible values: section
body.section.items.section
object
obbligatorio
Mostra parametri secondari
body.section.items.section.items
array of object
Mostra parametri secondari
body.section.items.section.items.type
string
obbligatorio
Possible values: text
body.section.items.section.items.text
object
obbligatorio
Mostra parametri secondari
body.section.items.section.items.text.text
string
obbligatorio
body.section.items.section.items.text.attachments
array of object
Mostra parametri secondari
body.section.items.section.items.text.attachments.mediaUrl
string
obbligatorio
body.section.items.section.items.text.attachments.filename
string
obbligatorio
body.section.items.section.items.text.attachments.inline
boolean
body.section.items.section.items.text.attachments.contentId
string
body.section.items.section.items.text.actions
array of object
Mostra parametri secondari
body.section.items.section.items.text.actions.type
string
obbligatorio
Possible values: link
body.section.items.section.items.text.actions.link
object
obbligatorio
Mostra parametri secondari
body.section.items.section.items.text.actions.link.text
string
obbligatorio
body.section.items.section.items.text.actions.link.url
string
obbligatorio
body.section.items.section.items.text.actions.locationRequest
object
Mostra parametri secondari
body.section.items.section.items.text.actions.locationRequest.text
string
body.section.items.section.items.text.actions.type
string
obbligatorio
Possible values: reply
body.section.items.section.items.text.actions.reply
object
obbligatorio
Mostra parametri secondari
body.section.items.section.items.text.actions.reply.text
string
obbligatorio
body.section.items.section.items.text.actions.reply.imageUrl
string
body.section.items.section.items.text.actions.reply.metadata
object
Mostra parametri secondari
body.section.items.section.items.text.actions.reply.metadata.description
object
Sets the description in the row objects for Whatsapp list messages. Only available usage for Whatsapp platform
Mostra parametri secondari
body.section.items.section.items.text.actions.reply.metadata.description.label
string
body.section.items.section.items.text.actions.locationRequest
object
Mostra parametri secondari
body.section.items.section.items.text.actions.locationRequest.text
string
body.section.items.section.items.text.actions.type
string
obbligatorio
Possible values: locationRequest
body.section.items.section.items.text.actions.locationRequest
object
Mostra parametri secondari
body.section.items.section.items.text.actions.locationRequest.text
string
body.section.items.section.items.text.actions.type
string
obbligatorio
Possible values: buy
body.section.items.section.items.text.actions.locationRequest
object
Mostra parametri secondari
body.section.items.section.items.text.actions.locationRequest.text
string
body.section.items.section.items.text.actions.buy
object
obbligatorio
Mostra parametri secondari
body.section.items.section.items.text.actions.buy.text
string
obbligatorio
body.section.items.section.items.text.actions.buy.amountCents
integer
obbligatorio
body.section.items.section.items.text.actions.buy.currency
string
obbligatorio
body.section.items.section.items.text.actions.type
string
obbligatorio
Possible values: postback
body.section.items.section.items.text.actions.locationRequest
object
Mostra parametri secondari
body.section.items.section.items.text.actions.locationRequest.text
string
body.section.items.section.items.text.actions.postback
object
obbligatorio
Mostra parametri secondari
body.section.items.section.items.text.actions.postback.text
string
obbligatorio
body.section.items.section.items.text.actions.postback.payload
string
body.section.items.section.items.text.actions.postback.imageUrl
string
body.section.items.section.items.text.actions.postback.metadata
object
Mostra parametri secondari
body.section.items.section.items.text.actions.postback.metadata.description
object
Sets the description in the row objects for Whatsapp list messages. Only available usage for Whatsapp platform
Mostra parametri secondari
body.section.items.section.items.text.actions.postback.metadata.description.label
string
body.section.items.section.items.text.metadata
object
Mostra parametri secondari
body.section.items.section.items.text.metadata.subject
string
body.section.items.section.items.text.metadata.headers
object
body.section.items.section.items.text.metadata.whatsapp
object
Mostra parametri secondari
body.section.items.section.items.text.metadata.whatsapp.previewUrl
boolean
When set to true, preview will be displayed within whatsapp chat.
body.section.items.section.items.text.metadata.whatsapp.sharedContacts
array of object
Contact cards the recipient shared, from a REQUEST_CONTACT_INFO button tap or a direct contact share.
Mostra parametri secondari
body.section.items.section.items.text.metadata.whatsapp.sharedContacts.origin
string
obbligatorio
How the contact was shared. contact_request for a REQUEST_CONTACT_INFO button tap, other for a direct share.
body.section.items.section.items.text.metadata.whatsapp.sharedContacts.vcard
string
body.section.items.section.items.text.metadata.whatsapp.sharedContacts.phones
array of object
Mostra parametri secondari
body.section.items.section.items.text.metadata.whatsapp.sharedContacts.phones.phone
string
body.section.items.section.items.text.metadata.whatsapp.sharedContacts.phones.waId
string
body.section.items.section.items.text.metadata.whatsapp.sharedContacts.phones.type
string
body.section.items.section.items.text.metadata.line
object
Mostra parametri secondari
body.section.items.section.items.text.metadata.line.emoji
object
Mostra parametri secondari
body.section.items.section.items.text.metadata.line.emoji.items
array of object
Mostra parametri secondari
body.section.items.section.items.text.metadata.line.emoji.items.index
integer
obbligatorio
body.section.items.section.items.text.metadata.line.emoji.items.productId
string
obbligatorio
body.section.items.section.items.text.metadata.line.emoji.items.emojiId
string
obbligatorio
body.section.items.section.items.text.metadata.line.emoji.items.length
integer
body.section.items.section.items.text.metadata.telegram
object
The property is specific to Telegram, indicating the markup type to be used for message formatting
Mostra parametri secondari
body.section.items.section.items.text.metadata.telegram.parseMode
string
Possible values: Markdown, MarkdownV2
body.section.items.section.items.text.metadata.apple
object
The property is specific to Apple Business Chat, containing Apple-specific metadata
Mostra parametri secondari
body.section.items.section.items.text.metadata.apple.summaryText
string
Summary text for Apple Business Chat messages
body.section.items.section.items.text.metadata.apple.appClipPreview
boolean
Indicates if the message includes an App Clip link
body.section.items.section.items.text.metadata.apple.appClipRegion
string
AppClipRegion is the ISO 3166 alpha-2 country code for the App Store region.
body.section.items.section.items.type
string
obbligatorio
Possible values: image
body.section.items.section.items.image
object
obbligatorio
Mostra parametri secondari
body.section.items.section.items.image.text
string
body.section.items.section.items.image.images
array of object
obbligatorio
Mostra parametri secondari
body.section.items.section.items.image.images.mediaUrl
string
obbligatorio
body.section.items.section.items.image.images.altText
string
body.section.items.section.items.image.metadata
object
Mostra parametri secondari
body.section.items.section.items.image.metadata.subject
string
The property is specific mms file, shows the subject of the mms.
body.section.items.section.items.image.metadata.fallbackText
string
The property is specific mms file, when a mms is not supported, it will fallback to show content with the fallbackText.
body.section.items.section.items.image.metadata.storyType
string
The property is specific instagram file, shows the story type.
body.section.items.section.items.image.metadata.telegram
object
The property is specific to Telegram, indicating the markup type to be used for message formatting
Mostra parametri secondari
body.section.items.section.items.image.metadata.telegram.parseMode
string
Possible values: Markdown, MarkdownV2
body.section.items.section.items.image.actions
array of object
Mostra parametri secondari
body.section.items.section.items.image.actions.type
string
obbligatorio
Possible values: link
body.section.items.section.items.image.actions.link
object
obbligatorio
Mostra parametri secondari
body.section.items.section.items.image.actions.link.text
string
obbligatorio
body.section.items.section.items.image.actions.link.url
string
obbligatorio
body.section.items.section.items.image.actions.locationRequest
object
Mostra parametri secondari
body.section.items.section.items.image.actions.locationRequest.text
string
body.section.items.section.items.image.actions.type
string
obbligatorio
Possible values: reply
body.section.items.section.items.image.actions.reply
object
obbligatorio
Mostra parametri secondari
body.section.items.section.items.image.actions.reply.text
string
obbligatorio
body.section.items.section.items.image.actions.reply.imageUrl
string
body.section.items.section.items.image.actions.reply.metadata
object
Mostra parametri secondari
body.section.items.section.items.image.actions.reply.metadata.description
object
Sets the description in the row objects for Whatsapp list messages. Only available usage for Whatsapp platform
Mostra parametri secondari
body.section.items.section.items.image.actions.reply.metadata.description.label
string
body.section.items.section.items.image.actions.locationRequest
object
Mostra parametri secondari
body.section.items.section.items.image.actions.locationRequest.text
string
body.section.items.section.items.image.actions.type
string
obbligatorio
Possible values: locationRequest
body.section.items.section.items.image.actions.locationRequest
object
Mostra parametri secondari
body.section.items.section.items.image.actions.locationRequest.text
string
body.section.items.section.items.image.actions.type
string
obbligatorio
Possible values: buy
body.section.items.section.items.image.actions.locationRequest
object
Mostra parametri secondari
body.section.items.section.items.image.actions.locationRequest.text
string
body.section.items.section.items.image.actions.buy
object
obbligatorio
Mostra parametri secondari
body.section.items.section.items.image.actions.buy.text
string
obbligatorio
body.section.items.section.items.image.actions.buy.amountCents
integer
obbligatorio
body.section.items.section.items.image.actions.buy.currency
string
obbligatorio
body.section.items.section.items.image.actions.type
string
obbligatorio
Possible values: postback
body.section.items.section.items.image.actions.locationRequest
object
Mostra parametri secondari
body.section.items.section.items.image.actions.locationRequest.text
string
body.section.items.section.items.image.actions.postback
object
obbligatorio
Mostra parametri secondari
body.section.items.section.items.image.actions.postback.text
string
obbligatorio
body.section.items.section.items.image.actions.postback.payload
string
body.section.items.section.items.image.actions.postback.imageUrl
string
body.section.items.section.items.image.actions.postback.metadata
object
Mostra parametri secondari
body.section.items.section.items.image.actions.postback.metadata.description
object
Sets the description in the row objects for Whatsapp list messages. Only available usage for Whatsapp platform
Mostra parametri secondari
body.section.items.section.items.image.actions.postback.metadata.description.label
string
body.section.items.section.items.type
string
obbligatorio
Possible values: file
body.section.items.section.items.file
object
obbligatorio
Mostra parametri secondari
body.section.items.section.items.file.text
string
body.section.items.section.items.file.files
array of object
obbligatorio
Mostra parametri secondari
body.section.items.section.items.file.files.mediaUrl
string
obbligatorio
body.section.items.section.items.file.files.contentType
string
obbligatorio
body.section.items.section.items.file.files.filename
string
body.section.items.section.items.file.files.altText
string
body.section.items.section.items.file.files.metadata
object
Mostra parametri secondari
body.section.items.section.items.file.files.metadata.isAnimated
boolean
The property is specific the sticker file, shows that if the sticker is animated or not.
body.section.items.section.items.file.metadata
object
Mostra parametri secondari
body.section.items.section.items.file.metadata.subject
string
The property is specific mms file, shows the subject of the mms.
body.section.items.section.items.file.metadata.fallbackText
string
The property is specific mms file, when a mms is not supported, it will fallback to show content with the fallbackText.
body.section.items.section.items.file.metadata.storyType
string
The property is specific instagram file, shows the story type.
body.section.items.section.items.file.metadata.telegram
object
The property is specific to Telegram, indicating the markup type to be used for message formatting
Mostra parametri secondari
body.section.items.section.items.file.metadata.telegram.parseMode
string
Possible values: Markdown, MarkdownV2
body.section.items.section.items.file.actions
array of object
Mostra parametri secondari
body.section.items.section.items.file.actions.type
string
obbligatorio
Possible values: link
body.section.items.section.items.file.actions.link
object
obbligatorio
Mostra parametri secondari
body.section.items.section.items.file.actions.link.text
string
obbligatorio
body.section.items.section.items.file.actions.link.url
string
obbligatorio
body.section.items.section.items.file.actions.locationRequest
object
Mostra parametri secondari
body.section.items.section.items.file.actions.locationRequest.text
string
body.section.items.section.items.file.actions.type
string
obbligatorio
Possible values: reply
body.section.items.section.items.file.actions.reply
object
obbligatorio
Mostra parametri secondari
body.section.items.section.items.file.actions.reply.text
string
obbligatorio
body.section.items.section.items.file.actions.reply.imageUrl
string
body.section.items.section.items.file.actions.reply.metadata
object
Mostra parametri secondari
body.section.items.section.items.file.actions.reply.metadata.description
object
Sets the description in the row objects for Whatsapp list messages. Only available usage for Whatsapp platform
Mostra parametri secondari
body.section.items.section.items.file.actions.reply.metadata.description.label
string
body.section.items.section.items.file.actions.locationRequest
object
Mostra parametri secondari
body.section.items.section.items.file.actions.locationRequest.text
string
body.section.items.section.items.file.actions.type
string
obbligatorio
Possible values: locationRequest
body.section.items.section.items.file.actions.locationRequest
object
Mostra parametri secondari
body.section.items.section.items.file.actions.locationRequest.text
string
body.section.items.section.items.file.actions.type
string
obbligatorio
Possible values: buy
body.section.items.section.items.file.actions.locationRequest
object
Mostra parametri secondari
body.section.items.section.items.file.actions.locationRequest.text
string
body.section.items.section.items.file.actions.buy
object
obbligatorio
Mostra parametri secondari
body.section.items.section.items.file.actions.buy.text
string
obbligatorio
body.section.items.section.items.file.actions.buy.amountCents
integer
obbligatorio
body.section.items.section.items.file.actions.buy.currency
string
obbligatorio
body.section.items.section.items.file.actions.type
string
obbligatorio
Possible values: postback
body.section.items.section.items.file.actions.locationRequest
object
Mostra parametri secondari
body.section.items.section.items.file.actions.locationRequest.text
string
body.section.items.section.items.file.actions.postback
object
obbligatorio
Mostra parametri secondari
body.section.items.section.items.file.actions.postback.text
string
obbligatorio
body.section.items.section.items.file.actions.postback.payload
string
body.section.items.section.items.file.actions.postback.imageUrl
string
body.section.items.section.items.file.actions.postback.metadata
object
Mostra parametri secondari
body.section.items.section.items.file.actions.postback.metadata.description
object
Sets the description in the row objects for Whatsapp list messages. Only available usage for Whatsapp platform
Mostra parametri secondari
body.section.items.section.items.file.actions.postback.metadata.description.label
string
body.section.items.section.items.type
string
obbligatorio
Possible values: gif
body.section.items.section.items.gif
object
obbligatorio
Mostra parametri secondari
body.section.items.section.items.gif.text
string
body.section.items.section.items.gif.mediaUrl
string
obbligatorio
body.section.items.section.items.gif.altText
string
body.section.items.section.items.gif.actions
array of object
Mostra parametri secondari
body.section.items.section.items.gif.actions.type
string
obbligatorio
Possible values: link
body.section.items.section.items.gif.actions.link
object
obbligatorio
Mostra parametri secondari
body.section.items.section.items.gif.actions.link.text
string
obbligatorio
body.section.items.section.items.gif.actions.link.url
string
obbligatorio
body.section.items.section.items.gif.actions.locationRequest
object
Mostra parametri secondari
body.section.items.section.items.gif.actions.locationRequest.text
string
body.section.items.section.items.gif.actions.type
string
obbligatorio
Possible values: reply
body.section.items.section.items.gif.actions.reply
object
obbligatorio
Mostra parametri secondari
body.section.items.section.items.gif.actions.reply.text
string
obbligatorio
body.section.items.section.items.gif.actions.reply.imageUrl
string
body.section.items.section.items.gif.actions.reply.metadata
object
Mostra parametri secondari
body.section.items.section.items.gif.actions.reply.metadata.description
object
Sets the description in the row objects for Whatsapp list messages. Only available usage for Whatsapp platform
Mostra parametri secondari
body.section.items.section.items.gif.actions.reply.metadata.description.label
string
body.section.items.section.items.gif.actions.locationRequest
object
Mostra parametri secondari
body.section.items.section.items.gif.actions.locationRequest.text
string
body.section.items.section.items.gif.actions.type
string
obbligatorio
Possible values: locationRequest
body.section.items.section.items.gif.actions.locationRequest
object
Mostra parametri secondari
body.section.items.section.items.gif.actions.locationRequest.text
string
body.section.items.section.items.gif.actions.type
string
obbligatorio
Possible values: buy
body.section.items.section.items.gif.actions.locationRequest
object
Mostra parametri secondari
body.section.items.section.items.gif.actions.locationRequest.text
string
body.section.items.section.items.gif.actions.buy
object
obbligatorio
Mostra parametri secondari
body.section.items.section.items.gif.actions.buy.text
string
obbligatorio
body.section.items.section.items.gif.actions.buy.amountCents
integer
obbligatorio
body.section.items.section.items.gif.actions.buy.currency
string
obbligatorio
body.section.items.section.items.gif.actions.type
string
obbligatorio
Possible values: postback
body.section.items.section.items.gif.actions.locationRequest
object
Mostra parametri secondari
body.section.items.section.items.gif.actions.locationRequest.text
string
body.section.items.section.items.gif.actions.postback
object
obbligatorio
Mostra parametri secondari
body.section.items.section.items.gif.actions.postback.text
string
obbligatorio
body.section.items.section.items.gif.actions.postback.payload
string
body.section.items.section.items.gif.actions.postback.imageUrl
string
body.section.items.section.items.gif.actions.postback.metadata
object
Mostra parametri secondari
body.section.items.section.items.gif.actions.postback.metadata.description
object
Sets the description in the row objects for Whatsapp list messages. Only available usage for Whatsapp platform
Mostra parametri secondari
body.section.items.section.items.gif.actions.postback.metadata.description.label
string
body.section.items.section.items.gif.metadata
object
Mostra parametri secondari
body.section.items.section.items.gif.metadata.telegram
object
The property is specific to Telegram, indicating the markup type to be used for message formatting
Mostra parametri secondari
body.section.items.section.items.gif.metadata.telegram.parseMode
string
Possible values: Markdown, MarkdownV2
body.section.items.section.items.type
string
obbligatorio
Possible values: location
body.section.items.section.items.location
object
obbligatorio
Mostra parametri secondari
body.section.items.section.items.location.coordinates
object
obbligatorio
Mostra parametri secondari
body.section.items.section.items.location.coordinates.latitude
number
body.section.items.section.items.location.coordinates.longitude
number
body.section.items.section.items.location.location
object
Mostra parametri secondari
body.section.items.section.items.location.location.address
string
body.section.items.section.items.location.location.label
string
body.section.items.section.items.type
string
obbligatorio
Possible values: carousel
body.section.items.section.items.carousel
object
obbligatorio
Mostra parametri secondari
body.section.items.section.items.carousel.text
string
Optional text displayed above the carousel cards
body.section.items.section.items.carousel.items
array of object
obbligatorio
Mostra parametri secondari
body.section.items.section.items.carousel.items.title
string
body.section.items.section.items.carousel.items.mediaUrl
string
body.section.items.section.items.carousel.items.description
string
body.section.items.section.items.carousel.items.altText
string
body.section.items.section.items.carousel.items.actions
array of object
Mostra parametri secondari
body.section.items.section.items.carousel.items.actions.type
string
obbligatorio
Possible values: link
body.section.items.section.items.carousel.items.actions.link
object
obbligatorio
Mostra parametri secondari
body.section.items.section.items.carousel.items.actions.link.text
string
obbligatorio
body.section.items.section.items.carousel.items.actions.link.url
string
obbligatorio
body.section.items.section.items.carousel.items.actions.locationRequest
object
Mostra parametri secondari
body.section.items.section.items.carousel.items.actions.locationRequest.text
string
body.section.items.section.items.carousel.items.actions.type
string
obbligatorio
Possible values: reply
body.section.items.section.items.carousel.items.actions.reply
object
obbligatorio
Mostra parametri secondari
body.section.items.section.items.carousel.items.actions.reply.text
string
obbligatorio
body.section.items.section.items.carousel.items.actions.reply.imageUrl
string
body.section.items.section.items.carousel.items.actions.reply.metadata
object
Mostra parametri secondari
body.section.items.section.items.carousel.items.actions.reply.metadata.description
object
Sets the description in the row objects for Whatsapp list messages. Only available usage for Whatsapp platform
Mostra parametri secondari
body.section.items.section.items.carousel.items.actions.reply.metadata.description.label
string
body.section.items.section.items.carousel.items.actions.locationRequest
object
Mostra parametri secondari
body.section.items.section.items.carousel.items.actions.locationRequest.text
string
body.section.items.section.items.carousel.items.actions.type
string
obbligatorio
Possible values: locationRequest
body.section.items.section.items.carousel.items.actions.locationRequest
object
Mostra parametri secondari
body.section.items.section.items.carousel.items.actions.locationRequest.text
string
body.section.items.section.items.carousel.items.actions.type
string
obbligatorio
Possible values: buy
body.section.items.section.items.carousel.items.actions.locationRequest
object
Mostra parametri secondari
body.section.items.section.items.carousel.items.actions.locationRequest.text
string
body.section.items.section.items.carousel.items.actions.buy
object
obbligatorio
Mostra parametri secondari
body.section.items.section.items.carousel.items.actions.buy.text
string
obbligatorio
body.section.items.section.items.carousel.items.actions.buy.amountCents
integer
obbligatorio
body.section.items.section.items.carousel.items.actions.buy.currency
string
obbligatorio
body.section.items.section.items.carousel.items.actions.type
string
obbligatorio
Possible values: postback
body.section.items.section.items.carousel.items.actions.locationRequest
object
Mostra parametri secondari
body.section.items.section.items.carousel.items.actions.locationRequest.text
string
body.section.items.section.items.carousel.items.actions.postback
object
obbligatorio
Mostra parametri secondari
body.section.items.section.items.carousel.items.actions.postback.text
string
obbligatorio
body.section.items.section.items.carousel.items.actions.postback.payload
string
body.section.items.section.items.carousel.items.actions.postback.imageUrl
string
body.section.items.section.items.carousel.items.actions.postback.metadata
object
Mostra parametri secondari
body.section.items.section.items.carousel.items.actions.postback.metadata.description
object
Sets the description in the row objects for Whatsapp list messages. Only available usage for Whatsapp platform
Mostra parametri secondari
body.section.items.section.items.carousel.items.actions.postback.metadata.description.label
string
body.section.items.section.items.type
string
obbligatorio
Possible values: list
body.section.items.section.items.list
object
obbligatorio
Mostra parametri secondari
body.section.items.section.items.list.title
string
body.section.items.section.items.list.text
string
obbligatorio
body.section.items.section.items.list.altText
string
body.section.items.section.items.list.items
array of object
Mostra parametri secondari
body.section.items.section.items.list.items.title
string
body.section.items.section.items.list.items.mediaUrl
string
body.section.items.section.items.list.items.description
string
body.section.items.section.items.list.items.altText
string
body.section.items.section.items.list.items.actions
array of object
Mostra parametri secondari
body.section.items.section.items.list.items.actions.type
string
obbligatorio
Possible values: link
body.section.items.section.items.list.items.actions.link
object
obbligatorio
Mostra parametri secondari
body.section.items.section.items.list.items.actions.link.text
string
obbligatorio
body.section.items.section.items.list.items.actions.link.url
string
obbligatorio
body.section.items.section.items.list.items.actions.locationRequest
object
Mostra parametri secondari
body.section.items.section.items.list.items.actions.locationRequest.text
string
body.section.items.section.items.list.items.actions.type
string
obbligatorio
Possible values: reply
body.section.items.section.items.list.items.actions.reply
object
obbligatorio
Mostra parametri secondari
body.section.items.section.items.list.items.actions.reply.text
string
obbligatorio
body.section.items.section.items.list.items.actions.reply.imageUrl
string
body.section.items.section.items.list.items.actions.reply.metadata
object
Mostra parametri secondari
body.section.items.section.items.list.items.actions.reply.metadata.description
object
Sets the description in the row objects for Whatsapp list messages. Only available usage for Whatsapp platform
Mostra parametri secondari
body.section.items.section.items.list.items.actions.reply.metadata.description.label
string
body.section.items.section.items.list.items.actions.locationRequest
object
Mostra parametri secondari
body.section.items.section.items.list.items.actions.locationRequest.text
string
body.section.items.section.items.list.items.actions.type
string
obbligatorio
Possible values: locationRequest
body.section.items.section.items.list.items.actions.locationRequest
object
Mostra parametri secondari
body.section.items.section.items.list.items.actions.locationRequest.text
string
body.section.items.section.items.list.items.actions.type
string
obbligatorio
Possible values: buy
body.section.items.section.items.list.items.actions.locationRequest
object
Mostra parametri secondari
body.section.items.section.items.list.items.actions.locationRequest.text
string
body.section.items.section.items.list.items.actions.buy
object
obbligatorio
Mostra parametri secondari
body.section.items.section.items.list.items.actions.buy.text
string
obbligatorio
body.section.items.section.items.list.items.actions.buy.amountCents
integer
obbligatorio
body.section.items.section.items.list.items.actions.buy.currency
string
obbligatorio
body.section.items.section.items.list.items.actions.type
string
obbligatorio
Possible values: postback
body.section.items.section.items.list.items.actions.locationRequest
object
Mostra parametri secondari
body.section.items.section.items.list.items.actions.locationRequest.text
string
body.section.items.section.items.list.items.actions.postback
object
obbligatorio
Mostra parametri secondari
body.section.items.section.items.list.items.actions.postback.text
string
obbligatorio
body.section.items.section.items.list.items.actions.postback.payload
string
body.section.items.section.items.list.items.actions.postback.imageUrl
string
body.section.items.section.items.list.items.actions.postback.metadata
object
Mostra parametri secondari
body.section.items.section.items.list.items.actions.postback.metadata.description
object
Sets the description in the row objects for Whatsapp list messages. Only available usage for Whatsapp platform
Mostra parametri secondari
body.section.items.section.items.list.items.actions.postback.metadata.description.label
string
body.section.items.section.items.list.actions
array of object
Mostra parametri secondari
body.section.items.section.items.list.actions.type
string
obbligatorio
Possible values: link
body.section.items.section.items.list.actions.link
object
obbligatorio
Mostra parametri secondari
body.section.items.section.items.list.actions.link.text
string
obbligatorio
body.section.items.section.items.list.actions.link.url
string
obbligatorio
body.section.items.section.items.list.actions.locationRequest
object
Mostra parametri secondari
body.section.items.section.items.list.actions.locationRequest.text
string
body.section.items.section.items.list.actions.type
string
obbligatorio
Possible values: reply
body.section.items.section.items.list.actions.reply
object
obbligatorio
Mostra parametri secondari
body.section.items.section.items.list.actions.reply.text
string
obbligatorio
body.section.items.section.items.list.actions.reply.imageUrl
string
body.section.items.section.items.list.actions.reply.metadata
object
Mostra parametri secondari
body.section.items.section.items.list.actions.reply.metadata.description
object
Sets the description in the row objects for Whatsapp list messages. Only available usage for Whatsapp platform
Mostra parametri secondari
body.section.items.section.items.list.actions.reply.metadata.description.label
string
body.section.items.section.items.list.actions.locationRequest
object
Mostra parametri secondari
body.section.items.section.items.list.actions.locationRequest.text
string
body.section.items.section.items.list.actions.type
string
obbligatorio
Possible values: locationRequest
body.section.items.section.items.list.actions.locationRequest
object
Mostra parametri secondari
body.section.items.section.items.list.actions.locationRequest.text
string
body.section.items.section.items.list.actions.type
string
obbligatorio
Possible values: buy
body.section.items.section.items.list.actions.locationRequest
object
Mostra parametri secondari
body.section.items.section.items.list.actions.locationRequest.text
string
body.section.items.section.items.list.actions.buy
object
obbligatorio
Mostra parametri secondari
body.section.items.section.items.list.actions.buy.text
string
obbligatorio
body.section.items.section.items.list.actions.buy.amountCents
integer
obbligatorio
body.section.items.section.items.list.actions.buy.currency
string
obbligatorio
body.section.items.section.items.list.actions.type
string
obbligatorio
Possible values: postback
body.section.items.section.items.list.actions.locationRequest
object
Mostra parametri secondari
body.section.items.section.items.list.actions.locationRequest.text
string
body.section.items.section.items.list.actions.postback
object
obbligatorio
Mostra parametri secondari
body.section.items.section.items.list.actions.postback.text
string
obbligatorio
body.section.items.section.items.list.actions.postback.payload
string
body.section.items.section.items.list.actions.postback.imageUrl
string
body.section.items.section.items.list.actions.postback.metadata
object
Mostra parametri secondari
body.section.items.section.items.list.actions.postback.metadata.description
object
Sets the description in the row objects for Whatsapp list messages. Only available usage for Whatsapp platform
Mostra parametri secondari
body.section.items.section.items.list.actions.postback.metadata.description.label
string
body.section.items.section.items.list.metadata
object
Mostra parametri secondari
body.section.items.section.items.list.metadata.button
object
Sets a button name for whatsapp list messages. Only available usage for Whatsapp platform
Mostra parametri secondari
body.section.items.section.items.list.metadata.button.label
string
body.section.items.section.items.list.metadata.replyMessage
object
Sets the reply message to be used when a list item is picked. Used for Apple Business Chat.
Mostra parametri secondari
body.section.items.section.items.list.metadata.replyMessage.title
string
body.section.items.section.items.list.metadata.replyMessage.text
string
body.section.items.section.configurations
object
Mostra parametri secondari
body.section.items.section.configurations.default
string
body.section.configurations
object
body.permission_request
object
Mostra parametri secondari
body.permission_request.resource
string
obbligatorio
Possible values: call
body.type
string
obbligatorio
Possible values: authentication
body.authentication
object
obbligatorio
Mostra parametri secondari
body.authentication.otp
object
Mostra parametri secondari
body.authentication.otp.disclaimer
boolean
obbligatorio
Whether to add a security disclaimer to the authentication body.
body.authentication.otp.expirationTime
integer
The number of seconds after which the authentication body will expire. If not set, no expiration notification will be sent.
body.authentication.otp.actions
array of object
Mostra parametri secondari
body.authentication.otp.actions.type
string
obbligatorio
Possible values: link
body.authentication.otp.actions.link
object
obbligatorio
Mostra parametri secondari
body.authentication.otp.actions.link.text
string
obbligatorio
body.authentication.otp.actions.link.url
string
obbligatorio
body.authentication.otp.actions.locationRequest
object
Mostra parametri secondari
body.authentication.otp.actions.locationRequest.text
string
body.authentication.otp.actions.type
string
obbligatorio
Possible values: reply
body.authentication.otp.actions.reply
object
obbligatorio
Mostra parametri secondari
body.authentication.otp.actions.reply.text
string
obbligatorio
body.authentication.otp.actions.reply.imageUrl
string
body.authentication.otp.actions.reply.metadata
object
Mostra parametri secondari
body.authentication.otp.actions.reply.metadata.description
object
Sets the description in the row objects for Whatsapp list messages. Only available usage for Whatsapp platform
Mostra parametri secondari
body.authentication.otp.actions.reply.metadata.description.label
string
body.authentication.otp.actions.locationRequest
object
Mostra parametri secondari
body.authentication.otp.actions.locationRequest.text
string
body.authentication.otp.actions.type
string
obbligatorio
Possible values: locationRequest
body.authentication.otp.actions.locationRequest
object
Mostra parametri secondari
body.authentication.otp.actions.locationRequest.text
string
body.authentication.otp.actions.type
string
obbligatorio
Possible values: buy
body.authentication.otp.actions.locationRequest
object
Mostra parametri secondari
body.authentication.otp.actions.locationRequest.text
string
body.authentication.otp.actions.buy
object
obbligatorio
Mostra parametri secondari
body.authentication.otp.actions.buy.text
string
obbligatorio
body.authentication.otp.actions.buy.amountCents
integer
obbligatorio
body.authentication.otp.actions.buy.currency
string
obbligatorio
body.authentication.otp.actions.type
string
obbligatorio
Possible values: postback
body.authentication.otp.actions.locationRequest
object
Mostra parametri secondari
body.authentication.otp.actions.locationRequest.text
string
body.authentication.otp.actions.postback
object
obbligatorio
Mostra parametri secondari
body.authentication.otp.actions.postback.text
string
obbligatorio
body.authentication.otp.actions.postback.payload
string
body.authentication.otp.actions.postback.imageUrl
string
body.authentication.otp.actions.postback.metadata
object
Mostra parametri secondari
body.authentication.otp.actions.postback.metadata.description
object
Sets the description in the row objects for Whatsapp list messages. Only available usage for Whatsapp platform
Mostra parametri secondari
body.authentication.otp.actions.postback.metadata.description.label
string
body.permission_request
object
Mostra parametri secondari
body.permission_request.resource
string
obbligatorio
Possible values: call
body.type
string
obbligatorio
Possible values: permission_request
body.permission_request
object
Mostra parametri secondari
body.permission_request.resource
string
obbligatorio
Possible values: call
notification
object
Mostra parametri secondari
notification.url
string
A custom webhook url to send events to. Note: you should have a created webhook subscription.
Refer to the Notifications API to learn how to create a webhook subscription.
capFrequency
boolean
If set to true, the frequency capping settings of the platform will be used
to either allow or reject the message to a contact. Can only be set to true
if the message is sent to a contact and .meta.extraInformation.useCase is marketing.
enableLinkTracking
boolean
If set to true and message is a test/campaign message, web tracking parameters will be appended to the links in the message.
ignoreQuietHours
boolean
If set to true, quiet hours settings will be ignored and the message will be sent as soon as possible.
ignoreGlobalHoldout
boolean
Do not check if the recipient is part of global holdout. To be used to send transactional messages.
tags
array of string
Tags to associate with the message. Tags are converted to lower case and tags
that do not exist are automatically created. You can view your created tags
in the UI. You can specify up to 10 tags per message.
shortLinks
object
SMS link shortening options. Must be included in the request for SMS channels
when enableLinkTracking is set to true. When using templates, please refer
to the template level shortLinks instead.
Mostra parametri secondari
shortLinks.domain
string
obbligatorio
The domain to use when shortening links. When set to default,
uses the default link shortening domain for the workspace.
scheduledFor
string
Scheduled time to send message at. Must be formated as RFC3339 timestamp. When
set, the message status will be scheduled until it's sent. Messages scheduled
for a time in the past or within 10 minutes of the request may be sent
immediately. Messages scheduled farther than 35 days will be rejected.
validity
integer
Validity determines for how many seconds a message is valid. If none is provided, the channel message type will be used to determine it.
A promotional, conversational or transactional channel message is valid for 36 hours (129600 seconds). A message sent from a 2FA channel is valid for 10 minutes (600 seconds).
sender
object
Mostra parametri secondari
sender.connector
object
obbligatorio
The sender of the message. For email messages, the sender is used to override the default sender username.
Mostra parametri secondari
sender.connector.identifierValue
string
obbligatorio
The identifier value of the sender.
sender.connector.annotations
object
Annotations are used to add additional information to a message.
For email messages, it can be used to specify a custom sender name.
Mostra parametri secondari
sender.connector.annotations.name
string
receiver
object
obbligatorio
Mostra parametri secondari
receiver.contacts
array of object
Mostra parametri secondari
receiver.contacts.id
string
The ID of the receiver. This is a reference to a contact.
receiver.contacts.identifierKey
string
The identifier key for finding the contact.
For WhatsApp channels with BSUID support, use whatsappbsuid to send
to a contact by their Business-Scoped User ID without needing to know
the channel's portfolio ID.
receiver.contacts.identifierValue
string
The identifier value for finding the contact.
receiver.contacts.type
string
The type of the receiver.
Possible values: cc, bcc, to
receiver.contacts.identifiers
array of object
Mostra parametri secondari
receiver.contacts.identifiers.identifierKey
string
obbligatorio
The identifier key for finding the contact.
receiver.contacts.identifiers.identifierValue
string
obbligatorio
The identifier value for finding the contact.
receiver.contacts.platformAddress
string
The value that is used to send the message to the platform.
receiver.contacts.platformAddressSelector
string
An expression that defines how we resolve the platform address (e.g. phone number or email address) from a contact.
This is an optional override for the default resolution logic (i.e. sending to the first
identifier key-value pair for the relevant platform).
reference
string
A reference to the message. This can be used to identify the message in the channel.
templates
object
obbligatorio
meta
object
Mostra parametri secondari
meta.extraInformation
object
Free-form metadata. The useCase key (marketing, otp, transactional, or conversation) classifies the message and affects handling such as routing, frequency capping, email deliverability, and the messaging type/tag used on Meta channels (Messenger, Instagram).
meta.referral
object
Mostra parametri secondari
meta.referral.source
string
meta.referral.title
string
meta.referral.text
string
meta.referral.group
string
meta.referral.metadata
object
Mostra parametri secondari
meta.referral.metadata.source_id
string
meta.referral.metadata.source_url
string
meta.referral.metadata.media_url
string
meta.referral.metadata.tracking_id
string
meta.order
object
The order object contains information about the purchase order.
Mostra parametri secondari
meta.order.products
array of object
Mostra parametri secondari
meta.order.products.externalCatalogId
string
The platform-specific catalog ID of the product.
meta.order.products.externalProductId
string
The platform-specific product ID.
meta.order.products.quantity
integer
The number of items purchased.
meta.order.products.price
object
The price of the product.
Mostra parametri secondari
meta.order.products.price.amount
integer
meta.order.products.price.exponent
integer
meta.order.products.price.currencyCode
string
meta.referredProduct
object
Referred product in an incoming message.
Mostra parametri secondari
meta.referredProduct.externalCatalogId
string
The platform-specific catalog ID of the product.
meta.referredProduct.externalProductId
string
The platform-specific product ID.
meta.email
object
Mostra parametri secondari
meta.email.subject
string
meta.email.headers
object
meta.email.from
object
Mostra parametri secondari
meta.email.from.username
string
meta.email.from.displayName
string
meta.sms
object
Mostra parametri secondari
meta.sms.smartEncoding
boolean
When enabled, attempts to transliterate Unicode characters to GSM-7 equivalents.
If the resulting text is fully GSM-7 compatible, fewer message segments may be required.
The original message body is preserved; transliteration is only applied when sending.
meta.pushNotifications
object
Mostra parametri secondari
meta.pushNotifications.gatewayTypeOverride
string
Possible values: apns, firebase, web
meta.navigatorId
string
meta.navigatorMessageId
string
meta.flow
object
Mostra parametri secondari
meta.flow.id
string
meta.flow.name
string
meta.flow.stepId
string
meta.flow.runId
string
meta.journey
object
Mostra parametri secondari
meta.journey.id
string
meta.journey.name
string
meta.journey.stepId
string
meta.journey.runId
string
meta.campaign
object
Mostra parametri secondari
meta.campaign.id
string
meta.campaign.name
string
replyTo
object
Mostra parametri secondari
replyTo.id
string
obbligatorio
The ID of the message that is being replied to.
replyTo.order
integer
The order of the message in the conversation.
replyTo.type
string
obbligatorio
Possible values: message, click, referrals
notification
object
Mostra parametri secondari
notification.url
string
A custom webhook url to send events to. Note: you should have a created webhook subscription.
Refer to the Notifications API to learn how to create a webhook subscription.
capFrequency
boolean
If set to true, the frequency capping settings of the platform will be used
to either allow or reject the message to a contact. Can only be set to true
if the message is sent to a contact and .meta.extraInformation.useCase is marketing.
enableLinkTracking
boolean
If set to true and message is a test/campaign message, web tracking parameters will be appended to the links in the message.
ignoreQuietHours
boolean
If set to true, quiet hours settings will be ignored and the message will be sent as soon as possible.
ignoreGlobalHoldout
boolean
Do not check if the recipient is part of global holdout. To be used to send transactional messages.
tags
array of string
Tags to associate with the message. Tags are converted to lower case and tags
that do not exist are automatically created. You can view your created tags
in the UI. You can specify up to 10 tags per message.
shortLinks
object
SMS link shortening options. Must be included in the request for SMS channels
when enableLinkTracking is set to true. When using templates, please refer
to the template level shortLinks instead.
Mostra parametri secondari
shortLinks.domain
string
obbligatorio
The domain to use when shortening links. When set to default,
uses the default link shortening domain for the workspace.
scheduledFor
string
Scheduled time to send message at. Must be formated as RFC3339 timestamp. When
set, the message status will be scheduled until it's sent. Messages scheduled
for a time in the past or within 10 minutes of the request may be sent
immediately. Messages scheduled farther than 35 days will be rejected.
validity
integer
Validity determines for how many seconds a message is valid. If none is provided, the channel message type will be used to determine it.
A promotional, conversational or transactional channel message is valid for 36 hours (129600 seconds). A message sent from a 2FA channel is valid for 10 minutes (600 seconds).
Payload della risposta
body
object
Mostra attributi secondari
body.text
object
obbligatorio
Mostra attributi secondari
body.text.actions
array of object
Mostra attributi secondari
body.text.actions.link
object
obbligatorio
Mostra attributi secondari
body.text.actions.link.metadata
object
Mostra attributi secondari
body.text.actions.link.metadata.description
object
Mostra attributi secondari
body.text.actions.link.metadata.description.label
string
obbligatorio
body.text.actions.link.text
string
obbligatorio
body.text.actions.link.url
string
obbligatorio
body.text.actions.type
string
obbligatorio
Possible values: link
body.text.actions.reply
object
obbligatorio
Mostra attributi secondari
body.text.actions.reply.imageUrl
string
body.text.actions.reply.metadata
object
Mostra attributi secondari
body.text.actions.reply.metadata.description
object
Mostra attributi secondari
body.text.actions.reply.metadata.description.label
string
obbligatorio
body.text.actions.reply.text
string
obbligatorio
body.text.actions.type
string
obbligatorio
Possible values: reply
body.text.actions.locationRequest
object
Mostra attributi secondari
body.text.actions.locationRequest.text
string
body.text.actions.type
string
obbligatorio
Possible values: locationRequest
body.text.actions.buy
object
obbligatorio
Mostra attributi secondari
body.text.actions.buy.amountCents
integer
obbligatorio
body.text.actions.buy.currency
string
obbligatorio
body.text.actions.buy.text
string
obbligatorio
body.text.actions.type
string
obbligatorio
Possible values: buy
body.text.actions.postback
object
obbligatorio
Mostra attributi secondari
body.text.actions.postback.handshake
object
Mostra attributi secondari
body.text.actions.postback.handshake.packageName
string
obbligatorio
body.text.actions.postback.handshake.signatureHash
string
obbligatorio
body.text.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
body.text.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
body.text.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
body.text.actions.postback.handshake.text
string
obbligatorio
body.text.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
body.text.actions.postback.imageUrl
string
body.text.actions.postback.metadata
object
Mostra attributi secondari
body.text.actions.postback.metadata.description
object
Mostra attributi secondari
body.text.actions.postback.metadata.description.label
string
obbligatorio
body.text.actions.postback.otpType
string
body.text.actions.postback.payload
string
body.text.actions.postback.text
string
obbligatorio
body.text.actions.type
string
obbligatorio
Possible values: postback
body.text.attachments
array of object
Mostra attributi secondari
body.text.attachments.content
string
body.text.attachments.contentId
string
body.text.attachments.contentType
string
body.text.attachments.filename
string
obbligatorio
body.text.attachments.inline
boolean
body.text.attachments.mediaUrl
string
obbligatorio
body.text.metadata
object
Mostra attributi secondari
body.text.metadata.apple
object
Mostra attributi secondari
body.text.metadata.apple.appClipPreview
boolean
body.text.metadata.apple.appClipRegion
string
body.text.metadata.apple.summaryText
string
body.text.metadata.headers
object
body.text.metadata.line
object
Mostra attributi secondari
body.text.metadata.line.emoji
object
Mostra attributi secondari
body.text.metadata.line.emoji.items
array of object
Mostra attributi secondari
body.text.metadata.line.emoji.items.emojiId
string
obbligatorio
body.text.metadata.line.emoji.items.index
integer
obbligatorio
body.text.metadata.line.emoji.items.length
integer
body.text.metadata.line.emoji.items.productId
string
obbligatorio
body.text.metadata.paymentDetails
object
Mostra attributi secondari
body.text.metadata.paymentDetails.amount
string
obbligatorio
body.text.metadata.paymentDetails.currency
string
obbligatorio
body.text.metadata.paymentDetails.sessionIdentifier
string
body.text.metadata.paymentDetails.state
string
obbligatorio
body.text.metadata.subject
string
body.text.metadata.telegram
object
Mostra attributi secondari
body.text.metadata.telegram.parseMode
string
body.text.metadata.whatsapp
object
Mostra attributi secondari
body.text.metadata.whatsapp.callPermissionExpiration
string
body.text.metadata.whatsapp.callPermissionResponse
string
Possible values: accept, reject
body.text.metadata.whatsapp.previewUrl
boolean
obbligatorio
body.text.metadata.whatsapp.sharedContacts
array of object
Mostra attributi secondari
body.text.metadata.whatsapp.sharedContacts.origin
string
obbligatorio
body.text.metadata.whatsapp.sharedContacts.phones
array of object
Mostra attributi secondari
body.text.metadata.whatsapp.sharedContacts.phones.phone
string
obbligatorio
body.text.metadata.whatsapp.sharedContacts.phones.type
string
obbligatorio
body.text.metadata.whatsapp.sharedContacts.phones.waId
string
obbligatorio
body.text.metadata.whatsapp.sharedContacts.vcard
string
body.text.text
string
obbligatorio
body.type
string
obbligatorio
Possible values: text
body.html
object
obbligatorio
Mostra attributi secondari
body.html.actions
array of object
Mostra attributi secondari
body.html.actions.link
object
obbligatorio
Mostra attributi secondari
body.html.actions.link.metadata
object
Mostra attributi secondari
body.html.actions.link.metadata.description
object
Mostra attributi secondari
body.html.actions.link.metadata.description.label
string
obbligatorio
body.html.actions.link.text
string
obbligatorio
body.html.actions.link.url
string
obbligatorio
body.html.actions.type
string
obbligatorio
Possible values: link
body.html.actions.reply
object
obbligatorio
Mostra attributi secondari
body.html.actions.reply.imageUrl
string
body.html.actions.reply.metadata
object
Mostra attributi secondari
body.html.actions.reply.metadata.description
object
Mostra attributi secondari
body.html.actions.reply.metadata.description.label
string
obbligatorio
body.html.actions.reply.text
string
obbligatorio
body.html.actions.type
string
obbligatorio
Possible values: reply
body.html.actions.locationRequest
object
Mostra attributi secondari
body.html.actions.locationRequest.text
string
body.html.actions.type
string
obbligatorio
Possible values: locationRequest
body.html.actions.buy
object
obbligatorio
Mostra attributi secondari
body.html.actions.buy.amountCents
integer
obbligatorio
body.html.actions.buy.currency
string
obbligatorio
body.html.actions.buy.text
string
obbligatorio
body.html.actions.type
string
obbligatorio
Possible values: buy
body.html.actions.postback
object
obbligatorio
Mostra attributi secondari
body.html.actions.postback.handshake
object
Mostra attributi secondari
body.html.actions.postback.handshake.packageName
string
obbligatorio
body.html.actions.postback.handshake.signatureHash
string
obbligatorio
body.html.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
body.html.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
body.html.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
body.html.actions.postback.handshake.text
string
obbligatorio
body.html.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
body.html.actions.postback.imageUrl
string
body.html.actions.postback.metadata
object
Mostra attributi secondari
body.html.actions.postback.metadata.description
object
Mostra attributi secondari
body.html.actions.postback.metadata.description.label
string
obbligatorio
body.html.actions.postback.otpType
string
body.html.actions.postback.payload
string
body.html.actions.postback.text
string
obbligatorio
body.html.actions.type
string
obbligatorio
Possible values: postback
body.html.attachments
array of object
Mostra attributi secondari
body.html.attachments.content
string
body.html.attachments.contentId
string
body.html.attachments.contentType
string
body.html.attachments.filename
string
obbligatorio
body.html.attachments.inline
boolean
body.html.attachments.mediaUrl
string
body.html.html
string
body.html.metadata
object
Mostra attributi secondari
body.html.metadata.clickTracking
boolean
body.html.metadata.from
object
Mostra attributi secondari
body.html.metadata.from.displayName
string
body.html.metadata.from.username
string
body.html.metadata.headers
object
body.html.metadata.initialOpenTracking
boolean
body.html.metadata.openTracking
boolean
body.html.metadata.subject
string
body.html.text
string
body.type
string
obbligatorio
Possible values: html
body.image
object
obbligatorio
Mostra attributi secondari
body.image.actions
array of object
Mostra attributi secondari
body.image.actions.link
object
obbligatorio
Mostra attributi secondari
body.image.actions.link.metadata
object
Mostra attributi secondari
body.image.actions.link.metadata.description
object
Mostra attributi secondari
body.image.actions.link.metadata.description.label
string
obbligatorio
body.image.actions.link.text
string
obbligatorio
body.image.actions.link.url
string
obbligatorio
body.image.actions.type
string
obbligatorio
Possible values: link
body.image.actions.reply
object
obbligatorio
Mostra attributi secondari
body.image.actions.reply.imageUrl
string
body.image.actions.reply.metadata
object
Mostra attributi secondari
body.image.actions.reply.metadata.description
object
Mostra attributi secondari
body.image.actions.reply.metadata.description.label
string
obbligatorio
body.image.actions.reply.text
string
obbligatorio
body.image.actions.type
string
obbligatorio
Possible values: reply
body.image.actions.locationRequest
object
Mostra attributi secondari
body.image.actions.locationRequest.text
string
body.image.actions.type
string
obbligatorio
Possible values: locationRequest
body.image.actions.buy
object
obbligatorio
Mostra attributi secondari
body.image.actions.buy.amountCents
integer
obbligatorio
body.image.actions.buy.currency
string
obbligatorio
body.image.actions.buy.text
string
obbligatorio
body.image.actions.type
string
obbligatorio
Possible values: buy
body.image.actions.postback
object
obbligatorio
Mostra attributi secondari
body.image.actions.postback.handshake
object
Mostra attributi secondari
body.image.actions.postback.handshake.packageName
string
obbligatorio
body.image.actions.postback.handshake.signatureHash
string
obbligatorio
body.image.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
body.image.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
body.image.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
body.image.actions.postback.handshake.text
string
obbligatorio
body.image.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
body.image.actions.postback.imageUrl
string
body.image.actions.postback.metadata
object
Mostra attributi secondari
body.image.actions.postback.metadata.description
object
Mostra attributi secondari
body.image.actions.postback.metadata.description.label
string
obbligatorio
body.image.actions.postback.otpType
string
body.image.actions.postback.payload
string
body.image.actions.postback.text
string
obbligatorio
body.image.actions.type
string
obbligatorio
Possible values: postback
body.image.images
array of object
obbligatorio
Mostra attributi secondari
body.image.images.altText
string
body.image.images.mediaPreviewUrl
string
body.image.images.mediaUrl
string
obbligatorio
body.image.metadata
object
Mostra attributi secondari
body.image.metadata.fallbackText
string
body.image.metadata.storyType
string
Possible values: mention, reply
body.image.metadata.subject
string
body.image.metadata.telegram
object
Mostra attributi secondari
body.image.metadata.telegram.parseMode
string
body.image.text
string
body.type
string
obbligatorio
Possible values: image
body.gif
object
obbligatorio
Mostra attributi secondari
body.gif.actions
array of object
Mostra attributi secondari
body.gif.actions.link
object
obbligatorio
Mostra attributi secondari
body.gif.actions.link.metadata
object
Mostra attributi secondari
body.gif.actions.link.metadata.description
object
Mostra attributi secondari
body.gif.actions.link.metadata.description.label
string
obbligatorio
body.gif.actions.link.text
string
obbligatorio
body.gif.actions.link.url
string
obbligatorio
body.gif.actions.type
string
obbligatorio
Possible values: link
body.gif.actions.reply
object
obbligatorio
Mostra attributi secondari
body.gif.actions.reply.imageUrl
string
body.gif.actions.reply.metadata
object
Mostra attributi secondari
body.gif.actions.reply.metadata.description
object
Mostra attributi secondari
body.gif.actions.reply.metadata.description.label
string
obbligatorio
body.gif.actions.reply.text
string
obbligatorio
body.gif.actions.type
string
obbligatorio
Possible values: reply
body.gif.actions.locationRequest
object
Mostra attributi secondari
body.gif.actions.locationRequest.text
string
body.gif.actions.type
string
obbligatorio
Possible values: locationRequest
body.gif.actions.buy
object
obbligatorio
Mostra attributi secondari
body.gif.actions.buy.amountCents
integer
obbligatorio
body.gif.actions.buy.currency
string
obbligatorio
body.gif.actions.buy.text
string
obbligatorio
body.gif.actions.type
string
obbligatorio
Possible values: buy
body.gif.actions.postback
object
obbligatorio
Mostra attributi secondari
body.gif.actions.postback.handshake
object
Mostra attributi secondari
body.gif.actions.postback.handshake.packageName
string
obbligatorio
body.gif.actions.postback.handshake.signatureHash
string
obbligatorio
body.gif.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
body.gif.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
body.gif.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
body.gif.actions.postback.handshake.text
string
obbligatorio
body.gif.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
body.gif.actions.postback.imageUrl
string
body.gif.actions.postback.metadata
object
Mostra attributi secondari
body.gif.actions.postback.metadata.description
object
Mostra attributi secondari
body.gif.actions.postback.metadata.description.label
string
obbligatorio
body.gif.actions.postback.otpType
string
body.gif.actions.postback.payload
string
body.gif.actions.postback.text
string
obbligatorio
body.gif.actions.type
string
obbligatorio
Possible values: postback
body.gif.altText
string
body.gif.mediaUrl
string
obbligatorio
body.gif.metadata
object
Mostra attributi secondari
body.gif.metadata.telegram
object
Mostra attributi secondari
body.gif.metadata.telegram.parseMode
string
body.gif.text
string
body.type
string
obbligatorio
Possible values: gif
body.file
object
obbligatorio
Mostra attributi secondari
body.file.actions
array of object
Mostra attributi secondari
body.file.actions.link
object
obbligatorio
Mostra attributi secondari
body.file.actions.link.metadata
object
Mostra attributi secondari
body.file.actions.link.metadata.description
object
Mostra attributi secondari
body.file.actions.link.metadata.description.label
string
obbligatorio
body.file.actions.link.text
string
obbligatorio
body.file.actions.link.url
string
obbligatorio
body.file.actions.type
string
obbligatorio
Possible values: link
body.file.actions.reply
object
obbligatorio
Mostra attributi secondari
body.file.actions.reply.imageUrl
string
body.file.actions.reply.metadata
object
Mostra attributi secondari
body.file.actions.reply.metadata.description
object
Mostra attributi secondari
body.file.actions.reply.metadata.description.label
string
obbligatorio
body.file.actions.reply.text
string
obbligatorio
body.file.actions.type
string
obbligatorio
Possible values: reply
body.file.actions.locationRequest
object
Mostra attributi secondari
body.file.actions.locationRequest.text
string
body.file.actions.type
string
obbligatorio
Possible values: locationRequest
body.file.actions.buy
object
obbligatorio
Mostra attributi secondari
body.file.actions.buy.amountCents
integer
obbligatorio
body.file.actions.buy.currency
string
obbligatorio
body.file.actions.buy.text
string
obbligatorio
body.file.actions.type
string
obbligatorio
Possible values: buy
body.file.actions.postback
object
obbligatorio
Mostra attributi secondari
body.file.actions.postback.handshake
object
Mostra attributi secondari
body.file.actions.postback.handshake.packageName
string
obbligatorio
body.file.actions.postback.handshake.signatureHash
string
obbligatorio
body.file.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
body.file.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
body.file.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
body.file.actions.postback.handshake.text
string
obbligatorio
body.file.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
body.file.actions.postback.imageUrl
string
body.file.actions.postback.metadata
object
Mostra attributi secondari
body.file.actions.postback.metadata.description
object
Mostra attributi secondari
body.file.actions.postback.metadata.description.label
string
obbligatorio
body.file.actions.postback.otpType
string
body.file.actions.postback.payload
string
body.file.actions.postback.text
string
obbligatorio
body.file.actions.type
string
obbligatorio
Possible values: postback
body.file.files
array of object
obbligatorio
Mostra attributi secondari
body.file.files.altText
string
body.file.files.contentType
string
obbligatorio
body.file.files.filename
string
body.file.files.mediaUrl
string
obbligatorio
body.file.files.metadata
object
Mostra attributi secondari
body.file.files.metadata.isAnimated
boolean
body.file.metadata
object
Mostra attributi secondari
body.file.metadata.fallbackText
string
body.file.metadata.storyType
string
Possible values: mention, reply
body.file.metadata.subject
string
body.file.metadata.telegram
object
Mostra attributi secondari
body.file.metadata.telegram.parseMode
string
body.file.text
string
body.type
string
obbligatorio
Possible values: file
body.location
object
obbligatorio
Mostra attributi secondari
body.location.coordinates
object
obbligatorio
Mostra attributi secondari
body.location.coordinates.latitude
number
obbligatorio
body.location.coordinates.longitude
number
obbligatorio
body.location.location
object
obbligatorio
Mostra attributi secondari
body.location.location.address
string
obbligatorio
body.location.location.label
string
obbligatorio
body.type
string
obbligatorio
Possible values: location
body.carousel
object
obbligatorio
Mostra attributi secondari
body.carousel.items
array of object
Mostra attributi secondari
body.carousel.items.actions
array of object
Mostra attributi secondari
body.carousel.items.actions.link
object
obbligatorio
Mostra attributi secondari
body.carousel.items.actions.link.metadata
object
Mostra attributi secondari
body.carousel.items.actions.link.metadata.description
object
Mostra attributi secondari
body.carousel.items.actions.link.metadata.description.label
string
obbligatorio
body.carousel.items.actions.link.text
string
obbligatorio
body.carousel.items.actions.link.url
string
obbligatorio
body.carousel.items.actions.type
string
obbligatorio
Possible values: link
body.carousel.items.actions.reply
object
obbligatorio
Mostra attributi secondari
body.carousel.items.actions.reply.imageUrl
string
body.carousel.items.actions.reply.metadata
object
Mostra attributi secondari
body.carousel.items.actions.reply.metadata.description
object
Mostra attributi secondari
body.carousel.items.actions.reply.metadata.description.label
string
obbligatorio
body.carousel.items.actions.reply.text
string
obbligatorio
body.carousel.items.actions.type
string
obbligatorio
Possible values: reply
body.carousel.items.actions.locationRequest
object
Mostra attributi secondari
body.carousel.items.actions.locationRequest.text
string
body.carousel.items.actions.type
string
obbligatorio
Possible values: locationRequest
body.carousel.items.actions.buy
object
obbligatorio
Mostra attributi secondari
body.carousel.items.actions.buy.amountCents
integer
obbligatorio
body.carousel.items.actions.buy.currency
string
obbligatorio
body.carousel.items.actions.buy.text
string
obbligatorio
body.carousel.items.actions.type
string
obbligatorio
Possible values: buy
body.carousel.items.actions.postback
object
obbligatorio
Mostra attributi secondari
body.carousel.items.actions.postback.handshake
object
Mostra attributi secondari
body.carousel.items.actions.postback.handshake.packageName
string
obbligatorio
body.carousel.items.actions.postback.handshake.signatureHash
string
obbligatorio
body.carousel.items.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
body.carousel.items.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
body.carousel.items.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
body.carousel.items.actions.postback.handshake.text
string
obbligatorio
body.carousel.items.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
body.carousel.items.actions.postback.imageUrl
string
body.carousel.items.actions.postback.metadata
object
Mostra attributi secondari
body.carousel.items.actions.postback.metadata.description
object
Mostra attributi secondari
body.carousel.items.actions.postback.metadata.description.label
string
obbligatorio
body.carousel.items.actions.postback.otpType
string
body.carousel.items.actions.postback.payload
string
body.carousel.items.actions.postback.text
string
obbligatorio
body.carousel.items.actions.type
string
obbligatorio
Possible values: postback
body.carousel.items.altText
string
body.carousel.items.description
string
body.carousel.items.mediaUrl
string
body.carousel.items.size
integer
body.carousel.items.title
string
body.carousel.text
string
Optional text displayed above the carousel cards.
body.type
string
obbligatorio
Possible values: carousel
body.list
object
obbligatorio
Mostra attributi secondari
body.list.actions
array of object
Mostra attributi secondari
body.list.actions.link
object
obbligatorio
Mostra attributi secondari
body.list.actions.link.metadata
object
Mostra attributi secondari
body.list.actions.link.metadata.description
object
Mostra attributi secondari
body.list.actions.link.metadata.description.label
string
obbligatorio
body.list.actions.link.text
string
obbligatorio
body.list.actions.link.url
string
obbligatorio
body.list.actions.type
string
obbligatorio
Possible values: link
body.list.actions.reply
object
obbligatorio
Mostra attributi secondari
body.list.actions.reply.imageUrl
string
body.list.actions.reply.metadata
object
Mostra attributi secondari
body.list.actions.reply.metadata.description
object
Mostra attributi secondari
body.list.actions.reply.metadata.description.label
string
obbligatorio
body.list.actions.reply.text
string
obbligatorio
body.list.actions.type
string
obbligatorio
Possible values: reply
body.list.actions.locationRequest
object
Mostra attributi secondari
body.list.actions.locationRequest.text
string
body.list.actions.type
string
obbligatorio
Possible values: locationRequest
body.list.actions.buy
object
obbligatorio
Mostra attributi secondari
body.list.actions.buy.amountCents
integer
obbligatorio
body.list.actions.buy.currency
string
obbligatorio
body.list.actions.buy.text
string
obbligatorio
body.list.actions.type
string
obbligatorio
Possible values: buy
body.list.actions.postback
object
obbligatorio
Mostra attributi secondari
body.list.actions.postback.handshake
object
Mostra attributi secondari
body.list.actions.postback.handshake.packageName
string
obbligatorio
body.list.actions.postback.handshake.signatureHash
string
obbligatorio
body.list.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
body.list.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
body.list.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
body.list.actions.postback.handshake.text
string
obbligatorio
body.list.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
body.list.actions.postback.imageUrl
string
body.list.actions.postback.metadata
object
Mostra attributi secondari
body.list.actions.postback.metadata.description
object
Mostra attributi secondari
body.list.actions.postback.metadata.description.label
string
obbligatorio
body.list.actions.postback.otpType
string
body.list.actions.postback.payload
string
body.list.actions.postback.text
string
obbligatorio
body.list.actions.type
string
obbligatorio
Possible values: postback
body.list.altText
string
body.list.items
array of object
Mostra attributi secondari
body.list.items.actions
array of object
Mostra attributi secondari
body.list.items.actions.link
object
obbligatorio
Mostra attributi secondari
body.list.items.actions.link.metadata
object
Mostra attributi secondari
body.list.items.actions.link.metadata.description
object
Mostra attributi secondari
body.list.items.actions.link.metadata.description.label
string
obbligatorio
body.list.items.actions.link.text
string
obbligatorio
body.list.items.actions.link.url
string
obbligatorio
body.list.items.actions.type
string
obbligatorio
Possible values: link
body.list.items.actions.reply
object
obbligatorio
Mostra attributi secondari
body.list.items.actions.reply.imageUrl
string
body.list.items.actions.reply.metadata
object
Mostra attributi secondari
body.list.items.actions.reply.metadata.description
object
Mostra attributi secondari
body.list.items.actions.reply.metadata.description.label
string
obbligatorio
body.list.items.actions.reply.text
string
obbligatorio
body.list.items.actions.type
string
obbligatorio
Possible values: reply
body.list.items.actions.locationRequest
object
Mostra attributi secondari
body.list.items.actions.locationRequest.text
string
body.list.items.actions.type
string
obbligatorio
Possible values: locationRequest
body.list.items.actions.buy
object
obbligatorio
Mostra attributi secondari
body.list.items.actions.buy.amountCents
integer
obbligatorio
body.list.items.actions.buy.currency
string
obbligatorio
body.list.items.actions.buy.text
string
obbligatorio
body.list.items.actions.type
string
obbligatorio
Possible values: buy
body.list.items.actions.postback
object
obbligatorio
Mostra attributi secondari
body.list.items.actions.postback.handshake
object
Mostra attributi secondari
body.list.items.actions.postback.handshake.packageName
string
obbligatorio
body.list.items.actions.postback.handshake.signatureHash
string
obbligatorio
body.list.items.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
body.list.items.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
body.list.items.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
body.list.items.actions.postback.handshake.text
string
obbligatorio
body.list.items.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
body.list.items.actions.postback.imageUrl
string
body.list.items.actions.postback.metadata
object
Mostra attributi secondari
body.list.items.actions.postback.metadata.description
object
Mostra attributi secondari
body.list.items.actions.postback.metadata.description.label
string
obbligatorio
body.list.items.actions.postback.otpType
string
body.list.items.actions.postback.payload
string
body.list.items.actions.postback.text
string
obbligatorio
body.list.items.actions.type
string
obbligatorio
Possible values: postback
body.list.items.altText
string
body.list.items.description
string
body.list.items.mediaUrl
string
body.list.items.size
integer
body.list.items.title
string
body.list.metadata
object
Mostra attributi secondari
body.list.metadata.button
object
Mostra attributi secondari
body.list.metadata.button.label
string
obbligatorio
body.list.metadata.replyMessage
object
Mostra attributi secondari
body.list.metadata.replyMessage.text
string
obbligatorio
body.list.metadata.replyMessage.title
string
obbligatorio
body.list.text
string
body.list.title
string
body.type
string
obbligatorio
Possible values: list
body.section
object
obbligatorio
Mostra attributi secondari
body.section.configurations
object
body.section.items
array of object
Mostra attributi secondari
body.section.items.text
object
obbligatorio
Mostra attributi secondari
body.section.items.text.actions
array of object
Mostra attributi secondari
body.section.items.text.actions.link
object
obbligatorio
Mostra attributi secondari
body.section.items.text.actions.link.metadata
object
Mostra attributi secondari
body.section.items.text.actions.link.metadata.description
object
Mostra attributi secondari
body.section.items.text.actions.link.metadata.description.label
string
obbligatorio
body.section.items.text.actions.link.text
string
obbligatorio
body.section.items.text.actions.link.url
string
obbligatorio
body.section.items.text.actions.type
string
obbligatorio
Possible values: link
body.section.items.text.actions.reply
object
obbligatorio
Mostra attributi secondari
body.section.items.text.actions.reply.imageUrl
string
body.section.items.text.actions.reply.metadata
object
Mostra attributi secondari
body.section.items.text.actions.reply.metadata.description
object
Mostra attributi secondari
body.section.items.text.actions.reply.metadata.description.label
string
obbligatorio
body.section.items.text.actions.reply.text
string
obbligatorio
body.section.items.text.actions.type
string
obbligatorio
Possible values: reply
body.section.items.text.actions.locationRequest
object
Mostra attributi secondari
body.section.items.text.actions.locationRequest.text
string
body.section.items.text.actions.type
string
obbligatorio
Possible values: locationRequest
body.section.items.text.actions.buy
object
obbligatorio
Mostra attributi secondari
body.section.items.text.actions.buy.amountCents
integer
obbligatorio
body.section.items.text.actions.buy.currency
string
obbligatorio
body.section.items.text.actions.buy.text
string
obbligatorio
body.section.items.text.actions.type
string
obbligatorio
Possible values: buy
body.section.items.text.actions.postback
object
obbligatorio
Mostra attributi secondari
body.section.items.text.actions.postback.handshake
object
Mostra attributi secondari
body.section.items.text.actions.postback.handshake.packageName
string
obbligatorio
body.section.items.text.actions.postback.handshake.signatureHash
string
obbligatorio
body.section.items.text.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
body.section.items.text.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
body.section.items.text.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
body.section.items.text.actions.postback.handshake.text
string
obbligatorio
body.section.items.text.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
body.section.items.text.actions.postback.imageUrl
string
body.section.items.text.actions.postback.metadata
object
Mostra attributi secondari
body.section.items.text.actions.postback.metadata.description
object
Mostra attributi secondari
body.section.items.text.actions.postback.metadata.description.label
string
obbligatorio
body.section.items.text.actions.postback.otpType
string
body.section.items.text.actions.postback.payload
string
body.section.items.text.actions.postback.text
string
obbligatorio
body.section.items.text.actions.type
string
obbligatorio
Possible values: postback
body.section.items.text.attachments
array of object
Mostra attributi secondari
body.section.items.text.attachments.content
string
body.section.items.text.attachments.contentId
string
body.section.items.text.attachments.contentType
string
body.section.items.text.attachments.filename
string
obbligatorio
body.section.items.text.attachments.inline
boolean
body.section.items.text.attachments.mediaUrl
string
obbligatorio
body.section.items.text.metadata
object
Mostra attributi secondari
body.section.items.text.metadata.apple
object
Mostra attributi secondari
body.section.items.text.metadata.apple.appClipPreview
boolean
body.section.items.text.metadata.apple.appClipRegion
string
body.section.items.text.metadata.apple.summaryText
string
body.section.items.text.metadata.headers
object
body.section.items.text.metadata.line
object
Mostra attributi secondari
body.section.items.text.metadata.line.emoji
object
Mostra attributi secondari
body.section.items.text.metadata.line.emoji.items
array of object
Mostra attributi secondari
body.section.items.text.metadata.line.emoji.items.emojiId
string
obbligatorio
body.section.items.text.metadata.line.emoji.items.index
integer
obbligatorio
body.section.items.text.metadata.line.emoji.items.length
integer
body.section.items.text.metadata.line.emoji.items.productId
string
obbligatorio
body.section.items.text.metadata.paymentDetails
object
Mostra attributi secondari
body.section.items.text.metadata.paymentDetails.amount
string
obbligatorio
body.section.items.text.metadata.paymentDetails.currency
string
obbligatorio
body.section.items.text.metadata.paymentDetails.sessionIdentifier
string
body.section.items.text.metadata.paymentDetails.state
string
obbligatorio
body.section.items.text.metadata.subject
string
body.section.items.text.metadata.telegram
object
Mostra attributi secondari
body.section.items.text.metadata.telegram.parseMode
string
body.section.items.text.metadata.whatsapp
object
Mostra attributi secondari
body.section.items.text.metadata.whatsapp.callPermissionExpiration
string
body.section.items.text.metadata.whatsapp.callPermissionResponse
string
Possible values: accept, reject
body.section.items.text.metadata.whatsapp.previewUrl
boolean
obbligatorio
body.section.items.text.metadata.whatsapp.sharedContacts
array of object
Mostra attributi secondari
body.section.items.text.metadata.whatsapp.sharedContacts.origin
string
obbligatorio
body.section.items.text.metadata.whatsapp.sharedContacts.phones
array of object
Mostra attributi secondari
body.section.items.text.metadata.whatsapp.sharedContacts.phones.phone
string
obbligatorio
body.section.items.text.metadata.whatsapp.sharedContacts.phones.type
string
obbligatorio
body.section.items.text.metadata.whatsapp.sharedContacts.phones.waId
string
obbligatorio
body.section.items.text.metadata.whatsapp.sharedContacts.vcard
string
body.section.items.text.text
string
obbligatorio
body.section.items.type
string
obbligatorio
Possible values: text
body.section.items.html
object
obbligatorio
Mostra attributi secondari
body.section.items.html.actions
array of object
Mostra attributi secondari
body.section.items.html.actions.link
object
obbligatorio
Mostra attributi secondari
body.section.items.html.actions.link.metadata
object
Mostra attributi secondari
body.section.items.html.actions.link.metadata.description
object
Mostra attributi secondari
body.section.items.html.actions.link.metadata.description.label
string
obbligatorio
body.section.items.html.actions.link.text
string
obbligatorio
body.section.items.html.actions.link.url
string
obbligatorio
body.section.items.html.actions.type
string
obbligatorio
Possible values: link
body.section.items.html.actions.reply
object
obbligatorio
Mostra attributi secondari
body.section.items.html.actions.reply.imageUrl
string
body.section.items.html.actions.reply.metadata
object
Mostra attributi secondari
body.section.items.html.actions.reply.metadata.description
object
Mostra attributi secondari
body.section.items.html.actions.reply.metadata.description.label
string
obbligatorio
body.section.items.html.actions.reply.text
string
obbligatorio
body.section.items.html.actions.type
string
obbligatorio
Possible values: reply
body.section.items.html.actions.locationRequest
object
Mostra attributi secondari
body.section.items.html.actions.locationRequest.text
string
body.section.items.html.actions.type
string
obbligatorio
Possible values: locationRequest
body.section.items.html.actions.buy
object
obbligatorio
Mostra attributi secondari
body.section.items.html.actions.buy.amountCents
integer
obbligatorio
body.section.items.html.actions.buy.currency
string
obbligatorio
body.section.items.html.actions.buy.text
string
obbligatorio
body.section.items.html.actions.type
string
obbligatorio
Possible values: buy
body.section.items.html.actions.postback
object
obbligatorio
Mostra attributi secondari
body.section.items.html.actions.postback.handshake
object
Mostra attributi secondari
body.section.items.html.actions.postback.handshake.packageName
string
obbligatorio
body.section.items.html.actions.postback.handshake.signatureHash
string
obbligatorio
body.section.items.html.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
body.section.items.html.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
body.section.items.html.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
body.section.items.html.actions.postback.handshake.text
string
obbligatorio
body.section.items.html.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
body.section.items.html.actions.postback.imageUrl
string
body.section.items.html.actions.postback.metadata
object
Mostra attributi secondari
body.section.items.html.actions.postback.metadata.description
object
Mostra attributi secondari
body.section.items.html.actions.postback.metadata.description.label
string
obbligatorio
body.section.items.html.actions.postback.otpType
string
body.section.items.html.actions.postback.payload
string
body.section.items.html.actions.postback.text
string
obbligatorio
body.section.items.html.actions.type
string
obbligatorio
Possible values: postback
body.section.items.html.attachments
array of object
Mostra attributi secondari
body.section.items.html.attachments.content
string
body.section.items.html.attachments.contentId
string
body.section.items.html.attachments.contentType
string
body.section.items.html.attachments.filename
string
obbligatorio
body.section.items.html.attachments.inline
boolean
body.section.items.html.attachments.mediaUrl
string
body.section.items.html.html
string
body.section.items.html.metadata
object
Mostra attributi secondari
body.section.items.html.metadata.clickTracking
boolean
body.section.items.html.metadata.from
object
Mostra attributi secondari
body.section.items.html.metadata.from.displayName
string
body.section.items.html.metadata.from.username
string
body.section.items.html.metadata.headers
object
body.section.items.html.metadata.initialOpenTracking
boolean
body.section.items.html.metadata.openTracking
boolean
body.section.items.html.metadata.subject
string
body.section.items.html.text
string
body.section.items.type
string
obbligatorio
Possible values: html
body.section.items.image
object
obbligatorio
Mostra attributi secondari
body.section.items.image.actions
array of object
Mostra attributi secondari
body.section.items.image.actions.link
object
obbligatorio
Mostra attributi secondari
body.section.items.image.actions.link.metadata
object
Mostra attributi secondari
body.section.items.image.actions.link.metadata.description
object
Mostra attributi secondari
body.section.items.image.actions.link.metadata.description.label
string
obbligatorio
body.section.items.image.actions.link.text
string
obbligatorio
body.section.items.image.actions.link.url
string
obbligatorio
body.section.items.image.actions.type
string
obbligatorio
Possible values: link
body.section.items.image.actions.reply
object
obbligatorio
Mostra attributi secondari
body.section.items.image.actions.reply.imageUrl
string
body.section.items.image.actions.reply.metadata
object
Mostra attributi secondari
body.section.items.image.actions.reply.metadata.description
object
Mostra attributi secondari
body.section.items.image.actions.reply.metadata.description.label
string
obbligatorio
body.section.items.image.actions.reply.text
string
obbligatorio
body.section.items.image.actions.type
string
obbligatorio
Possible values: reply
body.section.items.image.actions.locationRequest
object
Mostra attributi secondari
body.section.items.image.actions.locationRequest.text
string
body.section.items.image.actions.type
string
obbligatorio
Possible values: locationRequest
body.section.items.image.actions.buy
object
obbligatorio
Mostra attributi secondari
body.section.items.image.actions.buy.amountCents
integer
obbligatorio
body.section.items.image.actions.buy.currency
string
obbligatorio
body.section.items.image.actions.buy.text
string
obbligatorio
body.section.items.image.actions.type
string
obbligatorio
Possible values: buy
body.section.items.image.actions.postback
object
obbligatorio
Mostra attributi secondari
body.section.items.image.actions.postback.handshake
object
Mostra attributi secondari
body.section.items.image.actions.postback.handshake.packageName
string
obbligatorio
body.section.items.image.actions.postback.handshake.signatureHash
string
obbligatorio
body.section.items.image.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
body.section.items.image.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
body.section.items.image.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
body.section.items.image.actions.postback.handshake.text
string
obbligatorio
body.section.items.image.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
body.section.items.image.actions.postback.imageUrl
string
body.section.items.image.actions.postback.metadata
object
Mostra attributi secondari
body.section.items.image.actions.postback.metadata.description
object
Mostra attributi secondari
body.section.items.image.actions.postback.metadata.description.label
string
obbligatorio
body.section.items.image.actions.postback.otpType
string
body.section.items.image.actions.postback.payload
string
body.section.items.image.actions.postback.text
string
obbligatorio
body.section.items.image.actions.type
string
obbligatorio
Possible values: postback
body.section.items.image.images
array of object
obbligatorio
Mostra attributi secondari
body.section.items.image.images.altText
string
body.section.items.image.images.mediaPreviewUrl
string
body.section.items.image.images.mediaUrl
string
obbligatorio
body.section.items.image.metadata
object
Mostra attributi secondari
body.section.items.image.metadata.fallbackText
string
body.section.items.image.metadata.storyType
string
Possible values: mention, reply
body.section.items.image.metadata.subject
string
body.section.items.image.metadata.telegram
object
Mostra attributi secondari
body.section.items.image.metadata.telegram.parseMode
string
body.section.items.image.text
string
body.section.items.type
string
obbligatorio
Possible values: image
body.section.items.gif
object
obbligatorio
Mostra attributi secondari
body.section.items.gif.actions
array of object
Mostra attributi secondari
body.section.items.gif.actions.link
object
obbligatorio
Mostra attributi secondari
body.section.items.gif.actions.link.metadata
object
Mostra attributi secondari
body.section.items.gif.actions.link.metadata.description
object
Mostra attributi secondari
body.section.items.gif.actions.link.metadata.description.label
string
obbligatorio
body.section.items.gif.actions.link.text
string
obbligatorio
body.section.items.gif.actions.link.url
string
obbligatorio
body.section.items.gif.actions.type
string
obbligatorio
Possible values: link
body.section.items.gif.actions.reply
object
obbligatorio
Mostra attributi secondari
body.section.items.gif.actions.reply.imageUrl
string
body.section.items.gif.actions.reply.metadata
object
Mostra attributi secondari
body.section.items.gif.actions.reply.metadata.description
object
Mostra attributi secondari
body.section.items.gif.actions.reply.metadata.description.label
string
obbligatorio
body.section.items.gif.actions.reply.text
string
obbligatorio
body.section.items.gif.actions.type
string
obbligatorio
Possible values: reply
body.section.items.gif.actions.locationRequest
object
Mostra attributi secondari
body.section.items.gif.actions.locationRequest.text
string
body.section.items.gif.actions.type
string
obbligatorio
Possible values: locationRequest
body.section.items.gif.actions.buy
object
obbligatorio
Mostra attributi secondari
body.section.items.gif.actions.buy.amountCents
integer
obbligatorio
body.section.items.gif.actions.buy.currency
string
obbligatorio
body.section.items.gif.actions.buy.text
string
obbligatorio
body.section.items.gif.actions.type
string
obbligatorio
Possible values: buy
body.section.items.gif.actions.postback
object
obbligatorio
Mostra attributi secondari
body.section.items.gif.actions.postback.handshake
object
Mostra attributi secondari
body.section.items.gif.actions.postback.handshake.packageName
string
obbligatorio
body.section.items.gif.actions.postback.handshake.signatureHash
string
obbligatorio
body.section.items.gif.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
body.section.items.gif.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
body.section.items.gif.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
body.section.items.gif.actions.postback.handshake.text
string
obbligatorio
body.section.items.gif.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
body.section.items.gif.actions.postback.imageUrl
string
body.section.items.gif.actions.postback.metadata
object
Mostra attributi secondari
body.section.items.gif.actions.postback.metadata.description
object
Mostra attributi secondari
body.section.items.gif.actions.postback.metadata.description.label
string
obbligatorio
body.section.items.gif.actions.postback.otpType
string
body.section.items.gif.actions.postback.payload
string
body.section.items.gif.actions.postback.text
string
obbligatorio
body.section.items.gif.actions.type
string
obbligatorio
Possible values: postback
body.section.items.gif.altText
string
body.section.items.gif.mediaUrl
string
obbligatorio
body.section.items.gif.metadata
object
Mostra attributi secondari
body.section.items.gif.metadata.telegram
object
Mostra attributi secondari
body.section.items.gif.metadata.telegram.parseMode
string
body.section.items.gif.text
string
body.section.items.type
string
obbligatorio
Possible values: gif
body.section.items.file
object
obbligatorio
Mostra attributi secondari
body.section.items.file.actions
array of object
Mostra attributi secondari
body.section.items.file.actions.link
object
obbligatorio
Mostra attributi secondari
body.section.items.file.actions.link.metadata
object
Mostra attributi secondari
body.section.items.file.actions.link.metadata.description
object
Mostra attributi secondari
body.section.items.file.actions.link.metadata.description.label
string
obbligatorio
body.section.items.file.actions.link.text
string
obbligatorio
body.section.items.file.actions.link.url
string
obbligatorio
body.section.items.file.actions.type
string
obbligatorio
Possible values: link
body.section.items.file.actions.reply
object
obbligatorio
Mostra attributi secondari
body.section.items.file.actions.reply.imageUrl
string
body.section.items.file.actions.reply.metadata
object
Mostra attributi secondari
body.section.items.file.actions.reply.metadata.description
object
Mostra attributi secondari
body.section.items.file.actions.reply.metadata.description.label
string
obbligatorio
body.section.items.file.actions.reply.text
string
obbligatorio
body.section.items.file.actions.type
string
obbligatorio
Possible values: reply
body.section.items.file.actions.locationRequest
object
Mostra attributi secondari
body.section.items.file.actions.locationRequest.text
string
body.section.items.file.actions.type
string
obbligatorio
Possible values: locationRequest
body.section.items.file.actions.buy
object
obbligatorio
Mostra attributi secondari
body.section.items.file.actions.buy.amountCents
integer
obbligatorio
body.section.items.file.actions.buy.currency
string
obbligatorio
body.section.items.file.actions.buy.text
string
obbligatorio
body.section.items.file.actions.type
string
obbligatorio
Possible values: buy
body.section.items.file.actions.postback
object
obbligatorio
Mostra attributi secondari
body.section.items.file.actions.postback.handshake
object
Mostra attributi secondari
body.section.items.file.actions.postback.handshake.packageName
string
obbligatorio
body.section.items.file.actions.postback.handshake.signatureHash
string
obbligatorio
body.section.items.file.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
body.section.items.file.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
body.section.items.file.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
body.section.items.file.actions.postback.handshake.text
string
obbligatorio
body.section.items.file.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
body.section.items.file.actions.postback.imageUrl
string
body.section.items.file.actions.postback.metadata
object
Mostra attributi secondari
body.section.items.file.actions.postback.metadata.description
object
Mostra attributi secondari
body.section.items.file.actions.postback.metadata.description.label
string
obbligatorio
body.section.items.file.actions.postback.otpType
string
body.section.items.file.actions.postback.payload
string
body.section.items.file.actions.postback.text
string
obbligatorio
body.section.items.file.actions.type
string
obbligatorio
Possible values: postback
body.section.items.file.files
array of object
obbligatorio
Mostra attributi secondari
body.section.items.file.files.altText
string
body.section.items.file.files.contentType
string
obbligatorio
body.section.items.file.files.filename
string
body.section.items.file.files.mediaUrl
string
obbligatorio
body.section.items.file.files.metadata
object
Mostra attributi secondari
body.section.items.file.files.metadata.isAnimated
boolean
body.section.items.file.metadata
object
Mostra attributi secondari
body.section.items.file.metadata.fallbackText
string
body.section.items.file.metadata.storyType
string
Possible values: mention, reply
body.section.items.file.metadata.subject
string
body.section.items.file.metadata.telegram
object
Mostra attributi secondari
body.section.items.file.metadata.telegram.parseMode
string
body.section.items.file.text
string
body.section.items.type
string
obbligatorio
Possible values: file
body.section.items.location
object
obbligatorio
Mostra attributi secondari
body.section.items.location.coordinates
object
obbligatorio
Mostra attributi secondari
body.section.items.location.coordinates.latitude
number
obbligatorio
body.section.items.location.coordinates.longitude
number
obbligatorio
body.section.items.location.location
object
obbligatorio
Mostra attributi secondari
body.section.items.location.location.address
string
obbligatorio
body.section.items.location.location.label
string
obbligatorio
body.section.items.type
string
obbligatorio
Possible values: location
body.section.items.carousel
object
obbligatorio
Mostra attributi secondari
body.section.items.carousel.items
array of object
Mostra attributi secondari
body.section.items.carousel.items.actions
array of object
Mostra attributi secondari
body.section.items.carousel.items.actions.link
object
obbligatorio
Mostra attributi secondari
body.section.items.carousel.items.actions.link.metadata
object
Mostra attributi secondari
body.section.items.carousel.items.actions.link.metadata.description
object
Mostra attributi secondari
body.section.items.carousel.items.actions.link.metadata.description.label
string
obbligatorio
body.section.items.carousel.items.actions.link.text
string
obbligatorio
body.section.items.carousel.items.actions.link.url
string
obbligatorio
body.section.items.carousel.items.actions.type
string
obbligatorio
Possible values: link
body.section.items.carousel.items.actions.reply
object
obbligatorio
Mostra attributi secondari
body.section.items.carousel.items.actions.reply.imageUrl
string
body.section.items.carousel.items.actions.reply.metadata
object
Mostra attributi secondari
body.section.items.carousel.items.actions.reply.metadata.description
object
Mostra attributi secondari
body.section.items.carousel.items.actions.reply.metadata.description.label
string
obbligatorio
body.section.items.carousel.items.actions.reply.text
string
obbligatorio
body.section.items.carousel.items.actions.type
string
obbligatorio
Possible values: reply
body.section.items.carousel.items.actions.locationRequest
object
Mostra attributi secondari
body.section.items.carousel.items.actions.locationRequest.text
string
body.section.items.carousel.items.actions.type
string
obbligatorio
Possible values: locationRequest
body.section.items.carousel.items.actions.buy
object
obbligatorio
Mostra attributi secondari
body.section.items.carousel.items.actions.buy.amountCents
integer
obbligatorio
body.section.items.carousel.items.actions.buy.currency
string
obbligatorio
body.section.items.carousel.items.actions.buy.text
string
obbligatorio
body.section.items.carousel.items.actions.type
string
obbligatorio
Possible values: buy
body.section.items.carousel.items.actions.postback
object
obbligatorio
Mostra attributi secondari
body.section.items.carousel.items.actions.postback.handshake
object
Mostra attributi secondari
body.section.items.carousel.items.actions.postback.handshake.packageName
string
obbligatorio
body.section.items.carousel.items.actions.postback.handshake.signatureHash
string
obbligatorio
body.section.items.carousel.items.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
body.section.items.carousel.items.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
body.section.items.carousel.items.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
body.section.items.carousel.items.actions.postback.handshake.text
string
obbligatorio
body.section.items.carousel.items.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
body.section.items.carousel.items.actions.postback.imageUrl
string
body.section.items.carousel.items.actions.postback.metadata
object
Mostra attributi secondari
body.section.items.carousel.items.actions.postback.metadata.description
object
Mostra attributi secondari
body.section.items.carousel.items.actions.postback.metadata.description.label
string
obbligatorio
body.section.items.carousel.items.actions.postback.otpType
string
body.section.items.carousel.items.actions.postback.payload
string
body.section.items.carousel.items.actions.postback.text
string
obbligatorio
body.section.items.carousel.items.actions.type
string
obbligatorio
Possible values: postback
body.section.items.carousel.items.altText
string
body.section.items.carousel.items.description
string
body.section.items.carousel.items.mediaUrl
string
body.section.items.carousel.items.size
integer
body.section.items.carousel.items.title
string
body.section.items.carousel.text
string
Optional text displayed above the carousel cards.
body.section.items.type
string
obbligatorio
Possible values: carousel
body.section.items.list
object
obbligatorio
Mostra attributi secondari
body.section.items.list.actions
array of object
Mostra attributi secondari
body.section.items.list.actions.link
object
obbligatorio
Mostra attributi secondari
body.section.items.list.actions.link.metadata
object
Mostra attributi secondari
body.section.items.list.actions.link.metadata.description
object
Mostra attributi secondari
body.section.items.list.actions.link.metadata.description.label
string
obbligatorio
body.section.items.list.actions.link.text
string
obbligatorio
body.section.items.list.actions.link.url
string
obbligatorio
body.section.items.list.actions.type
string
obbligatorio
Possible values: link
body.section.items.list.actions.reply
object
obbligatorio
Mostra attributi secondari
body.section.items.list.actions.reply.imageUrl
string
body.section.items.list.actions.reply.metadata
object
Mostra attributi secondari
body.section.items.list.actions.reply.metadata.description
object
Mostra attributi secondari
body.section.items.list.actions.reply.metadata.description.label
string
obbligatorio
body.section.items.list.actions.reply.text
string
obbligatorio
body.section.items.list.actions.type
string
obbligatorio
Possible values: reply
body.section.items.list.actions.locationRequest
object
Mostra attributi secondari
body.section.items.list.actions.locationRequest.text
string
body.section.items.list.actions.type
string
obbligatorio
Possible values: locationRequest
body.section.items.list.actions.buy
object
obbligatorio
Mostra attributi secondari
body.section.items.list.actions.buy.amountCents
integer
obbligatorio
body.section.items.list.actions.buy.currency
string
obbligatorio
body.section.items.list.actions.buy.text
string
obbligatorio
body.section.items.list.actions.type
string
obbligatorio
Possible values: buy
body.section.items.list.actions.postback
object
obbligatorio
Mostra attributi secondari
body.section.items.list.actions.postback.handshake
object
Mostra attributi secondari
body.section.items.list.actions.postback.handshake.packageName
string
obbligatorio
body.section.items.list.actions.postback.handshake.signatureHash
string
obbligatorio
body.section.items.list.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
body.section.items.list.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
body.section.items.list.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
body.section.items.list.actions.postback.handshake.text
string
obbligatorio
body.section.items.list.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
body.section.items.list.actions.postback.imageUrl
string
body.section.items.list.actions.postback.metadata
object
Mostra attributi secondari
body.section.items.list.actions.postback.metadata.description
object
Mostra attributi secondari
body.section.items.list.actions.postback.metadata.description.label
string
obbligatorio
body.section.items.list.actions.postback.otpType
string
body.section.items.list.actions.postback.payload
string
body.section.items.list.actions.postback.text
string
obbligatorio
body.section.items.list.actions.type
string
obbligatorio
Possible values: postback
body.section.items.list.altText
string
body.section.items.list.items
array of object
Mostra attributi secondari
body.section.items.list.items.actions
array of object
Mostra attributi secondari
body.section.items.list.items.actions.link
object
obbligatorio
Mostra attributi secondari
body.section.items.list.items.actions.link.metadata
object
Mostra attributi secondari
body.section.items.list.items.actions.link.metadata.description
object
Mostra attributi secondari
body.section.items.list.items.actions.link.metadata.description.label
string
obbligatorio
body.section.items.list.items.actions.link.text
string
obbligatorio
body.section.items.list.items.actions.link.url
string
obbligatorio
body.section.items.list.items.actions.type
string
obbligatorio
Possible values: link
body.section.items.list.items.actions.reply
object
obbligatorio
Mostra attributi secondari
body.section.items.list.items.actions.reply.imageUrl
string
body.section.items.list.items.actions.reply.metadata
object
Mostra attributi secondari
body.section.items.list.items.actions.reply.metadata.description
object
Mostra attributi secondari
body.section.items.list.items.actions.reply.metadata.description.label
string
obbligatorio
body.section.items.list.items.actions.reply.text
string
obbligatorio
body.section.items.list.items.actions.type
string
obbligatorio
Possible values: reply
body.section.items.list.items.actions.locationRequest
object
Mostra attributi secondari
body.section.items.list.items.actions.locationRequest.text
string
body.section.items.list.items.actions.type
string
obbligatorio
Possible values: locationRequest
body.section.items.list.items.actions.buy
object
obbligatorio
Mostra attributi secondari
body.section.items.list.items.actions.buy.amountCents
integer
obbligatorio
body.section.items.list.items.actions.buy.currency
string
obbligatorio
body.section.items.list.items.actions.buy.text
string
obbligatorio
body.section.items.list.items.actions.type
string
obbligatorio
Possible values: buy
body.section.items.list.items.actions.postback
object
obbligatorio
Mostra attributi secondari
body.section.items.list.items.actions.postback.handshake
object
Mostra attributi secondari
body.section.items.list.items.actions.postback.handshake.packageName
string
obbligatorio
body.section.items.list.items.actions.postback.handshake.signatureHash
string
obbligatorio
body.section.items.list.items.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
body.section.items.list.items.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
body.section.items.list.items.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
body.section.items.list.items.actions.postback.handshake.text
string
obbligatorio
body.section.items.list.items.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
body.section.items.list.items.actions.postback.imageUrl
string
body.section.items.list.items.actions.postback.metadata
object
Mostra attributi secondari
body.section.items.list.items.actions.postback.metadata.description
object
Mostra attributi secondari
body.section.items.list.items.actions.postback.metadata.description.label
string
obbligatorio
body.section.items.list.items.actions.postback.otpType
string
body.section.items.list.items.actions.postback.payload
string
body.section.items.list.items.actions.postback.text
string
obbligatorio
body.section.items.list.items.actions.type
string
obbligatorio
Possible values: postback
body.section.items.list.items.altText
string
body.section.items.list.items.description
string
body.section.items.list.items.mediaUrl
string
body.section.items.list.items.size
integer
body.section.items.list.items.title
string
body.section.items.list.metadata
object
Mostra attributi secondari
body.section.items.list.metadata.button
object
Mostra attributi secondari
body.section.items.list.metadata.button.label
string
obbligatorio
body.section.items.list.metadata.replyMessage
object
Mostra attributi secondari
body.section.items.list.metadata.replyMessage.text
string
obbligatorio
body.section.items.list.metadata.replyMessage.title
string
obbligatorio
body.section.items.list.text
string
body.section.items.list.title
string
body.section.items.type
string
obbligatorio
Possible values: list
body.section.items.section
object
obbligatorio
body.section.items.type
string
obbligatorio
Possible values: section
body.section.items.authentication
object
obbligatorio
Mostra attributi secondari
body.section.items.authentication.otp
object
Mostra attributi secondari
body.section.items.authentication.otp.actions
array of object
Mostra attributi secondari
body.section.items.authentication.otp.actions.link
object
obbligatorio
Mostra attributi secondari
body.section.items.authentication.otp.actions.link.metadata
object
Mostra attributi secondari
body.section.items.authentication.otp.actions.link.metadata.description
object
Mostra attributi secondari
body.section.items.authentication.otp.actions.link.metadata.description.label
string
obbligatorio
body.section.items.authentication.otp.actions.link.text
string
obbligatorio
body.section.items.authentication.otp.actions.link.url
string
obbligatorio
body.section.items.authentication.otp.actions.type
string
obbligatorio
Possible values: link
body.section.items.authentication.otp.actions.reply
object
obbligatorio
Mostra attributi secondari
body.section.items.authentication.otp.actions.reply.imageUrl
string
body.section.items.authentication.otp.actions.reply.metadata
object
Mostra attributi secondari
body.section.items.authentication.otp.actions.reply.metadata.description
object
Mostra attributi secondari
body.section.items.authentication.otp.actions.reply.metadata.description.label
string
obbligatorio
body.section.items.authentication.otp.actions.reply.text
string
obbligatorio
body.section.items.authentication.otp.actions.type
string
obbligatorio
Possible values: reply
body.section.items.authentication.otp.actions.locationRequest
object
Mostra attributi secondari
body.section.items.authentication.otp.actions.locationRequest.text
string
body.section.items.authentication.otp.actions.type
string
obbligatorio
Possible values: locationRequest
body.section.items.authentication.otp.actions.buy
object
obbligatorio
Mostra attributi secondari
body.section.items.authentication.otp.actions.buy.amountCents
integer
obbligatorio
body.section.items.authentication.otp.actions.buy.currency
string
obbligatorio
body.section.items.authentication.otp.actions.buy.text
string
obbligatorio
body.section.items.authentication.otp.actions.type
string
obbligatorio
Possible values: buy
body.section.items.authentication.otp.actions.postback
object
obbligatorio
Mostra attributi secondari
body.section.items.authentication.otp.actions.postback.handshake
object
Mostra attributi secondari
body.section.items.authentication.otp.actions.postback.handshake.packageName
string
obbligatorio
body.section.items.authentication.otp.actions.postback.handshake.signatureHash
string
obbligatorio
body.section.items.authentication.otp.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
body.section.items.authentication.otp.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
body.section.items.authentication.otp.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
body.section.items.authentication.otp.actions.postback.handshake.text
string
obbligatorio
body.section.items.authentication.otp.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
body.section.items.authentication.otp.actions.postback.imageUrl
string
body.section.items.authentication.otp.actions.postback.metadata
object
Mostra attributi secondari
body.section.items.authentication.otp.actions.postback.metadata.description
object
Mostra attributi secondari
body.section.items.authentication.otp.actions.postback.metadata.description.label
string
obbligatorio
body.section.items.authentication.otp.actions.postback.otpType
string
body.section.items.authentication.otp.actions.postback.payload
string
body.section.items.authentication.otp.actions.postback.text
string
obbligatorio
body.section.items.authentication.otp.actions.type
string
obbligatorio
Possible values: postback
body.section.items.authentication.otp.disclaimer
boolean
obbligatorio
Whether to add a security disclaimer to the authentication body.
body.section.items.authentication.otp.expirationTime
integer
The number of seconds after which the authentication code expires. If not set, no expiration notification is sent.
body.section.items.type
string
obbligatorio
Possible values: authentication
body.section.items.action
object
obbligatorio
Mostra attributi secondari
body.section.items.action.action
string
obbligatorio
Possible values: permissionRequest
body.section.items.action.permissionRequest
object
obbligatorio
Mostra attributi secondari
body.section.items.action.permissionRequest.resource
string
obbligatorio
Possible values: call
body.section.items.type
string
obbligatorio
Possible values: action
body.type
string
obbligatorio
Possible values: section
body.authentication
object
obbligatorio
Mostra attributi secondari
body.authentication.otp
object
Mostra attributi secondari
body.authentication.otp.actions
array of object
Mostra attributi secondari
body.authentication.otp.actions.link
object
obbligatorio
Mostra attributi secondari
body.authentication.otp.actions.link.metadata
object
Mostra attributi secondari
body.authentication.otp.actions.link.metadata.description
object
Mostra attributi secondari
body.authentication.otp.actions.link.metadata.description.label
string
obbligatorio
body.authentication.otp.actions.link.text
string
obbligatorio
body.authentication.otp.actions.link.url
string
obbligatorio
body.authentication.otp.actions.type
string
obbligatorio
Possible values: link
body.authentication.otp.actions.reply
object
obbligatorio
Mostra attributi secondari
body.authentication.otp.actions.reply.imageUrl
string
body.authentication.otp.actions.reply.metadata
object
Mostra attributi secondari
body.authentication.otp.actions.reply.metadata.description
object
Mostra attributi secondari
body.authentication.otp.actions.reply.metadata.description.label
string
obbligatorio
body.authentication.otp.actions.reply.text
string
obbligatorio
body.authentication.otp.actions.type
string
obbligatorio
Possible values: reply
body.authentication.otp.actions.locationRequest
object
Mostra attributi secondari
body.authentication.otp.actions.locationRequest.text
string
body.authentication.otp.actions.type
string
obbligatorio
Possible values: locationRequest
body.authentication.otp.actions.buy
object
obbligatorio
Mostra attributi secondari
body.authentication.otp.actions.buy.amountCents
integer
obbligatorio
body.authentication.otp.actions.buy.currency
string
obbligatorio
body.authentication.otp.actions.buy.text
string
obbligatorio
body.authentication.otp.actions.type
string
obbligatorio
Possible values: buy
body.authentication.otp.actions.postback
object
obbligatorio
Mostra attributi secondari
body.authentication.otp.actions.postback.handshake
object
Mostra attributi secondari
body.authentication.otp.actions.postback.handshake.packageName
string
obbligatorio
body.authentication.otp.actions.postback.handshake.signatureHash
string
obbligatorio
body.authentication.otp.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
body.authentication.otp.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
body.authentication.otp.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
body.authentication.otp.actions.postback.handshake.text
string
obbligatorio
body.authentication.otp.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
body.authentication.otp.actions.postback.imageUrl
string
body.authentication.otp.actions.postback.metadata
object
Mostra attributi secondari
body.authentication.otp.actions.postback.metadata.description
object
Mostra attributi secondari
body.authentication.otp.actions.postback.metadata.description.label
string
obbligatorio
body.authentication.otp.actions.postback.otpType
string
body.authentication.otp.actions.postback.payload
string
body.authentication.otp.actions.postback.text
string
obbligatorio
body.authentication.otp.actions.type
string
obbligatorio
Possible values: postback
body.authentication.otp.disclaimer
boolean
obbligatorio
Whether to add a security disclaimer to the authentication body.
body.authentication.otp.expirationTime
integer
The number of seconds after which the authentication code expires. If not set, no expiration notification is sent.
body.type
string
obbligatorio
Possible values: authentication
body.action
object
obbligatorio
Mostra attributi secondari
body.action.action
string
obbligatorio
Possible values: permissionRequest
body.action.permissionRequest
object
obbligatorio
Mostra attributi secondari
body.action.permissionRequest.resource
string
obbligatorio
Possible values: call
body.type
string
obbligatorio
Possible values: action
bodyId
string
bodyStorage
object
Mostra attributi secondari
bodyStorage.type
string
obbligatorio
Possible values: s3
bodyStorage.s3
object
obbligatorio
Mostra attributi secondari
bodyStorage.s3.bucketArn
string
obbligatorio
bodyStorage.s3.encryptionKey
string
obbligatorio
bodyStorage.s3.key
string
obbligatorio
channelId
string
obbligatorio
chargeableUnits
integer
context
object
Mostra attributi secondari
context.id
string
context.tagIds
array of string
context.type
string
createdAt
string
obbligatorio
details
string
This field is used to store additional information related to the message status.
direction
string
Possible values: incoming, outgoing
failure
object
Mostra attributi secondari
failure.code
integer
omni channel interpretation of the failure to categorise the nature of message error
failure.description
string
human readable description of the error
failure.source
object
Mostra attributi secondari
failure.source.code
string
numerical, text or alphanumeric code that indicates the error or issue while delivering the message in the last step
failure.source.name
string
Possible values: pre-processing, accounting, contact, touchpoint, sms-messagebird, sms-twilio, email-messagebird, whatsapp, facebook, instagram, line, telegram, apple-business-chat, viber, chat, google-business-messages, voice, smtp-messagebird, rcs-google, service
id
string
obbligatorio
ignorePersistedEventhooks
boolean
lastStatusAt
string
obbligatorio
meta
object
Mostra attributi secondari
meta.campaign
object
Mostra attributi secondari
meta.campaign.id
string
meta.campaign.name
string
meta.campaignId
string
meta.chargeOnceDelivered
boolean
meta.email
object
Mostra attributi secondari
meta.email.from
object
Mostra attributi secondari
meta.email.from.displayName
string
meta.email.from.username
string
meta.email.headers
object
meta.email.subject
string
meta.extraInformation
object
meta.flow
object
Mostra attributi secondari
meta.flow.id
string
meta.flow.name
string
meta.flow.runId
string
meta.flow.scheduleExecutionId
string
meta.flow.stepId
string
meta.formResponse
object
Mostra attributi secondari
meta.formResponse.id
string
obbligatorio
meta.formResponse.jsonResponse
string
obbligatorio
meta.formResponse.requestIdentifier
string
obbligatorio
meta.formResponse.selections
array of object
Mostra attributi secondari
meta.formResponse.selections.items
array of object
Mostra attributi secondari
meta.formResponse.selections.items.identifier
string
obbligatorio
meta.formResponse.selections.items.title
string
obbligatorio
meta.formResponse.selections.items.type
string
obbligatorio
meta.formResponse.selections.items.value
string
obbligatorio
meta.formResponse.selections.pageIdentifier
string
obbligatorio
meta.formResponse.selections.subtitle
string
obbligatorio
meta.formResponse.selections.title
string
obbligatorio
meta.formResponse.sessionIdentifier
string
obbligatorio
meta.formResponse.template
string
obbligatorio
meta.formResponse.version
string
obbligatorio
meta.ignoreGlobalHoldout
boolean
meta.ignoreQuietHours
boolean
meta.journey
object
Mostra attributi secondari
meta.journey.id
string
meta.journey.name
string
meta.journey.runId
string
meta.journey.scheduleExecutionId
string
meta.journey.stepId
string
meta.longToShortLinks
object
meta.metaThreadId
string
meta.navigatorId
string
meta.navigatorMessageId
string
meta.order
object
The order object contains information about the purchase order associated with the message.
Mostra attributi secondari
meta.order.products
array of object
Mostra attributi secondari
meta.order.products.externalCatalogId
string
The platform-specific catalog ID of the product.
meta.order.products.externalProductId
string
obbligatorio
The platform-specific product ID.
meta.order.products.price
object
obbligatorio
Mostra attributi secondari
meta.order.products.price.amount
integer
obbligatorio
meta.order.products.price.currencyCode
string
obbligatorio
meta.order.products.price.exponent
integer
obbligatorio
meta.order.products.quantity
integer
obbligatorio
The number of items purchased.
meta.pushNotifications
object
Mostra attributi secondari
meta.pushNotifications.gatewayTypeOverride
string
Possible values: firebase, apns, web
meta.referral
object
Mostra attributi secondari
meta.referral.group
string
meta.referral.metadata
object
Mostra attributi secondari
meta.referral.metadata.caption
string
meta.referral.metadata.mediaType
string
meta.referral.metadata.mediaUrl
string
meta.referral.metadata.sourceId
string
obbligatorio
meta.referral.metadata.sourceUrl
string
meta.referral.metadata.timestamp
string
meta.referral.metadata.trackingId
string
meta.referral.metadata.username
string
meta.referral.source
string
obbligatorio
meta.referral.text
string
meta.referral.title
string
meta.referredProduct
object
Referred product in an incoming message (e.g. a product shared in a WhatsApp catalog message).
Mostra attributi secondari
meta.referredProduct.externalCatalogId
string
The platform-specific catalog ID of the product.
meta.referredProduct.externalProductId
string
obbligatorio
The platform-specific product ID.
meta.renderedContentBlocks
array of string
meta.shortToLongLinks
object
meta.skipThisMessage
string
Possible values: campaignHoldout, globalHoldout, journeyHoldout
meta.sms
object
Mostra attributi secondari
meta.sms.gatewayId
integer
meta.sms.registeredDelivery
string
Possible values: final, intermediate, all, noDlr
meta.sms.smartEncoding
boolean
When enabled, attempts to transliterate Unicode characters to GSM-7 equivalents. If the resulting text is fully GSM-7 compatible, fewer message segments may be required. The original message body is preserved; transliteration is only applied when sending.
meta.sms.smpp
object
Mostra attributi secondari
meta.sms.smpp.segments
array of object
Mostra attributi secondari
meta.sms.smpp.segments.id
string
obbligatorio
meta.sms.smpp.segments.registeredDelivery
string
obbligatorio
Possible values: final, intermediate, all, noDlr
meta.sms.smpp.userId
string
obbligatorio
meta.sms.validity
string
meta.useFallback
boolean
parts
array of object
Mostra attributi secondari
parts.id
string
parts.order
integer
parts.platformReferenceId
string
parts.platformStatusAt
string
parts.rawBody
string
parts.reason
string
parts.status
string
Possible values: accepted, processing, sent, sending_failed, delivered, delivery_failed, deleted, scheduled, skipped, rejected
parts.statusAt
string
platformId
string
platformReferenceId
string
previousMessages
array of object
Mostra attributi secondari
previousMessages.id
string
obbligatorio
previousMessages.useCaseType
string
obbligatorio
Possible values: unspecified, marketing, otp, transactional, conversation, test
reason
string
receiver
object
obbligatorio
Mostra attributi secondari
receiver.connector
object
Mostra attributi secondari
receiver.connector.annotations
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Mostra attributi secondari
receiver.connector.annotations.name
string
receiver.connector.id
string
obbligatorio
receiver.connector.identifierValue
string
The identifier value of the sender or receiver connector (e.g. email address or phone number).
receiver.connector.types
array of string
receiver.contacts
array of object
Mostra attributi secondari
receiver.contacts.contactAnnotation
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Mostra attributi secondari
receiver.contacts.contactAnnotation.name
string
receiver.contacts.countryCode
string
receiver.contacts.id
string
The ID of the contact.
receiver.contacts.identifierKey
string
The identifier key for finding the contact (e.g. emailaddress, phonenumber). For WhatsApp channels with BSUID support, use whatsappbsuid to send to a contact by their Business-Scoped User ID.
receiver.contacts.identifierValue
string
The identifier value for finding the contact.
receiver.contacts.identifiers
array of object
Additional identifiers to augment the contact during resolution.
Mostra attributi secondari
receiver.contacts.identifiers.identifierKey
string
obbligatorio
The identifier key for finding the contact (e.g. emailaddress, phonenumber).
receiver.contacts.identifiers.identifierValue
string
obbligatorio
The identifier value for finding the contact.
receiver.contacts.platformAddress
string
The resolved platform address used to deliver the message (e.g. phone number or email address).
receiver.contacts.platformAddressSelector
string
An expression that defines how we resolve the platform address from a contact. Optional override for the default resolution logic.
receiver.contacts.receiverExpression
string
receiver.contacts.receiverValue
string
receiver.contacts.type
string
The type of the receiver (e.g. to, cc, bcc for email).
receiver.device
object
Mostra attributi secondari
receiver.device.gateway
string
obbligatorio
Possible values: firebase, apns, web
receiver.device.id
string
obbligatorio
receiver.device.identifierValue
string
obbligatorio
receiver.inbox
object
Mostra attributi secondari
receiver.inbox.emailRecipientType
string
receiver.inbox.id
string
obbligatorio
receiver.inbox.identifierKey
string
obbligatorio
receiver.inbox.identifierValue
string
obbligatorio
receiver.inbox.type
string
obbligatorio
Possible values: user, group
receiver.userContacts
array of object
Mostra attributi secondari
receiver.userContacts.id
string
obbligatorio
receiver.userContacts.identifierKey
string
obbligatorio
receiver.userContacts.identifierValue
string
obbligatorio
receiver.userContacts.type
string
reference
string
A reference to the message. This can be used to identify the message in the channel.
replyTo
object
Mostra attributi secondari
replyTo.id
string
The ID of the message that is being replied to.
replyTo.order
integer
The order of the message part in the conversation.
replyTo.platformReference
string
replyTo.type
string
Possible values: message, click
schedule
object
Mostra attributi secondari
schedule.reason
string
obbligatorio
schedule.scheduledAt
string
obbligatorio
scheduledFor
string
Scheduled message send time (RFC3339). Messages scheduled within 10 minutes may be sent immediately; messages scheduled more than 35 days out will be rejected.
sendAt
string
sender
object
obbligatorio
Mostra attributi secondari
sender.connector
object
Mostra attributi secondari
sender.connector.annotations
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Mostra attributi secondari
sender.connector.annotations.name
string
sender.connector.id
string
obbligatorio
sender.connector.identifierValue
string
The identifier value of the sender or receiver connector (e.g. email address or phone number).
sender.connector.types
array of string
sender.contact
object
Mostra attributi secondari
sender.contact.contactAnnotation
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Mostra attributi secondari
sender.contact.contactAnnotation.name
string
sender.contact.countryCode
string
sender.contact.id
string
The ID of the contact.
sender.contact.identifierKey
string
The identifier key for finding the contact (e.g. emailaddress, phonenumber). For WhatsApp channels with BSUID support, use whatsappbsuid to send to a contact by their Business-Scoped User ID.
sender.contact.identifierValue
string
The identifier value for finding the contact.
sender.contact.identifiers
array of object
Additional identifiers to augment the contact during resolution.
Mostra attributi secondari
sender.contact.identifiers.identifierKey
string
obbligatorio
The identifier key for finding the contact (e.g. emailaddress, phonenumber).
sender.contact.identifiers.identifierValue
string
obbligatorio
The identifier value for finding the contact.
sender.contact.platformAddress
string
The resolved platform address used to deliver the message (e.g. phone number or email address).
sender.contact.platformAddressSelector
string
An expression that defines how we resolve the platform address from a contact. Optional override for the default resolution logic.
sender.contact.receiverExpression
string
sender.contact.receiverValue
string
sender.contact.type
string
The type of the receiver (e.g. to, cc, bcc for email).
sender.inbox
object
Mostra attributi secondari
sender.inbox.emailRecipientType
string
sender.inbox.id
string
obbligatorio
sender.inbox.identifierKey
string
obbligatorio
sender.inbox.identifierValue
string
obbligatorio
sender.inbox.type
string
obbligatorio
Possible values: user, group
sender.userContact
object
Mostra attributi secondari
sender.userContact.id
string
obbligatorio
sender.userContact.identifierKey
string
obbligatorio
sender.userContact.identifierValue
string
obbligatorio
sender.userContact.type
string
shortLinks
object
Mostra attributi secondari
shortLinks.domain
string
obbligatorio
The domain to use when shortening links. When set to default, uses the default link shortening domain for the workspace.
status
string
obbligatorio
Possible values: accepted, processing, sent, sending_failed, delivered, delivery_failed, deleted, scheduled, skipped, rejected
tagIds
array of string
tags
array of string
Tags to associate with the message. Tags are converted to lower case and automatically created if they don't exist. Up to 10 tags per message.
template
object
Mostra attributi secondari
template.attachments
array of object
Mostra attributi secondari
template.attachments.content
string
template.attachments.contentType
string
template.attachments.filename
string
obbligatorio
template.attachments.inline
boolean
obbligatorio
template.attachments.mediaUrl
string
obbligatorio
template.deployment
object
template.locale
string
obbligatorio
template.name
string
The platform name of the template.
template.parameters
array of object
Mostra attributi secondari
template.parameters.key
string
obbligatorio
template.parameters.sourceUrl
object
Mostra attributi secondari
template.parameters.sourceUrl.fullyReplaced
boolean
obbligatorio
template.parameters.sourceUrl.value
string
obbligatorio
template.parameters.type
string
obbligatorio
Possible values: string, timeslotList, productSections, productList, number, boolean, sectionList, shippingMethodList, lineItemList, whatsappProductSections, whatsappProductItems, shortLink, object, carouselCards, appleFormPageItems
template.parameters.value
object or array or string or number or boolean
obbligatorio
template.projectId
string
obbligatorio
The ID of the project from Studio.
template.settings
object
Mostra attributi secondari
template.settings.disallowMmLite
boolean
template.shortLinks
object
Mostra attributi secondari
template.shortLinks.domain
string
obbligatorio
The domain to use when shortening links. When set to default, uses the default link shortening domain for the workspace.
template.shortLinks.enabled
boolean
obbligatorio
Enables link shortening for SMS messages.
template.templateBody
object
Mostra attributi secondari
template.templateBody.text
object
obbligatorio
Mostra attributi secondari
template.templateBody.text.actions
array of object
Mostra attributi secondari
template.templateBody.text.actions.link
object
obbligatorio
Mostra attributi secondari
template.templateBody.text.actions.link.metadata
object
Mostra attributi secondari
template.templateBody.text.actions.link.metadata.description
object
Mostra attributi secondari
template.templateBody.text.actions.link.metadata.description.label
string
obbligatorio
template.templateBody.text.actions.link.text
string
obbligatorio
template.templateBody.text.actions.link.url
string
obbligatorio
template.templateBody.text.actions.type
string
obbligatorio
Possible values: link
template.templateBody.text.actions.reply
object
obbligatorio
Mostra attributi secondari
template.templateBody.text.actions.reply.imageUrl
string
template.templateBody.text.actions.reply.metadata
object
Mostra attributi secondari
template.templateBody.text.actions.reply.metadata.description
object
Mostra attributi secondari
template.templateBody.text.actions.reply.metadata.description.label
string
obbligatorio
template.templateBody.text.actions.reply.text
string
obbligatorio
template.templateBody.text.actions.type
string
obbligatorio
Possible values: reply
template.templateBody.text.actions.locationRequest
object
Mostra attributi secondari
template.templateBody.text.actions.locationRequest.text
string
template.templateBody.text.actions.type
string
obbligatorio
Possible values: locationRequest
template.templateBody.text.actions.buy
object
obbligatorio
Mostra attributi secondari
template.templateBody.text.actions.buy.amountCents
integer
obbligatorio
template.templateBody.text.actions.buy.currency
string
obbligatorio
template.templateBody.text.actions.buy.text
string
obbligatorio
template.templateBody.text.actions.type
string
obbligatorio
Possible values: buy
template.templateBody.text.actions.postback
object
obbligatorio
Mostra attributi secondari
template.templateBody.text.actions.postback.handshake
object
Mostra attributi secondari
template.templateBody.text.actions.postback.handshake.packageName
string
obbligatorio
template.templateBody.text.actions.postback.handshake.signatureHash
string
obbligatorio
template.templateBody.text.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
template.templateBody.text.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
template.templateBody.text.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
template.templateBody.text.actions.postback.handshake.text
string
obbligatorio
template.templateBody.text.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
template.templateBody.text.actions.postback.imageUrl
string
template.templateBody.text.actions.postback.metadata
object
Mostra attributi secondari
template.templateBody.text.actions.postback.metadata.description
object
Mostra attributi secondari
template.templateBody.text.actions.postback.metadata.description.label
string
obbligatorio
template.templateBody.text.actions.postback.otpType
string
template.templateBody.text.actions.postback.payload
string
template.templateBody.text.actions.postback.text
string
obbligatorio
template.templateBody.text.actions.type
string
obbligatorio
Possible values: postback
template.templateBody.text.attachments
array of object
Mostra attributi secondari
template.templateBody.text.attachments.content
string
template.templateBody.text.attachments.contentId
string
template.templateBody.text.attachments.contentType
string
template.templateBody.text.attachments.filename
string
obbligatorio
template.templateBody.text.attachments.inline
boolean
template.templateBody.text.attachments.mediaUrl
string
obbligatorio
template.templateBody.text.metadata
object
Mostra attributi secondari
template.templateBody.text.metadata.apple
object
Mostra attributi secondari
template.templateBody.text.metadata.apple.appClipPreview
boolean
template.templateBody.text.metadata.apple.appClipRegion
string
template.templateBody.text.metadata.apple.summaryText
string
template.templateBody.text.metadata.headers
object
template.templateBody.text.metadata.line
object
Mostra attributi secondari
template.templateBody.text.metadata.line.emoji
object
Mostra attributi secondari
template.templateBody.text.metadata.line.emoji.items
array of object
Mostra attributi secondari
template.templateBody.text.metadata.line.emoji.items.emojiId
string
obbligatorio
template.templateBody.text.metadata.line.emoji.items.index
integer
obbligatorio
template.templateBody.text.metadata.line.emoji.items.length
integer
template.templateBody.text.metadata.line.emoji.items.productId
string
obbligatorio
template.templateBody.text.metadata.paymentDetails
object
Mostra attributi secondari
template.templateBody.text.metadata.paymentDetails.amount
string
obbligatorio
template.templateBody.text.metadata.paymentDetails.currency
string
obbligatorio
template.templateBody.text.metadata.paymentDetails.sessionIdentifier
string
template.templateBody.text.metadata.paymentDetails.state
string
obbligatorio
template.templateBody.text.metadata.subject
string
template.templateBody.text.metadata.telegram
object
Mostra attributi secondari
template.templateBody.text.metadata.telegram.parseMode
string
template.templateBody.text.metadata.whatsapp
object
Mostra attributi secondari
template.templateBody.text.metadata.whatsapp.callPermissionExpiration
string
template.templateBody.text.metadata.whatsapp.callPermissionResponse
string
Possible values: accept, reject
template.templateBody.text.metadata.whatsapp.previewUrl
boolean
obbligatorio
template.templateBody.text.metadata.whatsapp.sharedContacts
array of object
Mostra attributi secondari
template.templateBody.text.metadata.whatsapp.sharedContacts.origin
string
obbligatorio
template.templateBody.text.metadata.whatsapp.sharedContacts.phones
array of object
Mostra attributi secondari
template.templateBody.text.metadata.whatsapp.sharedContacts.phones.phone
string
obbligatorio
template.templateBody.text.metadata.whatsapp.sharedContacts.phones.type
string
obbligatorio
template.templateBody.text.metadata.whatsapp.sharedContacts.phones.waId
string
obbligatorio
template.templateBody.text.metadata.whatsapp.sharedContacts.vcard
string
template.templateBody.text.text
string
obbligatorio
template.templateBody.type
string
obbligatorio
Possible values: text
template.templateBody.html
object
obbligatorio
Mostra attributi secondari
template.templateBody.html.actions
array of object
Mostra attributi secondari
template.templateBody.html.actions.link
object
obbligatorio
Mostra attributi secondari
template.templateBody.html.actions.link.metadata
object
Mostra attributi secondari
template.templateBody.html.actions.link.metadata.description
object
Mostra attributi secondari
template.templateBody.html.actions.link.metadata.description.label
string
obbligatorio
template.templateBody.html.actions.link.text
string
obbligatorio
template.templateBody.html.actions.link.url
string
obbligatorio
template.templateBody.html.actions.type
string
obbligatorio
Possible values: link
template.templateBody.html.actions.reply
object
obbligatorio
Mostra attributi secondari
template.templateBody.html.actions.reply.imageUrl
string
template.templateBody.html.actions.reply.metadata
object
Mostra attributi secondari
template.templateBody.html.actions.reply.metadata.description
object
Mostra attributi secondari
template.templateBody.html.actions.reply.metadata.description.label
string
obbligatorio
template.templateBody.html.actions.reply.text
string
obbligatorio
template.templateBody.html.actions.type
string
obbligatorio
Possible values: reply
template.templateBody.html.actions.locationRequest
object
Mostra attributi secondari
template.templateBody.html.actions.locationRequest.text
string
template.templateBody.html.actions.type
string
obbligatorio
Possible values: locationRequest
template.templateBody.html.actions.buy
object
obbligatorio
Mostra attributi secondari
template.templateBody.html.actions.buy.amountCents
integer
obbligatorio
template.templateBody.html.actions.buy.currency
string
obbligatorio
template.templateBody.html.actions.buy.text
string
obbligatorio
template.templateBody.html.actions.type
string
obbligatorio
Possible values: buy
template.templateBody.html.actions.postback
object
obbligatorio
Mostra attributi secondari
template.templateBody.html.actions.postback.handshake
object
Mostra attributi secondari
template.templateBody.html.actions.postback.handshake.packageName
string
obbligatorio
template.templateBody.html.actions.postback.handshake.signatureHash
string
obbligatorio
template.templateBody.html.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
template.templateBody.html.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
template.templateBody.html.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
template.templateBody.html.actions.postback.handshake.text
string
obbligatorio
template.templateBody.html.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
template.templateBody.html.actions.postback.imageUrl
string
template.templateBody.html.actions.postback.metadata
object
Mostra attributi secondari
template.templateBody.html.actions.postback.metadata.description
object
Mostra attributi secondari
template.templateBody.html.actions.postback.metadata.description.label
string
obbligatorio
template.templateBody.html.actions.postback.otpType
string
template.templateBody.html.actions.postback.payload
string
template.templateBody.html.actions.postback.text
string
obbligatorio
template.templateBody.html.actions.type
string
obbligatorio
Possible values: postback
template.templateBody.html.attachments
array of object
Mostra attributi secondari
template.templateBody.html.attachments.content
string
template.templateBody.html.attachments.contentId
string
template.templateBody.html.attachments.contentType
string
template.templateBody.html.attachments.filename
string
obbligatorio
template.templateBody.html.attachments.inline
boolean
template.templateBody.html.attachments.mediaUrl
string
template.templateBody.html.html
string
template.templateBody.html.metadata
object
Mostra attributi secondari
template.templateBody.html.metadata.clickTracking
boolean
template.templateBody.html.metadata.from
object
Mostra attributi secondari
template.templateBody.html.metadata.from.displayName
string
template.templateBody.html.metadata.from.username
string
template.templateBody.html.metadata.headers
object
template.templateBody.html.metadata.initialOpenTracking
boolean
template.templateBody.html.metadata.openTracking
boolean
template.templateBody.html.metadata.subject
string
template.templateBody.html.text
string
template.templateBody.type
string
obbligatorio
Possible values: html
template.templateBody.image
object
obbligatorio
Mostra attributi secondari
template.templateBody.image.actions
array of object
Mostra attributi secondari
template.templateBody.image.actions.link
object
obbligatorio
Mostra attributi secondari
template.templateBody.image.actions.link.metadata
object
Mostra attributi secondari
template.templateBody.image.actions.link.metadata.description
object
Mostra attributi secondari
template.templateBody.image.actions.link.metadata.description.label
string
obbligatorio
template.templateBody.image.actions.link.text
string
obbligatorio
template.templateBody.image.actions.link.url
string
obbligatorio
template.templateBody.image.actions.type
string
obbligatorio
Possible values: link
template.templateBody.image.actions.reply
object
obbligatorio
Mostra attributi secondari
template.templateBody.image.actions.reply.imageUrl
string
template.templateBody.image.actions.reply.metadata
object
Mostra attributi secondari
template.templateBody.image.actions.reply.metadata.description
object
Mostra attributi secondari
template.templateBody.image.actions.reply.metadata.description.label
string
obbligatorio
template.templateBody.image.actions.reply.text
string
obbligatorio
template.templateBody.image.actions.type
string
obbligatorio
Possible values: reply
template.templateBody.image.actions.locationRequest
object
Mostra attributi secondari
template.templateBody.image.actions.locationRequest.text
string
template.templateBody.image.actions.type
string
obbligatorio
Possible values: locationRequest
template.templateBody.image.actions.buy
object
obbligatorio
Mostra attributi secondari
template.templateBody.image.actions.buy.amountCents
integer
obbligatorio
template.templateBody.image.actions.buy.currency
string
obbligatorio
template.templateBody.image.actions.buy.text
string
obbligatorio
template.templateBody.image.actions.type
string
obbligatorio
Possible values: buy
template.templateBody.image.actions.postback
object
obbligatorio
Mostra attributi secondari
template.templateBody.image.actions.postback.handshake
object
Mostra attributi secondari
template.templateBody.image.actions.postback.handshake.packageName
string
obbligatorio
template.templateBody.image.actions.postback.handshake.signatureHash
string
obbligatorio
template.templateBody.image.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
template.templateBody.image.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
template.templateBody.image.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
template.templateBody.image.actions.postback.handshake.text
string
obbligatorio
template.templateBody.image.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
template.templateBody.image.actions.postback.imageUrl
string
template.templateBody.image.actions.postback.metadata
object
Mostra attributi secondari
template.templateBody.image.actions.postback.metadata.description
object
Mostra attributi secondari
template.templateBody.image.actions.postback.metadata.description.label
string
obbligatorio
template.templateBody.image.actions.postback.otpType
string
template.templateBody.image.actions.postback.payload
string
template.templateBody.image.actions.postback.text
string
obbligatorio
template.templateBody.image.actions.type
string
obbligatorio
Possible values: postback
template.templateBody.image.images
array of object
obbligatorio
Mostra attributi secondari
template.templateBody.image.images.altText
string
template.templateBody.image.images.mediaPreviewUrl
string
template.templateBody.image.images.mediaUrl
string
obbligatorio
template.templateBody.image.metadata
object
Mostra attributi secondari
template.templateBody.image.metadata.fallbackText
string
template.templateBody.image.metadata.storyType
string
Possible values: mention, reply
template.templateBody.image.metadata.subject
string
template.templateBody.image.metadata.telegram
object
Mostra attributi secondari
template.templateBody.image.metadata.telegram.parseMode
string
template.templateBody.image.text
string
template.templateBody.type
string
obbligatorio
Possible values: image
template.templateBody.gif
object
obbligatorio
Mostra attributi secondari
template.templateBody.gif.actions
array of object
Mostra attributi secondari
template.templateBody.gif.actions.link
object
obbligatorio
Mostra attributi secondari
template.templateBody.gif.actions.link.metadata
object
Mostra attributi secondari
template.templateBody.gif.actions.link.metadata.description
object
Mostra attributi secondari
template.templateBody.gif.actions.link.metadata.description.label
string
obbligatorio
template.templateBody.gif.actions.link.text
string
obbligatorio
template.templateBody.gif.actions.link.url
string
obbligatorio
template.templateBody.gif.actions.type
string
obbligatorio
Possible values: link
template.templateBody.gif.actions.reply
object
obbligatorio
Mostra attributi secondari
template.templateBody.gif.actions.reply.imageUrl
string
template.templateBody.gif.actions.reply.metadata
object
Mostra attributi secondari
template.templateBody.gif.actions.reply.metadata.description
object
Mostra attributi secondari
template.templateBody.gif.actions.reply.metadata.description.label
string
obbligatorio
template.templateBody.gif.actions.reply.text
string
obbligatorio
template.templateBody.gif.actions.type
string
obbligatorio
Possible values: reply
template.templateBody.gif.actions.locationRequest
object
Mostra attributi secondari
template.templateBody.gif.actions.locationRequest.text
string
template.templateBody.gif.actions.type
string
obbligatorio
Possible values: locationRequest
template.templateBody.gif.actions.buy
object
obbligatorio
Mostra attributi secondari
template.templateBody.gif.actions.buy.amountCents
integer
obbligatorio
template.templateBody.gif.actions.buy.currency
string
obbligatorio
template.templateBody.gif.actions.buy.text
string
obbligatorio
template.templateBody.gif.actions.type
string
obbligatorio
Possible values: buy
template.templateBody.gif.actions.postback
object
obbligatorio
Mostra attributi secondari
template.templateBody.gif.actions.postback.handshake
object
Mostra attributi secondari
template.templateBody.gif.actions.postback.handshake.packageName
string
obbligatorio
template.templateBody.gif.actions.postback.handshake.signatureHash
string
obbligatorio
template.templateBody.gif.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
template.templateBody.gif.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
template.templateBody.gif.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
template.templateBody.gif.actions.postback.handshake.text
string
obbligatorio
template.templateBody.gif.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
template.templateBody.gif.actions.postback.imageUrl
string
template.templateBody.gif.actions.postback.metadata
object
Mostra attributi secondari
template.templateBody.gif.actions.postback.metadata.description
object
Mostra attributi secondari
template.templateBody.gif.actions.postback.metadata.description.label
string
obbligatorio
template.templateBody.gif.actions.postback.otpType
string
template.templateBody.gif.actions.postback.payload
string
template.templateBody.gif.actions.postback.text
string
obbligatorio
template.templateBody.gif.actions.type
string
obbligatorio
Possible values: postback
template.templateBody.gif.altText
string
template.templateBody.gif.mediaUrl
string
obbligatorio
template.templateBody.gif.metadata
object
Mostra attributi secondari
template.templateBody.gif.metadata.telegram
object
Mostra attributi secondari
template.templateBody.gif.metadata.telegram.parseMode
string
template.templateBody.gif.text
string
template.templateBody.type
string
obbligatorio
Possible values: gif
template.templateBody.file
object
obbligatorio
Mostra attributi secondari
template.templateBody.file.actions
array of object
Mostra attributi secondari
template.templateBody.file.actions.link
object
obbligatorio
Mostra attributi secondari
template.templateBody.file.actions.link.metadata
object
Mostra attributi secondari
template.templateBody.file.actions.link.metadata.description
object
Mostra attributi secondari
template.templateBody.file.actions.link.metadata.description.label
string
obbligatorio
template.templateBody.file.actions.link.text
string
obbligatorio
template.templateBody.file.actions.link.url
string
obbligatorio
template.templateBody.file.actions.type
string
obbligatorio
Possible values: link
template.templateBody.file.actions.reply
object
obbligatorio
Mostra attributi secondari
template.templateBody.file.actions.reply.imageUrl
string
template.templateBody.file.actions.reply.metadata
object
Mostra attributi secondari
template.templateBody.file.actions.reply.metadata.description
object
Mostra attributi secondari
template.templateBody.file.actions.reply.metadata.description.label
string
obbligatorio
template.templateBody.file.actions.reply.text
string
obbligatorio
template.templateBody.file.actions.type
string
obbligatorio
Possible values: reply
template.templateBody.file.actions.locationRequest
object
Mostra attributi secondari
template.templateBody.file.actions.locationRequest.text
string
template.templateBody.file.actions.type
string
obbligatorio
Possible values: locationRequest
template.templateBody.file.actions.buy
object
obbligatorio
Mostra attributi secondari
template.templateBody.file.actions.buy.amountCents
integer
obbligatorio
template.templateBody.file.actions.buy.currency
string
obbligatorio
template.templateBody.file.actions.buy.text
string
obbligatorio
template.templateBody.file.actions.type
string
obbligatorio
Possible values: buy
template.templateBody.file.actions.postback
object
obbligatorio
Mostra attributi secondari
template.templateBody.file.actions.postback.handshake
object
Mostra attributi secondari
template.templateBody.file.actions.postback.handshake.packageName
string
obbligatorio
template.templateBody.file.actions.postback.handshake.signatureHash
string
obbligatorio
template.templateBody.file.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
template.templateBody.file.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
template.templateBody.file.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
template.templateBody.file.actions.postback.handshake.text
string
obbligatorio
template.templateBody.file.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
template.templateBody.file.actions.postback.imageUrl
string
template.templateBody.file.actions.postback.metadata
object
Mostra attributi secondari
template.templateBody.file.actions.postback.metadata.description
object
Mostra attributi secondari
template.templateBody.file.actions.postback.metadata.description.label
string
obbligatorio
template.templateBody.file.actions.postback.otpType
string
template.templateBody.file.actions.postback.payload
string
template.templateBody.file.actions.postback.text
string
obbligatorio
template.templateBody.file.actions.type
string
obbligatorio
Possible values: postback
template.templateBody.file.files
array of object
obbligatorio
Mostra attributi secondari
template.templateBody.file.files.altText
string
template.templateBody.file.files.contentType
string
obbligatorio
template.templateBody.file.files.filename
string
template.templateBody.file.files.mediaUrl
string
obbligatorio
template.templateBody.file.files.metadata
object
Mostra attributi secondari
template.templateBody.file.files.metadata.isAnimated
boolean
template.templateBody.file.metadata
object
Mostra attributi secondari
template.templateBody.file.metadata.fallbackText
string
template.templateBody.file.metadata.storyType
string
Possible values: mention, reply
template.templateBody.file.metadata.subject
string
template.templateBody.file.metadata.telegram
object
Mostra attributi secondari
template.templateBody.file.metadata.telegram.parseMode
string
template.templateBody.file.text
string
template.templateBody.type
string
obbligatorio
Possible values: file
template.templateBody.location
object
obbligatorio
Mostra attributi secondari
template.templateBody.location.coordinates
object
obbligatorio
Mostra attributi secondari
template.templateBody.location.coordinates.latitude
number
obbligatorio
template.templateBody.location.coordinates.longitude
number
obbligatorio
template.templateBody.location.location
object
obbligatorio
Mostra attributi secondari
template.templateBody.location.location.address
string
obbligatorio
template.templateBody.location.location.label
string
obbligatorio
template.templateBody.type
string
obbligatorio
Possible values: location
template.templateBody.carousel
object
obbligatorio
Mostra attributi secondari
template.templateBody.carousel.items
array of object
Mostra attributi secondari
template.templateBody.carousel.items.actions
array of object
Mostra attributi secondari
template.templateBody.carousel.items.actions.link
object
obbligatorio
Mostra attributi secondari
template.templateBody.carousel.items.actions.link.metadata
object
Mostra attributi secondari
template.templateBody.carousel.items.actions.link.metadata.description
object
Mostra attributi secondari
template.templateBody.carousel.items.actions.link.metadata.description.label
string
obbligatorio
template.templateBody.carousel.items.actions.link.text
string
obbligatorio
template.templateBody.carousel.items.actions.link.url
string
obbligatorio
template.templateBody.carousel.items.actions.type
string
obbligatorio
Possible values: link
template.templateBody.carousel.items.actions.reply
object
obbligatorio
Mostra attributi secondari
template.templateBody.carousel.items.actions.reply.imageUrl
string
template.templateBody.carousel.items.actions.reply.metadata
object
Mostra attributi secondari
template.templateBody.carousel.items.actions.reply.metadata.description
object
Mostra attributi secondari
template.templateBody.carousel.items.actions.reply.metadata.description.label
string
obbligatorio
template.templateBody.carousel.items.actions.reply.text
string
obbligatorio
template.templateBody.carousel.items.actions.type
string
obbligatorio
Possible values: reply
template.templateBody.carousel.items.actions.locationRequest
object
Mostra attributi secondari
template.templateBody.carousel.items.actions.locationRequest.text
string
template.templateBody.carousel.items.actions.type
string
obbligatorio
Possible values: locationRequest
template.templateBody.carousel.items.actions.buy
object
obbligatorio
Mostra attributi secondari
template.templateBody.carousel.items.actions.buy.amountCents
integer
obbligatorio
template.templateBody.carousel.items.actions.buy.currency
string
obbligatorio
template.templateBody.carousel.items.actions.buy.text
string
obbligatorio
template.templateBody.carousel.items.actions.type
string
obbligatorio
Possible values: buy
template.templateBody.carousel.items.actions.postback
object
obbligatorio
Mostra attributi secondari
template.templateBody.carousel.items.actions.postback.handshake
object
Mostra attributi secondari
template.templateBody.carousel.items.actions.postback.handshake.packageName
string
obbligatorio
template.templateBody.carousel.items.actions.postback.handshake.signatureHash
string
obbligatorio
template.templateBody.carousel.items.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
template.templateBody.carousel.items.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
template.templateBody.carousel.items.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
template.templateBody.carousel.items.actions.postback.handshake.text
string
obbligatorio
template.templateBody.carousel.items.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
template.templateBody.carousel.items.actions.postback.imageUrl
string
template.templateBody.carousel.items.actions.postback.metadata
object
Mostra attributi secondari
template.templateBody.carousel.items.actions.postback.metadata.description
object
Mostra attributi secondari
template.templateBody.carousel.items.actions.postback.metadata.description.label
string
obbligatorio
template.templateBody.carousel.items.actions.postback.otpType
string
template.templateBody.carousel.items.actions.postback.payload
string
template.templateBody.carousel.items.actions.postback.text
string
obbligatorio
template.templateBody.carousel.items.actions.type
string
obbligatorio
Possible values: postback
template.templateBody.carousel.items.altText
string
template.templateBody.carousel.items.description
string
template.templateBody.carousel.items.mediaUrl
string
template.templateBody.carousel.items.size
integer
template.templateBody.carousel.items.title
string
template.templateBody.carousel.text
string
Optional text displayed above the carousel cards.
template.templateBody.type
string
obbligatorio
Possible values: carousel
template.templateBody.list
object
obbligatorio
Mostra attributi secondari
template.templateBody.list.actions
array of object
Mostra attributi secondari
template.templateBody.list.actions.link
object
obbligatorio
Mostra attributi secondari
template.templateBody.list.actions.link.metadata
object
Mostra attributi secondari
template.templateBody.list.actions.link.metadata.description
object
Mostra attributi secondari
template.templateBody.list.actions.link.metadata.description.label
string
obbligatorio
template.templateBody.list.actions.link.text
string
obbligatorio
template.templateBody.list.actions.link.url
string
obbligatorio
template.templateBody.list.actions.type
string
obbligatorio
Possible values: link
template.templateBody.list.actions.reply
object
obbligatorio
Mostra attributi secondari
template.templateBody.list.actions.reply.imageUrl
string
template.templateBody.list.actions.reply.metadata
object
Mostra attributi secondari
template.templateBody.list.actions.reply.metadata.description
object
Mostra attributi secondari
template.templateBody.list.actions.reply.metadata.description.label
string
obbligatorio
template.templateBody.list.actions.reply.text
string
obbligatorio
template.templateBody.list.actions.type
string
obbligatorio
Possible values: reply
template.templateBody.list.actions.locationRequest
object
Mostra attributi secondari
template.templateBody.list.actions.locationRequest.text
string
template.templateBody.list.actions.type
string
obbligatorio
Possible values: locationRequest
template.templateBody.list.actions.buy
object
obbligatorio
Mostra attributi secondari
template.templateBody.list.actions.buy.amountCents
integer
obbligatorio
template.templateBody.list.actions.buy.currency
string
obbligatorio
template.templateBody.list.actions.buy.text
string
obbligatorio
template.templateBody.list.actions.type
string
obbligatorio
Possible values: buy
template.templateBody.list.actions.postback
object
obbligatorio
Mostra attributi secondari
template.templateBody.list.actions.postback.handshake
object
Mostra attributi secondari
template.templateBody.list.actions.postback.handshake.packageName
string
obbligatorio
template.templateBody.list.actions.postback.handshake.signatureHash
string
obbligatorio
template.templateBody.list.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
template.templateBody.list.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
template.templateBody.list.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
template.templateBody.list.actions.postback.handshake.text
string
obbligatorio
template.templateBody.list.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
template.templateBody.list.actions.postback.imageUrl
string
template.templateBody.list.actions.postback.metadata
object
Mostra attributi secondari
template.templateBody.list.actions.postback.metadata.description
object
Mostra attributi secondari
template.templateBody.list.actions.postback.metadata.description.label
string
obbligatorio
template.templateBody.list.actions.postback.otpType
string
template.templateBody.list.actions.postback.payload
string
template.templateBody.list.actions.postback.text
string
obbligatorio
template.templateBody.list.actions.type
string
obbligatorio
Possible values: postback
template.templateBody.list.altText
string
template.templateBody.list.items
array of object
Mostra attributi secondari
template.templateBody.list.items.actions
array of object
Mostra attributi secondari
template.templateBody.list.items.actions.link
object
obbligatorio
Mostra attributi secondari
template.templateBody.list.items.actions.link.metadata
object
Mostra attributi secondari
template.templateBody.list.items.actions.link.metadata.description
object
Mostra attributi secondari
template.templateBody.list.items.actions.link.metadata.description.label
string
obbligatorio
template.templateBody.list.items.actions.link.text
string
obbligatorio
template.templateBody.list.items.actions.link.url
string
obbligatorio
template.templateBody.list.items.actions.type
string
obbligatorio
Possible values: link
template.templateBody.list.items.actions.reply
object
obbligatorio
Mostra attributi secondari
template.templateBody.list.items.actions.reply.imageUrl
string
template.templateBody.list.items.actions.reply.metadata
object
Mostra attributi secondari
template.templateBody.list.items.actions.reply.metadata.description
object
Mostra attributi secondari
template.templateBody.list.items.actions.reply.metadata.description.label
string
obbligatorio
template.templateBody.list.items.actions.reply.text
string
obbligatorio
template.templateBody.list.items.actions.type
string
obbligatorio
Possible values: reply
template.templateBody.list.items.actions.locationRequest
object
Mostra attributi secondari
template.templateBody.list.items.actions.locationRequest.text
string
template.templateBody.list.items.actions.type
string
obbligatorio
Possible values: locationRequest
template.templateBody.list.items.actions.buy
object
obbligatorio
Mostra attributi secondari
template.templateBody.list.items.actions.buy.amountCents
integer
obbligatorio
template.templateBody.list.items.actions.buy.currency
string
obbligatorio
template.templateBody.list.items.actions.buy.text
string
obbligatorio
template.templateBody.list.items.actions.type
string
obbligatorio
Possible values: buy
template.templateBody.list.items.actions.postback
object
obbligatorio
Mostra attributi secondari
template.templateBody.list.items.actions.postback.handshake
object
Mostra attributi secondari
template.templateBody.list.items.actions.postback.handshake.packageName
string
obbligatorio
template.templateBody.list.items.actions.postback.handshake.signatureHash
string
obbligatorio
template.templateBody.list.items.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
template.templateBody.list.items.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
template.templateBody.list.items.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
template.templateBody.list.items.actions.postback.handshake.text
string
obbligatorio
template.templateBody.list.items.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
template.templateBody.list.items.actions.postback.imageUrl
string
template.templateBody.list.items.actions.postback.metadata
object
Mostra attributi secondari
template.templateBody.list.items.actions.postback.metadata.description
object
Mostra attributi secondari
template.templateBody.list.items.actions.postback.metadata.description.label
string
obbligatorio
template.templateBody.list.items.actions.postback.otpType
string
template.templateBody.list.items.actions.postback.payload
string
template.templateBody.list.items.actions.postback.text
string
obbligatorio
template.templateBody.list.items.actions.type
string
obbligatorio
Possible values: postback
template.templateBody.list.items.altText
string
template.templateBody.list.items.description
string
template.templateBody.list.items.mediaUrl
string
template.templateBody.list.items.size
integer
template.templateBody.list.items.title
string
template.templateBody.list.metadata
object
Mostra attributi secondari
template.templateBody.list.metadata.button
object
Mostra attributi secondari
template.templateBody.list.metadata.button.label
string
obbligatorio
template.templateBody.list.metadata.replyMessage
object
Mostra attributi secondari
template.templateBody.list.metadata.replyMessage.text
string
obbligatorio
template.templateBody.list.metadata.replyMessage.title
string
obbligatorio
template.templateBody.list.text
string
template.templateBody.list.title
string
template.templateBody.type
string
obbligatorio
Possible values: list
template.templateBody.section
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.configurations
object
template.templateBody.section.items
array of object
Mostra attributi secondari
template.templateBody.section.items.text
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.text.actions
array of object
Mostra attributi secondari
template.templateBody.section.items.text.actions.link
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.text.actions.link.metadata
object
Mostra attributi secondari
template.templateBody.section.items.text.actions.link.metadata.description
object
Mostra attributi secondari
template.templateBody.section.items.text.actions.link.metadata.description.label
string
obbligatorio
template.templateBody.section.items.text.actions.link.text
string
obbligatorio
template.templateBody.section.items.text.actions.link.url
string
obbligatorio
template.templateBody.section.items.text.actions.type
string
obbligatorio
Possible values: link
template.templateBody.section.items.text.actions.reply
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.text.actions.reply.imageUrl
string
template.templateBody.section.items.text.actions.reply.metadata
object
Mostra attributi secondari
template.templateBody.section.items.text.actions.reply.metadata.description
object
Mostra attributi secondari
template.templateBody.section.items.text.actions.reply.metadata.description.label
string
obbligatorio
template.templateBody.section.items.text.actions.reply.text
string
obbligatorio
template.templateBody.section.items.text.actions.type
string
obbligatorio
Possible values: reply
template.templateBody.section.items.text.actions.locationRequest
object
Mostra attributi secondari
template.templateBody.section.items.text.actions.locationRequest.text
string
template.templateBody.section.items.text.actions.type
string
obbligatorio
Possible values: locationRequest
template.templateBody.section.items.text.actions.buy
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.text.actions.buy.amountCents
integer
obbligatorio
template.templateBody.section.items.text.actions.buy.currency
string
obbligatorio
template.templateBody.section.items.text.actions.buy.text
string
obbligatorio
template.templateBody.section.items.text.actions.type
string
obbligatorio
Possible values: buy
template.templateBody.section.items.text.actions.postback
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.text.actions.postback.handshake
object
Mostra attributi secondari
template.templateBody.section.items.text.actions.postback.handshake.packageName
string
obbligatorio
template.templateBody.section.items.text.actions.postback.handshake.signatureHash
string
obbligatorio
template.templateBody.section.items.text.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
template.templateBody.section.items.text.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
template.templateBody.section.items.text.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
template.templateBody.section.items.text.actions.postback.handshake.text
string
obbligatorio
template.templateBody.section.items.text.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
template.templateBody.section.items.text.actions.postback.imageUrl
string
template.templateBody.section.items.text.actions.postback.metadata
object
Mostra attributi secondari
template.templateBody.section.items.text.actions.postback.metadata.description
object
Mostra attributi secondari
template.templateBody.section.items.text.actions.postback.metadata.description.label
string
obbligatorio
template.templateBody.section.items.text.actions.postback.otpType
string
template.templateBody.section.items.text.actions.postback.payload
string
template.templateBody.section.items.text.actions.postback.text
string
obbligatorio
template.templateBody.section.items.text.actions.type
string
obbligatorio
Possible values: postback
template.templateBody.section.items.text.attachments
array of object
Mostra attributi secondari
template.templateBody.section.items.text.attachments.content
string
template.templateBody.section.items.text.attachments.contentId
string
template.templateBody.section.items.text.attachments.contentType
string
template.templateBody.section.items.text.attachments.filename
string
obbligatorio
template.templateBody.section.items.text.attachments.inline
boolean
template.templateBody.section.items.text.attachments.mediaUrl
string
obbligatorio
template.templateBody.section.items.text.metadata
object
Mostra attributi secondari
template.templateBody.section.items.text.metadata.apple
object
Mostra attributi secondari
template.templateBody.section.items.text.metadata.apple.appClipPreview
boolean
template.templateBody.section.items.text.metadata.apple.appClipRegion
string
template.templateBody.section.items.text.metadata.apple.summaryText
string
template.templateBody.section.items.text.metadata.headers
object
template.templateBody.section.items.text.metadata.line
object
Mostra attributi secondari
template.templateBody.section.items.text.metadata.line.emoji
object
Mostra attributi secondari
template.templateBody.section.items.text.metadata.line.emoji.items
array of object
Mostra attributi secondari
template.templateBody.section.items.text.metadata.line.emoji.items.emojiId
string
obbligatorio
template.templateBody.section.items.text.metadata.line.emoji.items.index
integer
obbligatorio
template.templateBody.section.items.text.metadata.line.emoji.items.length
integer
template.templateBody.section.items.text.metadata.line.emoji.items.productId
string
obbligatorio
template.templateBody.section.items.text.metadata.paymentDetails
object
Mostra attributi secondari
template.templateBody.section.items.text.metadata.paymentDetails.amount
string
obbligatorio
template.templateBody.section.items.text.metadata.paymentDetails.currency
string
obbligatorio
template.templateBody.section.items.text.metadata.paymentDetails.sessionIdentifier
string
template.templateBody.section.items.text.metadata.paymentDetails.state
string
obbligatorio
template.templateBody.section.items.text.metadata.subject
string
template.templateBody.section.items.text.metadata.telegram
object
Mostra attributi secondari
template.templateBody.section.items.text.metadata.telegram.parseMode
string
template.templateBody.section.items.text.metadata.whatsapp
object
Mostra attributi secondari
template.templateBody.section.items.text.metadata.whatsapp.callPermissionExpiration
string
template.templateBody.section.items.text.metadata.whatsapp.callPermissionResponse
string
Possible values: accept, reject
template.templateBody.section.items.text.metadata.whatsapp.previewUrl
boolean
obbligatorio
template.templateBody.section.items.text.metadata.whatsapp.sharedContacts
array of object
Mostra attributi secondari
template.templateBody.section.items.text.metadata.whatsapp.sharedContacts.origin
string
obbligatorio
template.templateBody.section.items.text.metadata.whatsapp.sharedContacts.phones
array of object
Mostra attributi secondari
template.templateBody.section.items.text.metadata.whatsapp.sharedContacts.phones.phone
string
obbligatorio
template.templateBody.section.items.text.metadata.whatsapp.sharedContacts.phones.type
string
obbligatorio
template.templateBody.section.items.text.metadata.whatsapp.sharedContacts.phones.waId
string
obbligatorio
template.templateBody.section.items.text.metadata.whatsapp.sharedContacts.vcard
string
template.templateBody.section.items.text.text
string
obbligatorio
template.templateBody.section.items.type
string
obbligatorio
Possible values: text
template.templateBody.section.items.html
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.html.actions
array of object
Mostra attributi secondari
template.templateBody.section.items.html.actions.link
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.html.actions.link.metadata
object
Mostra attributi secondari
template.templateBody.section.items.html.actions.link.metadata.description
object
Mostra attributi secondari
template.templateBody.section.items.html.actions.link.metadata.description.label
string
obbligatorio
template.templateBody.section.items.html.actions.link.text
string
obbligatorio
template.templateBody.section.items.html.actions.link.url
string
obbligatorio
template.templateBody.section.items.html.actions.type
string
obbligatorio
Possible values: link
template.templateBody.section.items.html.actions.reply
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.html.actions.reply.imageUrl
string
template.templateBody.section.items.html.actions.reply.metadata
object
Mostra attributi secondari
template.templateBody.section.items.html.actions.reply.metadata.description
object
Mostra attributi secondari
template.templateBody.section.items.html.actions.reply.metadata.description.label
string
obbligatorio
template.templateBody.section.items.html.actions.reply.text
string
obbligatorio
template.templateBody.section.items.html.actions.type
string
obbligatorio
Possible values: reply
template.templateBody.section.items.html.actions.locationRequest
object
Mostra attributi secondari
template.templateBody.section.items.html.actions.locationRequest.text
string
template.templateBody.section.items.html.actions.type
string
obbligatorio
Possible values: locationRequest
template.templateBody.section.items.html.actions.buy
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.html.actions.buy.amountCents
integer
obbligatorio
template.templateBody.section.items.html.actions.buy.currency
string
obbligatorio
template.templateBody.section.items.html.actions.buy.text
string
obbligatorio
template.templateBody.section.items.html.actions.type
string
obbligatorio
Possible values: buy
template.templateBody.section.items.html.actions.postback
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.html.actions.postback.handshake
object
Mostra attributi secondari
template.templateBody.section.items.html.actions.postback.handshake.packageName
string
obbligatorio
template.templateBody.section.items.html.actions.postback.handshake.signatureHash
string
obbligatorio
template.templateBody.section.items.html.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
template.templateBody.section.items.html.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
template.templateBody.section.items.html.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
template.templateBody.section.items.html.actions.postback.handshake.text
string
obbligatorio
template.templateBody.section.items.html.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
template.templateBody.section.items.html.actions.postback.imageUrl
string
template.templateBody.section.items.html.actions.postback.metadata
object
Mostra attributi secondari
template.templateBody.section.items.html.actions.postback.metadata.description
object
Mostra attributi secondari
template.templateBody.section.items.html.actions.postback.metadata.description.label
string
obbligatorio
template.templateBody.section.items.html.actions.postback.otpType
string
template.templateBody.section.items.html.actions.postback.payload
string
template.templateBody.section.items.html.actions.postback.text
string
obbligatorio
template.templateBody.section.items.html.actions.type
string
obbligatorio
Possible values: postback
template.templateBody.section.items.html.attachments
array of object
Mostra attributi secondari
template.templateBody.section.items.html.attachments.content
string
template.templateBody.section.items.html.attachments.contentId
string
template.templateBody.section.items.html.attachments.contentType
string
template.templateBody.section.items.html.attachments.filename
string
obbligatorio
template.templateBody.section.items.html.attachments.inline
boolean
template.templateBody.section.items.html.attachments.mediaUrl
string
template.templateBody.section.items.html.html
string
template.templateBody.section.items.html.metadata
object
Mostra attributi secondari
template.templateBody.section.items.html.metadata.clickTracking
boolean
template.templateBody.section.items.html.metadata.from
object
Mostra attributi secondari
template.templateBody.section.items.html.metadata.from.displayName
string
template.templateBody.section.items.html.metadata.from.username
string
template.templateBody.section.items.html.metadata.headers
object
template.templateBody.section.items.html.metadata.initialOpenTracking
boolean
template.templateBody.section.items.html.metadata.openTracking
boolean
template.templateBody.section.items.html.metadata.subject
string
template.templateBody.section.items.html.text
string
template.templateBody.section.items.type
string
obbligatorio
Possible values: html
template.templateBody.section.items.image
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.image.actions
array of object
Mostra attributi secondari
template.templateBody.section.items.image.actions.link
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.image.actions.link.metadata
object
Mostra attributi secondari
template.templateBody.section.items.image.actions.link.metadata.description
object
Mostra attributi secondari
template.templateBody.section.items.image.actions.link.metadata.description.label
string
obbligatorio
template.templateBody.section.items.image.actions.link.text
string
obbligatorio
template.templateBody.section.items.image.actions.link.url
string
obbligatorio
template.templateBody.section.items.image.actions.type
string
obbligatorio
Possible values: link
template.templateBody.section.items.image.actions.reply
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.image.actions.reply.imageUrl
string
template.templateBody.section.items.image.actions.reply.metadata
object
Mostra attributi secondari
template.templateBody.section.items.image.actions.reply.metadata.description
object
Mostra attributi secondari
template.templateBody.section.items.image.actions.reply.metadata.description.label
string
obbligatorio
template.templateBody.section.items.image.actions.reply.text
string
obbligatorio
template.templateBody.section.items.image.actions.type
string
obbligatorio
Possible values: reply
template.templateBody.section.items.image.actions.locationRequest
object
Mostra attributi secondari
template.templateBody.section.items.image.actions.locationRequest.text
string
template.templateBody.section.items.image.actions.type
string
obbligatorio
Possible values: locationRequest
template.templateBody.section.items.image.actions.buy
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.image.actions.buy.amountCents
integer
obbligatorio
template.templateBody.section.items.image.actions.buy.currency
string
obbligatorio
template.templateBody.section.items.image.actions.buy.text
string
obbligatorio
template.templateBody.section.items.image.actions.type
string
obbligatorio
Possible values: buy
template.templateBody.section.items.image.actions.postback
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.image.actions.postback.handshake
object
Mostra attributi secondari
template.templateBody.section.items.image.actions.postback.handshake.packageName
string
obbligatorio
template.templateBody.section.items.image.actions.postback.handshake.signatureHash
string
obbligatorio
template.templateBody.section.items.image.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
template.templateBody.section.items.image.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
template.templateBody.section.items.image.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
template.templateBody.section.items.image.actions.postback.handshake.text
string
obbligatorio
template.templateBody.section.items.image.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
template.templateBody.section.items.image.actions.postback.imageUrl
string
template.templateBody.section.items.image.actions.postback.metadata
object
Mostra attributi secondari
template.templateBody.section.items.image.actions.postback.metadata.description
object
Mostra attributi secondari
template.templateBody.section.items.image.actions.postback.metadata.description.label
string
obbligatorio
template.templateBody.section.items.image.actions.postback.otpType
string
template.templateBody.section.items.image.actions.postback.payload
string
template.templateBody.section.items.image.actions.postback.text
string
obbligatorio
template.templateBody.section.items.image.actions.type
string
obbligatorio
Possible values: postback
template.templateBody.section.items.image.images
array of object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.image.images.altText
string
template.templateBody.section.items.image.images.mediaPreviewUrl
string
template.templateBody.section.items.image.images.mediaUrl
string
obbligatorio
template.templateBody.section.items.image.metadata
object
Mostra attributi secondari
template.templateBody.section.items.image.metadata.fallbackText
string
template.templateBody.section.items.image.metadata.storyType
string
Possible values: mention, reply
template.templateBody.section.items.image.metadata.subject
string
template.templateBody.section.items.image.metadata.telegram
object
Mostra attributi secondari
template.templateBody.section.items.image.metadata.telegram.parseMode
string
template.templateBody.section.items.image.text
string
template.templateBody.section.items.type
string
obbligatorio
Possible values: image
template.templateBody.section.items.gif
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.gif.actions
array of object
Mostra attributi secondari
template.templateBody.section.items.gif.actions.link
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.gif.actions.link.metadata
object
Mostra attributi secondari
template.templateBody.section.items.gif.actions.link.metadata.description
object
Mostra attributi secondari
template.templateBody.section.items.gif.actions.link.metadata.description.label
string
obbligatorio
template.templateBody.section.items.gif.actions.link.text
string
obbligatorio
template.templateBody.section.items.gif.actions.link.url
string
obbligatorio
template.templateBody.section.items.gif.actions.type
string
obbligatorio
Possible values: link
template.templateBody.section.items.gif.actions.reply
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.gif.actions.reply.imageUrl
string
template.templateBody.section.items.gif.actions.reply.metadata
object
Mostra attributi secondari
template.templateBody.section.items.gif.actions.reply.metadata.description
object
Mostra attributi secondari
template.templateBody.section.items.gif.actions.reply.metadata.description.label
string
obbligatorio
template.templateBody.section.items.gif.actions.reply.text
string
obbligatorio
template.templateBody.section.items.gif.actions.type
string
obbligatorio
Possible values: reply
template.templateBody.section.items.gif.actions.locationRequest
object
Mostra attributi secondari
template.templateBody.section.items.gif.actions.locationRequest.text
string
template.templateBody.section.items.gif.actions.type
string
obbligatorio
Possible values: locationRequest
template.templateBody.section.items.gif.actions.buy
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.gif.actions.buy.amountCents
integer
obbligatorio
template.templateBody.section.items.gif.actions.buy.currency
string
obbligatorio
template.templateBody.section.items.gif.actions.buy.text
string
obbligatorio
template.templateBody.section.items.gif.actions.type
string
obbligatorio
Possible values: buy
template.templateBody.section.items.gif.actions.postback
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.gif.actions.postback.handshake
object
Mostra attributi secondari
template.templateBody.section.items.gif.actions.postback.handshake.packageName
string
obbligatorio
template.templateBody.section.items.gif.actions.postback.handshake.signatureHash
string
obbligatorio
template.templateBody.section.items.gif.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
template.templateBody.section.items.gif.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
template.templateBody.section.items.gif.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
template.templateBody.section.items.gif.actions.postback.handshake.text
string
obbligatorio
template.templateBody.section.items.gif.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
template.templateBody.section.items.gif.actions.postback.imageUrl
string
template.templateBody.section.items.gif.actions.postback.metadata
object
Mostra attributi secondari
template.templateBody.section.items.gif.actions.postback.metadata.description
object
Mostra attributi secondari
template.templateBody.section.items.gif.actions.postback.metadata.description.label
string
obbligatorio
template.templateBody.section.items.gif.actions.postback.otpType
string
template.templateBody.section.items.gif.actions.postback.payload
string
template.templateBody.section.items.gif.actions.postback.text
string
obbligatorio
template.templateBody.section.items.gif.actions.type
string
obbligatorio
Possible values: postback
template.templateBody.section.items.gif.altText
string
template.templateBody.section.items.gif.mediaUrl
string
obbligatorio
template.templateBody.section.items.gif.metadata
object
Mostra attributi secondari
template.templateBody.section.items.gif.metadata.telegram
object
Mostra attributi secondari
template.templateBody.section.items.gif.metadata.telegram.parseMode
string
template.templateBody.section.items.gif.text
string
template.templateBody.section.items.type
string
obbligatorio
Possible values: gif
template.templateBody.section.items.file
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.file.actions
array of object
Mostra attributi secondari
template.templateBody.section.items.file.actions.link
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.file.actions.link.metadata
object
Mostra attributi secondari
template.templateBody.section.items.file.actions.link.metadata.description
object
Mostra attributi secondari
template.templateBody.section.items.file.actions.link.metadata.description.label
string
obbligatorio
template.templateBody.section.items.file.actions.link.text
string
obbligatorio
template.templateBody.section.items.file.actions.link.url
string
obbligatorio
template.templateBody.section.items.file.actions.type
string
obbligatorio
Possible values: link
template.templateBody.section.items.file.actions.reply
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.file.actions.reply.imageUrl
string
template.templateBody.section.items.file.actions.reply.metadata
object
Mostra attributi secondari
template.templateBody.section.items.file.actions.reply.metadata.description
object
Mostra attributi secondari
template.templateBody.section.items.file.actions.reply.metadata.description.label
string
obbligatorio
template.templateBody.section.items.file.actions.reply.text
string
obbligatorio
template.templateBody.section.items.file.actions.type
string
obbligatorio
Possible values: reply
template.templateBody.section.items.file.actions.locationRequest
object
Mostra attributi secondari
template.templateBody.section.items.file.actions.locationRequest.text
string
template.templateBody.section.items.file.actions.type
string
obbligatorio
Possible values: locationRequest
template.templateBody.section.items.file.actions.buy
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.file.actions.buy.amountCents
integer
obbligatorio
template.templateBody.section.items.file.actions.buy.currency
string
obbligatorio
template.templateBody.section.items.file.actions.buy.text
string
obbligatorio
template.templateBody.section.items.file.actions.type
string
obbligatorio
Possible values: buy
template.templateBody.section.items.file.actions.postback
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.file.actions.postback.handshake
object
Mostra attributi secondari
template.templateBody.section.items.file.actions.postback.handshake.packageName
string
obbligatorio
template.templateBody.section.items.file.actions.postback.handshake.signatureHash
string
obbligatorio
template.templateBody.section.items.file.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
template.templateBody.section.items.file.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
template.templateBody.section.items.file.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
template.templateBody.section.items.file.actions.postback.handshake.text
string
obbligatorio
template.templateBody.section.items.file.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
template.templateBody.section.items.file.actions.postback.imageUrl
string
template.templateBody.section.items.file.actions.postback.metadata
object
Mostra attributi secondari
template.templateBody.section.items.file.actions.postback.metadata.description
object
Mostra attributi secondari
template.templateBody.section.items.file.actions.postback.metadata.description.label
string
obbligatorio
template.templateBody.section.items.file.actions.postback.otpType
string
template.templateBody.section.items.file.actions.postback.payload
string
template.templateBody.section.items.file.actions.postback.text
string
obbligatorio
template.templateBody.section.items.file.actions.type
string
obbligatorio
Possible values: postback
template.templateBody.section.items.file.files
array of object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.file.files.altText
string
template.templateBody.section.items.file.files.contentType
string
obbligatorio
template.templateBody.section.items.file.files.filename
string
template.templateBody.section.items.file.files.mediaUrl
string
obbligatorio
template.templateBody.section.items.file.files.metadata
object
Mostra attributi secondari
template.templateBody.section.items.file.files.metadata.isAnimated
boolean
template.templateBody.section.items.file.metadata
object
Mostra attributi secondari
template.templateBody.section.items.file.metadata.fallbackText
string
template.templateBody.section.items.file.metadata.storyType
string
Possible values: mention, reply
template.templateBody.section.items.file.metadata.subject
string
template.templateBody.section.items.file.metadata.telegram
object
Mostra attributi secondari
template.templateBody.section.items.file.metadata.telegram.parseMode
string
template.templateBody.section.items.file.text
string
template.templateBody.section.items.type
string
obbligatorio
Possible values: file
template.templateBody.section.items.location
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.location.coordinates
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.location.coordinates.latitude
number
obbligatorio
template.templateBody.section.items.location.coordinates.longitude
number
obbligatorio
template.templateBody.section.items.location.location
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.location.location.address
string
obbligatorio
template.templateBody.section.items.location.location.label
string
obbligatorio
template.templateBody.section.items.type
string
obbligatorio
Possible values: location
template.templateBody.section.items.carousel
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.carousel.items
array of object
Mostra attributi secondari
template.templateBody.section.items.carousel.items.actions
array of object
Mostra attributi secondari
template.templateBody.section.items.carousel.items.actions.link
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.carousel.items.actions.link.metadata
object
Mostra attributi secondari
template.templateBody.section.items.carousel.items.actions.link.metadata.description
object
Mostra attributi secondari
template.templateBody.section.items.carousel.items.actions.link.metadata.description.label
string
obbligatorio
template.templateBody.section.items.carousel.items.actions.link.text
string
obbligatorio
template.templateBody.section.items.carousel.items.actions.link.url
string
obbligatorio
template.templateBody.section.items.carousel.items.actions.type
string
obbligatorio
Possible values: link
template.templateBody.section.items.carousel.items.actions.reply
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.carousel.items.actions.reply.imageUrl
string
template.templateBody.section.items.carousel.items.actions.reply.metadata
object
Mostra attributi secondari
template.templateBody.section.items.carousel.items.actions.reply.metadata.description
object
Mostra attributi secondari
template.templateBody.section.items.carousel.items.actions.reply.metadata.description.label
string
obbligatorio
template.templateBody.section.items.carousel.items.actions.reply.text
string
obbligatorio
template.templateBody.section.items.carousel.items.actions.type
string
obbligatorio
Possible values: reply
template.templateBody.section.items.carousel.items.actions.locationRequest
object
Mostra attributi secondari
template.templateBody.section.items.carousel.items.actions.locationRequest.text
string
template.templateBody.section.items.carousel.items.actions.type
string
obbligatorio
Possible values: locationRequest
template.templateBody.section.items.carousel.items.actions.buy
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.carousel.items.actions.buy.amountCents
integer
obbligatorio
template.templateBody.section.items.carousel.items.actions.buy.currency
string
obbligatorio
template.templateBody.section.items.carousel.items.actions.buy.text
string
obbligatorio
template.templateBody.section.items.carousel.items.actions.type
string
obbligatorio
Possible values: buy
template.templateBody.section.items.carousel.items.actions.postback
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.carousel.items.actions.postback.handshake
object
Mostra attributi secondari
template.templateBody.section.items.carousel.items.actions.postback.handshake.packageName
string
obbligatorio
template.templateBody.section.items.carousel.items.actions.postback.handshake.signatureHash
string
obbligatorio
template.templateBody.section.items.carousel.items.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
template.templateBody.section.items.carousel.items.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
template.templateBody.section.items.carousel.items.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
template.templateBody.section.items.carousel.items.actions.postback.handshake.text
string
obbligatorio
template.templateBody.section.items.carousel.items.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
template.templateBody.section.items.carousel.items.actions.postback.imageUrl
string
template.templateBody.section.items.carousel.items.actions.postback.metadata
object
Mostra attributi secondari
template.templateBody.section.items.carousel.items.actions.postback.metadata.description
object
Mostra attributi secondari
template.templateBody.section.items.carousel.items.actions.postback.metadata.description.label
string
obbligatorio
template.templateBody.section.items.carousel.items.actions.postback.otpType
string
template.templateBody.section.items.carousel.items.actions.postback.payload
string
template.templateBody.section.items.carousel.items.actions.postback.text
string
obbligatorio
template.templateBody.section.items.carousel.items.actions.type
string
obbligatorio
Possible values: postback
template.templateBody.section.items.carousel.items.altText
string
template.templateBody.section.items.carousel.items.description
string
template.templateBody.section.items.carousel.items.mediaUrl
string
template.templateBody.section.items.carousel.items.size
integer
template.templateBody.section.items.carousel.items.title
string
template.templateBody.section.items.carousel.text
string
Optional text displayed above the carousel cards.
template.templateBody.section.items.type
string
obbligatorio
Possible values: carousel
template.templateBody.section.items.list
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.list.actions
array of object
Mostra attributi secondari
template.templateBody.section.items.list.actions.link
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.list.actions.link.metadata
object
Mostra attributi secondari
template.templateBody.section.items.list.actions.link.metadata.description
object
Mostra attributi secondari
template.templateBody.section.items.list.actions.link.metadata.description.label
string
obbligatorio
template.templateBody.section.items.list.actions.link.text
string
obbligatorio
template.templateBody.section.items.list.actions.link.url
string
obbligatorio
template.templateBody.section.items.list.actions.type
string
obbligatorio
Possible values: link
template.templateBody.section.items.list.actions.reply
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.list.actions.reply.imageUrl
string
template.templateBody.section.items.list.actions.reply.metadata
object
Mostra attributi secondari
template.templateBody.section.items.list.actions.reply.metadata.description
object
Mostra attributi secondari
template.templateBody.section.items.list.actions.reply.metadata.description.label
string
obbligatorio
template.templateBody.section.items.list.actions.reply.text
string
obbligatorio
template.templateBody.section.items.list.actions.type
string
obbligatorio
Possible values: reply
template.templateBody.section.items.list.actions.locationRequest
object
Mostra attributi secondari
template.templateBody.section.items.list.actions.locationRequest.text
string
template.templateBody.section.items.list.actions.type
string
obbligatorio
Possible values: locationRequest
template.templateBody.section.items.list.actions.buy
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.list.actions.buy.amountCents
integer
obbligatorio
template.templateBody.section.items.list.actions.buy.currency
string
obbligatorio
template.templateBody.section.items.list.actions.buy.text
string
obbligatorio
template.templateBody.section.items.list.actions.type
string
obbligatorio
Possible values: buy
template.templateBody.section.items.list.actions.postback
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.list.actions.postback.handshake
object
Mostra attributi secondari
template.templateBody.section.items.list.actions.postback.handshake.packageName
string
obbligatorio
template.templateBody.section.items.list.actions.postback.handshake.signatureHash
string
obbligatorio
template.templateBody.section.items.list.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
template.templateBody.section.items.list.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
template.templateBody.section.items.list.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
template.templateBody.section.items.list.actions.postback.handshake.text
string
obbligatorio
template.templateBody.section.items.list.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
template.templateBody.section.items.list.actions.postback.imageUrl
string
template.templateBody.section.items.list.actions.postback.metadata
object
Mostra attributi secondari
template.templateBody.section.items.list.actions.postback.metadata.description
object
Mostra attributi secondari
template.templateBody.section.items.list.actions.postback.metadata.description.label
string
obbligatorio
template.templateBody.section.items.list.actions.postback.otpType
string
template.templateBody.section.items.list.actions.postback.payload
string
template.templateBody.section.items.list.actions.postback.text
string
obbligatorio
template.templateBody.section.items.list.actions.type
string
obbligatorio
Possible values: postback
template.templateBody.section.items.list.altText
string
template.templateBody.section.items.list.items
array of object
Mostra attributi secondari
template.templateBody.section.items.list.items.actions
array of object
Mostra attributi secondari
template.templateBody.section.items.list.items.actions.link
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.list.items.actions.link.metadata
object
Mostra attributi secondari
template.templateBody.section.items.list.items.actions.link.metadata.description
object
Mostra attributi secondari
template.templateBody.section.items.list.items.actions.link.metadata.description.label
string
obbligatorio
template.templateBody.section.items.list.items.actions.link.text
string
obbligatorio
template.templateBody.section.items.list.items.actions.link.url
string
obbligatorio
template.templateBody.section.items.list.items.actions.type
string
obbligatorio
Possible values: link
template.templateBody.section.items.list.items.actions.reply
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.list.items.actions.reply.imageUrl
string
template.templateBody.section.items.list.items.actions.reply.metadata
object
Mostra attributi secondari
template.templateBody.section.items.list.items.actions.reply.metadata.description
object
Mostra attributi secondari
template.templateBody.section.items.list.items.actions.reply.metadata.description.label
string
obbligatorio
template.templateBody.section.items.list.items.actions.reply.text
string
obbligatorio
template.templateBody.section.items.list.items.actions.type
string
obbligatorio
Possible values: reply
template.templateBody.section.items.list.items.actions.locationRequest
object
Mostra attributi secondari
template.templateBody.section.items.list.items.actions.locationRequest.text
string
template.templateBody.section.items.list.items.actions.type
string
obbligatorio
Possible values: locationRequest
template.templateBody.section.items.list.items.actions.buy
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.list.items.actions.buy.amountCents
integer
obbligatorio
template.templateBody.section.items.list.items.actions.buy.currency
string
obbligatorio
template.templateBody.section.items.list.items.actions.buy.text
string
obbligatorio
template.templateBody.section.items.list.items.actions.type
string
obbligatorio
Possible values: buy
template.templateBody.section.items.list.items.actions.postback
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.list.items.actions.postback.handshake
object
Mostra attributi secondari
template.templateBody.section.items.list.items.actions.postback.handshake.packageName
string
obbligatorio
template.templateBody.section.items.list.items.actions.postback.handshake.signatureHash
string
obbligatorio
template.templateBody.section.items.list.items.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
template.templateBody.section.items.list.items.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
template.templateBody.section.items.list.items.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
template.templateBody.section.items.list.items.actions.postback.handshake.text
string
obbligatorio
template.templateBody.section.items.list.items.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
template.templateBody.section.items.list.items.actions.postback.imageUrl
string
template.templateBody.section.items.list.items.actions.postback.metadata
object
Mostra attributi secondari
template.templateBody.section.items.list.items.actions.postback.metadata.description
object
Mostra attributi secondari
template.templateBody.section.items.list.items.actions.postback.metadata.description.label
string
obbligatorio
template.templateBody.section.items.list.items.actions.postback.otpType
string
template.templateBody.section.items.list.items.actions.postback.payload
string
template.templateBody.section.items.list.items.actions.postback.text
string
obbligatorio
template.templateBody.section.items.list.items.actions.type
string
obbligatorio
Possible values: postback
template.templateBody.section.items.list.items.altText
string
template.templateBody.section.items.list.items.description
string
template.templateBody.section.items.list.items.mediaUrl
string
template.templateBody.section.items.list.items.size
integer
template.templateBody.section.items.list.items.title
string
template.templateBody.section.items.list.metadata
object
Mostra attributi secondari
template.templateBody.section.items.list.metadata.button
object
Mostra attributi secondari
template.templateBody.section.items.list.metadata.button.label
string
obbligatorio
template.templateBody.section.items.list.metadata.replyMessage
object
Mostra attributi secondari
template.templateBody.section.items.list.metadata.replyMessage.text
string
obbligatorio
template.templateBody.section.items.list.metadata.replyMessage.title
string
obbligatorio
template.templateBody.section.items.list.text
string
template.templateBody.section.items.list.title
string
template.templateBody.section.items.type
string
obbligatorio
Possible values: list
template.templateBody.section.items.section
object
obbligatorio
template.templateBody.section.items.type
string
obbligatorio
Possible values: section
template.templateBody.section.items.authentication
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.authentication.otp
object
Mostra attributi secondari
template.templateBody.section.items.authentication.otp.actions
array of object
Mostra attributi secondari
template.templateBody.section.items.authentication.otp.actions.link
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.authentication.otp.actions.link.metadata
object
Mostra attributi secondari
template.templateBody.section.items.authentication.otp.actions.link.metadata.description
object
Mostra attributi secondari
template.templateBody.section.items.authentication.otp.actions.link.metadata.description.label
string
obbligatorio
template.templateBody.section.items.authentication.otp.actions.link.text
string
obbligatorio
template.templateBody.section.items.authentication.otp.actions.link.url
string
obbligatorio
template.templateBody.section.items.authentication.otp.actions.type
string
obbligatorio
Possible values: link
template.templateBody.section.items.authentication.otp.actions.reply
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.authentication.otp.actions.reply.imageUrl
string
template.templateBody.section.items.authentication.otp.actions.reply.metadata
object
Mostra attributi secondari
template.templateBody.section.items.authentication.otp.actions.reply.metadata.description
object
Mostra attributi secondari
template.templateBody.section.items.authentication.otp.actions.reply.metadata.description.label
string
obbligatorio
template.templateBody.section.items.authentication.otp.actions.reply.text
string
obbligatorio
template.templateBody.section.items.authentication.otp.actions.type
string
obbligatorio
Possible values: reply
template.templateBody.section.items.authentication.otp.actions.locationRequest
object
Mostra attributi secondari
template.templateBody.section.items.authentication.otp.actions.locationRequest.text
string
template.templateBody.section.items.authentication.otp.actions.type
string
obbligatorio
Possible values: locationRequest
template.templateBody.section.items.authentication.otp.actions.buy
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.authentication.otp.actions.buy.amountCents
integer
obbligatorio
template.templateBody.section.items.authentication.otp.actions.buy.currency
string
obbligatorio
template.templateBody.section.items.authentication.otp.actions.buy.text
string
obbligatorio
template.templateBody.section.items.authentication.otp.actions.type
string
obbligatorio
Possible values: buy
template.templateBody.section.items.authentication.otp.actions.postback
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.authentication.otp.actions.postback.handshake
object
Mostra attributi secondari
template.templateBody.section.items.authentication.otp.actions.postback.handshake.packageName
string
obbligatorio
template.templateBody.section.items.authentication.otp.actions.postback.handshake.signatureHash
string
obbligatorio
template.templateBody.section.items.authentication.otp.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
template.templateBody.section.items.authentication.otp.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
template.templateBody.section.items.authentication.otp.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
template.templateBody.section.items.authentication.otp.actions.postback.handshake.text
string
obbligatorio
template.templateBody.section.items.authentication.otp.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
template.templateBody.section.items.authentication.otp.actions.postback.imageUrl
string
template.templateBody.section.items.authentication.otp.actions.postback.metadata
object
Mostra attributi secondari
template.templateBody.section.items.authentication.otp.actions.postback.metadata.description
object
Mostra attributi secondari
template.templateBody.section.items.authentication.otp.actions.postback.metadata.description.label
string
obbligatorio
template.templateBody.section.items.authentication.otp.actions.postback.otpType
string
template.templateBody.section.items.authentication.otp.actions.postback.payload
string
template.templateBody.section.items.authentication.otp.actions.postback.text
string
obbligatorio
template.templateBody.section.items.authentication.otp.actions.type
string
obbligatorio
Possible values: postback
template.templateBody.section.items.authentication.otp.disclaimer
boolean
obbligatorio
Whether to add a security disclaimer to the authentication body.
template.templateBody.section.items.authentication.otp.expirationTime
integer
The number of seconds after which the authentication code expires. If not set, no expiration notification is sent.
template.templateBody.section.items.type
string
obbligatorio
Possible values: authentication
template.templateBody.section.items.action
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.action.action
string
obbligatorio
Possible values: permissionRequest
template.templateBody.section.items.action.permissionRequest
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.action.permissionRequest.resource
string
obbligatorio
Possible values: call
template.templateBody.section.items.type
string
obbligatorio
Possible values: action
template.templateBody.type
string
obbligatorio
Possible values: section
template.templateBody.authentication
object
obbligatorio
Mostra attributi secondari
template.templateBody.authentication.otp
object
Mostra attributi secondari
template.templateBody.authentication.otp.actions
array of object
Mostra attributi secondari
template.templateBody.authentication.otp.actions.link
object
obbligatorio
Mostra attributi secondari
template.templateBody.authentication.otp.actions.link.metadata
object
Mostra attributi secondari
template.templateBody.authentication.otp.actions.link.metadata.description
object
Mostra attributi secondari
template.templateBody.authentication.otp.actions.link.metadata.description.label
string
obbligatorio
template.templateBody.authentication.otp.actions.link.text
string
obbligatorio
template.templateBody.authentication.otp.actions.link.url
string
obbligatorio
template.templateBody.authentication.otp.actions.type
string
obbligatorio
Possible values: link
template.templateBody.authentication.otp.actions.reply
object
obbligatorio
Mostra attributi secondari
template.templateBody.authentication.otp.actions.reply.imageUrl
string
template.templateBody.authentication.otp.actions.reply.metadata
object
Mostra attributi secondari
template.templateBody.authentication.otp.actions.reply.metadata.description
object
Mostra attributi secondari
template.templateBody.authentication.otp.actions.reply.metadata.description.label
string
obbligatorio
template.templateBody.authentication.otp.actions.reply.text
string
obbligatorio
template.templateBody.authentication.otp.actions.type
string
obbligatorio
Possible values: reply
template.templateBody.authentication.otp.actions.locationRequest
object
Mostra attributi secondari
template.templateBody.authentication.otp.actions.locationRequest.text
string
template.templateBody.authentication.otp.actions.type
string
obbligatorio
Possible values: locationRequest
template.templateBody.authentication.otp.actions.buy
object
obbligatorio
Mostra attributi secondari
template.templateBody.authentication.otp.actions.buy.amountCents
integer
obbligatorio
template.templateBody.authentication.otp.actions.buy.currency
string
obbligatorio
template.templateBody.authentication.otp.actions.buy.text
string
obbligatorio
template.templateBody.authentication.otp.actions.type
string
obbligatorio
Possible values: buy
template.templateBody.authentication.otp.actions.postback
object
obbligatorio
Mostra attributi secondari
template.templateBody.authentication.otp.actions.postback.handshake
object
Mostra attributi secondari
template.templateBody.authentication.otp.actions.postback.handshake.packageName
string
obbligatorio
template.templateBody.authentication.otp.actions.postback.handshake.signatureHash
string
obbligatorio
template.templateBody.authentication.otp.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
template.templateBody.authentication.otp.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
template.templateBody.authentication.otp.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
template.templateBody.authentication.otp.actions.postback.handshake.text
string
obbligatorio
template.templateBody.authentication.otp.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
template.templateBody.authentication.otp.actions.postback.imageUrl
string
template.templateBody.authentication.otp.actions.postback.metadata
object
Mostra attributi secondari
template.templateBody.authentication.otp.actions.postback.metadata.description
object
Mostra attributi secondari
template.templateBody.authentication.otp.actions.postback.metadata.description.label
string
obbligatorio
template.templateBody.authentication.otp.actions.postback.otpType
string
template.templateBody.authentication.otp.actions.postback.payload
string
template.templateBody.authentication.otp.actions.postback.text
string
obbligatorio
template.templateBody.authentication.otp.actions.type
string
obbligatorio
Possible values: postback
template.templateBody.authentication.otp.disclaimer
boolean
obbligatorio
Whether to add a security disclaimer to the authentication body.
template.templateBody.authentication.otp.expirationTime
integer
The number of seconds after which the authentication code expires. If not set, no expiration notification is sent.
template.templateBody.type
string
obbligatorio
Possible values: authentication
template.templateBody.action
object
obbligatorio
Mostra attributi secondari
template.templateBody.action.action
string
obbligatorio
Possible values: permissionRequest
template.templateBody.action.permissionRequest
object
obbligatorio
Mostra attributi secondari
template.templateBody.action.permissionRequest.resource
string
obbligatorio
Possible values: call
template.templateBody.type
string
obbligatorio
Possible values: action
template.utmParameters
array of object
Mostra attributi secondari
template.utmParameters.key
string
obbligatorio
template.utmParameters.value
string
obbligatorio
template.utmParameters.key
string
obbligatorio
template.utmParameters.reference
string
obbligatorio
Possible values: platform_name, channel_name
template.variables
object
template.version
string
obbligatorio
The version of the template.
updatedAt
string
obbligatorio
templates
object
navigatorData
object
Mostra attributi secondari
navigatorData.attempts
array of object
Mostra attributi secondari
navigatorData.attempts.channelId
string
obbligatorio
navigatorData.attempts.messageId
string
obbligatorio
navigatorData.attempts.platformId
string
navigatorData.attempts.sender
string
navigatorData.attempts.attempt
integer
obbligatorio
navigatorData.attempts.createdAt
string
obbligatorio
navigatorData.attempts.status
string
obbligatorio
Possible values: accepted, processing, sent, sending_failed, delivered, delivery_failed, deleted, scheduled, skipped, rejected
navigatorData.attempts.failure
object
Mostra attributi secondari
navigatorData.attempts.failure.code
integer
omni channel interpretation of the failure to categorise the nature of message error
navigatorData.attempts.failure.description
string
human readable description of the error
navigatorData.attempts.failure.source
object
Mostra attributi secondari
navigatorData.attempts.failure.source.code
string
numerical, text or alphanumeric code that indicates the error or issue while delivering the message in the last step
navigatorData.attempts.failure.source.name
string
Possible values: pre-processing, accounting, contact, touchpoint, sms-messagebird, sms-twilio, email-messagebird, whatsapp, facebook, instagram, line, telegram, apple-business-chat, viber, chat, google-business-messages, voice, smtp-messagebird, rcs-google, service
Esempio di codice
curl -X POST 'https://api.bird.com/workspaces/{workspaceId}/navigators/{navigatorId}/messages' \
-H 'Authorization: AccessKey YOUR_ACCESS_KEY'The navigator message will contain navigator metadata, including.
Navigator information
providing UUID relevant to both the navigator objection and the navigator message objects
Esempio di codice
"meta": {
"navigatorId": "5f40c7f0-5904-4d68-8840-a1a5dc3e36c3",
"navigatorMessageId": "5ec65d4f-53b0-45f8-8f83-b177f976b3e3"
},Attempts
Navigator may attempt to send messages via more than one channel. attempts will list and providing information about all channels a navigator used when handling a given message
Esempio di codice
"navigatorData": {
"attempts": [
{
"channelId": "6f50cd25-d416-44d3-bf63-de88a60129d0",
"messageId": "3ecadc0d-cf7c-4b2a-90bc-fed5a3f6a26e",
"attempt": 1,
"status": "accepted",
"createdAt": "2024-07-18T14:04:18.214Z"
}You can get messages sent to a navigator by making a request to the channel endpoint that accepted the message based on the response above
Check Navigators Messages Status Reports
To receive status reports about messages, you will need webhook subscriptions. You can create the via UI
Configure Webhook Subscriptions
Navigators Webhooks
We recommend subscribing at least to navigator.outbound. Navigator event will provide you information about any fallback as well the status of your navigator messages.
Note: Navigator message status reflects the final outcome of all delivery attempts made by the Navigator. For example, if a WhatsApp delivery fails but the fallback via SMS succeeds, the navigator message status will be marked as "Delivered."
For the payload field by field, the events available per channel, and a worked example of monitoring an RCS send that falls back to SMS, see OTT channels and fallback.
Esempio di codice
{"service": "channels",
"event": "navigator.outbound",
"payload": {
"id": "00000000-0000-0000-0000-100000000000",
"navigatorId": {navigatorI},
"reference": "",
"attempts": [
{
"channelId": {channelId},
"platformId": "rcs-google",
"messageId": "00000000-0000-0000-0000-000000000000",
"attempt": 1,
"status": "sending_failed",
"createdAt": "2024-12-24T09:52:54.524Z"
},
{
"channelId": {channelId},
"platformId": "whatsapp",
"messageId": "00000000-0000-0000-0000-000000000001",
"attempt": 2,
"status": "sending_failed",
"createdAt": "2024-12-24T09:52:54.524Z",
"failure": {
"code": 12006,
"description": "Invalid message",
"source": {
"name": "pre-processing"
}
}
},
{
"channelId": {channelId},
"platformId": "sms-messagebird",
"messageId": "00000000-0000-0000-0000-000000000002",
"attempt": 3,
"status": "delivered",
"createdAt": "2024-12-24T09:52:54.524Z"
}
],
"status": "delivered",
"createdAt": "2024-12-24T09:52:54.524Z",
"updatedAt": "2024-12-24T09:52:55.855Z"
}
}
Optional: channel Webhooks
If you are interested in diving deep on specific attempts status you can also subscribe to sms.outbound and one for whatsapp.outbound . When doing so you will be able to retrieve the navigator ID and navigator message id in the meta field.
Esempio di codice
"meta": {
"navigatorId": "91af46ab-70ba-5152-a611-812cad0fbd71",
"navigatorMessageId": "defe9d3b-9cea-4585-9f67-2a4f1d93101a"
}
Check Incoming Messages
If you've only sent SMS messages before—especially if you haven’t operated in the U.S.—you’ve likely only used a one-way channel. WhatsApp, however, is a two-way channel by design, so users may try to contact you there. When using a Navigator to send both SMS and r WhatsApp traffic, it’s essential to monitor incoming messages to avoid missing user inquiries. Ignoring users can lead to frustration and could result in them reporting your channel to Meta, potentially causing suspension.
Programmatically
You can subscribe to sms.inbound and whatsapp.inbound event to capture all incoming messages in your workspace
NOTE incoming messages will not be linked to a navigator and will nto have the navigator information in the meta field
Via UI
If you navigate to the customer service section of our side panel you can find all incoming conversations in the entry corresponding to yours SMS or WhatsApp channels.
GET
/workspaces/{workspaceId}/channels/{channelId}/messages/{messageId}
Get a channel message
Payload della risposta
body
object
Mostra attributi secondari
body.text
object
obbligatorio
Mostra attributi secondari
body.text.actions
array of object
Mostra attributi secondari
body.text.actions.link
object
obbligatorio
Mostra attributi secondari
body.text.actions.link.metadata
object
Mostra attributi secondari
body.text.actions.link.metadata.description
object
Mostra attributi secondari
body.text.actions.link.metadata.description.label
string
obbligatorio
body.text.actions.link.text
string
obbligatorio
body.text.actions.link.url
string
obbligatorio
body.text.actions.type
string
obbligatorio
Possible values: link
body.text.actions.reply
object
obbligatorio
Mostra attributi secondari
body.text.actions.reply.imageUrl
string
body.text.actions.reply.metadata
object
Mostra attributi secondari
body.text.actions.reply.metadata.description
object
Mostra attributi secondari
body.text.actions.reply.metadata.description.label
string
obbligatorio
body.text.actions.reply.text
string
obbligatorio
body.text.actions.type
string
obbligatorio
Possible values: reply
body.text.actions.locationRequest
object
Mostra attributi secondari
body.text.actions.locationRequest.text
string
body.text.actions.type
string
obbligatorio
Possible values: locationRequest
body.text.actions.buy
object
obbligatorio
Mostra attributi secondari
body.text.actions.buy.amountCents
integer
obbligatorio
body.text.actions.buy.currency
string
obbligatorio
body.text.actions.buy.text
string
obbligatorio
body.text.actions.type
string
obbligatorio
Possible values: buy
body.text.actions.postback
object
obbligatorio
Mostra attributi secondari
body.text.actions.postback.handshake
object
Mostra attributi secondari
body.text.actions.postback.handshake.packageName
string
obbligatorio
body.text.actions.postback.handshake.signatureHash
string
obbligatorio
body.text.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
body.text.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
body.text.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
body.text.actions.postback.handshake.text
string
obbligatorio
body.text.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
body.text.actions.postback.imageUrl
string
body.text.actions.postback.metadata
object
Mostra attributi secondari
body.text.actions.postback.metadata.description
object
Mostra attributi secondari
body.text.actions.postback.metadata.description.label
string
obbligatorio
body.text.actions.postback.otpType
string
body.text.actions.postback.payload
string
body.text.actions.postback.text
string
obbligatorio
body.text.actions.type
string
obbligatorio
Possible values: postback
body.text.attachments
array of object
Mostra attributi secondari
body.text.attachments.content
string
body.text.attachments.contentId
string
body.text.attachments.contentType
string
body.text.attachments.filename
string
obbligatorio
body.text.attachments.inline
boolean
body.text.attachments.mediaUrl
string
obbligatorio
body.text.metadata
object
Mostra attributi secondari
body.text.metadata.apple
object
Mostra attributi secondari
body.text.metadata.apple.appClipPreview
boolean
body.text.metadata.apple.appClipRegion
string
body.text.metadata.apple.summaryText
string
body.text.metadata.headers
object
body.text.metadata.line
object
Mostra attributi secondari
body.text.metadata.line.emoji
object
Mostra attributi secondari
body.text.metadata.line.emoji.items
array of object
Mostra attributi secondari
body.text.metadata.line.emoji.items.emojiId
string
obbligatorio
body.text.metadata.line.emoji.items.index
integer
obbligatorio
body.text.metadata.line.emoji.items.length
integer
body.text.metadata.line.emoji.items.productId
string
obbligatorio
body.text.metadata.paymentDetails
object
Mostra attributi secondari
body.text.metadata.paymentDetails.amount
string
obbligatorio
body.text.metadata.paymentDetails.currency
string
obbligatorio
body.text.metadata.paymentDetails.sessionIdentifier
string
body.text.metadata.paymentDetails.state
string
obbligatorio
body.text.metadata.subject
string
body.text.metadata.telegram
object
Mostra attributi secondari
body.text.metadata.telegram.parseMode
string
body.text.metadata.whatsapp
object
Mostra attributi secondari
body.text.metadata.whatsapp.callPermissionExpiration
string
body.text.metadata.whatsapp.callPermissionResponse
string
Possible values: accept, reject
body.text.metadata.whatsapp.previewUrl
boolean
obbligatorio
body.text.metadata.whatsapp.sharedContacts
array of object
Mostra attributi secondari
body.text.metadata.whatsapp.sharedContacts.origin
string
obbligatorio
body.text.metadata.whatsapp.sharedContacts.phones
array of object
Mostra attributi secondari
body.text.metadata.whatsapp.sharedContacts.phones.phone
string
obbligatorio
body.text.metadata.whatsapp.sharedContacts.phones.type
string
obbligatorio
body.text.metadata.whatsapp.sharedContacts.phones.waId
string
obbligatorio
body.text.metadata.whatsapp.sharedContacts.vcard
string
body.text.text
string
obbligatorio
body.type
string
obbligatorio
Possible values: text
body.html
object
obbligatorio
Mostra attributi secondari
body.html.actions
array of object
Mostra attributi secondari
body.html.actions.link
object
obbligatorio
Mostra attributi secondari
body.html.actions.link.metadata
object
Mostra attributi secondari
body.html.actions.link.metadata.description
object
Mostra attributi secondari
body.html.actions.link.metadata.description.label
string
obbligatorio
body.html.actions.link.text
string
obbligatorio
body.html.actions.link.url
string
obbligatorio
body.html.actions.type
string
obbligatorio
Possible values: link
body.html.actions.reply
object
obbligatorio
Mostra attributi secondari
body.html.actions.reply.imageUrl
string
body.html.actions.reply.metadata
object
Mostra attributi secondari
body.html.actions.reply.metadata.description
object
Mostra attributi secondari
body.html.actions.reply.metadata.description.label
string
obbligatorio
body.html.actions.reply.text
string
obbligatorio
body.html.actions.type
string
obbligatorio
Possible values: reply
body.html.actions.locationRequest
object
Mostra attributi secondari
body.html.actions.locationRequest.text
string
body.html.actions.type
string
obbligatorio
Possible values: locationRequest
body.html.actions.buy
object
obbligatorio
Mostra attributi secondari
body.html.actions.buy.amountCents
integer
obbligatorio
body.html.actions.buy.currency
string
obbligatorio
body.html.actions.buy.text
string
obbligatorio
body.html.actions.type
string
obbligatorio
Possible values: buy
body.html.actions.postback
object
obbligatorio
Mostra attributi secondari
body.html.actions.postback.handshake
object
Mostra attributi secondari
body.html.actions.postback.handshake.packageName
string
obbligatorio
body.html.actions.postback.handshake.signatureHash
string
obbligatorio
body.html.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
body.html.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
body.html.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
body.html.actions.postback.handshake.text
string
obbligatorio
body.html.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
body.html.actions.postback.imageUrl
string
body.html.actions.postback.metadata
object
Mostra attributi secondari
body.html.actions.postback.metadata.description
object
Mostra attributi secondari
body.html.actions.postback.metadata.description.label
string
obbligatorio
body.html.actions.postback.otpType
string
body.html.actions.postback.payload
string
body.html.actions.postback.text
string
obbligatorio
body.html.actions.type
string
obbligatorio
Possible values: postback
body.html.attachments
array of object
Mostra attributi secondari
body.html.attachments.content
string
body.html.attachments.contentId
string
body.html.attachments.contentType
string
body.html.attachments.filename
string
obbligatorio
body.html.attachments.inline
boolean
body.html.attachments.mediaUrl
string
body.html.html
string
body.html.metadata
object
Mostra attributi secondari
body.html.metadata.clickTracking
boolean
body.html.metadata.from
object
Mostra attributi secondari
body.html.metadata.from.displayName
string
body.html.metadata.from.username
string
body.html.metadata.headers
object
body.html.metadata.initialOpenTracking
boolean
body.html.metadata.openTracking
boolean
body.html.metadata.subject
string
body.html.text
string
body.type
string
obbligatorio
Possible values: html
body.image
object
obbligatorio
Mostra attributi secondari
body.image.actions
array of object
Mostra attributi secondari
body.image.actions.link
object
obbligatorio
Mostra attributi secondari
body.image.actions.link.metadata
object
Mostra attributi secondari
body.image.actions.link.metadata.description
object
Mostra attributi secondari
body.image.actions.link.metadata.description.label
string
obbligatorio
body.image.actions.link.text
string
obbligatorio
body.image.actions.link.url
string
obbligatorio
body.image.actions.type
string
obbligatorio
Possible values: link
body.image.actions.reply
object
obbligatorio
Mostra attributi secondari
body.image.actions.reply.imageUrl
string
body.image.actions.reply.metadata
object
Mostra attributi secondari
body.image.actions.reply.metadata.description
object
Mostra attributi secondari
body.image.actions.reply.metadata.description.label
string
obbligatorio
body.image.actions.reply.text
string
obbligatorio
body.image.actions.type
string
obbligatorio
Possible values: reply
body.image.actions.locationRequest
object
Mostra attributi secondari
body.image.actions.locationRequest.text
string
body.image.actions.type
string
obbligatorio
Possible values: locationRequest
body.image.actions.buy
object
obbligatorio
Mostra attributi secondari
body.image.actions.buy.amountCents
integer
obbligatorio
body.image.actions.buy.currency
string
obbligatorio
body.image.actions.buy.text
string
obbligatorio
body.image.actions.type
string
obbligatorio
Possible values: buy
body.image.actions.postback
object
obbligatorio
Mostra attributi secondari
body.image.actions.postback.handshake
object
Mostra attributi secondari
body.image.actions.postback.handshake.packageName
string
obbligatorio
body.image.actions.postback.handshake.signatureHash
string
obbligatorio
body.image.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
body.image.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
body.image.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
body.image.actions.postback.handshake.text
string
obbligatorio
body.image.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
body.image.actions.postback.imageUrl
string
body.image.actions.postback.metadata
object
Mostra attributi secondari
body.image.actions.postback.metadata.description
object
Mostra attributi secondari
body.image.actions.postback.metadata.description.label
string
obbligatorio
body.image.actions.postback.otpType
string
body.image.actions.postback.payload
string
body.image.actions.postback.text
string
obbligatorio
body.image.actions.type
string
obbligatorio
Possible values: postback
body.image.images
array of object
obbligatorio
Mostra attributi secondari
body.image.images.altText
string
body.image.images.mediaPreviewUrl
string
body.image.images.mediaUrl
string
obbligatorio
body.image.metadata
object
Mostra attributi secondari
body.image.metadata.fallbackText
string
body.image.metadata.storyType
string
Possible values: mention, reply
body.image.metadata.subject
string
body.image.metadata.telegram
object
Mostra attributi secondari
body.image.metadata.telegram.parseMode
string
body.image.text
string
body.type
string
obbligatorio
Possible values: image
body.gif
object
obbligatorio
Mostra attributi secondari
body.gif.actions
array of object
Mostra attributi secondari
body.gif.actions.link
object
obbligatorio
Mostra attributi secondari
body.gif.actions.link.metadata
object
Mostra attributi secondari
body.gif.actions.link.metadata.description
object
Mostra attributi secondari
body.gif.actions.link.metadata.description.label
string
obbligatorio
body.gif.actions.link.text
string
obbligatorio
body.gif.actions.link.url
string
obbligatorio
body.gif.actions.type
string
obbligatorio
Possible values: link
body.gif.actions.reply
object
obbligatorio
Mostra attributi secondari
body.gif.actions.reply.imageUrl
string
body.gif.actions.reply.metadata
object
Mostra attributi secondari
body.gif.actions.reply.metadata.description
object
Mostra attributi secondari
body.gif.actions.reply.metadata.description.label
string
obbligatorio
body.gif.actions.reply.text
string
obbligatorio
body.gif.actions.type
string
obbligatorio
Possible values: reply
body.gif.actions.locationRequest
object
Mostra attributi secondari
body.gif.actions.locationRequest.text
string
body.gif.actions.type
string
obbligatorio
Possible values: locationRequest
body.gif.actions.buy
object
obbligatorio
Mostra attributi secondari
body.gif.actions.buy.amountCents
integer
obbligatorio
body.gif.actions.buy.currency
string
obbligatorio
body.gif.actions.buy.text
string
obbligatorio
body.gif.actions.type
string
obbligatorio
Possible values: buy
body.gif.actions.postback
object
obbligatorio
Mostra attributi secondari
body.gif.actions.postback.handshake
object
Mostra attributi secondari
body.gif.actions.postback.handshake.packageName
string
obbligatorio
body.gif.actions.postback.handshake.signatureHash
string
obbligatorio
body.gif.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
body.gif.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
body.gif.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
body.gif.actions.postback.handshake.text
string
obbligatorio
body.gif.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
body.gif.actions.postback.imageUrl
string
body.gif.actions.postback.metadata
object
Mostra attributi secondari
body.gif.actions.postback.metadata.description
object
Mostra attributi secondari
body.gif.actions.postback.metadata.description.label
string
obbligatorio
body.gif.actions.postback.otpType
string
body.gif.actions.postback.payload
string
body.gif.actions.postback.text
string
obbligatorio
body.gif.actions.type
string
obbligatorio
Possible values: postback
body.gif.altText
string
body.gif.mediaUrl
string
obbligatorio
body.gif.metadata
object
Mostra attributi secondari
body.gif.metadata.telegram
object
Mostra attributi secondari
body.gif.metadata.telegram.parseMode
string
body.gif.text
string
body.type
string
obbligatorio
Possible values: gif
body.file
object
obbligatorio
Mostra attributi secondari
body.file.actions
array of object
Mostra attributi secondari
body.file.actions.link
object
obbligatorio
Mostra attributi secondari
body.file.actions.link.metadata
object
Mostra attributi secondari
body.file.actions.link.metadata.description
object
Mostra attributi secondari
body.file.actions.link.metadata.description.label
string
obbligatorio
body.file.actions.link.text
string
obbligatorio
body.file.actions.link.url
string
obbligatorio
body.file.actions.type
string
obbligatorio
Possible values: link
body.file.actions.reply
object
obbligatorio
Mostra attributi secondari
body.file.actions.reply.imageUrl
string
body.file.actions.reply.metadata
object
Mostra attributi secondari
body.file.actions.reply.metadata.description
object
Mostra attributi secondari
body.file.actions.reply.metadata.description.label
string
obbligatorio
body.file.actions.reply.text
string
obbligatorio
body.file.actions.type
string
obbligatorio
Possible values: reply
body.file.actions.locationRequest
object
Mostra attributi secondari
body.file.actions.locationRequest.text
string
body.file.actions.type
string
obbligatorio
Possible values: locationRequest
body.file.actions.buy
object
obbligatorio
Mostra attributi secondari
body.file.actions.buy.amountCents
integer
obbligatorio
body.file.actions.buy.currency
string
obbligatorio
body.file.actions.buy.text
string
obbligatorio
body.file.actions.type
string
obbligatorio
Possible values: buy
body.file.actions.postback
object
obbligatorio
Mostra attributi secondari
body.file.actions.postback.handshake
object
Mostra attributi secondari
body.file.actions.postback.handshake.packageName
string
obbligatorio
body.file.actions.postback.handshake.signatureHash
string
obbligatorio
body.file.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
body.file.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
body.file.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
body.file.actions.postback.handshake.text
string
obbligatorio
body.file.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
body.file.actions.postback.imageUrl
string
body.file.actions.postback.metadata
object
Mostra attributi secondari
body.file.actions.postback.metadata.description
object
Mostra attributi secondari
body.file.actions.postback.metadata.description.label
string
obbligatorio
body.file.actions.postback.otpType
string
body.file.actions.postback.payload
string
body.file.actions.postback.text
string
obbligatorio
body.file.actions.type
string
obbligatorio
Possible values: postback
body.file.files
array of object
obbligatorio
Mostra attributi secondari
body.file.files.altText
string
body.file.files.contentType
string
obbligatorio
body.file.files.filename
string
body.file.files.mediaUrl
string
obbligatorio
body.file.files.metadata
object
Mostra attributi secondari
body.file.files.metadata.isAnimated
boolean
body.file.metadata
object
Mostra attributi secondari
body.file.metadata.fallbackText
string
body.file.metadata.storyType
string
Possible values: mention, reply
body.file.metadata.subject
string
body.file.metadata.telegram
object
Mostra attributi secondari
body.file.metadata.telegram.parseMode
string
body.file.text
string
body.type
string
obbligatorio
Possible values: file
body.location
object
obbligatorio
Mostra attributi secondari
body.location.coordinates
object
obbligatorio
Mostra attributi secondari
body.location.coordinates.latitude
number
obbligatorio
body.location.coordinates.longitude
number
obbligatorio
body.location.location
object
obbligatorio
Mostra attributi secondari
body.location.location.address
string
obbligatorio
body.location.location.label
string
obbligatorio
body.type
string
obbligatorio
Possible values: location
body.carousel
object
obbligatorio
Mostra attributi secondari
body.carousel.items
array of object
Mostra attributi secondari
body.carousel.items.actions
array of object
Mostra attributi secondari
body.carousel.items.actions.link
object
obbligatorio
Mostra attributi secondari
body.carousel.items.actions.link.metadata
object
Mostra attributi secondari
body.carousel.items.actions.link.metadata.description
object
Mostra attributi secondari
body.carousel.items.actions.link.metadata.description.label
string
obbligatorio
body.carousel.items.actions.link.text
string
obbligatorio
body.carousel.items.actions.link.url
string
obbligatorio
body.carousel.items.actions.type
string
obbligatorio
Possible values: link
body.carousel.items.actions.reply
object
obbligatorio
Mostra attributi secondari
body.carousel.items.actions.reply.imageUrl
string
body.carousel.items.actions.reply.metadata
object
Mostra attributi secondari
body.carousel.items.actions.reply.metadata.description
object
Mostra attributi secondari
body.carousel.items.actions.reply.metadata.description.label
string
obbligatorio
body.carousel.items.actions.reply.text
string
obbligatorio
body.carousel.items.actions.type
string
obbligatorio
Possible values: reply
body.carousel.items.actions.locationRequest
object
Mostra attributi secondari
body.carousel.items.actions.locationRequest.text
string
body.carousel.items.actions.type
string
obbligatorio
Possible values: locationRequest
body.carousel.items.actions.buy
object
obbligatorio
Mostra attributi secondari
body.carousel.items.actions.buy.amountCents
integer
obbligatorio
body.carousel.items.actions.buy.currency
string
obbligatorio
body.carousel.items.actions.buy.text
string
obbligatorio
body.carousel.items.actions.type
string
obbligatorio
Possible values: buy
body.carousel.items.actions.postback
object
obbligatorio
Mostra attributi secondari
body.carousel.items.actions.postback.handshake
object
Mostra attributi secondari
body.carousel.items.actions.postback.handshake.packageName
string
obbligatorio
body.carousel.items.actions.postback.handshake.signatureHash
string
obbligatorio
body.carousel.items.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
body.carousel.items.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
body.carousel.items.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
body.carousel.items.actions.postback.handshake.text
string
obbligatorio
body.carousel.items.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
body.carousel.items.actions.postback.imageUrl
string
body.carousel.items.actions.postback.metadata
object
Mostra attributi secondari
body.carousel.items.actions.postback.metadata.description
object
Mostra attributi secondari
body.carousel.items.actions.postback.metadata.description.label
string
obbligatorio
body.carousel.items.actions.postback.otpType
string
body.carousel.items.actions.postback.payload
string
body.carousel.items.actions.postback.text
string
obbligatorio
body.carousel.items.actions.type
string
obbligatorio
Possible values: postback
body.carousel.items.altText
string
body.carousel.items.description
string
body.carousel.items.mediaUrl
string
body.carousel.items.size
integer
body.carousel.items.title
string
body.carousel.text
string
Optional text displayed above the carousel cards.
body.type
string
obbligatorio
Possible values: carousel
body.list
object
obbligatorio
Mostra attributi secondari
body.list.actions
array of object
Mostra attributi secondari
body.list.actions.link
object
obbligatorio
Mostra attributi secondari
body.list.actions.link.metadata
object
Mostra attributi secondari
body.list.actions.link.metadata.description
object
Mostra attributi secondari
body.list.actions.link.metadata.description.label
string
obbligatorio
body.list.actions.link.text
string
obbligatorio
body.list.actions.link.url
string
obbligatorio
body.list.actions.type
string
obbligatorio
Possible values: link
body.list.actions.reply
object
obbligatorio
Mostra attributi secondari
body.list.actions.reply.imageUrl
string
body.list.actions.reply.metadata
object
Mostra attributi secondari
body.list.actions.reply.metadata.description
object
Mostra attributi secondari
body.list.actions.reply.metadata.description.label
string
obbligatorio
body.list.actions.reply.text
string
obbligatorio
body.list.actions.type
string
obbligatorio
Possible values: reply
body.list.actions.locationRequest
object
Mostra attributi secondari
body.list.actions.locationRequest.text
string
body.list.actions.type
string
obbligatorio
Possible values: locationRequest
body.list.actions.buy
object
obbligatorio
Mostra attributi secondari
body.list.actions.buy.amountCents
integer
obbligatorio
body.list.actions.buy.currency
string
obbligatorio
body.list.actions.buy.text
string
obbligatorio
body.list.actions.type
string
obbligatorio
Possible values: buy
body.list.actions.postback
object
obbligatorio
Mostra attributi secondari
body.list.actions.postback.handshake
object
Mostra attributi secondari
body.list.actions.postback.handshake.packageName
string
obbligatorio
body.list.actions.postback.handshake.signatureHash
string
obbligatorio
body.list.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
body.list.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
body.list.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
body.list.actions.postback.handshake.text
string
obbligatorio
body.list.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
body.list.actions.postback.imageUrl
string
body.list.actions.postback.metadata
object
Mostra attributi secondari
body.list.actions.postback.metadata.description
object
Mostra attributi secondari
body.list.actions.postback.metadata.description.label
string
obbligatorio
body.list.actions.postback.otpType
string
body.list.actions.postback.payload
string
body.list.actions.postback.text
string
obbligatorio
body.list.actions.type
string
obbligatorio
Possible values: postback
body.list.altText
string
body.list.items
array of object
Mostra attributi secondari
body.list.items.actions
array of object
Mostra attributi secondari
body.list.items.actions.link
object
obbligatorio
Mostra attributi secondari
body.list.items.actions.link.metadata
object
Mostra attributi secondari
body.list.items.actions.link.metadata.description
object
Mostra attributi secondari
body.list.items.actions.link.metadata.description.label
string
obbligatorio
body.list.items.actions.link.text
string
obbligatorio
body.list.items.actions.link.url
string
obbligatorio
body.list.items.actions.type
string
obbligatorio
Possible values: link
body.list.items.actions.reply
object
obbligatorio
Mostra attributi secondari
body.list.items.actions.reply.imageUrl
string
body.list.items.actions.reply.metadata
object
Mostra attributi secondari
body.list.items.actions.reply.metadata.description
object
Mostra attributi secondari
body.list.items.actions.reply.metadata.description.label
string
obbligatorio
body.list.items.actions.reply.text
string
obbligatorio
body.list.items.actions.type
string
obbligatorio
Possible values: reply
body.list.items.actions.locationRequest
object
Mostra attributi secondari
body.list.items.actions.locationRequest.text
string
body.list.items.actions.type
string
obbligatorio
Possible values: locationRequest
body.list.items.actions.buy
object
obbligatorio
Mostra attributi secondari
body.list.items.actions.buy.amountCents
integer
obbligatorio
body.list.items.actions.buy.currency
string
obbligatorio
body.list.items.actions.buy.text
string
obbligatorio
body.list.items.actions.type
string
obbligatorio
Possible values: buy
body.list.items.actions.postback
object
obbligatorio
Mostra attributi secondari
body.list.items.actions.postback.handshake
object
Mostra attributi secondari
body.list.items.actions.postback.handshake.packageName
string
obbligatorio
body.list.items.actions.postback.handshake.signatureHash
string
obbligatorio
body.list.items.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
body.list.items.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
body.list.items.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
body.list.items.actions.postback.handshake.text
string
obbligatorio
body.list.items.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
body.list.items.actions.postback.imageUrl
string
body.list.items.actions.postback.metadata
object
Mostra attributi secondari
body.list.items.actions.postback.metadata.description
object
Mostra attributi secondari
body.list.items.actions.postback.metadata.description.label
string
obbligatorio
body.list.items.actions.postback.otpType
string
body.list.items.actions.postback.payload
string
body.list.items.actions.postback.text
string
obbligatorio
body.list.items.actions.type
string
obbligatorio
Possible values: postback
body.list.items.altText
string
body.list.items.description
string
body.list.items.mediaUrl
string
body.list.items.size
integer
body.list.items.title
string
body.list.metadata
object
Mostra attributi secondari
body.list.metadata.button
object
Mostra attributi secondari
body.list.metadata.button.label
string
obbligatorio
body.list.metadata.replyMessage
object
Mostra attributi secondari
body.list.metadata.replyMessage.text
string
obbligatorio
body.list.metadata.replyMessage.title
string
obbligatorio
body.list.text
string
body.list.title
string
body.type
string
obbligatorio
Possible values: list
body.section
object
obbligatorio
Mostra attributi secondari
body.section.configurations
object
body.section.items
array of object
Mostra attributi secondari
body.section.items.text
object
obbligatorio
Mostra attributi secondari
body.section.items.text.actions
array of object
Mostra attributi secondari
body.section.items.text.actions.link
object
obbligatorio
Mostra attributi secondari
body.section.items.text.actions.link.metadata
object
Mostra attributi secondari
body.section.items.text.actions.link.metadata.description
object
Mostra attributi secondari
body.section.items.text.actions.link.metadata.description.label
string
obbligatorio
body.section.items.text.actions.link.text
string
obbligatorio
body.section.items.text.actions.link.url
string
obbligatorio
body.section.items.text.actions.type
string
obbligatorio
Possible values: link
body.section.items.text.actions.reply
object
obbligatorio
Mostra attributi secondari
body.section.items.text.actions.reply.imageUrl
string
body.section.items.text.actions.reply.metadata
object
Mostra attributi secondari
body.section.items.text.actions.reply.metadata.description
object
Mostra attributi secondari
body.section.items.text.actions.reply.metadata.description.label
string
obbligatorio
body.section.items.text.actions.reply.text
string
obbligatorio
body.section.items.text.actions.type
string
obbligatorio
Possible values: reply
body.section.items.text.actions.locationRequest
object
Mostra attributi secondari
body.section.items.text.actions.locationRequest.text
string
body.section.items.text.actions.type
string
obbligatorio
Possible values: locationRequest
body.section.items.text.actions.buy
object
obbligatorio
Mostra attributi secondari
body.section.items.text.actions.buy.amountCents
integer
obbligatorio
body.section.items.text.actions.buy.currency
string
obbligatorio
body.section.items.text.actions.buy.text
string
obbligatorio
body.section.items.text.actions.type
string
obbligatorio
Possible values: buy
body.section.items.text.actions.postback
object
obbligatorio
Mostra attributi secondari
body.section.items.text.actions.postback.handshake
object
Mostra attributi secondari
body.section.items.text.actions.postback.handshake.packageName
string
obbligatorio
body.section.items.text.actions.postback.handshake.signatureHash
string
obbligatorio
body.section.items.text.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
body.section.items.text.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
body.section.items.text.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
body.section.items.text.actions.postback.handshake.text
string
obbligatorio
body.section.items.text.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
body.section.items.text.actions.postback.imageUrl
string
body.section.items.text.actions.postback.metadata
object
Mostra attributi secondari
body.section.items.text.actions.postback.metadata.description
object
Mostra attributi secondari
body.section.items.text.actions.postback.metadata.description.label
string
obbligatorio
body.section.items.text.actions.postback.otpType
string
body.section.items.text.actions.postback.payload
string
body.section.items.text.actions.postback.text
string
obbligatorio
body.section.items.text.actions.type
string
obbligatorio
Possible values: postback
body.section.items.text.attachments
array of object
Mostra attributi secondari
body.section.items.text.attachments.content
string
body.section.items.text.attachments.contentId
string
body.section.items.text.attachments.contentType
string
body.section.items.text.attachments.filename
string
obbligatorio
body.section.items.text.attachments.inline
boolean
body.section.items.text.attachments.mediaUrl
string
obbligatorio
body.section.items.text.metadata
object
Mostra attributi secondari
body.section.items.text.metadata.apple
object
Mostra attributi secondari
body.section.items.text.metadata.apple.appClipPreview
boolean
body.section.items.text.metadata.apple.appClipRegion
string
body.section.items.text.metadata.apple.summaryText
string
body.section.items.text.metadata.headers
object
body.section.items.text.metadata.line
object
Mostra attributi secondari
body.section.items.text.metadata.line.emoji
object
Mostra attributi secondari
body.section.items.text.metadata.line.emoji.items
array of object
Mostra attributi secondari
body.section.items.text.metadata.line.emoji.items.emojiId
string
obbligatorio
body.section.items.text.metadata.line.emoji.items.index
integer
obbligatorio
body.section.items.text.metadata.line.emoji.items.length
integer
body.section.items.text.metadata.line.emoji.items.productId
string
obbligatorio
body.section.items.text.metadata.paymentDetails
object
Mostra attributi secondari
body.section.items.text.metadata.paymentDetails.amount
string
obbligatorio
body.section.items.text.metadata.paymentDetails.currency
string
obbligatorio
body.section.items.text.metadata.paymentDetails.sessionIdentifier
string
body.section.items.text.metadata.paymentDetails.state
string
obbligatorio
body.section.items.text.metadata.subject
string
body.section.items.text.metadata.telegram
object
Mostra attributi secondari
body.section.items.text.metadata.telegram.parseMode
string
body.section.items.text.metadata.whatsapp
object
Mostra attributi secondari
body.section.items.text.metadata.whatsapp.callPermissionExpiration
string
body.section.items.text.metadata.whatsapp.callPermissionResponse
string
Possible values: accept, reject
body.section.items.text.metadata.whatsapp.previewUrl
boolean
obbligatorio
body.section.items.text.metadata.whatsapp.sharedContacts
array of object
Mostra attributi secondari
body.section.items.text.metadata.whatsapp.sharedContacts.origin
string
obbligatorio
body.section.items.text.metadata.whatsapp.sharedContacts.phones
array of object
Mostra attributi secondari
body.section.items.text.metadata.whatsapp.sharedContacts.phones.phone
string
obbligatorio
body.section.items.text.metadata.whatsapp.sharedContacts.phones.type
string
obbligatorio
body.section.items.text.metadata.whatsapp.sharedContacts.phones.waId
string
obbligatorio
body.section.items.text.metadata.whatsapp.sharedContacts.vcard
string
body.section.items.text.text
string
obbligatorio
body.section.items.type
string
obbligatorio
Possible values: text
body.section.items.html
object
obbligatorio
Mostra attributi secondari
body.section.items.html.actions
array of object
Mostra attributi secondari
body.section.items.html.actions.link
object
obbligatorio
Mostra attributi secondari
body.section.items.html.actions.link.metadata
object
Mostra attributi secondari
body.section.items.html.actions.link.metadata.description
object
Mostra attributi secondari
body.section.items.html.actions.link.metadata.description.label
string
obbligatorio
body.section.items.html.actions.link.text
string
obbligatorio
body.section.items.html.actions.link.url
string
obbligatorio
body.section.items.html.actions.type
string
obbligatorio
Possible values: link
body.section.items.html.actions.reply
object
obbligatorio
Mostra attributi secondari
body.section.items.html.actions.reply.imageUrl
string
body.section.items.html.actions.reply.metadata
object
Mostra attributi secondari
body.section.items.html.actions.reply.metadata.description
object
Mostra attributi secondari
body.section.items.html.actions.reply.metadata.description.label
string
obbligatorio
body.section.items.html.actions.reply.text
string
obbligatorio
body.section.items.html.actions.type
string
obbligatorio
Possible values: reply
body.section.items.html.actions.locationRequest
object
Mostra attributi secondari
body.section.items.html.actions.locationRequest.text
string
body.section.items.html.actions.type
string
obbligatorio
Possible values: locationRequest
body.section.items.html.actions.buy
object
obbligatorio
Mostra attributi secondari
body.section.items.html.actions.buy.amountCents
integer
obbligatorio
body.section.items.html.actions.buy.currency
string
obbligatorio
body.section.items.html.actions.buy.text
string
obbligatorio
body.section.items.html.actions.type
string
obbligatorio
Possible values: buy
body.section.items.html.actions.postback
object
obbligatorio
Mostra attributi secondari
body.section.items.html.actions.postback.handshake
object
Mostra attributi secondari
body.section.items.html.actions.postback.handshake.packageName
string
obbligatorio
body.section.items.html.actions.postback.handshake.signatureHash
string
obbligatorio
body.section.items.html.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
body.section.items.html.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
body.section.items.html.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
body.section.items.html.actions.postback.handshake.text
string
obbligatorio
body.section.items.html.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
body.section.items.html.actions.postback.imageUrl
string
body.section.items.html.actions.postback.metadata
object
Mostra attributi secondari
body.section.items.html.actions.postback.metadata.description
object
Mostra attributi secondari
body.section.items.html.actions.postback.metadata.description.label
string
obbligatorio
body.section.items.html.actions.postback.otpType
string
body.section.items.html.actions.postback.payload
string
body.section.items.html.actions.postback.text
string
obbligatorio
body.section.items.html.actions.type
string
obbligatorio
Possible values: postback
body.section.items.html.attachments
array of object
Mostra attributi secondari
body.section.items.html.attachments.content
string
body.section.items.html.attachments.contentId
string
body.section.items.html.attachments.contentType
string
body.section.items.html.attachments.filename
string
obbligatorio
body.section.items.html.attachments.inline
boolean
body.section.items.html.attachments.mediaUrl
string
body.section.items.html.html
string
body.section.items.html.metadata
object
Mostra attributi secondari
body.section.items.html.metadata.clickTracking
boolean
body.section.items.html.metadata.from
object
Mostra attributi secondari
body.section.items.html.metadata.from.displayName
string
body.section.items.html.metadata.from.username
string
body.section.items.html.metadata.headers
object
body.section.items.html.metadata.initialOpenTracking
boolean
body.section.items.html.metadata.openTracking
boolean
body.section.items.html.metadata.subject
string
body.section.items.html.text
string
body.section.items.type
string
obbligatorio
Possible values: html
body.section.items.image
object
obbligatorio
Mostra attributi secondari
body.section.items.image.actions
array of object
Mostra attributi secondari
body.section.items.image.actions.link
object
obbligatorio
Mostra attributi secondari
body.section.items.image.actions.link.metadata
object
Mostra attributi secondari
body.section.items.image.actions.link.metadata.description
object
Mostra attributi secondari
body.section.items.image.actions.link.metadata.description.label
string
obbligatorio
body.section.items.image.actions.link.text
string
obbligatorio
body.section.items.image.actions.link.url
string
obbligatorio
body.section.items.image.actions.type
string
obbligatorio
Possible values: link
body.section.items.image.actions.reply
object
obbligatorio
Mostra attributi secondari
body.section.items.image.actions.reply.imageUrl
string
body.section.items.image.actions.reply.metadata
object
Mostra attributi secondari
body.section.items.image.actions.reply.metadata.description
object
Mostra attributi secondari
body.section.items.image.actions.reply.metadata.description.label
string
obbligatorio
body.section.items.image.actions.reply.text
string
obbligatorio
body.section.items.image.actions.type
string
obbligatorio
Possible values: reply
body.section.items.image.actions.locationRequest
object
Mostra attributi secondari
body.section.items.image.actions.locationRequest.text
string
body.section.items.image.actions.type
string
obbligatorio
Possible values: locationRequest
body.section.items.image.actions.buy
object
obbligatorio
Mostra attributi secondari
body.section.items.image.actions.buy.amountCents
integer
obbligatorio
body.section.items.image.actions.buy.currency
string
obbligatorio
body.section.items.image.actions.buy.text
string
obbligatorio
body.section.items.image.actions.type
string
obbligatorio
Possible values: buy
body.section.items.image.actions.postback
object
obbligatorio
Mostra attributi secondari
body.section.items.image.actions.postback.handshake
object
Mostra attributi secondari
body.section.items.image.actions.postback.handshake.packageName
string
obbligatorio
body.section.items.image.actions.postback.handshake.signatureHash
string
obbligatorio
body.section.items.image.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
body.section.items.image.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
body.section.items.image.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
body.section.items.image.actions.postback.handshake.text
string
obbligatorio
body.section.items.image.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
body.section.items.image.actions.postback.imageUrl
string
body.section.items.image.actions.postback.metadata
object
Mostra attributi secondari
body.section.items.image.actions.postback.metadata.description
object
Mostra attributi secondari
body.section.items.image.actions.postback.metadata.description.label
string
obbligatorio
body.section.items.image.actions.postback.otpType
string
body.section.items.image.actions.postback.payload
string
body.section.items.image.actions.postback.text
string
obbligatorio
body.section.items.image.actions.type
string
obbligatorio
Possible values: postback
body.section.items.image.images
array of object
obbligatorio
Mostra attributi secondari
body.section.items.image.images.altText
string
body.section.items.image.images.mediaPreviewUrl
string
body.section.items.image.images.mediaUrl
string
obbligatorio
body.section.items.image.metadata
object
Mostra attributi secondari
body.section.items.image.metadata.fallbackText
string
body.section.items.image.metadata.storyType
string
Possible values: mention, reply
body.section.items.image.metadata.subject
string
body.section.items.image.metadata.telegram
object
Mostra attributi secondari
body.section.items.image.metadata.telegram.parseMode
string
body.section.items.image.text
string
body.section.items.type
string
obbligatorio
Possible values: image
body.section.items.gif
object
obbligatorio
Mostra attributi secondari
body.section.items.gif.actions
array of object
Mostra attributi secondari
body.section.items.gif.actions.link
object
obbligatorio
Mostra attributi secondari
body.section.items.gif.actions.link.metadata
object
Mostra attributi secondari
body.section.items.gif.actions.link.metadata.description
object
Mostra attributi secondari
body.section.items.gif.actions.link.metadata.description.label
string
obbligatorio
body.section.items.gif.actions.link.text
string
obbligatorio
body.section.items.gif.actions.link.url
string
obbligatorio
body.section.items.gif.actions.type
string
obbligatorio
Possible values: link
body.section.items.gif.actions.reply
object
obbligatorio
Mostra attributi secondari
body.section.items.gif.actions.reply.imageUrl
string
body.section.items.gif.actions.reply.metadata
object
Mostra attributi secondari
body.section.items.gif.actions.reply.metadata.description
object
Mostra attributi secondari
body.section.items.gif.actions.reply.metadata.description.label
string
obbligatorio
body.section.items.gif.actions.reply.text
string
obbligatorio
body.section.items.gif.actions.type
string
obbligatorio
Possible values: reply
body.section.items.gif.actions.locationRequest
object
Mostra attributi secondari
body.section.items.gif.actions.locationRequest.text
string
body.section.items.gif.actions.type
string
obbligatorio
Possible values: locationRequest
body.section.items.gif.actions.buy
object
obbligatorio
Mostra attributi secondari
body.section.items.gif.actions.buy.amountCents
integer
obbligatorio
body.section.items.gif.actions.buy.currency
string
obbligatorio
body.section.items.gif.actions.buy.text
string
obbligatorio
body.section.items.gif.actions.type
string
obbligatorio
Possible values: buy
body.section.items.gif.actions.postback
object
obbligatorio
Mostra attributi secondari
body.section.items.gif.actions.postback.handshake
object
Mostra attributi secondari
body.section.items.gif.actions.postback.handshake.packageName
string
obbligatorio
body.section.items.gif.actions.postback.handshake.signatureHash
string
obbligatorio
body.section.items.gif.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
body.section.items.gif.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
body.section.items.gif.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
body.section.items.gif.actions.postback.handshake.text
string
obbligatorio
body.section.items.gif.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
body.section.items.gif.actions.postback.imageUrl
string
body.section.items.gif.actions.postback.metadata
object
Mostra attributi secondari
body.section.items.gif.actions.postback.metadata.description
object
Mostra attributi secondari
body.section.items.gif.actions.postback.metadata.description.label
string
obbligatorio
body.section.items.gif.actions.postback.otpType
string
body.section.items.gif.actions.postback.payload
string
body.section.items.gif.actions.postback.text
string
obbligatorio
body.section.items.gif.actions.type
string
obbligatorio
Possible values: postback
body.section.items.gif.altText
string
body.section.items.gif.mediaUrl
string
obbligatorio
body.section.items.gif.metadata
object
Mostra attributi secondari
body.section.items.gif.metadata.telegram
object
Mostra attributi secondari
body.section.items.gif.metadata.telegram.parseMode
string
body.section.items.gif.text
string
body.section.items.type
string
obbligatorio
Possible values: gif
body.section.items.file
object
obbligatorio
Mostra attributi secondari
body.section.items.file.actions
array of object
Mostra attributi secondari
body.section.items.file.actions.link
object
obbligatorio
Mostra attributi secondari
body.section.items.file.actions.link.metadata
object
Mostra attributi secondari
body.section.items.file.actions.link.metadata.description
object
Mostra attributi secondari
body.section.items.file.actions.link.metadata.description.label
string
obbligatorio
body.section.items.file.actions.link.text
string
obbligatorio
body.section.items.file.actions.link.url
string
obbligatorio
body.section.items.file.actions.type
string
obbligatorio
Possible values: link
body.section.items.file.actions.reply
object
obbligatorio
Mostra attributi secondari
body.section.items.file.actions.reply.imageUrl
string
body.section.items.file.actions.reply.metadata
object
Mostra attributi secondari
body.section.items.file.actions.reply.metadata.description
object
Mostra attributi secondari
body.section.items.file.actions.reply.metadata.description.label
string
obbligatorio
body.section.items.file.actions.reply.text
string
obbligatorio
body.section.items.file.actions.type
string
obbligatorio
Possible values: reply
body.section.items.file.actions.locationRequest
object
Mostra attributi secondari
body.section.items.file.actions.locationRequest.text
string
body.section.items.file.actions.type
string
obbligatorio
Possible values: locationRequest
body.section.items.file.actions.buy
object
obbligatorio
Mostra attributi secondari
body.section.items.file.actions.buy.amountCents
integer
obbligatorio
body.section.items.file.actions.buy.currency
string
obbligatorio
body.section.items.file.actions.buy.text
string
obbligatorio
body.section.items.file.actions.type
string
obbligatorio
Possible values: buy
body.section.items.file.actions.postback
object
obbligatorio
Mostra attributi secondari
body.section.items.file.actions.postback.handshake
object
Mostra attributi secondari
body.section.items.file.actions.postback.handshake.packageName
string
obbligatorio
body.section.items.file.actions.postback.handshake.signatureHash
string
obbligatorio
body.section.items.file.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
body.section.items.file.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
body.section.items.file.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
body.section.items.file.actions.postback.handshake.text
string
obbligatorio
body.section.items.file.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
body.section.items.file.actions.postback.imageUrl
string
body.section.items.file.actions.postback.metadata
object
Mostra attributi secondari
body.section.items.file.actions.postback.metadata.description
object
Mostra attributi secondari
body.section.items.file.actions.postback.metadata.description.label
string
obbligatorio
body.section.items.file.actions.postback.otpType
string
body.section.items.file.actions.postback.payload
string
body.section.items.file.actions.postback.text
string
obbligatorio
body.section.items.file.actions.type
string
obbligatorio
Possible values: postback
body.section.items.file.files
array of object
obbligatorio
Mostra attributi secondari
body.section.items.file.files.altText
string
body.section.items.file.files.contentType
string
obbligatorio
body.section.items.file.files.filename
string
body.section.items.file.files.mediaUrl
string
obbligatorio
body.section.items.file.files.metadata
object
Mostra attributi secondari
body.section.items.file.files.metadata.isAnimated
boolean
body.section.items.file.metadata
object
Mostra attributi secondari
body.section.items.file.metadata.fallbackText
string
body.section.items.file.metadata.storyType
string
Possible values: mention, reply
body.section.items.file.metadata.subject
string
body.section.items.file.metadata.telegram
object
Mostra attributi secondari
body.section.items.file.metadata.telegram.parseMode
string
body.section.items.file.text
string
body.section.items.type
string
obbligatorio
Possible values: file
body.section.items.location
object
obbligatorio
Mostra attributi secondari
body.section.items.location.coordinates
object
obbligatorio
Mostra attributi secondari
body.section.items.location.coordinates.latitude
number
obbligatorio
body.section.items.location.coordinates.longitude
number
obbligatorio
body.section.items.location.location
object
obbligatorio
Mostra attributi secondari
body.section.items.location.location.address
string
obbligatorio
body.section.items.location.location.label
string
obbligatorio
body.section.items.type
string
obbligatorio
Possible values: location
body.section.items.carousel
object
obbligatorio
Mostra attributi secondari
body.section.items.carousel.items
array of object
Mostra attributi secondari
body.section.items.carousel.items.actions
array of object
Mostra attributi secondari
body.section.items.carousel.items.actions.link
object
obbligatorio
Mostra attributi secondari
body.section.items.carousel.items.actions.link.metadata
object
Mostra attributi secondari
body.section.items.carousel.items.actions.link.metadata.description
object
Mostra attributi secondari
body.section.items.carousel.items.actions.link.metadata.description.label
string
obbligatorio
body.section.items.carousel.items.actions.link.text
string
obbligatorio
body.section.items.carousel.items.actions.link.url
string
obbligatorio
body.section.items.carousel.items.actions.type
string
obbligatorio
Possible values: link
body.section.items.carousel.items.actions.reply
object
obbligatorio
Mostra attributi secondari
body.section.items.carousel.items.actions.reply.imageUrl
string
body.section.items.carousel.items.actions.reply.metadata
object
Mostra attributi secondari
body.section.items.carousel.items.actions.reply.metadata.description
object
Mostra attributi secondari
body.section.items.carousel.items.actions.reply.metadata.description.label
string
obbligatorio
body.section.items.carousel.items.actions.reply.text
string
obbligatorio
body.section.items.carousel.items.actions.type
string
obbligatorio
Possible values: reply
body.section.items.carousel.items.actions.locationRequest
object
Mostra attributi secondari
body.section.items.carousel.items.actions.locationRequest.text
string
body.section.items.carousel.items.actions.type
string
obbligatorio
Possible values: locationRequest
body.section.items.carousel.items.actions.buy
object
obbligatorio
Mostra attributi secondari
body.section.items.carousel.items.actions.buy.amountCents
integer
obbligatorio
body.section.items.carousel.items.actions.buy.currency
string
obbligatorio
body.section.items.carousel.items.actions.buy.text
string
obbligatorio
body.section.items.carousel.items.actions.type
string
obbligatorio
Possible values: buy
body.section.items.carousel.items.actions.postback
object
obbligatorio
Mostra attributi secondari
body.section.items.carousel.items.actions.postback.handshake
object
Mostra attributi secondari
body.section.items.carousel.items.actions.postback.handshake.packageName
string
obbligatorio
body.section.items.carousel.items.actions.postback.handshake.signatureHash
string
obbligatorio
body.section.items.carousel.items.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
body.section.items.carousel.items.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
body.section.items.carousel.items.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
body.section.items.carousel.items.actions.postback.handshake.text
string
obbligatorio
body.section.items.carousel.items.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
body.section.items.carousel.items.actions.postback.imageUrl
string
body.section.items.carousel.items.actions.postback.metadata
object
Mostra attributi secondari
body.section.items.carousel.items.actions.postback.metadata.description
object
Mostra attributi secondari
body.section.items.carousel.items.actions.postback.metadata.description.label
string
obbligatorio
body.section.items.carousel.items.actions.postback.otpType
string
body.section.items.carousel.items.actions.postback.payload
string
body.section.items.carousel.items.actions.postback.text
string
obbligatorio
body.section.items.carousel.items.actions.type
string
obbligatorio
Possible values: postback
body.section.items.carousel.items.altText
string
body.section.items.carousel.items.description
string
body.section.items.carousel.items.mediaUrl
string
body.section.items.carousel.items.size
integer
body.section.items.carousel.items.title
string
body.section.items.carousel.text
string
Optional text displayed above the carousel cards.
body.section.items.type
string
obbligatorio
Possible values: carousel
body.section.items.list
object
obbligatorio
Mostra attributi secondari
body.section.items.list.actions
array of object
Mostra attributi secondari
body.section.items.list.actions.link
object
obbligatorio
Mostra attributi secondari
body.section.items.list.actions.link.metadata
object
Mostra attributi secondari
body.section.items.list.actions.link.metadata.description
object
Mostra attributi secondari
body.section.items.list.actions.link.metadata.description.label
string
obbligatorio
body.section.items.list.actions.link.text
string
obbligatorio
body.section.items.list.actions.link.url
string
obbligatorio
body.section.items.list.actions.type
string
obbligatorio
Possible values: link
body.section.items.list.actions.reply
object
obbligatorio
Mostra attributi secondari
body.section.items.list.actions.reply.imageUrl
string
body.section.items.list.actions.reply.metadata
object
Mostra attributi secondari
body.section.items.list.actions.reply.metadata.description
object
Mostra attributi secondari
body.section.items.list.actions.reply.metadata.description.label
string
obbligatorio
body.section.items.list.actions.reply.text
string
obbligatorio
body.section.items.list.actions.type
string
obbligatorio
Possible values: reply
body.section.items.list.actions.locationRequest
object
Mostra attributi secondari
body.section.items.list.actions.locationRequest.text
string
body.section.items.list.actions.type
string
obbligatorio
Possible values: locationRequest
body.section.items.list.actions.buy
object
obbligatorio
Mostra attributi secondari
body.section.items.list.actions.buy.amountCents
integer
obbligatorio
body.section.items.list.actions.buy.currency
string
obbligatorio
body.section.items.list.actions.buy.text
string
obbligatorio
body.section.items.list.actions.type
string
obbligatorio
Possible values: buy
body.section.items.list.actions.postback
object
obbligatorio
Mostra attributi secondari
body.section.items.list.actions.postback.handshake
object
Mostra attributi secondari
body.section.items.list.actions.postback.handshake.packageName
string
obbligatorio
body.section.items.list.actions.postback.handshake.signatureHash
string
obbligatorio
body.section.items.list.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
body.section.items.list.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
body.section.items.list.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
body.section.items.list.actions.postback.handshake.text
string
obbligatorio
body.section.items.list.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
body.section.items.list.actions.postback.imageUrl
string
body.section.items.list.actions.postback.metadata
object
Mostra attributi secondari
body.section.items.list.actions.postback.metadata.description
object
Mostra attributi secondari
body.section.items.list.actions.postback.metadata.description.label
string
obbligatorio
body.section.items.list.actions.postback.otpType
string
body.section.items.list.actions.postback.payload
string
body.section.items.list.actions.postback.text
string
obbligatorio
body.section.items.list.actions.type
string
obbligatorio
Possible values: postback
body.section.items.list.altText
string
body.section.items.list.items
array of object
Mostra attributi secondari
body.section.items.list.items.actions
array of object
Mostra attributi secondari
body.section.items.list.items.actions.link
object
obbligatorio
Mostra attributi secondari
body.section.items.list.items.actions.link.metadata
object
Mostra attributi secondari
body.section.items.list.items.actions.link.metadata.description
object
Mostra attributi secondari
body.section.items.list.items.actions.link.metadata.description.label
string
obbligatorio
body.section.items.list.items.actions.link.text
string
obbligatorio
body.section.items.list.items.actions.link.url
string
obbligatorio
body.section.items.list.items.actions.type
string
obbligatorio
Possible values: link
body.section.items.list.items.actions.reply
object
obbligatorio
Mostra attributi secondari
body.section.items.list.items.actions.reply.imageUrl
string
body.section.items.list.items.actions.reply.metadata
object
Mostra attributi secondari
body.section.items.list.items.actions.reply.metadata.description
object
Mostra attributi secondari
body.section.items.list.items.actions.reply.metadata.description.label
string
obbligatorio
body.section.items.list.items.actions.reply.text
string
obbligatorio
body.section.items.list.items.actions.type
string
obbligatorio
Possible values: reply
body.section.items.list.items.actions.locationRequest
object
Mostra attributi secondari
body.section.items.list.items.actions.locationRequest.text
string
body.section.items.list.items.actions.type
string
obbligatorio
Possible values: locationRequest
body.section.items.list.items.actions.buy
object
obbligatorio
Mostra attributi secondari
body.section.items.list.items.actions.buy.amountCents
integer
obbligatorio
body.section.items.list.items.actions.buy.currency
string
obbligatorio
body.section.items.list.items.actions.buy.text
string
obbligatorio
body.section.items.list.items.actions.type
string
obbligatorio
Possible values: buy
body.section.items.list.items.actions.postback
object
obbligatorio
Mostra attributi secondari
body.section.items.list.items.actions.postback.handshake
object
Mostra attributi secondari
body.section.items.list.items.actions.postback.handshake.packageName
string
obbligatorio
body.section.items.list.items.actions.postback.handshake.signatureHash
string
obbligatorio
body.section.items.list.items.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
body.section.items.list.items.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
body.section.items.list.items.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
body.section.items.list.items.actions.postback.handshake.text
string
obbligatorio
body.section.items.list.items.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
body.section.items.list.items.actions.postback.imageUrl
string
body.section.items.list.items.actions.postback.metadata
object
Mostra attributi secondari
body.section.items.list.items.actions.postback.metadata.description
object
Mostra attributi secondari
body.section.items.list.items.actions.postback.metadata.description.label
string
obbligatorio
body.section.items.list.items.actions.postback.otpType
string
body.section.items.list.items.actions.postback.payload
string
body.section.items.list.items.actions.postback.text
string
obbligatorio
body.section.items.list.items.actions.type
string
obbligatorio
Possible values: postback
body.section.items.list.items.altText
string
body.section.items.list.items.description
string
body.section.items.list.items.mediaUrl
string
body.section.items.list.items.size
integer
body.section.items.list.items.title
string
body.section.items.list.metadata
object
Mostra attributi secondari
body.section.items.list.metadata.button
object
Mostra attributi secondari
body.section.items.list.metadata.button.label
string
obbligatorio
body.section.items.list.metadata.replyMessage
object
Mostra attributi secondari
body.section.items.list.metadata.replyMessage.text
string
obbligatorio
body.section.items.list.metadata.replyMessage.title
string
obbligatorio
body.section.items.list.text
string
body.section.items.list.title
string
body.section.items.type
string
obbligatorio
Possible values: list
body.section.items.section
object
obbligatorio
body.section.items.type
string
obbligatorio
Possible values: section
body.section.items.authentication
object
obbligatorio
Mostra attributi secondari
body.section.items.authentication.otp
object
Mostra attributi secondari
body.section.items.authentication.otp.actions
array of object
Mostra attributi secondari
body.section.items.authentication.otp.actions.link
object
obbligatorio
Mostra attributi secondari
body.section.items.authentication.otp.actions.link.metadata
object
Mostra attributi secondari
body.section.items.authentication.otp.actions.link.metadata.description
object
Mostra attributi secondari
body.section.items.authentication.otp.actions.link.metadata.description.label
string
obbligatorio
body.section.items.authentication.otp.actions.link.text
string
obbligatorio
body.section.items.authentication.otp.actions.link.url
string
obbligatorio
body.section.items.authentication.otp.actions.type
string
obbligatorio
Possible values: link
body.section.items.authentication.otp.actions.reply
object
obbligatorio
Mostra attributi secondari
body.section.items.authentication.otp.actions.reply.imageUrl
string
body.section.items.authentication.otp.actions.reply.metadata
object
Mostra attributi secondari
body.section.items.authentication.otp.actions.reply.metadata.description
object
Mostra attributi secondari
body.section.items.authentication.otp.actions.reply.metadata.description.label
string
obbligatorio
body.section.items.authentication.otp.actions.reply.text
string
obbligatorio
body.section.items.authentication.otp.actions.type
string
obbligatorio
Possible values: reply
body.section.items.authentication.otp.actions.locationRequest
object
Mostra attributi secondari
body.section.items.authentication.otp.actions.locationRequest.text
string
body.section.items.authentication.otp.actions.type
string
obbligatorio
Possible values: locationRequest
body.section.items.authentication.otp.actions.buy
object
obbligatorio
Mostra attributi secondari
body.section.items.authentication.otp.actions.buy.amountCents
integer
obbligatorio
body.section.items.authentication.otp.actions.buy.currency
string
obbligatorio
body.section.items.authentication.otp.actions.buy.text
string
obbligatorio
body.section.items.authentication.otp.actions.type
string
obbligatorio
Possible values: buy
body.section.items.authentication.otp.actions.postback
object
obbligatorio
Mostra attributi secondari
body.section.items.authentication.otp.actions.postback.handshake
object
Mostra attributi secondari
body.section.items.authentication.otp.actions.postback.handshake.packageName
string
obbligatorio
body.section.items.authentication.otp.actions.postback.handshake.signatureHash
string
obbligatorio
body.section.items.authentication.otp.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
body.section.items.authentication.otp.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
body.section.items.authentication.otp.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
body.section.items.authentication.otp.actions.postback.handshake.text
string
obbligatorio
body.section.items.authentication.otp.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
body.section.items.authentication.otp.actions.postback.imageUrl
string
body.section.items.authentication.otp.actions.postback.metadata
object
Mostra attributi secondari
body.section.items.authentication.otp.actions.postback.metadata.description
object
Mostra attributi secondari
body.section.items.authentication.otp.actions.postback.metadata.description.label
string
obbligatorio
body.section.items.authentication.otp.actions.postback.otpType
string
body.section.items.authentication.otp.actions.postback.payload
string
body.section.items.authentication.otp.actions.postback.text
string
obbligatorio
body.section.items.authentication.otp.actions.type
string
obbligatorio
Possible values: postback
body.section.items.authentication.otp.disclaimer
boolean
obbligatorio
Whether to add a security disclaimer to the authentication body.
body.section.items.authentication.otp.expirationTime
integer
The number of seconds after which the authentication code expires. If not set, no expiration notification is sent.
body.section.items.type
string
obbligatorio
Possible values: authentication
body.section.items.action
object
obbligatorio
Mostra attributi secondari
body.section.items.action.action
string
obbligatorio
Possible values: permissionRequest
body.section.items.action.permissionRequest
object
obbligatorio
Mostra attributi secondari
body.section.items.action.permissionRequest.resource
string
obbligatorio
Possible values: call
body.section.items.type
string
obbligatorio
Possible values: action
body.type
string
obbligatorio
Possible values: section
body.authentication
object
obbligatorio
Mostra attributi secondari
body.authentication.otp
object
Mostra attributi secondari
body.authentication.otp.actions
array of object
Mostra attributi secondari
body.authentication.otp.actions.link
object
obbligatorio
Mostra attributi secondari
body.authentication.otp.actions.link.metadata
object
Mostra attributi secondari
body.authentication.otp.actions.link.metadata.description
object
Mostra attributi secondari
body.authentication.otp.actions.link.metadata.description.label
string
obbligatorio
body.authentication.otp.actions.link.text
string
obbligatorio
body.authentication.otp.actions.link.url
string
obbligatorio
body.authentication.otp.actions.type
string
obbligatorio
Possible values: link
body.authentication.otp.actions.reply
object
obbligatorio
Mostra attributi secondari
body.authentication.otp.actions.reply.imageUrl
string
body.authentication.otp.actions.reply.metadata
object
Mostra attributi secondari
body.authentication.otp.actions.reply.metadata.description
object
Mostra attributi secondari
body.authentication.otp.actions.reply.metadata.description.label
string
obbligatorio
body.authentication.otp.actions.reply.text
string
obbligatorio
body.authentication.otp.actions.type
string
obbligatorio
Possible values: reply
body.authentication.otp.actions.locationRequest
object
Mostra attributi secondari
body.authentication.otp.actions.locationRequest.text
string
body.authentication.otp.actions.type
string
obbligatorio
Possible values: locationRequest
body.authentication.otp.actions.buy
object
obbligatorio
Mostra attributi secondari
body.authentication.otp.actions.buy.amountCents
integer
obbligatorio
body.authentication.otp.actions.buy.currency
string
obbligatorio
body.authentication.otp.actions.buy.text
string
obbligatorio
body.authentication.otp.actions.type
string
obbligatorio
Possible values: buy
body.authentication.otp.actions.postback
object
obbligatorio
Mostra attributi secondari
body.authentication.otp.actions.postback.handshake
object
Mostra attributi secondari
body.authentication.otp.actions.postback.handshake.packageName
string
obbligatorio
body.authentication.otp.actions.postback.handshake.signatureHash
string
obbligatorio
body.authentication.otp.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
body.authentication.otp.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
body.authentication.otp.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
body.authentication.otp.actions.postback.handshake.text
string
obbligatorio
body.authentication.otp.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
body.authentication.otp.actions.postback.imageUrl
string
body.authentication.otp.actions.postback.metadata
object
Mostra attributi secondari
body.authentication.otp.actions.postback.metadata.description
object
Mostra attributi secondari
body.authentication.otp.actions.postback.metadata.description.label
string
obbligatorio
body.authentication.otp.actions.postback.otpType
string
body.authentication.otp.actions.postback.payload
string
body.authentication.otp.actions.postback.text
string
obbligatorio
body.authentication.otp.actions.type
string
obbligatorio
Possible values: postback
body.authentication.otp.disclaimer
boolean
obbligatorio
Whether to add a security disclaimer to the authentication body.
body.authentication.otp.expirationTime
integer
The number of seconds after which the authentication code expires. If not set, no expiration notification is sent.
body.type
string
obbligatorio
Possible values: authentication
body.action
object
obbligatorio
Mostra attributi secondari
body.action.action
string
obbligatorio
Possible values: permissionRequest
body.action.permissionRequest
object
obbligatorio
Mostra attributi secondari
body.action.permissionRequest.resource
string
obbligatorio
Possible values: call
body.type
string
obbligatorio
Possible values: action
bodyId
string
bodyStorage
object
Mostra attributi secondari
bodyStorage.type
string
obbligatorio
Possible values: s3
bodyStorage.s3
object
obbligatorio
Mostra attributi secondari
bodyStorage.s3.bucketArn
string
obbligatorio
bodyStorage.s3.encryptionKey
string
obbligatorio
bodyStorage.s3.key
string
obbligatorio
channelId
string
obbligatorio
chargeableUnits
integer
context
object
Mostra attributi secondari
context.id
string
context.tagIds
array of string
context.type
string
createdAt
string
obbligatorio
details
string
This field is used to store additional information related to the message status.
direction
string
Possible values: incoming, outgoing
failure
object
Mostra attributi secondari
failure.code
integer
omni channel interpretation of the failure to categorise the nature of message error
failure.description
string
human readable description of the error
failure.source
object
Mostra attributi secondari
failure.source.code
string
numerical, text or alphanumeric code that indicates the error or issue while delivering the message in the last step
failure.source.name
string
Possible values: pre-processing, accounting, contact, touchpoint, sms-messagebird, sms-twilio, email-messagebird, whatsapp, facebook, instagram, line, telegram, apple-business-chat, viber, chat, google-business-messages, voice, smtp-messagebird, rcs-google, service
id
string
obbligatorio
ignorePersistedEventhooks
boolean
lastStatusAt
string
obbligatorio
meta
object
Mostra attributi secondari
meta.campaign
object
Mostra attributi secondari
meta.campaign.id
string
meta.campaign.name
string
meta.campaignId
string
meta.chargeOnceDelivered
boolean
meta.email
object
Mostra attributi secondari
meta.email.from
object
Mostra attributi secondari
meta.email.from.displayName
string
meta.email.from.username
string
meta.email.headers
object
meta.email.subject
string
meta.extraInformation
object
meta.flow
object
Mostra attributi secondari
meta.flow.id
string
meta.flow.name
string
meta.flow.runId
string
meta.flow.scheduleExecutionId
string
meta.flow.stepId
string
meta.formResponse
object
Mostra attributi secondari
meta.formResponse.id
string
obbligatorio
meta.formResponse.jsonResponse
string
obbligatorio
meta.formResponse.requestIdentifier
string
obbligatorio
meta.formResponse.selections
array of object
Mostra attributi secondari
meta.formResponse.selections.items
array of object
Mostra attributi secondari
meta.formResponse.selections.items.identifier
string
obbligatorio
meta.formResponse.selections.items.title
string
obbligatorio
meta.formResponse.selections.items.type
string
obbligatorio
meta.formResponse.selections.items.value
string
obbligatorio
meta.formResponse.selections.pageIdentifier
string
obbligatorio
meta.formResponse.selections.subtitle
string
obbligatorio
meta.formResponse.selections.title
string
obbligatorio
meta.formResponse.sessionIdentifier
string
obbligatorio
meta.formResponse.template
string
obbligatorio
meta.formResponse.version
string
obbligatorio
meta.ignoreGlobalHoldout
boolean
meta.ignoreQuietHours
boolean
meta.journey
object
Mostra attributi secondari
meta.journey.id
string
meta.journey.name
string
meta.journey.runId
string
meta.journey.scheduleExecutionId
string
meta.journey.stepId
string
meta.longToShortLinks
object
meta.metaThreadId
string
meta.navigatorId
string
meta.navigatorMessageId
string
meta.order
object
The order object contains information about the purchase order associated with the message.
Mostra attributi secondari
meta.order.products
array of object
Mostra attributi secondari
meta.order.products.externalCatalogId
string
The platform-specific catalog ID of the product.
meta.order.products.externalProductId
string
obbligatorio
The platform-specific product ID.
meta.order.products.price
object
obbligatorio
Mostra attributi secondari
meta.order.products.price.amount
integer
obbligatorio
meta.order.products.price.currencyCode
string
obbligatorio
meta.order.products.price.exponent
integer
obbligatorio
meta.order.products.quantity
integer
obbligatorio
The number of items purchased.
meta.pushNotifications
object
Mostra attributi secondari
meta.pushNotifications.gatewayTypeOverride
string
Possible values: firebase, apns, web
meta.referral
object
Mostra attributi secondari
meta.referral.group
string
meta.referral.metadata
object
Mostra attributi secondari
meta.referral.metadata.caption
string
meta.referral.metadata.mediaType
string
meta.referral.metadata.mediaUrl
string
meta.referral.metadata.sourceId
string
obbligatorio
meta.referral.metadata.sourceUrl
string
meta.referral.metadata.timestamp
string
meta.referral.metadata.trackingId
string
meta.referral.metadata.username
string
meta.referral.source
string
obbligatorio
meta.referral.text
string
meta.referral.title
string
meta.referredProduct
object
Referred product in an incoming message (e.g. a product shared in a WhatsApp catalog message).
Mostra attributi secondari
meta.referredProduct.externalCatalogId
string
The platform-specific catalog ID of the product.
meta.referredProduct.externalProductId
string
obbligatorio
The platform-specific product ID.
meta.renderedContentBlocks
array of string
meta.shortToLongLinks
object
meta.skipThisMessage
string
Possible values: campaignHoldout, globalHoldout, journeyHoldout
meta.sms
object
Mostra attributi secondari
meta.sms.gatewayId
integer
meta.sms.registeredDelivery
string
Possible values: final, intermediate, all, noDlr
meta.sms.smartEncoding
boolean
When enabled, attempts to transliterate Unicode characters to GSM-7 equivalents. If the resulting text is fully GSM-7 compatible, fewer message segments may be required. The original message body is preserved; transliteration is only applied when sending.
meta.sms.smpp
object
Mostra attributi secondari
meta.sms.smpp.segments
array of object
Mostra attributi secondari
meta.sms.smpp.segments.id
string
obbligatorio
meta.sms.smpp.segments.registeredDelivery
string
obbligatorio
Possible values: final, intermediate, all, noDlr
meta.sms.smpp.userId
string
obbligatorio
meta.sms.validity
string
meta.useFallback
boolean
parts
array of object
Mostra attributi secondari
parts.id
string
parts.order
integer
parts.platformReferenceId
string
parts.platformStatusAt
string
parts.rawBody
string
parts.reason
string
parts.status
string
Possible values: accepted, processing, sent, sending_failed, delivered, delivery_failed, deleted, scheduled, skipped, rejected
parts.statusAt
string
platformId
string
platformReferenceId
string
previousMessages
array of object
Mostra attributi secondari
previousMessages.id
string
obbligatorio
previousMessages.useCaseType
string
obbligatorio
Possible values: unspecified, marketing, otp, transactional, conversation, test
reason
string
receiver
object
obbligatorio
Mostra attributi secondari
receiver.connector
object
Mostra attributi secondari
receiver.connector.annotations
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Mostra attributi secondari
receiver.connector.annotations.name
string
receiver.connector.id
string
obbligatorio
receiver.connector.identifierValue
string
The identifier value of the sender or receiver connector (e.g. email address or phone number).
receiver.connector.types
array of string
receiver.contacts
array of object
Mostra attributi secondari
receiver.contacts.contactAnnotation
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Mostra attributi secondari
receiver.contacts.contactAnnotation.name
string
receiver.contacts.countryCode
string
receiver.contacts.id
string
The ID of the contact.
receiver.contacts.identifierKey
string
The identifier key for finding the contact (e.g. emailaddress, phonenumber). For WhatsApp channels with BSUID support, use whatsappbsuid to send to a contact by their Business-Scoped User ID.
receiver.contacts.identifierValue
string
The identifier value for finding the contact.
receiver.contacts.identifiers
array of object
Additional identifiers to augment the contact during resolution.
Mostra attributi secondari
receiver.contacts.identifiers.identifierKey
string
obbligatorio
The identifier key for finding the contact (e.g. emailaddress, phonenumber).
receiver.contacts.identifiers.identifierValue
string
obbligatorio
The identifier value for finding the contact.
receiver.contacts.platformAddress
string
The resolved platform address used to deliver the message (e.g. phone number or email address).
receiver.contacts.platformAddressSelector
string
An expression that defines how we resolve the platform address from a contact. Optional override for the default resolution logic.
receiver.contacts.receiverExpression
string
receiver.contacts.receiverValue
string
receiver.contacts.type
string
The type of the receiver (e.g. to, cc, bcc for email).
receiver.device
object
Mostra attributi secondari
receiver.device.gateway
string
obbligatorio
Possible values: firebase, apns, web
receiver.device.id
string
obbligatorio
receiver.device.identifierValue
string
obbligatorio
receiver.inbox
object
Mostra attributi secondari
receiver.inbox.emailRecipientType
string
receiver.inbox.id
string
obbligatorio
receiver.inbox.identifierKey
string
obbligatorio
receiver.inbox.identifierValue
string
obbligatorio
receiver.inbox.type
string
obbligatorio
Possible values: user, group
receiver.userContacts
array of object
Mostra attributi secondari
receiver.userContacts.id
string
obbligatorio
receiver.userContacts.identifierKey
string
obbligatorio
receiver.userContacts.identifierValue
string
obbligatorio
receiver.userContacts.type
string
reference
string
A reference to the message. This can be used to identify the message in the channel.
replyTo
object
Mostra attributi secondari
replyTo.id
string
The ID of the message that is being replied to.
replyTo.order
integer
The order of the message part in the conversation.
replyTo.platformReference
string
replyTo.type
string
Possible values: message, click
schedule
object
Mostra attributi secondari
schedule.reason
string
obbligatorio
schedule.scheduledAt
string
obbligatorio
scheduledFor
string
Scheduled message send time (RFC3339). Messages scheduled within 10 minutes may be sent immediately; messages scheduled more than 35 days out will be rejected.
sendAt
string
sender
object
obbligatorio
Mostra attributi secondari
sender.connector
object
Mostra attributi secondari
sender.connector.annotations
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Mostra attributi secondari
sender.connector.annotations.name
string
sender.connector.id
string
obbligatorio
sender.connector.identifierValue
string
The identifier value of the sender or receiver connector (e.g. email address or phone number).
sender.connector.types
array of string
sender.contact
object
Mostra attributi secondari
sender.contact.contactAnnotation
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Mostra attributi secondari
sender.contact.contactAnnotation.name
string
sender.contact.countryCode
string
sender.contact.id
string
The ID of the contact.
sender.contact.identifierKey
string
The identifier key for finding the contact (e.g. emailaddress, phonenumber). For WhatsApp channels with BSUID support, use whatsappbsuid to send to a contact by their Business-Scoped User ID.
sender.contact.identifierValue
string
The identifier value for finding the contact.
sender.contact.identifiers
array of object
Additional identifiers to augment the contact during resolution.
Mostra attributi secondari
sender.contact.identifiers.identifierKey
string
obbligatorio
The identifier key for finding the contact (e.g. emailaddress, phonenumber).
sender.contact.identifiers.identifierValue
string
obbligatorio
The identifier value for finding the contact.
sender.contact.platformAddress
string
The resolved platform address used to deliver the message (e.g. phone number or email address).
sender.contact.platformAddressSelector
string
An expression that defines how we resolve the platform address from a contact. Optional override for the default resolution logic.
sender.contact.receiverExpression
string
sender.contact.receiverValue
string
sender.contact.type
string
The type of the receiver (e.g. to, cc, bcc for email).
sender.inbox
object
Mostra attributi secondari
sender.inbox.emailRecipientType
string
sender.inbox.id
string
obbligatorio
sender.inbox.identifierKey
string
obbligatorio
sender.inbox.identifierValue
string
obbligatorio
sender.inbox.type
string
obbligatorio
Possible values: user, group
sender.userContact
object
Mostra attributi secondari
sender.userContact.id
string
obbligatorio
sender.userContact.identifierKey
string
obbligatorio
sender.userContact.identifierValue
string
obbligatorio
sender.userContact.type
string
shortLinks
object
Mostra attributi secondari
shortLinks.domain
string
obbligatorio
The domain to use when shortening links. When set to default, uses the default link shortening domain for the workspace.
status
string
obbligatorio
Possible values: accepted, processing, sent, sending_failed, delivered, delivery_failed, deleted, scheduled, skipped, rejected
tagIds
array of string
tags
array of string
Tags to associate with the message. Tags are converted to lower case and automatically created if they don't exist. Up to 10 tags per message.
template
object
Mostra attributi secondari
template.attachments
array of object
Mostra attributi secondari
template.attachments.content
string
template.attachments.contentType
string
template.attachments.filename
string
obbligatorio
template.attachments.inline
boolean
obbligatorio
template.attachments.mediaUrl
string
obbligatorio
template.deployment
object
template.locale
string
obbligatorio
template.name
string
The platform name of the template.
template.parameters
array of object
Mostra attributi secondari
template.parameters.key
string
obbligatorio
template.parameters.sourceUrl
object
Mostra attributi secondari
template.parameters.sourceUrl.fullyReplaced
boolean
obbligatorio
template.parameters.sourceUrl.value
string
obbligatorio
template.parameters.type
string
obbligatorio
Possible values: string, timeslotList, productSections, productList, number, boolean, sectionList, shippingMethodList, lineItemList, whatsappProductSections, whatsappProductItems, shortLink, object, carouselCards, appleFormPageItems
template.parameters.value
object or array or string or number or boolean
obbligatorio
template.projectId
string
obbligatorio
The ID of the project from Studio.
template.settings
object
Mostra attributi secondari
template.settings.disallowMmLite
boolean
template.shortLinks
object
Mostra attributi secondari
template.shortLinks.domain
string
obbligatorio
The domain to use when shortening links. When set to default, uses the default link shortening domain for the workspace.
template.shortLinks.enabled
boolean
obbligatorio
Enables link shortening for SMS messages.
template.templateBody
object
Mostra attributi secondari
template.templateBody.text
object
obbligatorio
Mostra attributi secondari
template.templateBody.text.actions
array of object
Mostra attributi secondari
template.templateBody.text.actions.link
object
obbligatorio
Mostra attributi secondari
template.templateBody.text.actions.link.metadata
object
Mostra attributi secondari
template.templateBody.text.actions.link.metadata.description
object
Mostra attributi secondari
template.templateBody.text.actions.link.metadata.description.label
string
obbligatorio
template.templateBody.text.actions.link.text
string
obbligatorio
template.templateBody.text.actions.link.url
string
obbligatorio
template.templateBody.text.actions.type
string
obbligatorio
Possible values: link
template.templateBody.text.actions.reply
object
obbligatorio
Mostra attributi secondari
template.templateBody.text.actions.reply.imageUrl
string
template.templateBody.text.actions.reply.metadata
object
Mostra attributi secondari
template.templateBody.text.actions.reply.metadata.description
object
Mostra attributi secondari
template.templateBody.text.actions.reply.metadata.description.label
string
obbligatorio
template.templateBody.text.actions.reply.text
string
obbligatorio
template.templateBody.text.actions.type
string
obbligatorio
Possible values: reply
template.templateBody.text.actions.locationRequest
object
Mostra attributi secondari
template.templateBody.text.actions.locationRequest.text
string
template.templateBody.text.actions.type
string
obbligatorio
Possible values: locationRequest
template.templateBody.text.actions.buy
object
obbligatorio
Mostra attributi secondari
template.templateBody.text.actions.buy.amountCents
integer
obbligatorio
template.templateBody.text.actions.buy.currency
string
obbligatorio
template.templateBody.text.actions.buy.text
string
obbligatorio
template.templateBody.text.actions.type
string
obbligatorio
Possible values: buy
template.templateBody.text.actions.postback
object
obbligatorio
Mostra attributi secondari
template.templateBody.text.actions.postback.handshake
object
Mostra attributi secondari
template.templateBody.text.actions.postback.handshake.packageName
string
obbligatorio
template.templateBody.text.actions.postback.handshake.signatureHash
string
obbligatorio
template.templateBody.text.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
template.templateBody.text.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
template.templateBody.text.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
template.templateBody.text.actions.postback.handshake.text
string
obbligatorio
template.templateBody.text.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
template.templateBody.text.actions.postback.imageUrl
string
template.templateBody.text.actions.postback.metadata
object
Mostra attributi secondari
template.templateBody.text.actions.postback.metadata.description
object
Mostra attributi secondari
template.templateBody.text.actions.postback.metadata.description.label
string
obbligatorio
template.templateBody.text.actions.postback.otpType
string
template.templateBody.text.actions.postback.payload
string
template.templateBody.text.actions.postback.text
string
obbligatorio
template.templateBody.text.actions.type
string
obbligatorio
Possible values: postback
template.templateBody.text.attachments
array of object
Mostra attributi secondari
template.templateBody.text.attachments.content
string
template.templateBody.text.attachments.contentId
string
template.templateBody.text.attachments.contentType
string
template.templateBody.text.attachments.filename
string
obbligatorio
template.templateBody.text.attachments.inline
boolean
template.templateBody.text.attachments.mediaUrl
string
obbligatorio
template.templateBody.text.metadata
object
Mostra attributi secondari
template.templateBody.text.metadata.apple
object
Mostra attributi secondari
template.templateBody.text.metadata.apple.appClipPreview
boolean
template.templateBody.text.metadata.apple.appClipRegion
string
template.templateBody.text.metadata.apple.summaryText
string
template.templateBody.text.metadata.headers
object
template.templateBody.text.metadata.line
object
Mostra attributi secondari
template.templateBody.text.metadata.line.emoji
object
Mostra attributi secondari
template.templateBody.text.metadata.line.emoji.items
array of object
Mostra attributi secondari
template.templateBody.text.metadata.line.emoji.items.emojiId
string
obbligatorio
template.templateBody.text.metadata.line.emoji.items.index
integer
obbligatorio
template.templateBody.text.metadata.line.emoji.items.length
integer
template.templateBody.text.metadata.line.emoji.items.productId
string
obbligatorio
template.templateBody.text.metadata.paymentDetails
object
Mostra attributi secondari
template.templateBody.text.metadata.paymentDetails.amount
string
obbligatorio
template.templateBody.text.metadata.paymentDetails.currency
string
obbligatorio
template.templateBody.text.metadata.paymentDetails.sessionIdentifier
string
template.templateBody.text.metadata.paymentDetails.state
string
obbligatorio
template.templateBody.text.metadata.subject
string
template.templateBody.text.metadata.telegram
object
Mostra attributi secondari
template.templateBody.text.metadata.telegram.parseMode
string
template.templateBody.text.metadata.whatsapp
object
Mostra attributi secondari
template.templateBody.text.metadata.whatsapp.callPermissionExpiration
string
template.templateBody.text.metadata.whatsapp.callPermissionResponse
string
Possible values: accept, reject
template.templateBody.text.metadata.whatsapp.previewUrl
boolean
obbligatorio
template.templateBody.text.metadata.whatsapp.sharedContacts
array of object
Mostra attributi secondari
template.templateBody.text.metadata.whatsapp.sharedContacts.origin
string
obbligatorio
template.templateBody.text.metadata.whatsapp.sharedContacts.phones
array of object
Mostra attributi secondari
template.templateBody.text.metadata.whatsapp.sharedContacts.phones.phone
string
obbligatorio
template.templateBody.text.metadata.whatsapp.sharedContacts.phones.type
string
obbligatorio
template.templateBody.text.metadata.whatsapp.sharedContacts.phones.waId
string
obbligatorio
template.templateBody.text.metadata.whatsapp.sharedContacts.vcard
string
template.templateBody.text.text
string
obbligatorio
template.templateBody.type
string
obbligatorio
Possible values: text
template.templateBody.html
object
obbligatorio
Mostra attributi secondari
template.templateBody.html.actions
array of object
Mostra attributi secondari
template.templateBody.html.actions.link
object
obbligatorio
Mostra attributi secondari
template.templateBody.html.actions.link.metadata
object
Mostra attributi secondari
template.templateBody.html.actions.link.metadata.description
object
Mostra attributi secondari
template.templateBody.html.actions.link.metadata.description.label
string
obbligatorio
template.templateBody.html.actions.link.text
string
obbligatorio
template.templateBody.html.actions.link.url
string
obbligatorio
template.templateBody.html.actions.type
string
obbligatorio
Possible values: link
template.templateBody.html.actions.reply
object
obbligatorio
Mostra attributi secondari
template.templateBody.html.actions.reply.imageUrl
string
template.templateBody.html.actions.reply.metadata
object
Mostra attributi secondari
template.templateBody.html.actions.reply.metadata.description
object
Mostra attributi secondari
template.templateBody.html.actions.reply.metadata.description.label
string
obbligatorio
template.templateBody.html.actions.reply.text
string
obbligatorio
template.templateBody.html.actions.type
string
obbligatorio
Possible values: reply
template.templateBody.html.actions.locationRequest
object
Mostra attributi secondari
template.templateBody.html.actions.locationRequest.text
string
template.templateBody.html.actions.type
string
obbligatorio
Possible values: locationRequest
template.templateBody.html.actions.buy
object
obbligatorio
Mostra attributi secondari
template.templateBody.html.actions.buy.amountCents
integer
obbligatorio
template.templateBody.html.actions.buy.currency
string
obbligatorio
template.templateBody.html.actions.buy.text
string
obbligatorio
template.templateBody.html.actions.type
string
obbligatorio
Possible values: buy
template.templateBody.html.actions.postback
object
obbligatorio
Mostra attributi secondari
template.templateBody.html.actions.postback.handshake
object
Mostra attributi secondari
template.templateBody.html.actions.postback.handshake.packageName
string
obbligatorio
template.templateBody.html.actions.postback.handshake.signatureHash
string
obbligatorio
template.templateBody.html.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
template.templateBody.html.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
template.templateBody.html.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
template.templateBody.html.actions.postback.handshake.text
string
obbligatorio
template.templateBody.html.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
template.templateBody.html.actions.postback.imageUrl
string
template.templateBody.html.actions.postback.metadata
object
Mostra attributi secondari
template.templateBody.html.actions.postback.metadata.description
object
Mostra attributi secondari
template.templateBody.html.actions.postback.metadata.description.label
string
obbligatorio
template.templateBody.html.actions.postback.otpType
string
template.templateBody.html.actions.postback.payload
string
template.templateBody.html.actions.postback.text
string
obbligatorio
template.templateBody.html.actions.type
string
obbligatorio
Possible values: postback
template.templateBody.html.attachments
array of object
Mostra attributi secondari
template.templateBody.html.attachments.content
string
template.templateBody.html.attachments.contentId
string
template.templateBody.html.attachments.contentType
string
template.templateBody.html.attachments.filename
string
obbligatorio
template.templateBody.html.attachments.inline
boolean
template.templateBody.html.attachments.mediaUrl
string
template.templateBody.html.html
string
template.templateBody.html.metadata
object
Mostra attributi secondari
template.templateBody.html.metadata.clickTracking
boolean
template.templateBody.html.metadata.from
object
Mostra attributi secondari
template.templateBody.html.metadata.from.displayName
string
template.templateBody.html.metadata.from.username
string
template.templateBody.html.metadata.headers
object
template.templateBody.html.metadata.initialOpenTracking
boolean
template.templateBody.html.metadata.openTracking
boolean
template.templateBody.html.metadata.subject
string
template.templateBody.html.text
string
template.templateBody.type
string
obbligatorio
Possible values: html
template.templateBody.image
object
obbligatorio
Mostra attributi secondari
template.templateBody.image.actions
array of object
Mostra attributi secondari
template.templateBody.image.actions.link
object
obbligatorio
Mostra attributi secondari
template.templateBody.image.actions.link.metadata
object
Mostra attributi secondari
template.templateBody.image.actions.link.metadata.description
object
Mostra attributi secondari
template.templateBody.image.actions.link.metadata.description.label
string
obbligatorio
template.templateBody.image.actions.link.text
string
obbligatorio
template.templateBody.image.actions.link.url
string
obbligatorio
template.templateBody.image.actions.type
string
obbligatorio
Possible values: link
template.templateBody.image.actions.reply
object
obbligatorio
Mostra attributi secondari
template.templateBody.image.actions.reply.imageUrl
string
template.templateBody.image.actions.reply.metadata
object
Mostra attributi secondari
template.templateBody.image.actions.reply.metadata.description
object
Mostra attributi secondari
template.templateBody.image.actions.reply.metadata.description.label
string
obbligatorio
template.templateBody.image.actions.reply.text
string
obbligatorio
template.templateBody.image.actions.type
string
obbligatorio
Possible values: reply
template.templateBody.image.actions.locationRequest
object
Mostra attributi secondari
template.templateBody.image.actions.locationRequest.text
string
template.templateBody.image.actions.type
string
obbligatorio
Possible values: locationRequest
template.templateBody.image.actions.buy
object
obbligatorio
Mostra attributi secondari
template.templateBody.image.actions.buy.amountCents
integer
obbligatorio
template.templateBody.image.actions.buy.currency
string
obbligatorio
template.templateBody.image.actions.buy.text
string
obbligatorio
template.templateBody.image.actions.type
string
obbligatorio
Possible values: buy
template.templateBody.image.actions.postback
object
obbligatorio
Mostra attributi secondari
template.templateBody.image.actions.postback.handshake
object
Mostra attributi secondari
template.templateBody.image.actions.postback.handshake.packageName
string
obbligatorio
template.templateBody.image.actions.postback.handshake.signatureHash
string
obbligatorio
template.templateBody.image.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
template.templateBody.image.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
template.templateBody.image.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
template.templateBody.image.actions.postback.handshake.text
string
obbligatorio
template.templateBody.image.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
template.templateBody.image.actions.postback.imageUrl
string
template.templateBody.image.actions.postback.metadata
object
Mostra attributi secondari
template.templateBody.image.actions.postback.metadata.description
object
Mostra attributi secondari
template.templateBody.image.actions.postback.metadata.description.label
string
obbligatorio
template.templateBody.image.actions.postback.otpType
string
template.templateBody.image.actions.postback.payload
string
template.templateBody.image.actions.postback.text
string
obbligatorio
template.templateBody.image.actions.type
string
obbligatorio
Possible values: postback
template.templateBody.image.images
array of object
obbligatorio
Mostra attributi secondari
template.templateBody.image.images.altText
string
template.templateBody.image.images.mediaPreviewUrl
string
template.templateBody.image.images.mediaUrl
string
obbligatorio
template.templateBody.image.metadata
object
Mostra attributi secondari
template.templateBody.image.metadata.fallbackText
string
template.templateBody.image.metadata.storyType
string
Possible values: mention, reply
template.templateBody.image.metadata.subject
string
template.templateBody.image.metadata.telegram
object
Mostra attributi secondari
template.templateBody.image.metadata.telegram.parseMode
string
template.templateBody.image.text
string
template.templateBody.type
string
obbligatorio
Possible values: image
template.templateBody.gif
object
obbligatorio
Mostra attributi secondari
template.templateBody.gif.actions
array of object
Mostra attributi secondari
template.templateBody.gif.actions.link
object
obbligatorio
Mostra attributi secondari
template.templateBody.gif.actions.link.metadata
object
Mostra attributi secondari
template.templateBody.gif.actions.link.metadata.description
object
Mostra attributi secondari
template.templateBody.gif.actions.link.metadata.description.label
string
obbligatorio
template.templateBody.gif.actions.link.text
string
obbligatorio
template.templateBody.gif.actions.link.url
string
obbligatorio
template.templateBody.gif.actions.type
string
obbligatorio
Possible values: link
template.templateBody.gif.actions.reply
object
obbligatorio
Mostra attributi secondari
template.templateBody.gif.actions.reply.imageUrl
string
template.templateBody.gif.actions.reply.metadata
object
Mostra attributi secondari
template.templateBody.gif.actions.reply.metadata.description
object
Mostra attributi secondari
template.templateBody.gif.actions.reply.metadata.description.label
string
obbligatorio
template.templateBody.gif.actions.reply.text
string
obbligatorio
template.templateBody.gif.actions.type
string
obbligatorio
Possible values: reply
template.templateBody.gif.actions.locationRequest
object
Mostra attributi secondari
template.templateBody.gif.actions.locationRequest.text
string
template.templateBody.gif.actions.type
string
obbligatorio
Possible values: locationRequest
template.templateBody.gif.actions.buy
object
obbligatorio
Mostra attributi secondari
template.templateBody.gif.actions.buy.amountCents
integer
obbligatorio
template.templateBody.gif.actions.buy.currency
string
obbligatorio
template.templateBody.gif.actions.buy.text
string
obbligatorio
template.templateBody.gif.actions.type
string
obbligatorio
Possible values: buy
template.templateBody.gif.actions.postback
object
obbligatorio
Mostra attributi secondari
template.templateBody.gif.actions.postback.handshake
object
Mostra attributi secondari
template.templateBody.gif.actions.postback.handshake.packageName
string
obbligatorio
template.templateBody.gif.actions.postback.handshake.signatureHash
string
obbligatorio
template.templateBody.gif.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
template.templateBody.gif.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
template.templateBody.gif.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
template.templateBody.gif.actions.postback.handshake.text
string
obbligatorio
template.templateBody.gif.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
template.templateBody.gif.actions.postback.imageUrl
string
template.templateBody.gif.actions.postback.metadata
object
Mostra attributi secondari
template.templateBody.gif.actions.postback.metadata.description
object
Mostra attributi secondari
template.templateBody.gif.actions.postback.metadata.description.label
string
obbligatorio
template.templateBody.gif.actions.postback.otpType
string
template.templateBody.gif.actions.postback.payload
string
template.templateBody.gif.actions.postback.text
string
obbligatorio
template.templateBody.gif.actions.type
string
obbligatorio
Possible values: postback
template.templateBody.gif.altText
string
template.templateBody.gif.mediaUrl
string
obbligatorio
template.templateBody.gif.metadata
object
Mostra attributi secondari
template.templateBody.gif.metadata.telegram
object
Mostra attributi secondari
template.templateBody.gif.metadata.telegram.parseMode
string
template.templateBody.gif.text
string
template.templateBody.type
string
obbligatorio
Possible values: gif
template.templateBody.file
object
obbligatorio
Mostra attributi secondari
template.templateBody.file.actions
array of object
Mostra attributi secondari
template.templateBody.file.actions.link
object
obbligatorio
Mostra attributi secondari
template.templateBody.file.actions.link.metadata
object
Mostra attributi secondari
template.templateBody.file.actions.link.metadata.description
object
Mostra attributi secondari
template.templateBody.file.actions.link.metadata.description.label
string
obbligatorio
template.templateBody.file.actions.link.text
string
obbligatorio
template.templateBody.file.actions.link.url
string
obbligatorio
template.templateBody.file.actions.type
string
obbligatorio
Possible values: link
template.templateBody.file.actions.reply
object
obbligatorio
Mostra attributi secondari
template.templateBody.file.actions.reply.imageUrl
string
template.templateBody.file.actions.reply.metadata
object
Mostra attributi secondari
template.templateBody.file.actions.reply.metadata.description
object
Mostra attributi secondari
template.templateBody.file.actions.reply.metadata.description.label
string
obbligatorio
template.templateBody.file.actions.reply.text
string
obbligatorio
template.templateBody.file.actions.type
string
obbligatorio
Possible values: reply
template.templateBody.file.actions.locationRequest
object
Mostra attributi secondari
template.templateBody.file.actions.locationRequest.text
string
template.templateBody.file.actions.type
string
obbligatorio
Possible values: locationRequest
template.templateBody.file.actions.buy
object
obbligatorio
Mostra attributi secondari
template.templateBody.file.actions.buy.amountCents
integer
obbligatorio
template.templateBody.file.actions.buy.currency
string
obbligatorio
template.templateBody.file.actions.buy.text
string
obbligatorio
template.templateBody.file.actions.type
string
obbligatorio
Possible values: buy
template.templateBody.file.actions.postback
object
obbligatorio
Mostra attributi secondari
template.templateBody.file.actions.postback.handshake
object
Mostra attributi secondari
template.templateBody.file.actions.postback.handshake.packageName
string
obbligatorio
template.templateBody.file.actions.postback.handshake.signatureHash
string
obbligatorio
template.templateBody.file.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
template.templateBody.file.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
template.templateBody.file.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
template.templateBody.file.actions.postback.handshake.text
string
obbligatorio
template.templateBody.file.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
template.templateBody.file.actions.postback.imageUrl
string
template.templateBody.file.actions.postback.metadata
object
Mostra attributi secondari
template.templateBody.file.actions.postback.metadata.description
object
Mostra attributi secondari
template.templateBody.file.actions.postback.metadata.description.label
string
obbligatorio
template.templateBody.file.actions.postback.otpType
string
template.templateBody.file.actions.postback.payload
string
template.templateBody.file.actions.postback.text
string
obbligatorio
template.templateBody.file.actions.type
string
obbligatorio
Possible values: postback
template.templateBody.file.files
array of object
obbligatorio
Mostra attributi secondari
template.templateBody.file.files.altText
string
template.templateBody.file.files.contentType
string
obbligatorio
template.templateBody.file.files.filename
string
template.templateBody.file.files.mediaUrl
string
obbligatorio
template.templateBody.file.files.metadata
object
Mostra attributi secondari
template.templateBody.file.files.metadata.isAnimated
boolean
template.templateBody.file.metadata
object
Mostra attributi secondari
template.templateBody.file.metadata.fallbackText
string
template.templateBody.file.metadata.storyType
string
Possible values: mention, reply
template.templateBody.file.metadata.subject
string
template.templateBody.file.metadata.telegram
object
Mostra attributi secondari
template.templateBody.file.metadata.telegram.parseMode
string
template.templateBody.file.text
string
template.templateBody.type
string
obbligatorio
Possible values: file
template.templateBody.location
object
obbligatorio
Mostra attributi secondari
template.templateBody.location.coordinates
object
obbligatorio
Mostra attributi secondari
template.templateBody.location.coordinates.latitude
number
obbligatorio
template.templateBody.location.coordinates.longitude
number
obbligatorio
template.templateBody.location.location
object
obbligatorio
Mostra attributi secondari
template.templateBody.location.location.address
string
obbligatorio
template.templateBody.location.location.label
string
obbligatorio
template.templateBody.type
string
obbligatorio
Possible values: location
template.templateBody.carousel
object
obbligatorio
Mostra attributi secondari
template.templateBody.carousel.items
array of object
Mostra attributi secondari
template.templateBody.carousel.items.actions
array of object
Mostra attributi secondari
template.templateBody.carousel.items.actions.link
object
obbligatorio
Mostra attributi secondari
template.templateBody.carousel.items.actions.link.metadata
object
Mostra attributi secondari
template.templateBody.carousel.items.actions.link.metadata.description
object
Mostra attributi secondari
template.templateBody.carousel.items.actions.link.metadata.description.label
string
obbligatorio
template.templateBody.carousel.items.actions.link.text
string
obbligatorio
template.templateBody.carousel.items.actions.link.url
string
obbligatorio
template.templateBody.carousel.items.actions.type
string
obbligatorio
Possible values: link
template.templateBody.carousel.items.actions.reply
object
obbligatorio
Mostra attributi secondari
template.templateBody.carousel.items.actions.reply.imageUrl
string
template.templateBody.carousel.items.actions.reply.metadata
object
Mostra attributi secondari
template.templateBody.carousel.items.actions.reply.metadata.description
object
Mostra attributi secondari
template.templateBody.carousel.items.actions.reply.metadata.description.label
string
obbligatorio
template.templateBody.carousel.items.actions.reply.text
string
obbligatorio
template.templateBody.carousel.items.actions.type
string
obbligatorio
Possible values: reply
template.templateBody.carousel.items.actions.locationRequest
object
Mostra attributi secondari
template.templateBody.carousel.items.actions.locationRequest.text
string
template.templateBody.carousel.items.actions.type
string
obbligatorio
Possible values: locationRequest
template.templateBody.carousel.items.actions.buy
object
obbligatorio
Mostra attributi secondari
template.templateBody.carousel.items.actions.buy.amountCents
integer
obbligatorio
template.templateBody.carousel.items.actions.buy.currency
string
obbligatorio
template.templateBody.carousel.items.actions.buy.text
string
obbligatorio
template.templateBody.carousel.items.actions.type
string
obbligatorio
Possible values: buy
template.templateBody.carousel.items.actions.postback
object
obbligatorio
Mostra attributi secondari
template.templateBody.carousel.items.actions.postback.handshake
object
Mostra attributi secondari
template.templateBody.carousel.items.actions.postback.handshake.packageName
string
obbligatorio
template.templateBody.carousel.items.actions.postback.handshake.signatureHash
string
obbligatorio
template.templateBody.carousel.items.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
template.templateBody.carousel.items.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
template.templateBody.carousel.items.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
template.templateBody.carousel.items.actions.postback.handshake.text
string
obbligatorio
template.templateBody.carousel.items.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
template.templateBody.carousel.items.actions.postback.imageUrl
string
template.templateBody.carousel.items.actions.postback.metadata
object
Mostra attributi secondari
template.templateBody.carousel.items.actions.postback.metadata.description
object
Mostra attributi secondari
template.templateBody.carousel.items.actions.postback.metadata.description.label
string
obbligatorio
template.templateBody.carousel.items.actions.postback.otpType
string
template.templateBody.carousel.items.actions.postback.payload
string
template.templateBody.carousel.items.actions.postback.text
string
obbligatorio
template.templateBody.carousel.items.actions.type
string
obbligatorio
Possible values: postback
template.templateBody.carousel.items.altText
string
template.templateBody.carousel.items.description
string
template.templateBody.carousel.items.mediaUrl
string
template.templateBody.carousel.items.size
integer
template.templateBody.carousel.items.title
string
template.templateBody.carousel.text
string
Optional text displayed above the carousel cards.
template.templateBody.type
string
obbligatorio
Possible values: carousel
template.templateBody.list
object
obbligatorio
Mostra attributi secondari
template.templateBody.list.actions
array of object
Mostra attributi secondari
template.templateBody.list.actions.link
object
obbligatorio
Mostra attributi secondari
template.templateBody.list.actions.link.metadata
object
Mostra attributi secondari
template.templateBody.list.actions.link.metadata.description
object
Mostra attributi secondari
template.templateBody.list.actions.link.metadata.description.label
string
obbligatorio
template.templateBody.list.actions.link.text
string
obbligatorio
template.templateBody.list.actions.link.url
string
obbligatorio
template.templateBody.list.actions.type
string
obbligatorio
Possible values: link
template.templateBody.list.actions.reply
object
obbligatorio
Mostra attributi secondari
template.templateBody.list.actions.reply.imageUrl
string
template.templateBody.list.actions.reply.metadata
object
Mostra attributi secondari
template.templateBody.list.actions.reply.metadata.description
object
Mostra attributi secondari
template.templateBody.list.actions.reply.metadata.description.label
string
obbligatorio
template.templateBody.list.actions.reply.text
string
obbligatorio
template.templateBody.list.actions.type
string
obbligatorio
Possible values: reply
template.templateBody.list.actions.locationRequest
object
Mostra attributi secondari
template.templateBody.list.actions.locationRequest.text
string
template.templateBody.list.actions.type
string
obbligatorio
Possible values: locationRequest
template.templateBody.list.actions.buy
object
obbligatorio
Mostra attributi secondari
template.templateBody.list.actions.buy.amountCents
integer
obbligatorio
template.templateBody.list.actions.buy.currency
string
obbligatorio
template.templateBody.list.actions.buy.text
string
obbligatorio
template.templateBody.list.actions.type
string
obbligatorio
Possible values: buy
template.templateBody.list.actions.postback
object
obbligatorio
Mostra attributi secondari
template.templateBody.list.actions.postback.handshake
object
Mostra attributi secondari
template.templateBody.list.actions.postback.handshake.packageName
string
obbligatorio
template.templateBody.list.actions.postback.handshake.signatureHash
string
obbligatorio
template.templateBody.list.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
template.templateBody.list.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
template.templateBody.list.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
template.templateBody.list.actions.postback.handshake.text
string
obbligatorio
template.templateBody.list.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
template.templateBody.list.actions.postback.imageUrl
string
template.templateBody.list.actions.postback.metadata
object
Mostra attributi secondari
template.templateBody.list.actions.postback.metadata.description
object
Mostra attributi secondari
template.templateBody.list.actions.postback.metadata.description.label
string
obbligatorio
template.templateBody.list.actions.postback.otpType
string
template.templateBody.list.actions.postback.payload
string
template.templateBody.list.actions.postback.text
string
obbligatorio
template.templateBody.list.actions.type
string
obbligatorio
Possible values: postback
template.templateBody.list.altText
string
template.templateBody.list.items
array of object
Mostra attributi secondari
template.templateBody.list.items.actions
array of object
Mostra attributi secondari
template.templateBody.list.items.actions.link
object
obbligatorio
Mostra attributi secondari
template.templateBody.list.items.actions.link.metadata
object
Mostra attributi secondari
template.templateBody.list.items.actions.link.metadata.description
object
Mostra attributi secondari
template.templateBody.list.items.actions.link.metadata.description.label
string
obbligatorio
template.templateBody.list.items.actions.link.text
string
obbligatorio
template.templateBody.list.items.actions.link.url
string
obbligatorio
template.templateBody.list.items.actions.type
string
obbligatorio
Possible values: link
template.templateBody.list.items.actions.reply
object
obbligatorio
Mostra attributi secondari
template.templateBody.list.items.actions.reply.imageUrl
string
template.templateBody.list.items.actions.reply.metadata
object
Mostra attributi secondari
template.templateBody.list.items.actions.reply.metadata.description
object
Mostra attributi secondari
template.templateBody.list.items.actions.reply.metadata.description.label
string
obbligatorio
template.templateBody.list.items.actions.reply.text
string
obbligatorio
template.templateBody.list.items.actions.type
string
obbligatorio
Possible values: reply
template.templateBody.list.items.actions.locationRequest
object
Mostra attributi secondari
template.templateBody.list.items.actions.locationRequest.text
string
template.templateBody.list.items.actions.type
string
obbligatorio
Possible values: locationRequest
template.templateBody.list.items.actions.buy
object
obbligatorio
Mostra attributi secondari
template.templateBody.list.items.actions.buy.amountCents
integer
obbligatorio
template.templateBody.list.items.actions.buy.currency
string
obbligatorio
template.templateBody.list.items.actions.buy.text
string
obbligatorio
template.templateBody.list.items.actions.type
string
obbligatorio
Possible values: buy
template.templateBody.list.items.actions.postback
object
obbligatorio
Mostra attributi secondari
template.templateBody.list.items.actions.postback.handshake
object
Mostra attributi secondari
template.templateBody.list.items.actions.postback.handshake.packageName
string
obbligatorio
template.templateBody.list.items.actions.postback.handshake.signatureHash
string
obbligatorio
template.templateBody.list.items.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
template.templateBody.list.items.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
template.templateBody.list.items.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
template.templateBody.list.items.actions.postback.handshake.text
string
obbligatorio
template.templateBody.list.items.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
template.templateBody.list.items.actions.postback.imageUrl
string
template.templateBody.list.items.actions.postback.metadata
object
Mostra attributi secondari
template.templateBody.list.items.actions.postback.metadata.description
object
Mostra attributi secondari
template.templateBody.list.items.actions.postback.metadata.description.label
string
obbligatorio
template.templateBody.list.items.actions.postback.otpType
string
template.templateBody.list.items.actions.postback.payload
string
template.templateBody.list.items.actions.postback.text
string
obbligatorio
template.templateBody.list.items.actions.type
string
obbligatorio
Possible values: postback
template.templateBody.list.items.altText
string
template.templateBody.list.items.description
string
template.templateBody.list.items.mediaUrl
string
template.templateBody.list.items.size
integer
template.templateBody.list.items.title
string
template.templateBody.list.metadata
object
Mostra attributi secondari
template.templateBody.list.metadata.button
object
Mostra attributi secondari
template.templateBody.list.metadata.button.label
string
obbligatorio
template.templateBody.list.metadata.replyMessage
object
Mostra attributi secondari
template.templateBody.list.metadata.replyMessage.text
string
obbligatorio
template.templateBody.list.metadata.replyMessage.title
string
obbligatorio
template.templateBody.list.text
string
template.templateBody.list.title
string
template.templateBody.type
string
obbligatorio
Possible values: list
template.templateBody.section
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.configurations
object
template.templateBody.section.items
array of object
Mostra attributi secondari
template.templateBody.section.items.text
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.text.actions
array of object
Mostra attributi secondari
template.templateBody.section.items.text.actions.link
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.text.actions.link.metadata
object
Mostra attributi secondari
template.templateBody.section.items.text.actions.link.metadata.description
object
Mostra attributi secondari
template.templateBody.section.items.text.actions.link.metadata.description.label
string
obbligatorio
template.templateBody.section.items.text.actions.link.text
string
obbligatorio
template.templateBody.section.items.text.actions.link.url
string
obbligatorio
template.templateBody.section.items.text.actions.type
string
obbligatorio
Possible values: link
template.templateBody.section.items.text.actions.reply
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.text.actions.reply.imageUrl
string
template.templateBody.section.items.text.actions.reply.metadata
object
Mostra attributi secondari
template.templateBody.section.items.text.actions.reply.metadata.description
object
Mostra attributi secondari
template.templateBody.section.items.text.actions.reply.metadata.description.label
string
obbligatorio
template.templateBody.section.items.text.actions.reply.text
string
obbligatorio
template.templateBody.section.items.text.actions.type
string
obbligatorio
Possible values: reply
template.templateBody.section.items.text.actions.locationRequest
object
Mostra attributi secondari
template.templateBody.section.items.text.actions.locationRequest.text
string
template.templateBody.section.items.text.actions.type
string
obbligatorio
Possible values: locationRequest
template.templateBody.section.items.text.actions.buy
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.text.actions.buy.amountCents
integer
obbligatorio
template.templateBody.section.items.text.actions.buy.currency
string
obbligatorio
template.templateBody.section.items.text.actions.buy.text
string
obbligatorio
template.templateBody.section.items.text.actions.type
string
obbligatorio
Possible values: buy
template.templateBody.section.items.text.actions.postback
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.text.actions.postback.handshake
object
Mostra attributi secondari
template.templateBody.section.items.text.actions.postback.handshake.packageName
string
obbligatorio
template.templateBody.section.items.text.actions.postback.handshake.signatureHash
string
obbligatorio
template.templateBody.section.items.text.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
template.templateBody.section.items.text.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
template.templateBody.section.items.text.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
template.templateBody.section.items.text.actions.postback.handshake.text
string
obbligatorio
template.templateBody.section.items.text.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
template.templateBody.section.items.text.actions.postback.imageUrl
string
template.templateBody.section.items.text.actions.postback.metadata
object
Mostra attributi secondari
template.templateBody.section.items.text.actions.postback.metadata.description
object
Mostra attributi secondari
template.templateBody.section.items.text.actions.postback.metadata.description.label
string
obbligatorio
template.templateBody.section.items.text.actions.postback.otpType
string
template.templateBody.section.items.text.actions.postback.payload
string
template.templateBody.section.items.text.actions.postback.text
string
obbligatorio
template.templateBody.section.items.text.actions.type
string
obbligatorio
Possible values: postback
template.templateBody.section.items.text.attachments
array of object
Mostra attributi secondari
template.templateBody.section.items.text.attachments.content
string
template.templateBody.section.items.text.attachments.contentId
string
template.templateBody.section.items.text.attachments.contentType
string
template.templateBody.section.items.text.attachments.filename
string
obbligatorio
template.templateBody.section.items.text.attachments.inline
boolean
template.templateBody.section.items.text.attachments.mediaUrl
string
obbligatorio
template.templateBody.section.items.text.metadata
object
Mostra attributi secondari
template.templateBody.section.items.text.metadata.apple
object
Mostra attributi secondari
template.templateBody.section.items.text.metadata.apple.appClipPreview
boolean
template.templateBody.section.items.text.metadata.apple.appClipRegion
string
template.templateBody.section.items.text.metadata.apple.summaryText
string
template.templateBody.section.items.text.metadata.headers
object
template.templateBody.section.items.text.metadata.line
object
Mostra attributi secondari
template.templateBody.section.items.text.metadata.line.emoji
object
Mostra attributi secondari
template.templateBody.section.items.text.metadata.line.emoji.items
array of object
Mostra attributi secondari
template.templateBody.section.items.text.metadata.line.emoji.items.emojiId
string
obbligatorio
template.templateBody.section.items.text.metadata.line.emoji.items.index
integer
obbligatorio
template.templateBody.section.items.text.metadata.line.emoji.items.length
integer
template.templateBody.section.items.text.metadata.line.emoji.items.productId
string
obbligatorio
template.templateBody.section.items.text.metadata.paymentDetails
object
Mostra attributi secondari
template.templateBody.section.items.text.metadata.paymentDetails.amount
string
obbligatorio
template.templateBody.section.items.text.metadata.paymentDetails.currency
string
obbligatorio
template.templateBody.section.items.text.metadata.paymentDetails.sessionIdentifier
string
template.templateBody.section.items.text.metadata.paymentDetails.state
string
obbligatorio
template.templateBody.section.items.text.metadata.subject
string
template.templateBody.section.items.text.metadata.telegram
object
Mostra attributi secondari
template.templateBody.section.items.text.metadata.telegram.parseMode
string
template.templateBody.section.items.text.metadata.whatsapp
object
Mostra attributi secondari
template.templateBody.section.items.text.metadata.whatsapp.callPermissionExpiration
string
template.templateBody.section.items.text.metadata.whatsapp.callPermissionResponse
string
Possible values: accept, reject
template.templateBody.section.items.text.metadata.whatsapp.previewUrl
boolean
obbligatorio
template.templateBody.section.items.text.metadata.whatsapp.sharedContacts
array of object
Mostra attributi secondari
template.templateBody.section.items.text.metadata.whatsapp.sharedContacts.origin
string
obbligatorio
template.templateBody.section.items.text.metadata.whatsapp.sharedContacts.phones
array of object
Mostra attributi secondari
template.templateBody.section.items.text.metadata.whatsapp.sharedContacts.phones.phone
string
obbligatorio
template.templateBody.section.items.text.metadata.whatsapp.sharedContacts.phones.type
string
obbligatorio
template.templateBody.section.items.text.metadata.whatsapp.sharedContacts.phones.waId
string
obbligatorio
template.templateBody.section.items.text.metadata.whatsapp.sharedContacts.vcard
string
template.templateBody.section.items.text.text
string
obbligatorio
template.templateBody.section.items.type
string
obbligatorio
Possible values: text
template.templateBody.section.items.html
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.html.actions
array of object
Mostra attributi secondari
template.templateBody.section.items.html.actions.link
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.html.actions.link.metadata
object
Mostra attributi secondari
template.templateBody.section.items.html.actions.link.metadata.description
object
Mostra attributi secondari
template.templateBody.section.items.html.actions.link.metadata.description.label
string
obbligatorio
template.templateBody.section.items.html.actions.link.text
string
obbligatorio
template.templateBody.section.items.html.actions.link.url
string
obbligatorio
template.templateBody.section.items.html.actions.type
string
obbligatorio
Possible values: link
template.templateBody.section.items.html.actions.reply
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.html.actions.reply.imageUrl
string
template.templateBody.section.items.html.actions.reply.metadata
object
Mostra attributi secondari
template.templateBody.section.items.html.actions.reply.metadata.description
object
Mostra attributi secondari
template.templateBody.section.items.html.actions.reply.metadata.description.label
string
obbligatorio
template.templateBody.section.items.html.actions.reply.text
string
obbligatorio
template.templateBody.section.items.html.actions.type
string
obbligatorio
Possible values: reply
template.templateBody.section.items.html.actions.locationRequest
object
Mostra attributi secondari
template.templateBody.section.items.html.actions.locationRequest.text
string
template.templateBody.section.items.html.actions.type
string
obbligatorio
Possible values: locationRequest
template.templateBody.section.items.html.actions.buy
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.html.actions.buy.amountCents
integer
obbligatorio
template.templateBody.section.items.html.actions.buy.currency
string
obbligatorio
template.templateBody.section.items.html.actions.buy.text
string
obbligatorio
template.templateBody.section.items.html.actions.type
string
obbligatorio
Possible values: buy
template.templateBody.section.items.html.actions.postback
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.html.actions.postback.handshake
object
Mostra attributi secondari
template.templateBody.section.items.html.actions.postback.handshake.packageName
string
obbligatorio
template.templateBody.section.items.html.actions.postback.handshake.signatureHash
string
obbligatorio
template.templateBody.section.items.html.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
template.templateBody.section.items.html.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
template.templateBody.section.items.html.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
template.templateBody.section.items.html.actions.postback.handshake.text
string
obbligatorio
template.templateBody.section.items.html.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
template.templateBody.section.items.html.actions.postback.imageUrl
string
template.templateBody.section.items.html.actions.postback.metadata
object
Mostra attributi secondari
template.templateBody.section.items.html.actions.postback.metadata.description
object
Mostra attributi secondari
template.templateBody.section.items.html.actions.postback.metadata.description.label
string
obbligatorio
template.templateBody.section.items.html.actions.postback.otpType
string
template.templateBody.section.items.html.actions.postback.payload
string
template.templateBody.section.items.html.actions.postback.text
string
obbligatorio
template.templateBody.section.items.html.actions.type
string
obbligatorio
Possible values: postback
template.templateBody.section.items.html.attachments
array of object
Mostra attributi secondari
template.templateBody.section.items.html.attachments.content
string
template.templateBody.section.items.html.attachments.contentId
string
template.templateBody.section.items.html.attachments.contentType
string
template.templateBody.section.items.html.attachments.filename
string
obbligatorio
template.templateBody.section.items.html.attachments.inline
boolean
template.templateBody.section.items.html.attachments.mediaUrl
string
template.templateBody.section.items.html.html
string
template.templateBody.section.items.html.metadata
object
Mostra attributi secondari
template.templateBody.section.items.html.metadata.clickTracking
boolean
template.templateBody.section.items.html.metadata.from
object
Mostra attributi secondari
template.templateBody.section.items.html.metadata.from.displayName
string
template.templateBody.section.items.html.metadata.from.username
string
template.templateBody.section.items.html.metadata.headers
object
template.templateBody.section.items.html.metadata.initialOpenTracking
boolean
template.templateBody.section.items.html.metadata.openTracking
boolean
template.templateBody.section.items.html.metadata.subject
string
template.templateBody.section.items.html.text
string
template.templateBody.section.items.type
string
obbligatorio
Possible values: html
template.templateBody.section.items.image
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.image.actions
array of object
Mostra attributi secondari
template.templateBody.section.items.image.actions.link
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.image.actions.link.metadata
object
Mostra attributi secondari
template.templateBody.section.items.image.actions.link.metadata.description
object
Mostra attributi secondari
template.templateBody.section.items.image.actions.link.metadata.description.label
string
obbligatorio
template.templateBody.section.items.image.actions.link.text
string
obbligatorio
template.templateBody.section.items.image.actions.link.url
string
obbligatorio
template.templateBody.section.items.image.actions.type
string
obbligatorio
Possible values: link
template.templateBody.section.items.image.actions.reply
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.image.actions.reply.imageUrl
string
template.templateBody.section.items.image.actions.reply.metadata
object
Mostra attributi secondari
template.templateBody.section.items.image.actions.reply.metadata.description
object
Mostra attributi secondari
template.templateBody.section.items.image.actions.reply.metadata.description.label
string
obbligatorio
template.templateBody.section.items.image.actions.reply.text
string
obbligatorio
template.templateBody.section.items.image.actions.type
string
obbligatorio
Possible values: reply
template.templateBody.section.items.image.actions.locationRequest
object
Mostra attributi secondari
template.templateBody.section.items.image.actions.locationRequest.text
string
template.templateBody.section.items.image.actions.type
string
obbligatorio
Possible values: locationRequest
template.templateBody.section.items.image.actions.buy
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.image.actions.buy.amountCents
integer
obbligatorio
template.templateBody.section.items.image.actions.buy.currency
string
obbligatorio
template.templateBody.section.items.image.actions.buy.text
string
obbligatorio
template.templateBody.section.items.image.actions.type
string
obbligatorio
Possible values: buy
template.templateBody.section.items.image.actions.postback
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.image.actions.postback.handshake
object
Mostra attributi secondari
template.templateBody.section.items.image.actions.postback.handshake.packageName
string
obbligatorio
template.templateBody.section.items.image.actions.postback.handshake.signatureHash
string
obbligatorio
template.templateBody.section.items.image.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
template.templateBody.section.items.image.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
template.templateBody.section.items.image.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
template.templateBody.section.items.image.actions.postback.handshake.text
string
obbligatorio
template.templateBody.section.items.image.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
template.templateBody.section.items.image.actions.postback.imageUrl
string
template.templateBody.section.items.image.actions.postback.metadata
object
Mostra attributi secondari
template.templateBody.section.items.image.actions.postback.metadata.description
object
Mostra attributi secondari
template.templateBody.section.items.image.actions.postback.metadata.description.label
string
obbligatorio
template.templateBody.section.items.image.actions.postback.otpType
string
template.templateBody.section.items.image.actions.postback.payload
string
template.templateBody.section.items.image.actions.postback.text
string
obbligatorio
template.templateBody.section.items.image.actions.type
string
obbligatorio
Possible values: postback
template.templateBody.section.items.image.images
array of object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.image.images.altText
string
template.templateBody.section.items.image.images.mediaPreviewUrl
string
template.templateBody.section.items.image.images.mediaUrl
string
obbligatorio
template.templateBody.section.items.image.metadata
object
Mostra attributi secondari
template.templateBody.section.items.image.metadata.fallbackText
string
template.templateBody.section.items.image.metadata.storyType
string
Possible values: mention, reply
template.templateBody.section.items.image.metadata.subject
string
template.templateBody.section.items.image.metadata.telegram
object
Mostra attributi secondari
template.templateBody.section.items.image.metadata.telegram.parseMode
string
template.templateBody.section.items.image.text
string
template.templateBody.section.items.type
string
obbligatorio
Possible values: image
template.templateBody.section.items.gif
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.gif.actions
array of object
Mostra attributi secondari
template.templateBody.section.items.gif.actions.link
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.gif.actions.link.metadata
object
Mostra attributi secondari
template.templateBody.section.items.gif.actions.link.metadata.description
object
Mostra attributi secondari
template.templateBody.section.items.gif.actions.link.metadata.description.label
string
obbligatorio
template.templateBody.section.items.gif.actions.link.text
string
obbligatorio
template.templateBody.section.items.gif.actions.link.url
string
obbligatorio
template.templateBody.section.items.gif.actions.type
string
obbligatorio
Possible values: link
template.templateBody.section.items.gif.actions.reply
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.gif.actions.reply.imageUrl
string
template.templateBody.section.items.gif.actions.reply.metadata
object
Mostra attributi secondari
template.templateBody.section.items.gif.actions.reply.metadata.description
object
Mostra attributi secondari
template.templateBody.section.items.gif.actions.reply.metadata.description.label
string
obbligatorio
template.templateBody.section.items.gif.actions.reply.text
string
obbligatorio
template.templateBody.section.items.gif.actions.type
string
obbligatorio
Possible values: reply
template.templateBody.section.items.gif.actions.locationRequest
object
Mostra attributi secondari
template.templateBody.section.items.gif.actions.locationRequest.text
string
template.templateBody.section.items.gif.actions.type
string
obbligatorio
Possible values: locationRequest
template.templateBody.section.items.gif.actions.buy
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.gif.actions.buy.amountCents
integer
obbligatorio
template.templateBody.section.items.gif.actions.buy.currency
string
obbligatorio
template.templateBody.section.items.gif.actions.buy.text
string
obbligatorio
template.templateBody.section.items.gif.actions.type
string
obbligatorio
Possible values: buy
template.templateBody.section.items.gif.actions.postback
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.gif.actions.postback.handshake
object
Mostra attributi secondari
template.templateBody.section.items.gif.actions.postback.handshake.packageName
string
obbligatorio
template.templateBody.section.items.gif.actions.postback.handshake.signatureHash
string
obbligatorio
template.templateBody.section.items.gif.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
template.templateBody.section.items.gif.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
template.templateBody.section.items.gif.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
template.templateBody.section.items.gif.actions.postback.handshake.text
string
obbligatorio
template.templateBody.section.items.gif.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
template.templateBody.section.items.gif.actions.postback.imageUrl
string
template.templateBody.section.items.gif.actions.postback.metadata
object
Mostra attributi secondari
template.templateBody.section.items.gif.actions.postback.metadata.description
object
Mostra attributi secondari
template.templateBody.section.items.gif.actions.postback.metadata.description.label
string
obbligatorio
template.templateBody.section.items.gif.actions.postback.otpType
string
template.templateBody.section.items.gif.actions.postback.payload
string
template.templateBody.section.items.gif.actions.postback.text
string
obbligatorio
template.templateBody.section.items.gif.actions.type
string
obbligatorio
Possible values: postback
template.templateBody.section.items.gif.altText
string
template.templateBody.section.items.gif.mediaUrl
string
obbligatorio
template.templateBody.section.items.gif.metadata
object
Mostra attributi secondari
template.templateBody.section.items.gif.metadata.telegram
object
Mostra attributi secondari
template.templateBody.section.items.gif.metadata.telegram.parseMode
string
template.templateBody.section.items.gif.text
string
template.templateBody.section.items.type
string
obbligatorio
Possible values: gif
template.templateBody.section.items.file
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.file.actions
array of object
Mostra attributi secondari
template.templateBody.section.items.file.actions.link
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.file.actions.link.metadata
object
Mostra attributi secondari
template.templateBody.section.items.file.actions.link.metadata.description
object
Mostra attributi secondari
template.templateBody.section.items.file.actions.link.metadata.description.label
string
obbligatorio
template.templateBody.section.items.file.actions.link.text
string
obbligatorio
template.templateBody.section.items.file.actions.link.url
string
obbligatorio
template.templateBody.section.items.file.actions.type
string
obbligatorio
Possible values: link
template.templateBody.section.items.file.actions.reply
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.file.actions.reply.imageUrl
string
template.templateBody.section.items.file.actions.reply.metadata
object
Mostra attributi secondari
template.templateBody.section.items.file.actions.reply.metadata.description
object
Mostra attributi secondari
template.templateBody.section.items.file.actions.reply.metadata.description.label
string
obbligatorio
template.templateBody.section.items.file.actions.reply.text
string
obbligatorio
template.templateBody.section.items.file.actions.type
string
obbligatorio
Possible values: reply
template.templateBody.section.items.file.actions.locationRequest
object
Mostra attributi secondari
template.templateBody.section.items.file.actions.locationRequest.text
string
template.templateBody.section.items.file.actions.type
string
obbligatorio
Possible values: locationRequest
template.templateBody.section.items.file.actions.buy
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.file.actions.buy.amountCents
integer
obbligatorio
template.templateBody.section.items.file.actions.buy.currency
string
obbligatorio
template.templateBody.section.items.file.actions.buy.text
string
obbligatorio
template.templateBody.section.items.file.actions.type
string
obbligatorio
Possible values: buy
template.templateBody.section.items.file.actions.postback
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.file.actions.postback.handshake
object
Mostra attributi secondari
template.templateBody.section.items.file.actions.postback.handshake.packageName
string
obbligatorio
template.templateBody.section.items.file.actions.postback.handshake.signatureHash
string
obbligatorio
template.templateBody.section.items.file.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
template.templateBody.section.items.file.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
template.templateBody.section.items.file.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
template.templateBody.section.items.file.actions.postback.handshake.text
string
obbligatorio
template.templateBody.section.items.file.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
template.templateBody.section.items.file.actions.postback.imageUrl
string
template.templateBody.section.items.file.actions.postback.metadata
object
Mostra attributi secondari
template.templateBody.section.items.file.actions.postback.metadata.description
object
Mostra attributi secondari
template.templateBody.section.items.file.actions.postback.metadata.description.label
string
obbligatorio
template.templateBody.section.items.file.actions.postback.otpType
string
template.templateBody.section.items.file.actions.postback.payload
string
template.templateBody.section.items.file.actions.postback.text
string
obbligatorio
template.templateBody.section.items.file.actions.type
string
obbligatorio
Possible values: postback
template.templateBody.section.items.file.files
array of object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.file.files.altText
string
template.templateBody.section.items.file.files.contentType
string
obbligatorio
template.templateBody.section.items.file.files.filename
string
template.templateBody.section.items.file.files.mediaUrl
string
obbligatorio
template.templateBody.section.items.file.files.metadata
object
Mostra attributi secondari
template.templateBody.section.items.file.files.metadata.isAnimated
boolean
template.templateBody.section.items.file.metadata
object
Mostra attributi secondari
template.templateBody.section.items.file.metadata.fallbackText
string
template.templateBody.section.items.file.metadata.storyType
string
Possible values: mention, reply
template.templateBody.section.items.file.metadata.subject
string
template.templateBody.section.items.file.metadata.telegram
object
Mostra attributi secondari
template.templateBody.section.items.file.metadata.telegram.parseMode
string
template.templateBody.section.items.file.text
string
template.templateBody.section.items.type
string
obbligatorio
Possible values: file
template.templateBody.section.items.location
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.location.coordinates
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.location.coordinates.latitude
number
obbligatorio
template.templateBody.section.items.location.coordinates.longitude
number
obbligatorio
template.templateBody.section.items.location.location
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.location.location.address
string
obbligatorio
template.templateBody.section.items.location.location.label
string
obbligatorio
template.templateBody.section.items.type
string
obbligatorio
Possible values: location
template.templateBody.section.items.carousel
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.carousel.items
array of object
Mostra attributi secondari
template.templateBody.section.items.carousel.items.actions
array of object
Mostra attributi secondari
template.templateBody.section.items.carousel.items.actions.link
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.carousel.items.actions.link.metadata
object
Mostra attributi secondari
template.templateBody.section.items.carousel.items.actions.link.metadata.description
object
Mostra attributi secondari
template.templateBody.section.items.carousel.items.actions.link.metadata.description.label
string
obbligatorio
template.templateBody.section.items.carousel.items.actions.link.text
string
obbligatorio
template.templateBody.section.items.carousel.items.actions.link.url
string
obbligatorio
template.templateBody.section.items.carousel.items.actions.type
string
obbligatorio
Possible values: link
template.templateBody.section.items.carousel.items.actions.reply
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.carousel.items.actions.reply.imageUrl
string
template.templateBody.section.items.carousel.items.actions.reply.metadata
object
Mostra attributi secondari
template.templateBody.section.items.carousel.items.actions.reply.metadata.description
object
Mostra attributi secondari
template.templateBody.section.items.carousel.items.actions.reply.metadata.description.label
string
obbligatorio
template.templateBody.section.items.carousel.items.actions.reply.text
string
obbligatorio
template.templateBody.section.items.carousel.items.actions.type
string
obbligatorio
Possible values: reply
template.templateBody.section.items.carousel.items.actions.locationRequest
object
Mostra attributi secondari
template.templateBody.section.items.carousel.items.actions.locationRequest.text
string
template.templateBody.section.items.carousel.items.actions.type
string
obbligatorio
Possible values: locationRequest
template.templateBody.section.items.carousel.items.actions.buy
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.carousel.items.actions.buy.amountCents
integer
obbligatorio
template.templateBody.section.items.carousel.items.actions.buy.currency
string
obbligatorio
template.templateBody.section.items.carousel.items.actions.buy.text
string
obbligatorio
template.templateBody.section.items.carousel.items.actions.type
string
obbligatorio
Possible values: buy
template.templateBody.section.items.carousel.items.actions.postback
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.carousel.items.actions.postback.handshake
object
Mostra attributi secondari
template.templateBody.section.items.carousel.items.actions.postback.handshake.packageName
string
obbligatorio
template.templateBody.section.items.carousel.items.actions.postback.handshake.signatureHash
string
obbligatorio
template.templateBody.section.items.carousel.items.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
template.templateBody.section.items.carousel.items.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
template.templateBody.section.items.carousel.items.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
template.templateBody.section.items.carousel.items.actions.postback.handshake.text
string
obbligatorio
template.templateBody.section.items.carousel.items.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
template.templateBody.section.items.carousel.items.actions.postback.imageUrl
string
template.templateBody.section.items.carousel.items.actions.postback.metadata
object
Mostra attributi secondari
template.templateBody.section.items.carousel.items.actions.postback.metadata.description
object
Mostra attributi secondari
template.templateBody.section.items.carousel.items.actions.postback.metadata.description.label
string
obbligatorio
template.templateBody.section.items.carousel.items.actions.postback.otpType
string
template.templateBody.section.items.carousel.items.actions.postback.payload
string
template.templateBody.section.items.carousel.items.actions.postback.text
string
obbligatorio
template.templateBody.section.items.carousel.items.actions.type
string
obbligatorio
Possible values: postback
template.templateBody.section.items.carousel.items.altText
string
template.templateBody.section.items.carousel.items.description
string
template.templateBody.section.items.carousel.items.mediaUrl
string
template.templateBody.section.items.carousel.items.size
integer
template.templateBody.section.items.carousel.items.title
string
template.templateBody.section.items.carousel.text
string
Optional text displayed above the carousel cards.
template.templateBody.section.items.type
string
obbligatorio
Possible values: carousel
template.templateBody.section.items.list
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.list.actions
array of object
Mostra attributi secondari
template.templateBody.section.items.list.actions.link
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.list.actions.link.metadata
object
Mostra attributi secondari
template.templateBody.section.items.list.actions.link.metadata.description
object
Mostra attributi secondari
template.templateBody.section.items.list.actions.link.metadata.description.label
string
obbligatorio
template.templateBody.section.items.list.actions.link.text
string
obbligatorio
template.templateBody.section.items.list.actions.link.url
string
obbligatorio
template.templateBody.section.items.list.actions.type
string
obbligatorio
Possible values: link
template.templateBody.section.items.list.actions.reply
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.list.actions.reply.imageUrl
string
template.templateBody.section.items.list.actions.reply.metadata
object
Mostra attributi secondari
template.templateBody.section.items.list.actions.reply.metadata.description
object
Mostra attributi secondari
template.templateBody.section.items.list.actions.reply.metadata.description.label
string
obbligatorio
template.templateBody.section.items.list.actions.reply.text
string
obbligatorio
template.templateBody.section.items.list.actions.type
string
obbligatorio
Possible values: reply
template.templateBody.section.items.list.actions.locationRequest
object
Mostra attributi secondari
template.templateBody.section.items.list.actions.locationRequest.text
string
template.templateBody.section.items.list.actions.type
string
obbligatorio
Possible values: locationRequest
template.templateBody.section.items.list.actions.buy
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.list.actions.buy.amountCents
integer
obbligatorio
template.templateBody.section.items.list.actions.buy.currency
string
obbligatorio
template.templateBody.section.items.list.actions.buy.text
string
obbligatorio
template.templateBody.section.items.list.actions.type
string
obbligatorio
Possible values: buy
template.templateBody.section.items.list.actions.postback
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.list.actions.postback.handshake
object
Mostra attributi secondari
template.templateBody.section.items.list.actions.postback.handshake.packageName
string
obbligatorio
template.templateBody.section.items.list.actions.postback.handshake.signatureHash
string
obbligatorio
template.templateBody.section.items.list.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
template.templateBody.section.items.list.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
template.templateBody.section.items.list.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
template.templateBody.section.items.list.actions.postback.handshake.text
string
obbligatorio
template.templateBody.section.items.list.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
template.templateBody.section.items.list.actions.postback.imageUrl
string
template.templateBody.section.items.list.actions.postback.metadata
object
Mostra attributi secondari
template.templateBody.section.items.list.actions.postback.metadata.description
object
Mostra attributi secondari
template.templateBody.section.items.list.actions.postback.metadata.description.label
string
obbligatorio
template.templateBody.section.items.list.actions.postback.otpType
string
template.templateBody.section.items.list.actions.postback.payload
string
template.templateBody.section.items.list.actions.postback.text
string
obbligatorio
template.templateBody.section.items.list.actions.type
string
obbligatorio
Possible values: postback
template.templateBody.section.items.list.altText
string
template.templateBody.section.items.list.items
array of object
Mostra attributi secondari
template.templateBody.section.items.list.items.actions
array of object
Mostra attributi secondari
template.templateBody.section.items.list.items.actions.link
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.list.items.actions.link.metadata
object
Mostra attributi secondari
template.templateBody.section.items.list.items.actions.link.metadata.description
object
Mostra attributi secondari
template.templateBody.section.items.list.items.actions.link.metadata.description.label
string
obbligatorio
template.templateBody.section.items.list.items.actions.link.text
string
obbligatorio
template.templateBody.section.items.list.items.actions.link.url
string
obbligatorio
template.templateBody.section.items.list.items.actions.type
string
obbligatorio
Possible values: link
template.templateBody.section.items.list.items.actions.reply
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.list.items.actions.reply.imageUrl
string
template.templateBody.section.items.list.items.actions.reply.metadata
object
Mostra attributi secondari
template.templateBody.section.items.list.items.actions.reply.metadata.description
object
Mostra attributi secondari
template.templateBody.section.items.list.items.actions.reply.metadata.description.label
string
obbligatorio
template.templateBody.section.items.list.items.actions.reply.text
string
obbligatorio
template.templateBody.section.items.list.items.actions.type
string
obbligatorio
Possible values: reply
template.templateBody.section.items.list.items.actions.locationRequest
object
Mostra attributi secondari
template.templateBody.section.items.list.items.actions.locationRequest.text
string
template.templateBody.section.items.list.items.actions.type
string
obbligatorio
Possible values: locationRequest
template.templateBody.section.items.list.items.actions.buy
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.list.items.actions.buy.amountCents
integer
obbligatorio
template.templateBody.section.items.list.items.actions.buy.currency
string
obbligatorio
template.templateBody.section.items.list.items.actions.buy.text
string
obbligatorio
template.templateBody.section.items.list.items.actions.type
string
obbligatorio
Possible values: buy
template.templateBody.section.items.list.items.actions.postback
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.list.items.actions.postback.handshake
object
Mostra attributi secondari
template.templateBody.section.items.list.items.actions.postback.handshake.packageName
string
obbligatorio
template.templateBody.section.items.list.items.actions.postback.handshake.signatureHash
string
obbligatorio
template.templateBody.section.items.list.items.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
template.templateBody.section.items.list.items.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
template.templateBody.section.items.list.items.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
template.templateBody.section.items.list.items.actions.postback.handshake.text
string
obbligatorio
template.templateBody.section.items.list.items.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
template.templateBody.section.items.list.items.actions.postback.imageUrl
string
template.templateBody.section.items.list.items.actions.postback.metadata
object
Mostra attributi secondari
template.templateBody.section.items.list.items.actions.postback.metadata.description
object
Mostra attributi secondari
template.templateBody.section.items.list.items.actions.postback.metadata.description.label
string
obbligatorio
template.templateBody.section.items.list.items.actions.postback.otpType
string
template.templateBody.section.items.list.items.actions.postback.payload
string
template.templateBody.section.items.list.items.actions.postback.text
string
obbligatorio
template.templateBody.section.items.list.items.actions.type
string
obbligatorio
Possible values: postback
template.templateBody.section.items.list.items.altText
string
template.templateBody.section.items.list.items.description
string
template.templateBody.section.items.list.items.mediaUrl
string
template.templateBody.section.items.list.items.size
integer
template.templateBody.section.items.list.items.title
string
template.templateBody.section.items.list.metadata
object
Mostra attributi secondari
template.templateBody.section.items.list.metadata.button
object
Mostra attributi secondari
template.templateBody.section.items.list.metadata.button.label
string
obbligatorio
template.templateBody.section.items.list.metadata.replyMessage
object
Mostra attributi secondari
template.templateBody.section.items.list.metadata.replyMessage.text
string
obbligatorio
template.templateBody.section.items.list.metadata.replyMessage.title
string
obbligatorio
template.templateBody.section.items.list.text
string
template.templateBody.section.items.list.title
string
template.templateBody.section.items.type
string
obbligatorio
Possible values: list
template.templateBody.section.items.section
object
obbligatorio
template.templateBody.section.items.type
string
obbligatorio
Possible values: section
template.templateBody.section.items.authentication
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.authentication.otp
object
Mostra attributi secondari
template.templateBody.section.items.authentication.otp.actions
array of object
Mostra attributi secondari
template.templateBody.section.items.authentication.otp.actions.link
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.authentication.otp.actions.link.metadata
object
Mostra attributi secondari
template.templateBody.section.items.authentication.otp.actions.link.metadata.description
object
Mostra attributi secondari
template.templateBody.section.items.authentication.otp.actions.link.metadata.description.label
string
obbligatorio
template.templateBody.section.items.authentication.otp.actions.link.text
string
obbligatorio
template.templateBody.section.items.authentication.otp.actions.link.url
string
obbligatorio
template.templateBody.section.items.authentication.otp.actions.type
string
obbligatorio
Possible values: link
template.templateBody.section.items.authentication.otp.actions.reply
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.authentication.otp.actions.reply.imageUrl
string
template.templateBody.section.items.authentication.otp.actions.reply.metadata
object
Mostra attributi secondari
template.templateBody.section.items.authentication.otp.actions.reply.metadata.description
object
Mostra attributi secondari
template.templateBody.section.items.authentication.otp.actions.reply.metadata.description.label
string
obbligatorio
template.templateBody.section.items.authentication.otp.actions.reply.text
string
obbligatorio
template.templateBody.section.items.authentication.otp.actions.type
string
obbligatorio
Possible values: reply
template.templateBody.section.items.authentication.otp.actions.locationRequest
object
Mostra attributi secondari
template.templateBody.section.items.authentication.otp.actions.locationRequest.text
string
template.templateBody.section.items.authentication.otp.actions.type
string
obbligatorio
Possible values: locationRequest
template.templateBody.section.items.authentication.otp.actions.buy
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.authentication.otp.actions.buy.amountCents
integer
obbligatorio
template.templateBody.section.items.authentication.otp.actions.buy.currency
string
obbligatorio
template.templateBody.section.items.authentication.otp.actions.buy.text
string
obbligatorio
template.templateBody.section.items.authentication.otp.actions.type
string
obbligatorio
Possible values: buy
template.templateBody.section.items.authentication.otp.actions.postback
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.authentication.otp.actions.postback.handshake
object
Mostra attributi secondari
template.templateBody.section.items.authentication.otp.actions.postback.handshake.packageName
string
obbligatorio
template.templateBody.section.items.authentication.otp.actions.postback.handshake.signatureHash
string
obbligatorio
template.templateBody.section.items.authentication.otp.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
template.templateBody.section.items.authentication.otp.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
template.templateBody.section.items.authentication.otp.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
template.templateBody.section.items.authentication.otp.actions.postback.handshake.text
string
obbligatorio
template.templateBody.section.items.authentication.otp.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
template.templateBody.section.items.authentication.otp.actions.postback.imageUrl
string
template.templateBody.section.items.authentication.otp.actions.postback.metadata
object
Mostra attributi secondari
template.templateBody.section.items.authentication.otp.actions.postback.metadata.description
object
Mostra attributi secondari
template.templateBody.section.items.authentication.otp.actions.postback.metadata.description.label
string
obbligatorio
template.templateBody.section.items.authentication.otp.actions.postback.otpType
string
template.templateBody.section.items.authentication.otp.actions.postback.payload
string
template.templateBody.section.items.authentication.otp.actions.postback.text
string
obbligatorio
template.templateBody.section.items.authentication.otp.actions.type
string
obbligatorio
Possible values: postback
template.templateBody.section.items.authentication.otp.disclaimer
boolean
obbligatorio
Whether to add a security disclaimer to the authentication body.
template.templateBody.section.items.authentication.otp.expirationTime
integer
The number of seconds after which the authentication code expires. If not set, no expiration notification is sent.
template.templateBody.section.items.type
string
obbligatorio
Possible values: authentication
template.templateBody.section.items.action
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.action.action
string
obbligatorio
Possible values: permissionRequest
template.templateBody.section.items.action.permissionRequest
object
obbligatorio
Mostra attributi secondari
template.templateBody.section.items.action.permissionRequest.resource
string
obbligatorio
Possible values: call
template.templateBody.section.items.type
string
obbligatorio
Possible values: action
template.templateBody.type
string
obbligatorio
Possible values: section
template.templateBody.authentication
object
obbligatorio
Mostra attributi secondari
template.templateBody.authentication.otp
object
Mostra attributi secondari
template.templateBody.authentication.otp.actions
array of object
Mostra attributi secondari
template.templateBody.authentication.otp.actions.link
object
obbligatorio
Mostra attributi secondari
template.templateBody.authentication.otp.actions.link.metadata
object
Mostra attributi secondari
template.templateBody.authentication.otp.actions.link.metadata.description
object
Mostra attributi secondari
template.templateBody.authentication.otp.actions.link.metadata.description.label
string
obbligatorio
template.templateBody.authentication.otp.actions.link.text
string
obbligatorio
template.templateBody.authentication.otp.actions.link.url
string
obbligatorio
template.templateBody.authentication.otp.actions.type
string
obbligatorio
Possible values: link
template.templateBody.authentication.otp.actions.reply
object
obbligatorio
Mostra attributi secondari
template.templateBody.authentication.otp.actions.reply.imageUrl
string
template.templateBody.authentication.otp.actions.reply.metadata
object
Mostra attributi secondari
template.templateBody.authentication.otp.actions.reply.metadata.description
object
Mostra attributi secondari
template.templateBody.authentication.otp.actions.reply.metadata.description.label
string
obbligatorio
template.templateBody.authentication.otp.actions.reply.text
string
obbligatorio
template.templateBody.authentication.otp.actions.type
string
obbligatorio
Possible values: reply
template.templateBody.authentication.otp.actions.locationRequest
object
Mostra attributi secondari
template.templateBody.authentication.otp.actions.locationRequest.text
string
template.templateBody.authentication.otp.actions.type
string
obbligatorio
Possible values: locationRequest
template.templateBody.authentication.otp.actions.buy
object
obbligatorio
Mostra attributi secondari
template.templateBody.authentication.otp.actions.buy.amountCents
integer
obbligatorio
template.templateBody.authentication.otp.actions.buy.currency
string
obbligatorio
template.templateBody.authentication.otp.actions.buy.text
string
obbligatorio
template.templateBody.authentication.otp.actions.type
string
obbligatorio
Possible values: buy
template.templateBody.authentication.otp.actions.postback
object
obbligatorio
Mostra attributi secondari
template.templateBody.authentication.otp.actions.postback.handshake
object
Mostra attributi secondari
template.templateBody.authentication.otp.actions.postback.handshake.packageName
string
obbligatorio
template.templateBody.authentication.otp.actions.postback.handshake.signatureHash
string
obbligatorio
template.templateBody.authentication.otp.actions.postback.handshake.supportedApps
array of object
Mostra attributi secondari
template.templateBody.authentication.otp.actions.postback.handshake.supportedApps.packageName
string
obbligatorio
template.templateBody.authentication.otp.actions.postback.handshake.supportedApps.signatureHash
string
obbligatorio
template.templateBody.authentication.otp.actions.postback.handshake.text
string
obbligatorio
template.templateBody.authentication.otp.actions.postback.handshake.zeroTapTermsAccepted
boolean
obbligatorio
template.templateBody.authentication.otp.actions.postback.imageUrl
string
template.templateBody.authentication.otp.actions.postback.metadata
object
Mostra attributi secondari
template.templateBody.authentication.otp.actions.postback.metadata.description
object
Mostra attributi secondari
template.templateBody.authentication.otp.actions.postback.metadata.description.label
string
obbligatorio
template.templateBody.authentication.otp.actions.postback.otpType
string
template.templateBody.authentication.otp.actions.postback.payload
string
template.templateBody.authentication.otp.actions.postback.text
string
obbligatorio
template.templateBody.authentication.otp.actions.type
string
obbligatorio
Possible values: postback
template.templateBody.authentication.otp.disclaimer
boolean
obbligatorio
Whether to add a security disclaimer to the authentication body.
template.templateBody.authentication.otp.expirationTime
integer
The number of seconds after which the authentication code expires. If not set, no expiration notification is sent.
template.templateBody.type
string
obbligatorio
Possible values: authentication
template.templateBody.action
object
obbligatorio
Mostra attributi secondari
template.templateBody.action.action
string
obbligatorio
Possible values: permissionRequest
template.templateBody.action.permissionRequest
object
obbligatorio
Mostra attributi secondari
template.templateBody.action.permissionRequest.resource
string
obbligatorio
Possible values: call
template.templateBody.type
string
obbligatorio
Possible values: action
template.utmParameters
array of object
Mostra attributi secondari
template.utmParameters.key
string
obbligatorio
template.utmParameters.value
string
obbligatorio
template.utmParameters.key
string
obbligatorio
template.utmParameters.reference
string
obbligatorio
Possible values: platform_name, channel_name
template.variables
object
template.version
string
obbligatorio
The version of the template.
updatedAt
string
obbligatorio
Esempio di codice
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/channels/{channelId}/messages/{messageId}' \
-H 'Authorization: AccessKey YOUR_ACCESS_KEY'Create a Customize Navigator
If you want to limit the selection of channels a navigator can access, you can create a customized one.
POST
/workspaces/{workspaceId}/navigators
Create a new navigator for the workspace.
Payload della richiesta
name
string
obbligatorio
The name of the navigator.
type
string
obbligatorio
The type of navigator defines how the navigator selects a channel for a message. * messaging - navigator configured with a pool of channels and performs channel selection based on channel availability and best originator type for a recipient country. The best originator type for a recipient country is determined by the strategy - prioritized list of originator types for each country. At this moment, the default pre-configured strategy (set of country policies) is used see https://docs.bird.com/applications/channels/channels/supported-channels/sms/concepts/choosing-the-right-sender-availability-and-restrictions-by-country
Possible values: messaging
settings
object
obbligatorio
Mostra parametri secondari
settings.channels
array of object
obbligatorio
List of channels to be used
Mostra parametri secondari
settings.channels.channelId
string
obbligatorio
settings.channels.countries
array of string
ISO 3166-1 alpha-2 codes this channel may be used for. Omit or leave empty to allow every country. RCS availability is granted per carrier per country, so an RCS channel should always name the countries it covers.
settings.preferredChannels
array of object
Channels attempted in this order ahead of anything the country policy yields. Listing a channel here is the opt-in; a channel present only in channels stays policy-gated however its platform routes.
Mostra parametri secondari
settings.preferredChannels.channelId
string
obbligatorio
settings.preferredChannels.countries
array of string
ISO 3166-1 alpha-2 codes this channel may be used for. Omit or leave empty to allow every country. RCS availability is granted per carrier per country, so an RCS channel should always name the countries it covers.
Payload della risposta
navigatorId
string
obbligatorio
workspaceId
string
obbligatorio
name
string
obbligatorio
The name of the navigator.
type
string
obbligatorio
The type of navigator defines how the navigator selects a channel for a message. * messaging - navigator configured with a pool of channels and performs channel selection based on channel availability and best originator type for a recipient country. The best originator type for a recipient country is determined by the strategy - prioritized list of originator types for each country. At this moment, the default pre-configured strategy (set of country policies) is used see https://docs.bird.com/applications/channels/channels/supported-channels/sms/concepts/choosing-the-right-sender-availability-and-restrictions-by-country
Possible values: messaging, use-case-messaging, otp
settings
object
obbligatorio
Mostra attributi secondari
settings.channels
array of object
obbligatorio
List of channels to be used
Mostra attributi secondari
settings.channels.channelId
string
obbligatorio
settings.channels.countries
array of string
ISO 3166-1 alpha-2 codes this channel may be used for. Omit or leave empty to allow every country. RCS availability is granted per carrier per country, so an RCS channel should always name the countries it covers.
settings.preferredChannels
array of object
Channels attempted in this order ahead of anything the country policy yields. Listing a channel here is the opt-in; a channel present only in channels stays policy-gated however its platform routes.
Mostra attributi secondari
settings.preferredChannels.channelId
string
obbligatorio
settings.preferredChannels.countries
array of string
ISO 3166-1 alpha-2 codes this channel may be used for. Omit or leave empty to allow every country. RCS availability is granted per carrier per country, so an RCS channel should always name the countries it covers.
settings.useCaseType
string
obbligatorio
Possible values: otp, transactional, marketing, conversation
settings.ottChannels
array of object
OTT channels the navigator attempts before SMS, in order. Each entry may be scoped to the countries where its sender is launched.
Mostra attributi secondari
settings.ottChannels.channelId
string
obbligatorio
settings.ottChannels.countries
array of string
ISO 3166-1 alpha-2 codes this channel may be used for. Omit or leave empty to allow every country. RCS availability is granted per carrier per country, so an RCS channel should always name the countries it covers.
settings.ottChannelsIds
object
Enrols one OTT channel per platform key. Channels enrolled this way join the navigator's pool without being preferred, so the country policy decides whether they are used. Use ottChannels to attempt them ahead of SMS, in a chosen order, and to scope them by country.
Mostra attributi secondari
settings.ottChannelsIds.whatsapp
string
Channel for WA
settings.ottChannelsIds.rcs
string
Channel for RCS
createdAt
string
obbligatorio
updatedAt
string
Esempio di codice
curl -X POST 'https://api.bird.com/workspaces/{workspaceId}/navigators' \
-H 'Authorization: AccessKey YOUR_ACCESS_KEY'Update a Navigator
You can add or remove channels from a navigator
PATCH
/workspaces/{workspaceId}/navigators/{navigatorId}
Update a navigator by ID
Payload della richiesta
name
string
obbligatorio
The name of the navigator.
type
string
obbligatorio
The type of navigator defines how the navigator selects a channel for a message. * messaging - navigator configured with a pool of channels and performs channel selection based on channel availability and best originator type for a recipient country. The best originator type for a recipient country is determined by the strategy - prioritized list of originator types for each country. At this moment, the default pre-configured strategy (set of country policies) is used see https://docs.bird.com/applications/channels/channels/supported-channels/sms/concepts/choosing-the-right-sender-availability-and-restrictions-by-country
Possible values: messaging, use-case-messaging, otp
settings
object
Mostra parametri secondari
settings.channels
array of object
obbligatorio
List of channels to be used
Mostra parametri secondari
settings.channels.channelId
string
obbligatorio
settings.channels.countries
array of string
ISO 3166-1 alpha-2 codes this channel may be used for. Omit or leave empty to allow every country. RCS availability is granted per carrier per country, so an RCS channel should always name the countries it covers.
settings.preferredChannels
array of object
Channels attempted in this order ahead of anything the country policy yields. Listing a channel here is the opt-in; a channel present only in channels stays policy-gated however its platform routes.
Mostra parametri secondari
settings.preferredChannels.channelId
string
obbligatorio
settings.preferredChannels.countries
array of string
ISO 3166-1 alpha-2 codes this channel may be used for. Omit or leave empty to allow every country. RCS availability is granted per carrier per country, so an RCS channel should always name the countries it covers.
settings.useCaseType
string
obbligatorio
Possible values: otp, transactional, marketing, conversation
settings.ottChannels
array of object
OTT channels the navigator attempts before SMS, in order. Each entry may be scoped to the countries where its sender is launched.
Mostra parametri secondari
settings.ottChannels.channelId
string
obbligatorio
settings.ottChannels.countries
array of string
ISO 3166-1 alpha-2 codes this channel may be used for. Omit or leave empty to allow every country. RCS availability is granted per carrier per country, so an RCS channel should always name the countries it covers.
settings.ottChannelsIds
object
Enrols one OTT channel per platform key. Channels enrolled this way join the navigator's pool without being preferred, so the country policy decides whether they are used. Use ottChannels to attempt them ahead of SMS, in a chosen order, and to scope them by country.
Mostra parametri secondari
settings.ottChannelsIds.whatsapp
string
Channel for WA
settings.ottChannelsIds.rcs
string
Channel for RCS
Esempio di codice
curl -X PATCH 'https://api.bird.com/workspaces/{workspaceId}/navigators/{navigatorId}' \
-H 'Authorization: AccessKey YOUR_ACCESS_KEY'Delete a Navigator
DELETE
/workspaces/{workspaceId}/navigators/{navigatorId}
Delete the navigator by ID
Esempio di codice
curl -X DELETE 'https://api.bird.com/workspaces/{workspaceId}/navigators/{navigatorId}' \
-H 'Authorization: AccessKey YOUR_ACCESS_KEY'Check Logs & Insight
You can check SMS and Log insight separately via the relevant SMS and WhatsApp tabs in our developer view, you can also use the dedicated Navigator logs, which does allow the tracking of attempts and fallbacks
