Get conversation message
GET
/workspaces/{workspaceId}/conversations/{conversationId}/messages/{messageId}
Get a message from a conversation
Antwoord-payload
body
object
Onderliggende attributen tonen
body.text
object
verplicht
Onderliggende attributen tonen
body.text.actions
array of object
Onderliggende attributen tonen
body.text.actions.link
object
verplicht
Onderliggende attributen tonen
body.text.actions.link.metadata
object
Onderliggende attributen tonen
body.text.actions.link.metadata.description
object
Onderliggende attributen tonen
body.text.actions.link.metadata.description.label
string
verplicht
body.text.actions.link.text
string
verplicht
body.text.actions.link.url
string
verplicht
body.text.actions.type
string
verplicht
Possible values: link
body.text.actions.reply
object
verplicht
Onderliggende attributen tonen
body.text.actions.reply.imageUrl
string
body.text.actions.reply.metadata
object
Onderliggende attributen tonen
body.text.actions.reply.metadata.description
object
Onderliggende attributen tonen
body.text.actions.reply.metadata.description.label
string
verplicht
body.text.actions.reply.text
string
verplicht
body.text.actions.type
string
verplicht
Possible values: reply
body.text.actions.locationRequest
object
Onderliggende attributen tonen
body.text.actions.locationRequest.text
string
body.text.actions.type
string
verplicht
Possible values: locationRequest
body.text.actions.buy
object
verplicht
Onderliggende attributen tonen
body.text.actions.buy.amountCents
integer
verplicht
body.text.actions.buy.currency
string
verplicht
body.text.actions.buy.text
string
verplicht
body.text.actions.type
string
verplicht
Possible values: buy
body.text.actions.postback
object
verplicht
Onderliggende attributen tonen
body.text.actions.postback.handshake
object
Onderliggende attributen tonen
body.text.actions.postback.handshake.packageName
string
verplicht
body.text.actions.postback.handshake.signatureHash
string
verplicht
body.text.actions.postback.handshake.supportedApps
array of object
Onderliggende attributen tonen
body.text.actions.postback.handshake.supportedApps.packageName
string
verplicht
body.text.actions.postback.handshake.supportedApps.signatureHash
string
verplicht
body.text.actions.postback.handshake.text
string
verplicht
body.text.actions.postback.handshake.zeroTapTermsAccepted
boolean
verplicht
body.text.actions.postback.imageUrl
string
body.text.actions.postback.metadata
object
Onderliggende attributen tonen
body.text.actions.postback.metadata.description
object
Onderliggende attributen tonen
body.text.actions.postback.metadata.description.label
string
verplicht
body.text.actions.postback.otpType
string
body.text.actions.postback.payload
string
body.text.actions.postback.text
string
verplicht
body.text.actions.type
string
verplicht
Possible values: postback
body.text.attachments
array of object
Onderliggende attributen tonen
body.text.attachments.content
string
body.text.attachments.contentId
string
body.text.attachments.contentType
string
body.text.attachments.filename
string
verplicht
body.text.attachments.inline
boolean
body.text.attachments.mediaUrl
string
verplicht
body.text.metadata
object
Onderliggende attributen tonen
body.text.metadata.apple
object
Onderliggende attributen tonen
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
Onderliggende attributen tonen
body.text.metadata.line.emoji
object
Onderliggende attributen tonen
body.text.metadata.line.emoji.items
array of object
Onderliggende attributen tonen
body.text.metadata.line.emoji.items.emojiId
string
verplicht
body.text.metadata.line.emoji.items.index
integer
verplicht
body.text.metadata.line.emoji.items.length
integer
body.text.metadata.line.emoji.items.productId
string
verplicht
body.text.metadata.paymentDetails
object
Onderliggende attributen tonen
body.text.metadata.paymentDetails.amount
string
verplicht
body.text.metadata.paymentDetails.currency
string
verplicht
body.text.metadata.paymentDetails.sessionIdentifier
string
body.text.metadata.paymentDetails.state
string
verplicht
body.text.metadata.subject
string
body.text.metadata.telegram
object
Onderliggende attributen tonen
body.text.metadata.telegram.parseMode
string
body.text.metadata.whatsapp
object
Onderliggende attributen tonen
body.text.metadata.whatsapp.callPermissionExpiration
string
body.text.metadata.whatsapp.callPermissionResponse
string
Possible values: accept, reject
body.text.metadata.whatsapp.previewUrl
boolean
verplicht
body.text.metadata.whatsapp.sharedContacts
array of object
Onderliggende attributen tonen
body.text.metadata.whatsapp.sharedContacts.origin
string
verplicht
body.text.metadata.whatsapp.sharedContacts.phones
array of object
Onderliggende attributen tonen
body.text.metadata.whatsapp.sharedContacts.phones.phone
string
verplicht
body.text.metadata.whatsapp.sharedContacts.phones.type
string
verplicht
body.text.metadata.whatsapp.sharedContacts.phones.waId
string
verplicht
body.text.metadata.whatsapp.sharedContacts.vcard
string
body.text.text
string
verplicht
body.type
string
verplicht
Possible values: text
body.html
object
verplicht
Onderliggende attributen tonen
body.html.actions
array of object
Onderliggende attributen tonen
body.html.actions.link
object
verplicht
Onderliggende attributen tonen
body.html.actions.link.metadata
object
Onderliggende attributen tonen
body.html.actions.link.metadata.description
object
Onderliggende attributen tonen
body.html.actions.link.metadata.description.label
string
verplicht
body.html.actions.link.text
string
verplicht
body.html.actions.link.url
string
verplicht
body.html.actions.type
string
verplicht
Possible values: link
body.html.actions.reply
object
verplicht
Onderliggende attributen tonen
body.html.actions.reply.imageUrl
string
body.html.actions.reply.metadata
object
Onderliggende attributen tonen
body.html.actions.reply.metadata.description
object
Onderliggende attributen tonen
body.html.actions.reply.metadata.description.label
string
verplicht
body.html.actions.reply.text
string
verplicht
body.html.actions.type
string
verplicht
Possible values: reply
body.html.actions.locationRequest
object
Onderliggende attributen tonen
body.html.actions.locationRequest.text
string
body.html.actions.type
string
verplicht
Possible values: locationRequest
body.html.actions.buy
object
verplicht
Onderliggende attributen tonen
body.html.actions.buy.amountCents
integer
verplicht
body.html.actions.buy.currency
string
verplicht
body.html.actions.buy.text
string
verplicht
body.html.actions.type
string
verplicht
Possible values: buy
body.html.actions.postback
object
verplicht
Onderliggende attributen tonen
body.html.actions.postback.handshake
object
Onderliggende attributen tonen
body.html.actions.postback.handshake.packageName
string
verplicht
body.html.actions.postback.handshake.signatureHash
string
verplicht
body.html.actions.postback.handshake.supportedApps
array of object
Onderliggende attributen tonen
body.html.actions.postback.handshake.supportedApps.packageName
string
verplicht
body.html.actions.postback.handshake.supportedApps.signatureHash
string
verplicht
body.html.actions.postback.handshake.text
string
verplicht
body.html.actions.postback.handshake.zeroTapTermsAccepted
boolean
verplicht
body.html.actions.postback.imageUrl
string
body.html.actions.postback.metadata
object
Onderliggende attributen tonen
body.html.actions.postback.metadata.description
object
Onderliggende attributen tonen
body.html.actions.postback.metadata.description.label
string
verplicht
body.html.actions.postback.otpType
string
body.html.actions.postback.payload
string
body.html.actions.postback.text
string
verplicht
body.html.actions.type
string
verplicht
Possible values: postback
body.html.attachments
array of object
Onderliggende attributen tonen
body.html.attachments.content
string
body.html.attachments.contentId
string
body.html.attachments.contentType
string
body.html.attachments.filename
string
verplicht
body.html.attachments.inline
boolean
body.html.attachments.mediaUrl
string
body.html.html
string
body.html.metadata
object
Onderliggende attributen tonen
body.html.metadata.clickTracking
boolean
body.html.metadata.from
object
Onderliggende attributen tonen
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
verplicht
Possible values: html
body.image
object
verplicht
Onderliggende attributen tonen
body.image.actions
array of object
Onderliggende attributen tonen
body.image.actions.link
object
verplicht
Onderliggende attributen tonen
body.image.actions.link.metadata
object
Onderliggende attributen tonen
body.image.actions.link.metadata.description
object
Onderliggende attributen tonen
body.image.actions.link.metadata.description.label
string
verplicht
body.image.actions.link.text
string
verplicht
body.image.actions.link.url
string
verplicht
body.image.actions.type
string
verplicht
Possible values: link
body.image.actions.reply
object
verplicht
Onderliggende attributen tonen
body.image.actions.reply.imageUrl
string
body.image.actions.reply.metadata
object
Onderliggende attributen tonen
body.image.actions.reply.metadata.description
object
Onderliggende attributen tonen
body.image.actions.reply.metadata.description.label
string
verplicht
body.image.actions.reply.text
string
verplicht
body.image.actions.type
string
verplicht
Possible values: reply
body.image.actions.locationRequest
object
Onderliggende attributen tonen
body.image.actions.locationRequest.text
string
body.image.actions.type
string
verplicht
Possible values: locationRequest
body.image.actions.buy
object
verplicht
Onderliggende attributen tonen
body.image.actions.buy.amountCents
integer
verplicht
body.image.actions.buy.currency
string
verplicht
body.image.actions.buy.text
string
verplicht
body.image.actions.type
string
verplicht
Possible values: buy
body.image.actions.postback
object
verplicht
Onderliggende attributen tonen
body.image.actions.postback.handshake
object
Onderliggende attributen tonen
body.image.actions.postback.handshake.packageName
string
verplicht
body.image.actions.postback.handshake.signatureHash
string
verplicht
body.image.actions.postback.handshake.supportedApps
array of object
Onderliggende attributen tonen
body.image.actions.postback.handshake.supportedApps.packageName
string
verplicht
body.image.actions.postback.handshake.supportedApps.signatureHash
string
verplicht
body.image.actions.postback.handshake.text
string
verplicht
body.image.actions.postback.handshake.zeroTapTermsAccepted
boolean
verplicht
body.image.actions.postback.imageUrl
string
body.image.actions.postback.metadata
object
Onderliggende attributen tonen
body.image.actions.postback.metadata.description
object
Onderliggende attributen tonen
body.image.actions.postback.metadata.description.label
string
verplicht
body.image.actions.postback.otpType
string
body.image.actions.postback.payload
string
body.image.actions.postback.text
string
verplicht
body.image.actions.type
string
verplicht
Possible values: postback
body.image.images
array of object
verplicht
Onderliggende attributen tonen
body.image.images.altText
string
body.image.images.mediaPreviewUrl
string
body.image.images.mediaUrl
string
verplicht
body.image.metadata
object
Onderliggende attributen tonen
body.image.metadata.fallbackText
string
body.image.metadata.storyType
string
Possible values: mention, reply
body.image.metadata.subject
string
body.image.metadata.telegram
object
Onderliggende attributen tonen
body.image.metadata.telegram.parseMode
string
body.image.text
string
body.type
string
verplicht
Possible values: image
body.gif
object
verplicht
Onderliggende attributen tonen
body.gif.actions
array of object
Onderliggende attributen tonen
body.gif.actions.link
object
verplicht
Onderliggende attributen tonen
body.gif.actions.link.metadata
object
Onderliggende attributen tonen
body.gif.actions.link.metadata.description
object
Onderliggende attributen tonen
body.gif.actions.link.metadata.description.label
string
verplicht
body.gif.actions.link.text
string
verplicht
body.gif.actions.link.url
string
verplicht
body.gif.actions.type
string
verplicht
Possible values: link
body.gif.actions.reply
object
verplicht
Onderliggende attributen tonen
body.gif.actions.reply.imageUrl
string
body.gif.actions.reply.metadata
object
Onderliggende attributen tonen
body.gif.actions.reply.metadata.description
object
Onderliggende attributen tonen
body.gif.actions.reply.metadata.description.label
string
verplicht
body.gif.actions.reply.text
string
verplicht
body.gif.actions.type
string
verplicht
Possible values: reply
body.gif.actions.locationRequest
object
Onderliggende attributen tonen
body.gif.actions.locationRequest.text
string
body.gif.actions.type
string
verplicht
Possible values: locationRequest
body.gif.actions.buy
object
verplicht
Onderliggende attributen tonen
body.gif.actions.buy.amountCents
integer
verplicht
body.gif.actions.buy.currency
string
verplicht
body.gif.actions.buy.text
string
verplicht
body.gif.actions.type
string
verplicht
Possible values: buy
body.gif.actions.postback
object
verplicht
Onderliggende attributen tonen
body.gif.actions.postback.handshake
object
Onderliggende attributen tonen
body.gif.actions.postback.handshake.packageName
string
verplicht
body.gif.actions.postback.handshake.signatureHash
string
verplicht
body.gif.actions.postback.handshake.supportedApps
array of object
Onderliggende attributen tonen
body.gif.actions.postback.handshake.supportedApps.packageName
string
verplicht
body.gif.actions.postback.handshake.supportedApps.signatureHash
string
verplicht
body.gif.actions.postback.handshake.text
string
verplicht
body.gif.actions.postback.handshake.zeroTapTermsAccepted
boolean
verplicht
body.gif.actions.postback.imageUrl
string
body.gif.actions.postback.metadata
object
Onderliggende attributen tonen
body.gif.actions.postback.metadata.description
object
Onderliggende attributen tonen
body.gif.actions.postback.metadata.description.label
string
verplicht
body.gif.actions.postback.otpType
string
body.gif.actions.postback.payload
string
body.gif.actions.postback.text
string
verplicht
body.gif.actions.type
string
verplicht
Possible values: postback
body.gif.altText
string
body.gif.mediaUrl
string
verplicht
body.gif.metadata
object
Onderliggende attributen tonen
body.gif.metadata.telegram
object
Onderliggende attributen tonen
body.gif.metadata.telegram.parseMode
string
body.gif.text
string
body.type
string
verplicht
Possible values: gif
body.file
object
verplicht
Onderliggende attributen tonen
body.file.actions
array of object
Onderliggende attributen tonen
body.file.actions.link
object
verplicht
Onderliggende attributen tonen
body.file.actions.link.metadata
object
Onderliggende attributen tonen
body.file.actions.link.metadata.description
object
Onderliggende attributen tonen
body.file.actions.link.metadata.description.label
string
verplicht
body.file.actions.link.text
string
verplicht
body.file.actions.link.url
string
verplicht
body.file.actions.type
string
verplicht
Possible values: link
body.file.actions.reply
object
verplicht
Onderliggende attributen tonen
body.file.actions.reply.imageUrl
string
body.file.actions.reply.metadata
object
Onderliggende attributen tonen
body.file.actions.reply.metadata.description
object
Onderliggende attributen tonen
body.file.actions.reply.metadata.description.label
string
verplicht
body.file.actions.reply.text
string
verplicht
body.file.actions.type
string
verplicht
Possible values: reply
body.file.actions.locationRequest
object
Onderliggende attributen tonen
body.file.actions.locationRequest.text
string
body.file.actions.type
string
verplicht
Possible values: locationRequest
body.file.actions.buy
object
verplicht
Onderliggende attributen tonen
body.file.actions.buy.amountCents
integer
verplicht
body.file.actions.buy.currency
string
verplicht
body.file.actions.buy.text
string
verplicht
body.file.actions.type
string
verplicht
Possible values: buy
body.file.actions.postback
object
verplicht
Onderliggende attributen tonen
body.file.actions.postback.handshake
object
Onderliggende attributen tonen
body.file.actions.postback.handshake.packageName
string
verplicht
body.file.actions.postback.handshake.signatureHash
string
verplicht
body.file.actions.postback.handshake.supportedApps
array of object
Onderliggende attributen tonen
body.file.actions.postback.handshake.supportedApps.packageName
string
verplicht
body.file.actions.postback.handshake.supportedApps.signatureHash
string
verplicht
body.file.actions.postback.handshake.text
string
verplicht
body.file.actions.postback.handshake.zeroTapTermsAccepted
boolean
verplicht
body.file.actions.postback.imageUrl
string
body.file.actions.postback.metadata
object
Onderliggende attributen tonen
body.file.actions.postback.metadata.description
object
Onderliggende attributen tonen
body.file.actions.postback.metadata.description.label
string
verplicht
body.file.actions.postback.otpType
string
body.file.actions.postback.payload
string
body.file.actions.postback.text
string
verplicht
body.file.actions.type
string
verplicht
Possible values: postback
body.file.files
array of object
verplicht
Onderliggende attributen tonen
body.file.files.altText
string
body.file.files.contentType
string
verplicht
body.file.files.filename
string
body.file.files.mediaUrl
string
verplicht
body.file.files.metadata
object
Onderliggende attributen tonen
body.file.files.metadata.isAnimated
boolean
body.file.metadata
object
Onderliggende attributen tonen
body.file.metadata.fallbackText
string
body.file.metadata.storyType
string
Possible values: mention, reply
body.file.metadata.subject
string
body.file.metadata.telegram
object
Onderliggende attributen tonen
body.file.metadata.telegram.parseMode
string
body.file.text
string
body.type
string
verplicht
Possible values: file
body.location
object
verplicht
Onderliggende attributen tonen
body.location.coordinates
object
verplicht
Onderliggende attributen tonen
body.location.coordinates.latitude
number
verplicht
body.location.coordinates.longitude
number
verplicht
body.location.location
object
verplicht
Onderliggende attributen tonen
body.location.location.address
string
verplicht
body.location.location.label
string
verplicht
body.type
string
verplicht
Possible values: location
body.carousel
object
verplicht
Onderliggende attributen tonen
body.carousel.items
array of object
Onderliggende attributen tonen
body.carousel.items.actions
array of object
Onderliggende attributen tonen
body.carousel.items.actions.link
object
verplicht
Onderliggende attributen tonen
body.carousel.items.actions.link.metadata
object
Onderliggende attributen tonen
body.carousel.items.actions.link.metadata.description
object
Onderliggende attributen tonen
body.carousel.items.actions.link.metadata.description.label
string
verplicht
body.carousel.items.actions.link.text
string
verplicht
body.carousel.items.actions.link.url
string
verplicht
body.carousel.items.actions.type
string
verplicht
Possible values: link
body.carousel.items.actions.reply
object
verplicht
Onderliggende attributen tonen
body.carousel.items.actions.reply.imageUrl
string
body.carousel.items.actions.reply.metadata
object
Onderliggende attributen tonen
body.carousel.items.actions.reply.metadata.description
object
Onderliggende attributen tonen
body.carousel.items.actions.reply.metadata.description.label
string
verplicht
body.carousel.items.actions.reply.text
string
verplicht
body.carousel.items.actions.type
string
verplicht
Possible values: reply
body.carousel.items.actions.locationRequest
object
Onderliggende attributen tonen
body.carousel.items.actions.locationRequest.text
string
body.carousel.items.actions.type
string
verplicht
Possible values: locationRequest
body.carousel.items.actions.buy
object
verplicht
Onderliggende attributen tonen
body.carousel.items.actions.buy.amountCents
integer
verplicht
body.carousel.items.actions.buy.currency
string
verplicht
body.carousel.items.actions.buy.text
string
verplicht
body.carousel.items.actions.type
string
verplicht
Possible values: buy
body.carousel.items.actions.postback
object
verplicht
Onderliggende attributen tonen
body.carousel.items.actions.postback.handshake
object
Onderliggende attributen tonen
body.carousel.items.actions.postback.handshake.packageName
string
verplicht
body.carousel.items.actions.postback.handshake.signatureHash
string
verplicht
body.carousel.items.actions.postback.handshake.supportedApps
array of object
Onderliggende attributen tonen
body.carousel.items.actions.postback.handshake.supportedApps.packageName
string
verplicht
body.carousel.items.actions.postback.handshake.supportedApps.signatureHash
string
verplicht
body.carousel.items.actions.postback.handshake.text
string
verplicht
body.carousel.items.actions.postback.handshake.zeroTapTermsAccepted
boolean
verplicht
body.carousel.items.actions.postback.imageUrl
string
body.carousel.items.actions.postback.metadata
object
Onderliggende attributen tonen
body.carousel.items.actions.postback.metadata.description
object
Onderliggende attributen tonen
body.carousel.items.actions.postback.metadata.description.label
string
verplicht
body.carousel.items.actions.postback.otpType
string
body.carousel.items.actions.postback.payload
string
body.carousel.items.actions.postback.text
string
verplicht
body.carousel.items.actions.type
string
verplicht
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
verplicht
Possible values: carousel
body.list
object
verplicht
Onderliggende attributen tonen
body.list.actions
array of object
Onderliggende attributen tonen
body.list.actions.link
object
verplicht
Onderliggende attributen tonen
body.list.actions.link.metadata
object
Onderliggende attributen tonen
body.list.actions.link.metadata.description
object
Onderliggende attributen tonen
body.list.actions.link.metadata.description.label
string
verplicht
body.list.actions.link.text
string
verplicht
body.list.actions.link.url
string
verplicht
body.list.actions.type
string
verplicht
Possible values: link
body.list.actions.reply
object
verplicht
Onderliggende attributen tonen
body.list.actions.reply.imageUrl
string
body.list.actions.reply.metadata
object
Onderliggende attributen tonen
body.list.actions.reply.metadata.description
object
Onderliggende attributen tonen
body.list.actions.reply.metadata.description.label
string
verplicht
body.list.actions.reply.text
string
verplicht
body.list.actions.type
string
verplicht
Possible values: reply
body.list.actions.locationRequest
object
Onderliggende attributen tonen
body.list.actions.locationRequest.text
string
body.list.actions.type
string
verplicht
Possible values: locationRequest
body.list.actions.buy
object
verplicht
Onderliggende attributen tonen
body.list.actions.buy.amountCents
integer
verplicht
body.list.actions.buy.currency
string
verplicht
body.list.actions.buy.text
string
verplicht
body.list.actions.type
string
verplicht
Possible values: buy
body.list.actions.postback
object
verplicht
Onderliggende attributen tonen
body.list.actions.postback.handshake
object
Onderliggende attributen tonen
body.list.actions.postback.handshake.packageName
string
verplicht
body.list.actions.postback.handshake.signatureHash
string
verplicht
body.list.actions.postback.handshake.supportedApps
array of object
Onderliggende attributen tonen
body.list.actions.postback.handshake.supportedApps.packageName
string
verplicht
body.list.actions.postback.handshake.supportedApps.signatureHash
string
verplicht
body.list.actions.postback.handshake.text
string
verplicht
body.list.actions.postback.handshake.zeroTapTermsAccepted
boolean
verplicht
body.list.actions.postback.imageUrl
string
body.list.actions.postback.metadata
object
Onderliggende attributen tonen
body.list.actions.postback.metadata.description
object
Onderliggende attributen tonen
body.list.actions.postback.metadata.description.label
string
verplicht
body.list.actions.postback.otpType
string
body.list.actions.postback.payload
string
body.list.actions.postback.text
string
verplicht
body.list.actions.type
string
verplicht
Possible values: postback
body.list.altText
string
body.list.items
array of object
Onderliggende attributen tonen
body.list.items.actions
array of object
Onderliggende attributen tonen
body.list.items.actions.link
object
verplicht
Onderliggende attributen tonen
body.list.items.actions.link.metadata
object
Onderliggende attributen tonen
body.list.items.actions.link.metadata.description
object
Onderliggende attributen tonen
body.list.items.actions.link.metadata.description.label
string
verplicht
body.list.items.actions.link.text
string
verplicht
body.list.items.actions.link.url
string
verplicht
body.list.items.actions.type
string
verplicht
Possible values: link
body.list.items.actions.reply
object
verplicht
Onderliggende attributen tonen
body.list.items.actions.reply.imageUrl
string
body.list.items.actions.reply.metadata
object
Onderliggende attributen tonen
body.list.items.actions.reply.metadata.description
object
Onderliggende attributen tonen
body.list.items.actions.reply.metadata.description.label
string
verplicht
body.list.items.actions.reply.text
string
verplicht
body.list.items.actions.type
string
verplicht
Possible values: reply
body.list.items.actions.locationRequest
object
Onderliggende attributen tonen
body.list.items.actions.locationRequest.text
string
body.list.items.actions.type
string
verplicht
Possible values: locationRequest
body.list.items.actions.buy
object
verplicht
Onderliggende attributen tonen
body.list.items.actions.buy.amountCents
integer
verplicht
body.list.items.actions.buy.currency
string
verplicht
body.list.items.actions.buy.text
string
verplicht
body.list.items.actions.type
string
verplicht
Possible values: buy
body.list.items.actions.postback
object
verplicht
Onderliggende attributen tonen
body.list.items.actions.postback.handshake
object
Onderliggende attributen tonen
body.list.items.actions.postback.handshake.packageName
string
verplicht
body.list.items.actions.postback.handshake.signatureHash
string
verplicht
body.list.items.actions.postback.handshake.supportedApps
array of object
Onderliggende attributen tonen
body.list.items.actions.postback.handshake.supportedApps.packageName
string
verplicht
body.list.items.actions.postback.handshake.supportedApps.signatureHash
string
verplicht
body.list.items.actions.postback.handshake.text
string
verplicht
body.list.items.actions.postback.handshake.zeroTapTermsAccepted
boolean
verplicht
body.list.items.actions.postback.imageUrl
string
body.list.items.actions.postback.metadata
object
Onderliggende attributen tonen
body.list.items.actions.postback.metadata.description
object
Onderliggende attributen tonen
body.list.items.actions.postback.metadata.description.label
string
verplicht
body.list.items.actions.postback.otpType
string
body.list.items.actions.postback.payload
string
body.list.items.actions.postback.text
string
verplicht
body.list.items.actions.type
string
verplicht
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
Onderliggende attributen tonen
body.list.metadata.button
object
Onderliggende attributen tonen
body.list.metadata.button.label
string
verplicht
body.list.metadata.replyMessage
object
Onderliggende attributen tonen
body.list.metadata.replyMessage.text
string
verplicht
body.list.metadata.replyMessage.title
string
verplicht
body.list.text
string
body.list.title
string
body.type
string
verplicht
Possible values: list
body.section
object
verplicht
Onderliggende attributen tonen
body.section.configurations
object
body.section.items
array of object
Onderliggende attributen tonen
body.section.items.text
object
verplicht
Onderliggende attributen tonen
body.section.items.text.actions
array of object
Onderliggende attributen tonen
body.section.items.text.actions.link
object
verplicht
Onderliggende attributen tonen
body.section.items.text.actions.link.metadata
object
Onderliggende attributen tonen
body.section.items.text.actions.link.metadata.description
object
Onderliggende attributen tonen
body.section.items.text.actions.link.metadata.description.label
string
verplicht
body.section.items.text.actions.link.text
string
verplicht
body.section.items.text.actions.link.url
string
verplicht
body.section.items.text.actions.type
string
verplicht
Possible values: link
body.section.items.text.actions.reply
object
verplicht
Onderliggende attributen tonen
body.section.items.text.actions.reply.imageUrl
string
body.section.items.text.actions.reply.metadata
object
Onderliggende attributen tonen
body.section.items.text.actions.reply.metadata.description
object
Onderliggende attributen tonen
body.section.items.text.actions.reply.metadata.description.label
string
verplicht
body.section.items.text.actions.reply.text
string
verplicht
body.section.items.text.actions.type
string
verplicht
Possible values: reply
body.section.items.text.actions.locationRequest
object
Onderliggende attributen tonen
body.section.items.text.actions.locationRequest.text
string
body.section.items.text.actions.type
string
verplicht
Possible values: locationRequest
body.section.items.text.actions.buy
object
verplicht
Onderliggende attributen tonen
body.section.items.text.actions.buy.amountCents
integer
verplicht
body.section.items.text.actions.buy.currency
string
verplicht
body.section.items.text.actions.buy.text
string
verplicht
body.section.items.text.actions.type
string
verplicht
Possible values: buy
body.section.items.text.actions.postback
object
verplicht
Onderliggende attributen tonen
body.section.items.text.actions.postback.handshake
object
Onderliggende attributen tonen
body.section.items.text.actions.postback.handshake.packageName
string
verplicht
body.section.items.text.actions.postback.handshake.signatureHash
string
verplicht
body.section.items.text.actions.postback.handshake.supportedApps
array of object
Onderliggende attributen tonen
body.section.items.text.actions.postback.handshake.supportedApps.packageName
string
verplicht
body.section.items.text.actions.postback.handshake.supportedApps.signatureHash
string
verplicht
body.section.items.text.actions.postback.handshake.text
string
verplicht
body.section.items.text.actions.postback.handshake.zeroTapTermsAccepted
boolean
verplicht
body.section.items.text.actions.postback.imageUrl
string
body.section.items.text.actions.postback.metadata
object
Onderliggende attributen tonen
body.section.items.text.actions.postback.metadata.description
object
Onderliggende attributen tonen
body.section.items.text.actions.postback.metadata.description.label
string
verplicht
body.section.items.text.actions.postback.otpType
string
body.section.items.text.actions.postback.payload
string
body.section.items.text.actions.postback.text
string
verplicht
body.section.items.text.actions.type
string
verplicht
Possible values: postback
body.section.items.text.attachments
array of object
Onderliggende attributen tonen
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
verplicht
body.section.items.text.attachments.inline
boolean
body.section.items.text.attachments.mediaUrl
string
verplicht
body.section.items.text.metadata
object
Onderliggende attributen tonen
body.section.items.text.metadata.apple
object
Onderliggende attributen tonen
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
Onderliggende attributen tonen
body.section.items.text.metadata.line.emoji
object
Onderliggende attributen tonen
body.section.items.text.metadata.line.emoji.items
array of object
Onderliggende attributen tonen
body.section.items.text.metadata.line.emoji.items.emojiId
string
verplicht
body.section.items.text.metadata.line.emoji.items.index
integer
verplicht
body.section.items.text.metadata.line.emoji.items.length
integer
body.section.items.text.metadata.line.emoji.items.productId
string
verplicht
body.section.items.text.metadata.paymentDetails
object
Onderliggende attributen tonen
body.section.items.text.metadata.paymentDetails.amount
string
verplicht
body.section.items.text.metadata.paymentDetails.currency
string
verplicht
body.section.items.text.metadata.paymentDetails.sessionIdentifier
string
body.section.items.text.metadata.paymentDetails.state
string
verplicht
body.section.items.text.metadata.subject
string
body.section.items.text.metadata.telegram
object
Onderliggende attributen tonen
body.section.items.text.metadata.telegram.parseMode
string
body.section.items.text.metadata.whatsapp
object
Onderliggende attributen tonen
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
verplicht
body.section.items.text.metadata.whatsapp.sharedContacts
array of object
Onderliggende attributen tonen
body.section.items.text.metadata.whatsapp.sharedContacts.origin
string
verplicht
body.section.items.text.metadata.whatsapp.sharedContacts.phones
array of object
Onderliggende attributen tonen
body.section.items.text.metadata.whatsapp.sharedContacts.phones.phone
string
verplicht
body.section.items.text.metadata.whatsapp.sharedContacts.phones.type
string
verplicht
body.section.items.text.metadata.whatsapp.sharedContacts.phones.waId
string
verplicht
body.section.items.text.metadata.whatsapp.sharedContacts.vcard
string
body.section.items.text.text
string
verplicht
body.section.items.type
string
verplicht
Possible values: text
body.section.items.html
object
verplicht
Onderliggende attributen tonen
body.section.items.html.actions
array of object
Onderliggende attributen tonen
body.section.items.html.actions.link
object
verplicht
Onderliggende attributen tonen
body.section.items.html.actions.link.metadata
object
Onderliggende attributen tonen
body.section.items.html.actions.link.metadata.description
object
Onderliggende attributen tonen
body.section.items.html.actions.link.metadata.description.label
string
verplicht
body.section.items.html.actions.link.text
string
verplicht
body.section.items.html.actions.link.url
string
verplicht
body.section.items.html.actions.type
string
verplicht
Possible values: link
body.section.items.html.actions.reply
object
verplicht
Onderliggende attributen tonen
body.section.items.html.actions.reply.imageUrl
string
body.section.items.html.actions.reply.metadata
object
Onderliggende attributen tonen
body.section.items.html.actions.reply.metadata.description
object
Onderliggende attributen tonen
body.section.items.html.actions.reply.metadata.description.label
string
verplicht
body.section.items.html.actions.reply.text
string
verplicht
body.section.items.html.actions.type
string
verplicht
Possible values: reply
body.section.items.html.actions.locationRequest
object
Onderliggende attributen tonen
body.section.items.html.actions.locationRequest.text
string
body.section.items.html.actions.type
string
verplicht
Possible values: locationRequest
body.section.items.html.actions.buy
object
verplicht
Onderliggende attributen tonen
body.section.items.html.actions.buy.amountCents
integer
verplicht
body.section.items.html.actions.buy.currency
string
verplicht
body.section.items.html.actions.buy.text
string
verplicht
body.section.items.html.actions.type
string
verplicht
Possible values: buy
body.section.items.html.actions.postback
object
verplicht
Onderliggende attributen tonen
body.section.items.html.actions.postback.handshake
object
Onderliggende attributen tonen
body.section.items.html.actions.postback.handshake.packageName
string
verplicht
body.section.items.html.actions.postback.handshake.signatureHash
string
verplicht
body.section.items.html.actions.postback.handshake.supportedApps
array of object
Onderliggende attributen tonen
body.section.items.html.actions.postback.handshake.supportedApps.packageName
string
verplicht
body.section.items.html.actions.postback.handshake.supportedApps.signatureHash
string
verplicht
body.section.items.html.actions.postback.handshake.text
string
verplicht
body.section.items.html.actions.postback.handshake.zeroTapTermsAccepted
boolean
verplicht
body.section.items.html.actions.postback.imageUrl
string
body.section.items.html.actions.postback.metadata
object
Onderliggende attributen tonen
body.section.items.html.actions.postback.metadata.description
object
Onderliggende attributen tonen
body.section.items.html.actions.postback.metadata.description.label
string
verplicht
body.section.items.html.actions.postback.otpType
string
body.section.items.html.actions.postback.payload
string
body.section.items.html.actions.postback.text
string
verplicht
body.section.items.html.actions.type
string
verplicht
Possible values: postback
body.section.items.html.attachments
array of object
Onderliggende attributen tonen
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
verplicht
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
Onderliggende attributen tonen
body.section.items.html.metadata.clickTracking
boolean
body.section.items.html.metadata.from
object
Onderliggende attributen tonen
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
verplicht
Possible values: html
body.section.items.image
object
verplicht
Onderliggende attributen tonen
body.section.items.image.actions
array of object
Onderliggende attributen tonen
body.section.items.image.actions.link
object
verplicht
Onderliggende attributen tonen
body.section.items.image.actions.link.metadata
object
Onderliggende attributen tonen
body.section.items.image.actions.link.metadata.description
object
Onderliggende attributen tonen
body.section.items.image.actions.link.metadata.description.label
string
verplicht
body.section.items.image.actions.link.text
string
verplicht
body.section.items.image.actions.link.url
string
verplicht
body.section.items.image.actions.type
string
verplicht
Possible values: link
body.section.items.image.actions.reply
object
verplicht
Onderliggende attributen tonen
body.section.items.image.actions.reply.imageUrl
string
body.section.items.image.actions.reply.metadata
object
Onderliggende attributen tonen
body.section.items.image.actions.reply.metadata.description
object
Onderliggende attributen tonen
body.section.items.image.actions.reply.metadata.description.label
string
verplicht
body.section.items.image.actions.reply.text
string
verplicht
body.section.items.image.actions.type
string
verplicht
Possible values: reply
body.section.items.image.actions.locationRequest
object
Onderliggende attributen tonen
body.section.items.image.actions.locationRequest.text
string
body.section.items.image.actions.type
string
verplicht
Possible values: locationRequest
body.section.items.image.actions.buy
object
verplicht
Onderliggende attributen tonen
body.section.items.image.actions.buy.amountCents
integer
verplicht
body.section.items.image.actions.buy.currency
string
verplicht
body.section.items.image.actions.buy.text
string
verplicht
body.section.items.image.actions.type
string
verplicht
Possible values: buy
body.section.items.image.actions.postback
object
verplicht
Onderliggende attributen tonen
body.section.items.image.actions.postback.handshake
object
Onderliggende attributen tonen
body.section.items.image.actions.postback.handshake.packageName
string
verplicht
body.section.items.image.actions.postback.handshake.signatureHash
string
verplicht
body.section.items.image.actions.postback.handshake.supportedApps
array of object
Onderliggende attributen tonen
body.section.items.image.actions.postback.handshake.supportedApps.packageName
string
verplicht
body.section.items.image.actions.postback.handshake.supportedApps.signatureHash
string
verplicht
body.section.items.image.actions.postback.handshake.text
string
verplicht
body.section.items.image.actions.postback.handshake.zeroTapTermsAccepted
boolean
verplicht
body.section.items.image.actions.postback.imageUrl
string
body.section.items.image.actions.postback.metadata
object
Onderliggende attributen tonen
body.section.items.image.actions.postback.metadata.description
object
Onderliggende attributen tonen
body.section.items.image.actions.postback.metadata.description.label
string
verplicht
body.section.items.image.actions.postback.otpType
string
body.section.items.image.actions.postback.payload
string
body.section.items.image.actions.postback.text
string
verplicht
body.section.items.image.actions.type
string
verplicht
Possible values: postback
body.section.items.image.images
array of object
verplicht
Onderliggende attributen tonen
body.section.items.image.images.altText
string
body.section.items.image.images.mediaPreviewUrl
string
body.section.items.image.images.mediaUrl
string
verplicht
body.section.items.image.metadata
object
Onderliggende attributen tonen
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
Onderliggende attributen tonen
body.section.items.image.metadata.telegram.parseMode
string
body.section.items.image.text
string
body.section.items.type
string
verplicht
Possible values: image
body.section.items.gif
object
verplicht
Onderliggende attributen tonen
body.section.items.gif.actions
array of object
Onderliggende attributen tonen
body.section.items.gif.actions.link
object
verplicht
Onderliggende attributen tonen
body.section.items.gif.actions.link.metadata
object
Onderliggende attributen tonen
body.section.items.gif.actions.link.metadata.description
object
Onderliggende attributen tonen
body.section.items.gif.actions.link.metadata.description.label
string
verplicht
body.section.items.gif.actions.link.text
string
verplicht
body.section.items.gif.actions.link.url
string
verplicht
body.section.items.gif.actions.type
string
verplicht
Possible values: link
body.section.items.gif.actions.reply
object
verplicht
Onderliggende attributen tonen
body.section.items.gif.actions.reply.imageUrl
string
body.section.items.gif.actions.reply.metadata
object
Onderliggende attributen tonen
body.section.items.gif.actions.reply.metadata.description
object
Onderliggende attributen tonen
body.section.items.gif.actions.reply.metadata.description.label
string
verplicht
body.section.items.gif.actions.reply.text
string
verplicht
body.section.items.gif.actions.type
string
verplicht
Possible values: reply
body.section.items.gif.actions.locationRequest
object
Onderliggende attributen tonen
body.section.items.gif.actions.locationRequest.text
string
body.section.items.gif.actions.type
string
verplicht
Possible values: locationRequest
body.section.items.gif.actions.buy
object
verplicht
Onderliggende attributen tonen
body.section.items.gif.actions.buy.amountCents
integer
verplicht
body.section.items.gif.actions.buy.currency
string
verplicht
body.section.items.gif.actions.buy.text
string
verplicht
body.section.items.gif.actions.type
string
verplicht
Possible values: buy
body.section.items.gif.actions.postback
object
verplicht
Onderliggende attributen tonen
body.section.items.gif.actions.postback.handshake
object
Onderliggende attributen tonen
body.section.items.gif.actions.postback.handshake.packageName
string
verplicht
body.section.items.gif.actions.postback.handshake.signatureHash
string
verplicht
body.section.items.gif.actions.postback.handshake.supportedApps
array of object
Onderliggende attributen tonen
body.section.items.gif.actions.postback.handshake.supportedApps.packageName
string
verplicht
body.section.items.gif.actions.postback.handshake.supportedApps.signatureHash
string
verplicht
body.section.items.gif.actions.postback.handshake.text
string
verplicht
body.section.items.gif.actions.postback.handshake.zeroTapTermsAccepted
boolean
verplicht
body.section.items.gif.actions.postback.imageUrl
string
body.section.items.gif.actions.postback.metadata
object
Onderliggende attributen tonen
body.section.items.gif.actions.postback.metadata.description
object
Onderliggende attributen tonen
body.section.items.gif.actions.postback.metadata.description.label
string
verplicht
body.section.items.gif.actions.postback.otpType
string
body.section.items.gif.actions.postback.payload
string
body.section.items.gif.actions.postback.text
string
verplicht
body.section.items.gif.actions.type
string
verplicht
Possible values: postback
body.section.items.gif.altText
string
body.section.items.gif.mediaUrl
string
verplicht
body.section.items.gif.metadata
object
Onderliggende attributen tonen
body.section.items.gif.metadata.telegram
object
Onderliggende attributen tonen
body.section.items.gif.metadata.telegram.parseMode
string
body.section.items.gif.text
string
body.section.items.type
string
verplicht
Possible values: gif
body.section.items.file
object
verplicht
Onderliggende attributen tonen
body.section.items.file.actions
array of object
Onderliggende attributen tonen
body.section.items.file.actions.link
object
verplicht
Onderliggende attributen tonen
body.section.items.file.actions.link.metadata
object
Onderliggende attributen tonen
body.section.items.file.actions.link.metadata.description
object
Onderliggende attributen tonen
body.section.items.file.actions.link.metadata.description.label
string
verplicht
body.section.items.file.actions.link.text
string
verplicht
body.section.items.file.actions.link.url
string
verplicht
body.section.items.file.actions.type
string
verplicht
Possible values: link
body.section.items.file.actions.reply
object
verplicht
Onderliggende attributen tonen
body.section.items.file.actions.reply.imageUrl
string
body.section.items.file.actions.reply.metadata
object
Onderliggende attributen tonen
body.section.items.file.actions.reply.metadata.description
object
Onderliggende attributen tonen
body.section.items.file.actions.reply.metadata.description.label
string
verplicht
body.section.items.file.actions.reply.text
string
verplicht
body.section.items.file.actions.type
string
verplicht
Possible values: reply
body.section.items.file.actions.locationRequest
object
Onderliggende attributen tonen
body.section.items.file.actions.locationRequest.text
string
body.section.items.file.actions.type
string
verplicht
Possible values: locationRequest
body.section.items.file.actions.buy
object
verplicht
Onderliggende attributen tonen
body.section.items.file.actions.buy.amountCents
integer
verplicht
body.section.items.file.actions.buy.currency
string
verplicht
body.section.items.file.actions.buy.text
string
verplicht
body.section.items.file.actions.type
string
verplicht
Possible values: buy
body.section.items.file.actions.postback
object
verplicht
Onderliggende attributen tonen
body.section.items.file.actions.postback.handshake
object
Onderliggende attributen tonen
body.section.items.file.actions.postback.handshake.packageName
string
verplicht
body.section.items.file.actions.postback.handshake.signatureHash
string
verplicht
body.section.items.file.actions.postback.handshake.supportedApps
array of object
Onderliggende attributen tonen
body.section.items.file.actions.postback.handshake.supportedApps.packageName
string
verplicht
body.section.items.file.actions.postback.handshake.supportedApps.signatureHash
string
verplicht
body.section.items.file.actions.postback.handshake.text
string
verplicht
body.section.items.file.actions.postback.handshake.zeroTapTermsAccepted
boolean
verplicht
body.section.items.file.actions.postback.imageUrl
string
body.section.items.file.actions.postback.metadata
object
Onderliggende attributen tonen
body.section.items.file.actions.postback.metadata.description
object
Onderliggende attributen tonen
body.section.items.file.actions.postback.metadata.description.label
string
verplicht
body.section.items.file.actions.postback.otpType
string
body.section.items.file.actions.postback.payload
string
body.section.items.file.actions.postback.text
string
verplicht
body.section.items.file.actions.type
string
verplicht
Possible values: postback
body.section.items.file.files
array of object
verplicht
Onderliggende attributen tonen
body.section.items.file.files.altText
string
body.section.items.file.files.contentType
string
verplicht
body.section.items.file.files.filename
string
body.section.items.file.files.mediaUrl
string
verplicht
body.section.items.file.files.metadata
object
Onderliggende attributen tonen
body.section.items.file.files.metadata.isAnimated
boolean
body.section.items.file.metadata
object
Onderliggende attributen tonen
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
Onderliggende attributen tonen
body.section.items.file.metadata.telegram.parseMode
string
body.section.items.file.text
string
body.section.items.type
string
verplicht
Possible values: file
body.section.items.location
object
verplicht
Onderliggende attributen tonen
body.section.items.location.coordinates
object
verplicht
Onderliggende attributen tonen
body.section.items.location.coordinates.latitude
number
verplicht
body.section.items.location.coordinates.longitude
number
verplicht
body.section.items.location.location
object
verplicht
Onderliggende attributen tonen
body.section.items.location.location.address
string
verplicht
body.section.items.location.location.label
string
verplicht
body.section.items.type
string
verplicht
Possible values: location
body.section.items.carousel
object
verplicht
Onderliggende attributen tonen
body.section.items.carousel.items
array of object
Onderliggende attributen tonen
body.section.items.carousel.items.actions
array of object
Onderliggende attributen tonen
body.section.items.carousel.items.actions.link
object
verplicht
Onderliggende attributen tonen
body.section.items.carousel.items.actions.link.metadata
object
Onderliggende attributen tonen
body.section.items.carousel.items.actions.link.metadata.description
object
Onderliggende attributen tonen
body.section.items.carousel.items.actions.link.metadata.description.label
string
verplicht
body.section.items.carousel.items.actions.link.text
string
verplicht
body.section.items.carousel.items.actions.link.url
string
verplicht
body.section.items.carousel.items.actions.type
string
verplicht
Possible values: link
body.section.items.carousel.items.actions.reply
object
verplicht
Onderliggende attributen tonen
body.section.items.carousel.items.actions.reply.imageUrl
string
body.section.items.carousel.items.actions.reply.metadata
object
Onderliggende attributen tonen
body.section.items.carousel.items.actions.reply.metadata.description
object
Onderliggende attributen tonen
body.section.items.carousel.items.actions.reply.metadata.description.label
string
verplicht
body.section.items.carousel.items.actions.reply.text
string
verplicht
body.section.items.carousel.items.actions.type
string
verplicht
Possible values: reply
body.section.items.carousel.items.actions.locationRequest
object
Onderliggende attributen tonen
body.section.items.carousel.items.actions.locationRequest.text
string
body.section.items.carousel.items.actions.type
string
verplicht
Possible values: locationRequest
body.section.items.carousel.items.actions.buy
object
verplicht
Onderliggende attributen tonen
body.section.items.carousel.items.actions.buy.amountCents
integer
verplicht
body.section.items.carousel.items.actions.buy.currency
string
verplicht
body.section.items.carousel.items.actions.buy.text
string
verplicht
body.section.items.carousel.items.actions.type
string
verplicht
Possible values: buy
body.section.items.carousel.items.actions.postback
object
verplicht
Onderliggende attributen tonen
body.section.items.carousel.items.actions.postback.handshake
object
Onderliggende attributen tonen
body.section.items.carousel.items.actions.postback.handshake.packageName
string
verplicht
body.section.items.carousel.items.actions.postback.handshake.signatureHash
string
verplicht
body.section.items.carousel.items.actions.postback.handshake.supportedApps
array of object
Onderliggende attributen tonen
body.section.items.carousel.items.actions.postback.handshake.supportedApps.packageName
string
verplicht
body.section.items.carousel.items.actions.postback.handshake.supportedApps.signatureHash
string
verplicht
body.section.items.carousel.items.actions.postback.handshake.text
string
verplicht
body.section.items.carousel.items.actions.postback.handshake.zeroTapTermsAccepted
boolean
verplicht
body.section.items.carousel.items.actions.postback.imageUrl
string
body.section.items.carousel.items.actions.postback.metadata
object
Onderliggende attributen tonen
body.section.items.carousel.items.actions.postback.metadata.description
object
Onderliggende attributen tonen
body.section.items.carousel.items.actions.postback.metadata.description.label
string
verplicht
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
verplicht
body.section.items.carousel.items.actions.type
string
verplicht
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
verplicht
Possible values: carousel
body.section.items.list
object
verplicht
Onderliggende attributen tonen
body.section.items.list.actions
array of object
Onderliggende attributen tonen
body.section.items.list.actions.link
object
verplicht
Onderliggende attributen tonen
body.section.items.list.actions.link.metadata
object
Onderliggende attributen tonen
body.section.items.list.actions.link.metadata.description
object
Onderliggende attributen tonen
body.section.items.list.actions.link.metadata.description.label
string
verplicht
body.section.items.list.actions.link.text
string
verplicht
body.section.items.list.actions.link.url
string
verplicht
body.section.items.list.actions.type
string
verplicht
Possible values: link
body.section.items.list.actions.reply
object
verplicht
Onderliggende attributen tonen
body.section.items.list.actions.reply.imageUrl
string
body.section.items.list.actions.reply.metadata
object
Onderliggende attributen tonen
body.section.items.list.actions.reply.metadata.description
object
Onderliggende attributen tonen
body.section.items.list.actions.reply.metadata.description.label
string
verplicht
body.section.items.list.actions.reply.text
string
verplicht
body.section.items.list.actions.type
string
verplicht
Possible values: reply
body.section.items.list.actions.locationRequest
object
Onderliggende attributen tonen
body.section.items.list.actions.locationRequest.text
string
body.section.items.list.actions.type
string
verplicht
Possible values: locationRequest
body.section.items.list.actions.buy
object
verplicht
Onderliggende attributen tonen
body.section.items.list.actions.buy.amountCents
integer
verplicht
body.section.items.list.actions.buy.currency
string
verplicht
body.section.items.list.actions.buy.text
string
verplicht
body.section.items.list.actions.type
string
verplicht
Possible values: buy
body.section.items.list.actions.postback
object
verplicht
Onderliggende attributen tonen
body.section.items.list.actions.postback.handshake
object
Onderliggende attributen tonen
body.section.items.list.actions.postback.handshake.packageName
string
verplicht
body.section.items.list.actions.postback.handshake.signatureHash
string
verplicht
body.section.items.list.actions.postback.handshake.supportedApps
array of object
Onderliggende attributen tonen
body.section.items.list.actions.postback.handshake.supportedApps.packageName
string
verplicht
body.section.items.list.actions.postback.handshake.supportedApps.signatureHash
string
verplicht
body.section.items.list.actions.postback.handshake.text
string
verplicht
body.section.items.list.actions.postback.handshake.zeroTapTermsAccepted
boolean
verplicht
body.section.items.list.actions.postback.imageUrl
string
body.section.items.list.actions.postback.metadata
object
Onderliggende attributen tonen
body.section.items.list.actions.postback.metadata.description
object
Onderliggende attributen tonen
body.section.items.list.actions.postback.metadata.description.label
string
verplicht
body.section.items.list.actions.postback.otpType
string
body.section.items.list.actions.postback.payload
string
body.section.items.list.actions.postback.text
string
verplicht
body.section.items.list.actions.type
string
verplicht
Possible values: postback
body.section.items.list.altText
string
body.section.items.list.items
array of object
Onderliggende attributen tonen
body.section.items.list.items.actions
array of object
Onderliggende attributen tonen
body.section.items.list.items.actions.link
object
verplicht
Onderliggende attributen tonen
body.section.items.list.items.actions.link.metadata
object
Onderliggende attributen tonen
body.section.items.list.items.actions.link.metadata.description
object
Onderliggende attributen tonen
body.section.items.list.items.actions.link.metadata.description.label
string
verplicht
body.section.items.list.items.actions.link.text
string
verplicht
body.section.items.list.items.actions.link.url
string
verplicht
body.section.items.list.items.actions.type
string
verplicht
Possible values: link
body.section.items.list.items.actions.reply
object
verplicht
Onderliggende attributen tonen
body.section.items.list.items.actions.reply.imageUrl
string
body.section.items.list.items.actions.reply.metadata
object
Onderliggende attributen tonen
body.section.items.list.items.actions.reply.metadata.description
object
Onderliggende attributen tonen
body.section.items.list.items.actions.reply.metadata.description.label
string
verplicht
body.section.items.list.items.actions.reply.text
string
verplicht
body.section.items.list.items.actions.type
string
verplicht
Possible values: reply
body.section.items.list.items.actions.locationRequest
object
Onderliggende attributen tonen
body.section.items.list.items.actions.locationRequest.text
string
body.section.items.list.items.actions.type
string
verplicht
Possible values: locationRequest
body.section.items.list.items.actions.buy
object
verplicht
Onderliggende attributen tonen
body.section.items.list.items.actions.buy.amountCents
integer
verplicht
body.section.items.list.items.actions.buy.currency
string
verplicht
body.section.items.list.items.actions.buy.text
string
verplicht
body.section.items.list.items.actions.type
string
verplicht
Possible values: buy
body.section.items.list.items.actions.postback
object
verplicht
Onderliggende attributen tonen
body.section.items.list.items.actions.postback.handshake
object
Onderliggende attributen tonen
body.section.items.list.items.actions.postback.handshake.packageName
string
verplicht
body.section.items.list.items.actions.postback.handshake.signatureHash
string
verplicht
body.section.items.list.items.actions.postback.handshake.supportedApps
array of object
Onderliggende attributen tonen
body.section.items.list.items.actions.postback.handshake.supportedApps.packageName
string
verplicht
body.section.items.list.items.actions.postback.handshake.supportedApps.signatureHash
string
verplicht
body.section.items.list.items.actions.postback.handshake.text
string
verplicht
body.section.items.list.items.actions.postback.handshake.zeroTapTermsAccepted
boolean
verplicht
body.section.items.list.items.actions.postback.imageUrl
string
body.section.items.list.items.actions.postback.metadata
object
Onderliggende attributen tonen
body.section.items.list.items.actions.postback.metadata.description
object
Onderliggende attributen tonen
body.section.items.list.items.actions.postback.metadata.description.label
string
verplicht
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
verplicht
body.section.items.list.items.actions.type
string
verplicht
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
Onderliggende attributen tonen
body.section.items.list.metadata.button
object
Onderliggende attributen tonen
body.section.items.list.metadata.button.label
string
verplicht
body.section.items.list.metadata.replyMessage
object
Onderliggende attributen tonen
body.section.items.list.metadata.replyMessage.text
string
verplicht
body.section.items.list.metadata.replyMessage.title
string
verplicht
body.section.items.list.text
string
body.section.items.list.title
string
body.section.items.type
string
verplicht
Possible values: list
body.section.items.section
object
verplicht
body.section.items.type
string
verplicht
Possible values: section
body.section.items.authentication
object
verplicht
Onderliggende attributen tonen
body.section.items.authentication.otp
object
Onderliggende attributen tonen
body.section.items.authentication.otp.actions
array of object
Onderliggende attributen tonen
body.section.items.authentication.otp.actions.link
object
verplicht
Onderliggende attributen tonen
body.section.items.authentication.otp.actions.link.metadata
object
Onderliggende attributen tonen
body.section.items.authentication.otp.actions.link.metadata.description
object
Onderliggende attributen tonen
body.section.items.authentication.otp.actions.link.metadata.description.label
string
verplicht
body.section.items.authentication.otp.actions.link.text
string
verplicht
body.section.items.authentication.otp.actions.link.url
string
verplicht
body.section.items.authentication.otp.actions.type
string
verplicht
Possible values: link
body.section.items.authentication.otp.actions.reply
object
verplicht
Onderliggende attributen tonen
body.section.items.authentication.otp.actions.reply.imageUrl
string
body.section.items.authentication.otp.actions.reply.metadata
object
Onderliggende attributen tonen
body.section.items.authentication.otp.actions.reply.metadata.description
object
Onderliggende attributen tonen
body.section.items.authentication.otp.actions.reply.metadata.description.label
string
verplicht
body.section.items.authentication.otp.actions.reply.text
string
verplicht
body.section.items.authentication.otp.actions.type
string
verplicht
Possible values: reply
body.section.items.authentication.otp.actions.locationRequest
object
Onderliggende attributen tonen
body.section.items.authentication.otp.actions.locationRequest.text
string
body.section.items.authentication.otp.actions.type
string
verplicht
Possible values: locationRequest
body.section.items.authentication.otp.actions.buy
object
verplicht
Onderliggende attributen tonen
body.section.items.authentication.otp.actions.buy.amountCents
integer
verplicht
body.section.items.authentication.otp.actions.buy.currency
string
verplicht
body.section.items.authentication.otp.actions.buy.text
string
verplicht
body.section.items.authentication.otp.actions.type
string
verplicht
Possible values: buy
body.section.items.authentication.otp.actions.postback
object
verplicht
Onderliggende attributen tonen
body.section.items.authentication.otp.actions.postback.handshake
object
Onderliggende attributen tonen
body.section.items.authentication.otp.actions.postback.handshake.packageName
string
verplicht
body.section.items.authentication.otp.actions.postback.handshake.signatureHash
string
verplicht
body.section.items.authentication.otp.actions.postback.handshake.supportedApps
array of object
Onderliggende attributen tonen
body.section.items.authentication.otp.actions.postback.handshake.supportedApps.packageName
string
verplicht
body.section.items.authentication.otp.actions.postback.handshake.supportedApps.signatureHash
string
verplicht
body.section.items.authentication.otp.actions.postback.handshake.text
string
verplicht
body.section.items.authentication.otp.actions.postback.handshake.zeroTapTermsAccepted
boolean
verplicht
body.section.items.authentication.otp.actions.postback.imageUrl
string
body.section.items.authentication.otp.actions.postback.metadata
object
Onderliggende attributen tonen
body.section.items.authentication.otp.actions.postback.metadata.description
object
Onderliggende attributen tonen
body.section.items.authentication.otp.actions.postback.metadata.description.label
string
verplicht
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
verplicht
body.section.items.authentication.otp.actions.type
string
verplicht
Possible values: postback
body.section.items.authentication.otp.disclaimer
boolean
verplicht
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
verplicht
Possible values: authentication
body.section.items.action
object
verplicht
Onderliggende attributen tonen
body.section.items.action.action
string
verplicht
Possible values: permissionRequest
body.section.items.action.permissionRequest
object
verplicht
Onderliggende attributen tonen
body.section.items.action.permissionRequest.resource
string
verplicht
Possible values: call
body.section.items.type
string
verplicht
Possible values: action
body.type
string
verplicht
Possible values: section
body.authentication
object
verplicht
Onderliggende attributen tonen
body.authentication.otp
object
Onderliggende attributen tonen
body.authentication.otp.actions
array of object
Onderliggende attributen tonen
body.authentication.otp.actions.link
object
verplicht
Onderliggende attributen tonen
body.authentication.otp.actions.link.metadata
object
Onderliggende attributen tonen
body.authentication.otp.actions.link.metadata.description
object
Onderliggende attributen tonen
body.authentication.otp.actions.link.metadata.description.label
string
verplicht
body.authentication.otp.actions.link.text
string
verplicht
body.authentication.otp.actions.link.url
string
verplicht
body.authentication.otp.actions.type
string
verplicht
Possible values: link
body.authentication.otp.actions.reply
object
verplicht
Onderliggende attributen tonen
body.authentication.otp.actions.reply.imageUrl
string
body.authentication.otp.actions.reply.metadata
object
Onderliggende attributen tonen
body.authentication.otp.actions.reply.metadata.description
object
Onderliggende attributen tonen
body.authentication.otp.actions.reply.metadata.description.label
string
verplicht
body.authentication.otp.actions.reply.text
string
verplicht
body.authentication.otp.actions.type
string
verplicht
Possible values: reply
body.authentication.otp.actions.locationRequest
object
Onderliggende attributen tonen
body.authentication.otp.actions.locationRequest.text
string
body.authentication.otp.actions.type
string
verplicht
Possible values: locationRequest
body.authentication.otp.actions.buy
object
verplicht
Onderliggende attributen tonen
body.authentication.otp.actions.buy.amountCents
integer
verplicht
body.authentication.otp.actions.buy.currency
string
verplicht
body.authentication.otp.actions.buy.text
string
verplicht
body.authentication.otp.actions.type
string
verplicht
Possible values: buy
body.authentication.otp.actions.postback
object
verplicht
Onderliggende attributen tonen
body.authentication.otp.actions.postback.handshake
object
Onderliggende attributen tonen
body.authentication.otp.actions.postback.handshake.packageName
string
verplicht
body.authentication.otp.actions.postback.handshake.signatureHash
string
verplicht
body.authentication.otp.actions.postback.handshake.supportedApps
array of object
Onderliggende attributen tonen
body.authentication.otp.actions.postback.handshake.supportedApps.packageName
string
verplicht
body.authentication.otp.actions.postback.handshake.supportedApps.signatureHash
string
verplicht
body.authentication.otp.actions.postback.handshake.text
string
verplicht
body.authentication.otp.actions.postback.handshake.zeroTapTermsAccepted
boolean
verplicht
body.authentication.otp.actions.postback.imageUrl
string
body.authentication.otp.actions.postback.metadata
object
Onderliggende attributen tonen
body.authentication.otp.actions.postback.metadata.description
object
Onderliggende attributen tonen
body.authentication.otp.actions.postback.metadata.description.label
string
verplicht
body.authentication.otp.actions.postback.otpType
string
body.authentication.otp.actions.postback.payload
string
body.authentication.otp.actions.postback.text
string
verplicht
body.authentication.otp.actions.type
string
verplicht
Possible values: postback
body.authentication.otp.disclaimer
boolean
verplicht
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
verplicht
Possible values: authentication
body.action
object
verplicht
Onderliggende attributen tonen
body.action.action
string
verplicht
Possible values: permissionRequest
body.action.permissionRequest
object
verplicht
Onderliggende attributen tonen
body.action.permissionRequest.resource
string
verplicht
Possible values: call
body.type
string
verplicht
Possible values: action
channelId
string
conversationCreatedAt
string
conversationId
string
verplicht
createdAt
string
verplicht
draft
boolean
verplicht
Whether this message is a draft.
draftMeta
object
Metadata for draft messages.
Onderliggende attributen tonen
draftMeta.creatorType
string
verplicht
Possible values: user, bot
id
string
verplicht
A unique identifier for this message.
interactions
array of object
A list of interactions associated with the message (e.g. read receipts, clicks, reactions).
Onderliggende attributen tonen
interactions.bodyTemplateProjectId
string
interactions.channelId
string
verplicht
interactions.context
object
verplicht
Onderliggende attributen tonen
interactions.context.id
string
interactions.context.tagIds
array of string
interactions.context.type
string
interactions.createdAt
string
verplicht
interactions.details
string
interactions.id
string
verplicht
interactions.isFirstInteraction
boolean
interactions.isFirstInteractionIncludingBots
boolean
interactions.journey
object
Onderliggende attributen tonen
interactions.journey.id
string
interactions.journey.name
string
interactions.journey.runId
string
interactions.journey.scheduleExecutionId
string
interactions.journey.stepId
string
interactions.messageCreatedAt
string
interactions.messageId
string
verplicht
interactions.messagePartsCount
integer
verplicht
interactions.messageReference
string
verplicht
interactions.messageTags
array of string
interactions.metadata
object
Onderliggende attributen tonen
interactions.metadata.button
object
Onderliggende attributen tonen
interactions.metadata.button.payload
string
verplicht
interactions.metadata.conversion
object
Onderliggende attributen tonen
interactions.metadata.conversion.method
string
Method of entering the code
Possible values: unknown, manual, auto
interactions.metadata.conversion.status
string
Status of the conversion
Possible values: converted, canceled, not_converted, incorrect_code, resent, received_after_expiration
interactions.metadata.conversion.timestamp
string
Timestamp of when the conversion was recorded
interactions.metadata.conversion.type
string
Type of conversion
Possible values: otp, url, promo_code
interactions.metadata.extraInformation
object
interactions.metadata.link
object
Onderliggende attributen tonen
interactions.metadata.link.clickType
string
Possible values: link, button
interactions.metadata.link.name
string
verplicht
interactions.metadata.link.url
string
verplicht
interactions.metadata.prefetched
boolean
interactions.metadata.reaction
object
Onderliggende attributen tonen
interactions.metadata.reaction.action
string
verplicht
Possible values: react, unreact
interactions.metadata.reaction.emoji
string
verplicht
interactions.metadata.renderedContentBlocks
array of string
interactions.metadata.subscriptionList
object
Onderliggende attributen tonen
interactions.metadata.subscriptionList.subscriptionListId
string
verplicht
interactions.notification
object
Onderliggende attributen tonen
interactions.notification.template
string
interactions.notification.url
string
verplicht
interactions.platformId
string
verplicht
interactions.platformReferenceId
string
interactions.receiver
object
verplicht
Onderliggende attributen tonen
interactions.receiver.connector
object
Onderliggende attributen tonen
interactions.receiver.connector.annotations
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Onderliggende attributen tonen
interactions.receiver.connector.annotations.name
string
interactions.receiver.connector.id
string
verplicht
interactions.receiver.connector.identifierValue
string
The identifier value of the sender or receiver connector (e.g. email address or phone number).
interactions.receiver.connector.types
array of string
interactions.receiver.contacts
array of object
Onderliggende attributen tonen
interactions.receiver.contacts.contactAnnotation
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Onderliggende attributen tonen
interactions.receiver.contacts.contactAnnotation.name
string
interactions.receiver.contacts.countryCode
string
interactions.receiver.contacts.id
string
The ID of the contact.
interactions.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.
interactions.receiver.contacts.identifierValue
string
The identifier value for finding the contact.
interactions.receiver.contacts.identifiers
array of object
Additional identifiers to augment the contact during resolution.
Onderliggende attributen tonen
interactions.receiver.contacts.identifiers.identifierKey
string
verplicht
The identifier key for finding the contact (e.g. emailaddress, phonenumber).
interactions.receiver.contacts.identifiers.identifierValue
string
verplicht
The identifier value for finding the contact.
interactions.receiver.contacts.platformAddress
string
The resolved platform address used to deliver the message (e.g. phone number or email address).
interactions.receiver.contacts.platformAddressSelector
string
An expression that defines how we resolve the platform address from a contact. Optional override for the default resolution logic.
interactions.receiver.contacts.receiverExpression
string
interactions.receiver.contacts.receiverValue
string
interactions.receiver.contacts.type
string
The type of the receiver (e.g. to, cc, bcc for email).
interactions.receiver.device
object
Onderliggende attributen tonen
interactions.receiver.device.gateway
string
verplicht
Possible values: firebase, apns, web
interactions.receiver.device.id
string
verplicht
interactions.receiver.device.identifierValue
string
verplicht
interactions.receiver.inbox
object
Onderliggende attributen tonen
interactions.receiver.inbox.emailRecipientType
string
interactions.receiver.inbox.id
string
verplicht
interactions.receiver.inbox.identifierKey
string
verplicht
interactions.receiver.inbox.identifierValue
string
verplicht
interactions.receiver.inbox.type
string
verplicht
Possible values: user, group
interactions.receiver.userContacts
array of object
Onderliggende attributen tonen
interactions.receiver.userContacts.id
string
verplicht
interactions.receiver.userContacts.identifierKey
string
verplicht
interactions.receiver.userContacts.identifierValue
string
verplicht
interactions.receiver.userContacts.type
string
interactions.type
string
verplicht
Possible values: invalid, read, opened, clicked, reported-as-spam, unsubscribe-request, delete, reaction, subscribe-request, subscribe-consent, conversion
interactions.useCaseType
string
Possible values: unspecified, marketing, otp, transactional, conversation, test
meta
object
Onderliggende attributen tonen
meta.campaign
object
Onderliggende attributen tonen
meta.campaign.id
string
meta.campaign.name
string
meta.campaignId
string
meta.chargeOnceDelivered
boolean
meta.email
object
Onderliggende attributen tonen
meta.email.from
object
Onderliggende attributen tonen
meta.email.from.displayName
string
meta.email.from.username
string
meta.email.headers
object
meta.email.subject
string
meta.extraInformation
object
meta.flow
object
Onderliggende attributen tonen
meta.flow.id
string
meta.flow.name
string
meta.flow.runId
string
meta.flow.scheduleExecutionId
string
meta.flow.stepId
string
meta.formResponse
object
Onderliggende attributen tonen
meta.formResponse.id
string
verplicht
meta.formResponse.jsonResponse
string
verplicht
meta.formResponse.requestIdentifier
string
verplicht
meta.formResponse.selections
array of object
Onderliggende attributen tonen
meta.formResponse.selections.items
array of object
Onderliggende attributen tonen
meta.formResponse.selections.items.identifier
string
verplicht
meta.formResponse.selections.items.title
string
verplicht
meta.formResponse.selections.items.type
string
verplicht
meta.formResponse.selections.items.value
string
verplicht
meta.formResponse.selections.pageIdentifier
string
verplicht
meta.formResponse.selections.subtitle
string
verplicht
meta.formResponse.selections.title
string
verplicht
meta.formResponse.sessionIdentifier
string
verplicht
meta.formResponse.template
string
verplicht
meta.formResponse.version
string
verplicht
meta.ignoreGlobalHoldout
boolean
meta.ignoreQuietHours
boolean
meta.journey
object
Onderliggende attributen tonen
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.
Onderliggende attributen tonen
meta.order.products
array of object
Onderliggende attributen tonen
meta.order.products.externalCatalogId
string
The platform-specific catalog ID of the product.
meta.order.products.externalProductId
string
verplicht
The platform-specific product ID.
meta.order.products.price
object
verplicht
Onderliggende attributen tonen
meta.order.products.price.amount
integer
verplicht
meta.order.products.price.currencyCode
string
verplicht
meta.order.products.price.exponent
integer
verplicht
meta.order.products.quantity
integer
verplicht
The number of items purchased.
meta.pushNotifications
object
Onderliggende attributen tonen
meta.pushNotifications.gatewayTypeOverride
string
Possible values: firebase, apns, web
meta.referral
object
Onderliggende attributen tonen
meta.referral.group
string
meta.referral.metadata
object
Onderliggende attributen tonen
meta.referral.metadata.caption
string
meta.referral.metadata.mediaType
string
meta.referral.metadata.mediaUrl
string
meta.referral.metadata.sourceId
string
verplicht
meta.referral.metadata.sourceUrl
string
meta.referral.metadata.timestamp
string
meta.referral.metadata.trackingId
string
meta.referral.metadata.username
string
meta.referral.source
string
verplicht
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).
Onderliggende attributen tonen
meta.referredProduct.externalCatalogId
string
The platform-specific catalog ID of the product.
meta.referredProduct.externalProductId
string
verplicht
The platform-specific product ID.
meta.renderedContentBlocks
array of string
meta.shortToLongLinks
object
meta.skipThisMessage
string
Possible values: campaignHoldout, globalHoldout, journeyHoldout
meta.sms
object
Onderliggende attributen tonen
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
Onderliggende attributen tonen
meta.sms.smpp.segments
array of object
Onderliggende attributen tonen
meta.sms.smpp.segments.id
string
verplicht
meta.sms.smpp.segments.registeredDelivery
string
verplicht
Possible values: final, intermediate, all, noDlr
meta.sms.smpp.userId
string
verplicht
meta.sms.validity
string
meta.useFallback
boolean
reason
string
Failure reason. Populated when status is sending_failed or delivery_failed.
receiver
object
Onderliggende attributen tonen
receiver.connector
object
Onderliggende attributen tonen
receiver.connector.annotations
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Onderliggende attributen tonen
receiver.connector.annotations.name
string
receiver.connector.id
string
verplicht
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
Onderliggende attributen tonen
receiver.contacts.contactAnnotation
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Onderliggende attributen tonen
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.
Onderliggende attributen tonen
receiver.contacts.identifiers.identifierKey
string
verplicht
The identifier key for finding the contact (e.g. emailaddress, phonenumber).
receiver.contacts.identifiers.identifierValue
string
verplicht
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
Onderliggende attributen tonen
receiver.device.gateway
string
verplicht
Possible values: firebase, apns, web
receiver.device.id
string
verplicht
receiver.device.identifierValue
string
verplicht
receiver.inbox
object
Onderliggende attributen tonen
receiver.inbox.emailRecipientType
string
receiver.inbox.id
string
verplicht
receiver.inbox.identifierKey
string
verplicht
receiver.inbox.identifierValue
string
verplicht
receiver.inbox.type
string
verplicht
Possible values: user, group
receiver.userContacts
array of object
Onderliggende attributen tonen
receiver.userContacts.id
string
verplicht
receiver.userContacts.identifierKey
string
verplicht
receiver.userContacts.identifierValue
string
verplicht
receiver.userContacts.type
string
receiverTypes
array of string
Receiver types for the message (to/cc/bcc). Currently only used for inbound email messages.
recipients
array of object
Onderliggende attributen tonen
recipients.contactAnnotation
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Onderliggende attributen tonen
recipients.contactAnnotation.name
string
recipients.countryCode
string
recipients.id
string
The ID of the contact.
recipients.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.
recipients.identifierValue
string
The identifier value for finding the contact.
recipients.identifiers
array of object
Additional identifiers to augment the contact during resolution.
Onderliggende attributen tonen
recipients.identifiers.identifierKey
string
verplicht
The identifier key for finding the contact (e.g. emailaddress, phonenumber).
recipients.identifiers.identifierValue
string
verplicht
The identifier value for finding the contact.
recipients.platformAddress
string
The resolved platform address used to deliver the message (e.g. phone number or email address).
recipients.platformAddressSelector
string
An expression that defines how we resolve the platform address from a contact. Optional override for the default resolution logic.
recipients.receiverExpression
string
recipients.receiverValue
string
recipients.type
string
The type of the receiver (e.g. to, cc, bcc for email).
reference
string
verplicht
A customizable ID assigned to messages you send. Can be used to correlate messages with data from your own services. Must be globally unique within a workspace.
replyTo
object
Onderliggende attributen tonen
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
resourceUri
string
sender
object
verplicht
Onderliggende attributen tonen
sender.email
string
sender.name
string
sender.avatarUrl
string
sender.contact
object
Onderliggende attributen tonen
sender.contact.identifierKey
string
verplicht
sender.contact.identifierValue
string
verplicht
sender.contact.platformAddress
string
sender.contact.platformAddressSelector
string
sender.conversationId
string
sender.createdAt
string
sender.displayName
string
sender.id
string
verplicht
sender.resourceUri
string
sender.status
string
Possible values: invited, pending, active, inactive
sender.type
string
verplicht
Possible values: user, contact, agent, flow, bot, accessKey, channel, connector, collaborationAutomation
sender.updatedAt
string
source
string
verplicht
Possible values: conversations, channels, bots, external
status
string
verplicht
Possible values: accepted, processing, sent, sending_failed, delivered, delivery_failed, deleted
template
object
Onderliggende attributen tonen
template.attachments
array of object
Onderliggende attributen tonen
template.attachments.content
string
template.attachments.contentType
string
template.attachments.filename
string
verplicht
template.attachments.inline
boolean
verplicht
template.attachments.mediaUrl
string
verplicht
template.deployment
object
template.locale
string
verplicht
template.name
string
The platform name of the template.
template.parameters
array of object
Onderliggende attributen tonen
template.parameters.key
string
verplicht
template.parameters.sourceUrl
object
Onderliggende attributen tonen
template.parameters.sourceUrl.fullyReplaced
boolean
verplicht
template.parameters.sourceUrl.value
string
verplicht
template.parameters.type
string
verplicht
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
verplicht
template.projectId
string
verplicht
The ID of the project from Studio.
template.settings
object
Onderliggende attributen tonen
template.settings.disallowMmLite
boolean
template.shortLinks
object
Onderliggende attributen tonen
template.shortLinks.domain
string
verplicht
The domain to use when shortening links. When set to default, uses the default link shortening domain for the workspace.
template.shortLinks.enabled
boolean
verplicht
Enables link shortening for SMS messages.
template.templateBody
object
Onderliggende attributen tonen
template.templateBody.text
object
verplicht
Onderliggende attributen tonen
template.templateBody.text.actions
array of object
Onderliggende attributen tonen
template.templateBody.text.actions.link
object
verplicht
Onderliggende attributen tonen
template.templateBody.text.actions.link.metadata
object
Onderliggende attributen tonen
template.templateBody.text.actions.link.metadata.description
object
Onderliggende attributen tonen
template.templateBody.text.actions.link.metadata.description.label
string
verplicht
template.templateBody.text.actions.link.text
string
verplicht
template.templateBody.text.actions.link.url
string
verplicht
template.templateBody.text.actions.type
string
verplicht
Possible values: link
template.templateBody.text.actions.reply
object
verplicht
Onderliggende attributen tonen
template.templateBody.text.actions.reply.imageUrl
string
template.templateBody.text.actions.reply.metadata
object
Onderliggende attributen tonen
template.templateBody.text.actions.reply.metadata.description
object
Onderliggende attributen tonen
template.templateBody.text.actions.reply.metadata.description.label
string
verplicht
template.templateBody.text.actions.reply.text
string
verplicht
template.templateBody.text.actions.type
string
verplicht
Possible values: reply
template.templateBody.text.actions.locationRequest
object
Onderliggende attributen tonen
template.templateBody.text.actions.locationRequest.text
string
template.templateBody.text.actions.type
string
verplicht
Possible values: locationRequest
template.templateBody.text.actions.buy
object
verplicht
Onderliggende attributen tonen
template.templateBody.text.actions.buy.amountCents
integer
verplicht
template.templateBody.text.actions.buy.currency
string
verplicht
template.templateBody.text.actions.buy.text
string
verplicht
template.templateBody.text.actions.type
string
verplicht
Possible values: buy
template.templateBody.text.actions.postback
object
verplicht
Onderliggende attributen tonen
template.templateBody.text.actions.postback.handshake
object
Onderliggende attributen tonen
template.templateBody.text.actions.postback.handshake.packageName
string
verplicht
template.templateBody.text.actions.postback.handshake.signatureHash
string
verplicht
template.templateBody.text.actions.postback.handshake.supportedApps
array of object
Onderliggende attributen tonen
template.templateBody.text.actions.postback.handshake.supportedApps.packageName
string
verplicht
template.templateBody.text.actions.postback.handshake.supportedApps.signatureHash
string
verplicht
template.templateBody.text.actions.postback.handshake.text
string
verplicht
template.templateBody.text.actions.postback.handshake.zeroTapTermsAccepted
boolean
verplicht
template.templateBody.text.actions.postback.imageUrl
string
template.templateBody.text.actions.postback.metadata
object
Onderliggende attributen tonen
template.templateBody.text.actions.postback.metadata.description
object
Onderliggende attributen tonen
template.templateBody.text.actions.postback.metadata.description.label
string
verplicht
template.templateBody.text.actions.postback.otpType
string
template.templateBody.text.actions.postback.payload
string
template.templateBody.text.actions.postback.text
string
verplicht
template.templateBody.text.actions.type
string
verplicht
Possible values: postback
template.templateBody.text.attachments
array of object
Onderliggende attributen tonen
template.templateBody.text.attachments.content
string
template.templateBody.text.attachments.contentId
string
template.templateBody.text.attachments.contentType
string
template.templateBody.text.attachments.filename
string
verplicht
template.templateBody.text.attachments.inline
boolean
template.templateBody.text.attachments.mediaUrl
string
verplicht
template.templateBody.text.metadata
object
Onderliggende attributen tonen
template.templateBody.text.metadata.apple
object
Onderliggende attributen tonen
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
Onderliggende attributen tonen
template.templateBody.text.metadata.line.emoji
object
Onderliggende attributen tonen
template.templateBody.text.metadata.line.emoji.items
array of object
Onderliggende attributen tonen
template.templateBody.text.metadata.line.emoji.items.emojiId
string
verplicht
template.templateBody.text.metadata.line.emoji.items.index
integer
verplicht
template.templateBody.text.metadata.line.emoji.items.length
integer
template.templateBody.text.metadata.line.emoji.items.productId
string
verplicht
template.templateBody.text.metadata.paymentDetails
object
Onderliggende attributen tonen
template.templateBody.text.metadata.paymentDetails.amount
string
verplicht
template.templateBody.text.metadata.paymentDetails.currency
string
verplicht
template.templateBody.text.metadata.paymentDetails.sessionIdentifier
string
template.templateBody.text.metadata.paymentDetails.state
string
verplicht
template.templateBody.text.metadata.subject
string
template.templateBody.text.metadata.telegram
object
Onderliggende attributen tonen
template.templateBody.text.metadata.telegram.parseMode
string
template.templateBody.text.metadata.whatsapp
object
Onderliggende attributen tonen
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
verplicht
template.templateBody.text.metadata.whatsapp.sharedContacts
array of object
Onderliggende attributen tonen
template.templateBody.text.metadata.whatsapp.sharedContacts.origin
string
verplicht
template.templateBody.text.metadata.whatsapp.sharedContacts.phones
array of object
Onderliggende attributen tonen
template.templateBody.text.metadata.whatsapp.sharedContacts.phones.phone
string
verplicht
template.templateBody.text.metadata.whatsapp.sharedContacts.phones.type
string
verplicht
template.templateBody.text.metadata.whatsapp.sharedContacts.phones.waId
string
verplicht
template.templateBody.text.metadata.whatsapp.sharedContacts.vcard
string
template.templateBody.text.text
string
verplicht
template.templateBody.type
string
verplicht
Possible values: text
template.templateBody.html
object
verplicht
Onderliggende attributen tonen
template.templateBody.html.actions
array of object
Onderliggende attributen tonen
template.templateBody.html.actions.link
object
verplicht
Onderliggende attributen tonen
template.templateBody.html.actions.link.metadata
object
Onderliggende attributen tonen
template.templateBody.html.actions.link.metadata.description
object
Onderliggende attributen tonen
template.templateBody.html.actions.link.metadata.description.label
string
verplicht
template.templateBody.html.actions.link.text
string
verplicht
template.templateBody.html.actions.link.url
string
verplicht
template.templateBody.html.actions.type
string
verplicht
Possible values: link
template.templateBody.html.actions.reply
object
verplicht
Onderliggende attributen tonen
template.templateBody.html.actions.reply.imageUrl
string
template.templateBody.html.actions.reply.metadata
object
Onderliggende attributen tonen
template.templateBody.html.actions.reply.metadata.description
object
Onderliggende attributen tonen
template.templateBody.html.actions.reply.metadata.description.label
string
verplicht
template.templateBody.html.actions.reply.text
string
verplicht
template.templateBody.html.actions.type
string
verplicht
Possible values: reply
template.templateBody.html.actions.locationRequest
object
Onderliggende attributen tonen
template.templateBody.html.actions.locationRequest.text
string
template.templateBody.html.actions.type
string
verplicht
Possible values: locationRequest
template.templateBody.html.actions.buy
object
verplicht
Onderliggende attributen tonen
template.templateBody.html.actions.buy.amountCents
integer
verplicht
template.templateBody.html.actions.buy.currency
string
verplicht
template.templateBody.html.actions.buy.text
string
verplicht
template.templateBody.html.actions.type
string
verplicht
Possible values: buy
template.templateBody.html.actions.postback
object
verplicht
Onderliggende attributen tonen
template.templateBody.html.actions.postback.handshake
object
Onderliggende attributen tonen
template.templateBody.html.actions.postback.handshake.packageName
string
verplicht
template.templateBody.html.actions.postback.handshake.signatureHash
string
verplicht
template.templateBody.html.actions.postback.handshake.supportedApps
array of object
Onderliggende attributen tonen
template.templateBody.html.actions.postback.handshake.supportedApps.packageName
string
verplicht
template.templateBody.html.actions.postback.handshake.supportedApps.signatureHash
string
verplicht
template.templateBody.html.actions.postback.handshake.text
string
verplicht
template.templateBody.html.actions.postback.handshake.zeroTapTermsAccepted
boolean
verplicht
template.templateBody.html.actions.postback.imageUrl
string
template.templateBody.html.actions.postback.metadata
object
Onderliggende attributen tonen
template.templateBody.html.actions.postback.metadata.description
object
Onderliggende attributen tonen
template.templateBody.html.actions.postback.metadata.description.label
string
verplicht
template.templateBody.html.actions.postback.otpType
string
template.templateBody.html.actions.postback.payload
string
template.templateBody.html.actions.postback.text
string
verplicht
template.templateBody.html.actions.type
string
verplicht
Possible values: postback
template.templateBody.html.attachments
array of object
Onderliggende attributen tonen
template.templateBody.html.attachments.content
string
template.templateBody.html.attachments.contentId
string
template.templateBody.html.attachments.contentType
string
template.templateBody.html.attachments.filename
string
verplicht
template.templateBody.html.attachments.inline
boolean
template.templateBody.html.attachments.mediaUrl
string
template.templateBody.html.html
string
template.templateBody.html.metadata
object
Onderliggende attributen tonen
template.templateBody.html.metadata.clickTracking
boolean
template.templateBody.html.metadata.from
object
Onderliggende attributen tonen
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
verplicht
Possible values: html
template.templateBody.image
object
verplicht
Onderliggende attributen tonen
template.templateBody.image.actions
array of object
Onderliggende attributen tonen
template.templateBody.image.actions.link
object
verplicht
Onderliggende attributen tonen
template.templateBody.image.actions.link.metadata
object
Onderliggende attributen tonen
template.templateBody.image.actions.link.metadata.description
object
Onderliggende attributen tonen
template.templateBody.image.actions.link.metadata.description.label
string
verplicht
template.templateBody.image.actions.link.text
string
verplicht
template.templateBody.image.actions.link.url
string
verplicht
template.templateBody.image.actions.type
string
verplicht
Possible values: link
template.templateBody.image.actions.reply
object
verplicht
Onderliggende attributen tonen
template.templateBody.image.actions.reply.imageUrl
string
template.templateBody.image.actions.reply.metadata
object
Onderliggende attributen tonen
template.templateBody.image.actions.reply.metadata.description
object
Onderliggende attributen tonen
template.templateBody.image.actions.reply.metadata.description.label
string
verplicht
template.templateBody.image.actions.reply.text
string
verplicht
template.templateBody.image.actions.type
string
verplicht
Possible values: reply
template.templateBody.image.actions.locationRequest
object
Onderliggende attributen tonen
template.templateBody.image.actions.locationRequest.text
string
template.templateBody.image.actions.type
string
verplicht
Possible values: locationRequest
template.templateBody.image.actions.buy
object
verplicht
Onderliggende attributen tonen
template.templateBody.image.actions.buy.amountCents
integer
verplicht
template.templateBody.image.actions.buy.currency
string
verplicht
template.templateBody.image.actions.buy.text
string
verplicht
template.templateBody.image.actions.type
string
verplicht
Possible values: buy
template.templateBody.image.actions.postback
object
verplicht
Onderliggende attributen tonen
template.templateBody.image.actions.postback.handshake
object
Onderliggende attributen tonen
template.templateBody.image.actions.postback.handshake.packageName
string
verplicht
template.templateBody.image.actions.postback.handshake.signatureHash
string
verplicht
template.templateBody.image.actions.postback.handshake.supportedApps
array of object
Onderliggende attributen tonen
template.templateBody.image.actions.postback.handshake.supportedApps.packageName
string
verplicht
template.templateBody.image.actions.postback.handshake.supportedApps.signatureHash
string
verplicht
template.templateBody.image.actions.postback.handshake.text
string
verplicht
template.templateBody.image.actions.postback.handshake.zeroTapTermsAccepted
boolean
verplicht
template.templateBody.image.actions.postback.imageUrl
string
template.templateBody.image.actions.postback.metadata
object
Onderliggende attributen tonen
template.templateBody.image.actions.postback.metadata.description
object
Onderliggende attributen tonen
template.templateBody.image.actions.postback.metadata.description.label
string
verplicht
template.templateBody.image.actions.postback.otpType
string
template.templateBody.image.actions.postback.payload
string
template.templateBody.image.actions.postback.text
string
verplicht
template.templateBody.image.actions.type
string
verplicht
Possible values: postback
template.templateBody.image.images
array of object
verplicht
Onderliggende attributen tonen
template.templateBody.image.images.altText
string
template.templateBody.image.images.mediaPreviewUrl
string
template.templateBody.image.images.mediaUrl
string
verplicht
template.templateBody.image.metadata
object
Onderliggende attributen tonen
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
Onderliggende attributen tonen
template.templateBody.image.metadata.telegram.parseMode
string
template.templateBody.image.text
string
template.templateBody.type
string
verplicht
Possible values: image
template.templateBody.gif
object
verplicht
Onderliggende attributen tonen
template.templateBody.gif.actions
array of object
Onderliggende attributen tonen
template.templateBody.gif.actions.link
object
verplicht
Onderliggende attributen tonen
template.templateBody.gif.actions.link.metadata
object
Onderliggende attributen tonen
template.templateBody.gif.actions.link.metadata.description
object
Onderliggende attributen tonen
template.templateBody.gif.actions.link.metadata.description.label
string
verplicht
template.templateBody.gif.actions.link.text
string
verplicht
template.templateBody.gif.actions.link.url
string
verplicht
template.templateBody.gif.actions.type
string
verplicht
Possible values: link
template.templateBody.gif.actions.reply
object
verplicht
Onderliggende attributen tonen
template.templateBody.gif.actions.reply.imageUrl
string
template.templateBody.gif.actions.reply.metadata
object
Onderliggende attributen tonen
template.templateBody.gif.actions.reply.metadata.description
object
Onderliggende attributen tonen
template.templateBody.gif.actions.reply.metadata.description.label
string
verplicht
template.templateBody.gif.actions.reply.text
string
verplicht
template.templateBody.gif.actions.type
string
verplicht
Possible values: reply
template.templateBody.gif.actions.locationRequest
object
Onderliggende attributen tonen
template.templateBody.gif.actions.locationRequest.text
string
template.templateBody.gif.actions.type
string
verplicht
Possible values: locationRequest
template.templateBody.gif.actions.buy
object
verplicht
Onderliggende attributen tonen
template.templateBody.gif.actions.buy.amountCents
integer
verplicht
template.templateBody.gif.actions.buy.currency
string
verplicht
template.templateBody.gif.actions.buy.text
string
verplicht
template.templateBody.gif.actions.type
string
verplicht
Possible values: buy
template.templateBody.gif.actions.postback
object
verplicht
Onderliggende attributen tonen
template.templateBody.gif.actions.postback.handshake
object
Onderliggende attributen tonen
template.templateBody.gif.actions.postback.handshake.packageName
string
verplicht
template.templateBody.gif.actions.postback.handshake.signatureHash
string
verplicht
template.templateBody.gif.actions.postback.handshake.supportedApps
array of object
Onderliggende attributen tonen
template.templateBody.gif.actions.postback.handshake.supportedApps.packageName
string
verplicht
template.templateBody.gif.actions.postback.handshake.supportedApps.signatureHash
string
verplicht
template.templateBody.gif.actions.postback.handshake.text
string
verplicht
template.templateBody.gif.actions.postback.handshake.zeroTapTermsAccepted
boolean
verplicht
template.templateBody.gif.actions.postback.imageUrl
string
template.templateBody.gif.actions.postback.metadata
object
Onderliggende attributen tonen
template.templateBody.gif.actions.postback.metadata.description
object
Onderliggende attributen tonen
template.templateBody.gif.actions.postback.metadata.description.label
string
verplicht
template.templateBody.gif.actions.postback.otpType
string
template.templateBody.gif.actions.postback.payload
string
template.templateBody.gif.actions.postback.text
string
verplicht
template.templateBody.gif.actions.type
string
verplicht
Possible values: postback
template.templateBody.gif.altText
string
template.templateBody.gif.mediaUrl
string
verplicht
template.templateBody.gif.metadata
object
Onderliggende attributen tonen
template.templateBody.gif.metadata.telegram
object
Onderliggende attributen tonen
template.templateBody.gif.metadata.telegram.parseMode
string
template.templateBody.gif.text
string
template.templateBody.type
string
verplicht
Possible values: gif
template.templateBody.file
object
verplicht
Onderliggende attributen tonen
template.templateBody.file.actions
array of object
Onderliggende attributen tonen
template.templateBody.file.actions.link
object
verplicht
Onderliggende attributen tonen
template.templateBody.file.actions.link.metadata
object
Onderliggende attributen tonen
template.templateBody.file.actions.link.metadata.description
object
Onderliggende attributen tonen
template.templateBody.file.actions.link.metadata.description.label
string
verplicht
template.templateBody.file.actions.link.text
string
verplicht
template.templateBody.file.actions.link.url
string
verplicht
template.templateBody.file.actions.type
string
verplicht
Possible values: link
template.templateBody.file.actions.reply
object
verplicht
Onderliggende attributen tonen
template.templateBody.file.actions.reply.imageUrl
string
template.templateBody.file.actions.reply.metadata
object
Onderliggende attributen tonen
template.templateBody.file.actions.reply.metadata.description
object
Onderliggende attributen tonen
template.templateBody.file.actions.reply.metadata.description.label
string
verplicht
template.templateBody.file.actions.reply.text
string
verplicht
template.templateBody.file.actions.type
string
verplicht
Possible values: reply
template.templateBody.file.actions.locationRequest
object
Onderliggende attributen tonen
template.templateBody.file.actions.locationRequest.text
string
template.templateBody.file.actions.type
string
verplicht
Possible values: locationRequest
template.templateBody.file.actions.buy
object
verplicht
Onderliggende attributen tonen
template.templateBody.file.actions.buy.amountCents
integer
verplicht
template.templateBody.file.actions.buy.currency
string
verplicht
template.templateBody.file.actions.buy.text
string
verplicht
template.templateBody.file.actions.type
string
verplicht
Possible values: buy
template.templateBody.file.actions.postback
object
verplicht
Onderliggende attributen tonen
template.templateBody.file.actions.postback.handshake
object
Onderliggende attributen tonen
template.templateBody.file.actions.postback.handshake.packageName
string
verplicht
template.templateBody.file.actions.postback.handshake.signatureHash
string
verplicht
template.templateBody.file.actions.postback.handshake.supportedApps
array of object
Onderliggende attributen tonen
template.templateBody.file.actions.postback.handshake.supportedApps.packageName
string
verplicht
template.templateBody.file.actions.postback.handshake.supportedApps.signatureHash
string
verplicht
template.templateBody.file.actions.postback.handshake.text
string
verplicht
template.templateBody.file.actions.postback.handshake.zeroTapTermsAccepted
boolean
verplicht
template.templateBody.file.actions.postback.imageUrl
string
template.templateBody.file.actions.postback.metadata
object
Onderliggende attributen tonen
template.templateBody.file.actions.postback.metadata.description
object
Onderliggende attributen tonen
template.templateBody.file.actions.postback.metadata.description.label
string
verplicht
template.templateBody.file.actions.postback.otpType
string
template.templateBody.file.actions.postback.payload
string
template.templateBody.file.actions.postback.text
string
verplicht
template.templateBody.file.actions.type
string
verplicht
Possible values: postback
template.templateBody.file.files
array of object
verplicht
Onderliggende attributen tonen
template.templateBody.file.files.altText
string
template.templateBody.file.files.contentType
string
verplicht
template.templateBody.file.files.filename
string
template.templateBody.file.files.mediaUrl
string
verplicht
template.templateBody.file.files.metadata
object
Onderliggende attributen tonen
template.templateBody.file.files.metadata.isAnimated
boolean
template.templateBody.file.metadata
object
Onderliggende attributen tonen
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
Onderliggende attributen tonen
template.templateBody.file.metadata.telegram.parseMode
string
template.templateBody.file.text
string
template.templateBody.type
string
verplicht
Possible values: file
template.templateBody.location
object
verplicht
Onderliggende attributen tonen
template.templateBody.location.coordinates
object
verplicht
Onderliggende attributen tonen
template.templateBody.location.coordinates.latitude
number
verplicht
template.templateBody.location.coordinates.longitude
number
verplicht
template.templateBody.location.location
object
verplicht
Onderliggende attributen tonen
template.templateBody.location.location.address
string
verplicht
template.templateBody.location.location.label
string
verplicht
template.templateBody.type
string
verplicht
Possible values: location
template.templateBody.carousel
object
verplicht
Onderliggende attributen tonen
template.templateBody.carousel.items
array of object
Onderliggende attributen tonen
template.templateBody.carousel.items.actions
array of object
Onderliggende attributen tonen
template.templateBody.carousel.items.actions.link
object
verplicht
Onderliggende attributen tonen
template.templateBody.carousel.items.actions.link.metadata
object
Onderliggende attributen tonen
template.templateBody.carousel.items.actions.link.metadata.description
object
Onderliggende attributen tonen
template.templateBody.carousel.items.actions.link.metadata.description.label
string
verplicht
template.templateBody.carousel.items.actions.link.text
string
verplicht
template.templateBody.carousel.items.actions.link.url
string
verplicht
template.templateBody.carousel.items.actions.type
string
verplicht
Possible values: link
template.templateBody.carousel.items.actions.reply
object
verplicht
Onderliggende attributen tonen
template.templateBody.carousel.items.actions.reply.imageUrl
string
template.templateBody.carousel.items.actions.reply.metadata
object
Onderliggende attributen tonen
template.templateBody.carousel.items.actions.reply.metadata.description
object
Onderliggende attributen tonen
template.templateBody.carousel.items.actions.reply.metadata.description.label
string
verplicht
template.templateBody.carousel.items.actions.reply.text
string
verplicht
template.templateBody.carousel.items.actions.type
string
verplicht
Possible values: reply
template.templateBody.carousel.items.actions.locationRequest
object
Onderliggende attributen tonen
template.templateBody.carousel.items.actions.locationRequest.text
string
template.templateBody.carousel.items.actions.type
string
verplicht
Possible values: locationRequest
template.templateBody.carousel.items.actions.buy
object
verplicht
Onderliggende attributen tonen
template.templateBody.carousel.items.actions.buy.amountCents
integer
verplicht
template.templateBody.carousel.items.actions.buy.currency
string
verplicht
template.templateBody.carousel.items.actions.buy.text
string
verplicht
template.templateBody.carousel.items.actions.type
string
verplicht
Possible values: buy
template.templateBody.carousel.items.actions.postback
object
verplicht
Onderliggende attributen tonen
template.templateBody.carousel.items.actions.postback.handshake
object
Onderliggende attributen tonen
template.templateBody.carousel.items.actions.postback.handshake.packageName
string
verplicht
template.templateBody.carousel.items.actions.postback.handshake.signatureHash
string
verplicht
template.templateBody.carousel.items.actions.postback.handshake.supportedApps
array of object
Onderliggende attributen tonen
template.templateBody.carousel.items.actions.postback.handshake.supportedApps.packageName
string
verplicht
template.templateBody.carousel.items.actions.postback.handshake.supportedApps.signatureHash
string
verplicht
template.templateBody.carousel.items.actions.postback.handshake.text
string
verplicht
template.templateBody.carousel.items.actions.postback.handshake.zeroTapTermsAccepted
boolean
verplicht
template.templateBody.carousel.items.actions.postback.imageUrl
string
template.templateBody.carousel.items.actions.postback.metadata
object
Onderliggende attributen tonen
template.templateBody.carousel.items.actions.postback.metadata.description
object
Onderliggende attributen tonen
template.templateBody.carousel.items.actions.postback.metadata.description.label
string
verplicht
template.templateBody.carousel.items.actions.postback.otpType
string
template.templateBody.carousel.items.actions.postback.payload
string
template.templateBody.carousel.items.actions.postback.text
string
verplicht
template.templateBody.carousel.items.actions.type
string
verplicht
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
verplicht
Possible values: carousel
template.templateBody.list
object
verplicht
Onderliggende attributen tonen
template.templateBody.list.actions
array of object
Onderliggende attributen tonen
template.templateBody.list.actions.link
object
verplicht
Onderliggende attributen tonen
template.templateBody.list.actions.link.metadata
object
Onderliggende attributen tonen
template.templateBody.list.actions.link.metadata.description
object
Onderliggende attributen tonen
template.templateBody.list.actions.link.metadata.description.label
string
verplicht
template.templateBody.list.actions.link.text
string
verplicht
template.templateBody.list.actions.link.url
string
verplicht
template.templateBody.list.actions.type
string
verplicht
Possible values: link
template.templateBody.list.actions.reply
object
verplicht
Onderliggende attributen tonen
template.templateBody.list.actions.reply.imageUrl
string
template.templateBody.list.actions.reply.metadata
object
Onderliggende attributen tonen
template.templateBody.list.actions.reply.metadata.description
object
Onderliggende attributen tonen
template.templateBody.list.actions.reply.metadata.description.label
string
verplicht
template.templateBody.list.actions.reply.text
string
verplicht
template.templateBody.list.actions.type
string
verplicht
Possible values: reply
template.templateBody.list.actions.locationRequest
object
Onderliggende attributen tonen
template.templateBody.list.actions.locationRequest.text
string
template.templateBody.list.actions.type
string
verplicht
Possible values: locationRequest
template.templateBody.list.actions.buy
object
verplicht
Onderliggende attributen tonen
template.templateBody.list.actions.buy.amountCents
integer
verplicht
template.templateBody.list.actions.buy.currency
string
verplicht
template.templateBody.list.actions.buy.text
string
verplicht
template.templateBody.list.actions.type
string
verplicht
Possible values: buy
template.templateBody.list.actions.postback
object
verplicht
Onderliggende attributen tonen
template.templateBody.list.actions.postback.handshake
object
Onderliggende attributen tonen
template.templateBody.list.actions.postback.handshake.packageName
string
verplicht
template.templateBody.list.actions.postback.handshake.signatureHash
string
verplicht
template.templateBody.list.actions.postback.handshake.supportedApps
array of object
Onderliggende attributen tonen
template.templateBody.list.actions.postback.handshake.supportedApps.packageName
string
verplicht
template.templateBody.list.actions.postback.handshake.supportedApps.signatureHash
string
verplicht
template.templateBody.list.actions.postback.handshake.text
string
verplicht
template.templateBody.list.actions.postback.handshake.zeroTapTermsAccepted
boolean
verplicht
template.templateBody.list.actions.postback.imageUrl
string
template.templateBody.list.actions.postback.metadata
object
Onderliggende attributen tonen
template.templateBody.list.actions.postback.metadata.description
object
Onderliggende attributen tonen
template.templateBody.list.actions.postback.metadata.description.label
string
verplicht
template.templateBody.list.actions.postback.otpType
string
template.templateBody.list.actions.postback.payload
string
template.templateBody.list.actions.postback.text
string
verplicht
template.templateBody.list.actions.type
string
verplicht
Possible values: postback
template.templateBody.list.altText
string
template.templateBody.list.items
array of object
Onderliggende attributen tonen
template.templateBody.list.items.actions
array of object
Onderliggende attributen tonen
template.templateBody.list.items.actions.link
object
verplicht
Onderliggende attributen tonen
template.templateBody.list.items.actions.link.metadata
object
Onderliggende attributen tonen
template.templateBody.list.items.actions.link.metadata.description
object
Onderliggende attributen tonen
template.templateBody.list.items.actions.link.metadata.description.label
string
verplicht
template.templateBody.list.items.actions.link.text
string
verplicht
template.templateBody.list.items.actions.link.url
string
verplicht
template.templateBody.list.items.actions.type
string
verplicht
Possible values: link
template.templateBody.list.items.actions.reply
object
verplicht
Onderliggende attributen tonen
template.templateBody.list.items.actions.reply.imageUrl
string
template.templateBody.list.items.actions.reply.metadata
object
Onderliggende attributen tonen
template.templateBody.list.items.actions.reply.metadata.description
object
Onderliggende attributen tonen
template.templateBody.list.items.actions.reply.metadata.description.label
string
verplicht
template.templateBody.list.items.actions.reply.text
string
verplicht
template.templateBody.list.items.actions.type
string
verplicht
Possible values: reply
template.templateBody.list.items.actions.locationRequest
object
Onderliggende attributen tonen
template.templateBody.list.items.actions.locationRequest.text
string
template.templateBody.list.items.actions.type
string
verplicht
Possible values: locationRequest
template.templateBody.list.items.actions.buy
object
verplicht
Onderliggende attributen tonen
template.templateBody.list.items.actions.buy.amountCents
integer
verplicht
template.templateBody.list.items.actions.buy.currency
string
verplicht
template.templateBody.list.items.actions.buy.text
string
verplicht
template.templateBody.list.items.actions.type
string
verplicht
Possible values: buy
template.templateBody.list.items.actions.postback
object
verplicht
Onderliggende attributen tonen
template.templateBody.list.items.actions.postback.handshake
object
Onderliggende attributen tonen
template.templateBody.list.items.actions.postback.handshake.packageName
string
verplicht
template.templateBody.list.items.actions.postback.handshake.signatureHash
string
verplicht
template.templateBody.list.items.actions.postback.handshake.supportedApps
array of object
Onderliggende attributen tonen
template.templateBody.list.items.actions.postback.handshake.supportedApps.packageName
string
verplicht
template.templateBody.list.items.actions.postback.handshake.supportedApps.signatureHash
string
verplicht
template.templateBody.list.items.actions.postback.handshake.text
string
verplicht
template.templateBody.list.items.actions.postback.handshake.zeroTapTermsAccepted
boolean
verplicht
template.templateBody.list.items.actions.postback.imageUrl
string
template.templateBody.list.items.actions.postback.metadata
object
Onderliggende attributen tonen
template.templateBody.list.items.actions.postback.metadata.description
object
Onderliggende attributen tonen
template.templateBody.list.items.actions.postback.metadata.description.label
string
verplicht
template.templateBody.list.items.actions.postback.otpType
string
template.templateBody.list.items.actions.postback.payload
string
template.templateBody.list.items.actions.postback.text
string
verplicht
template.templateBody.list.items.actions.type
string
verplicht
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
Onderliggende attributen tonen
template.templateBody.list.metadata.button
object
Onderliggende attributen tonen
template.templateBody.list.metadata.button.label
string
verplicht
template.templateBody.list.metadata.replyMessage
object
Onderliggende attributen tonen
template.templateBody.list.metadata.replyMessage.text
string
verplicht
template.templateBody.list.metadata.replyMessage.title
string
verplicht
template.templateBody.list.text
string
template.templateBody.list.title
string
template.templateBody.type
string
verplicht
Possible values: list
template.templateBody.section
object
verplicht
Onderliggende attributen tonen
template.templateBody.section.configurations
object
template.templateBody.section.items
array of object
Onderliggende attributen tonen
template.templateBody.section.items.text
object
verplicht
Onderliggende attributen tonen
template.templateBody.section.items.text.actions
array of object
Onderliggende attributen tonen
template.templateBody.section.items.text.actions.link
object
verplicht
Onderliggende attributen tonen
template.templateBody.section.items.text.actions.link.metadata
object
Onderliggende attributen tonen
template.templateBody.section.items.text.actions.link.metadata.description
object
Onderliggende attributen tonen
template.templateBody.section.items.text.actions.link.metadata.description.label
string
verplicht
template.templateBody.section.items.text.actions.link.text
string
verplicht
template.templateBody.section.items.text.actions.link.url
string
verplicht
template.templateBody.section.items.text.actions.type
string
verplicht
Possible values: link
template.templateBody.section.items.text.actions.reply
object
verplicht
Onderliggende attributen tonen
template.templateBody.section.items.text.actions.reply.imageUrl
string
template.templateBody.section.items.text.actions.reply.metadata
object
Onderliggende attributen tonen
template.templateBody.section.items.text.actions.reply.metadata.description
object
Onderliggende attributen tonen
template.templateBody.section.items.text.actions.reply.metadata.description.label
string
verplicht
template.templateBody.section.items.text.actions.reply.text
string
verplicht
template.templateBody.section.items.text.actions.type
string
verplicht
Possible values: reply
template.templateBody.section.items.text.actions.locationRequest
object
Onderliggende attributen tonen
template.templateBody.section.items.text.actions.locationRequest.text
string
template.templateBody.section.items.text.actions.type
string
verplicht
Possible values: locationRequest
template.templateBody.section.items.text.actions.buy
object
verplicht
Onderliggende attributen tonen
template.templateBody.section.items.text.actions.buy.amountCents
integer
verplicht
template.templateBody.section.items.text.actions.buy.currency
string
verplicht
template.templateBody.section.items.text.actions.buy.text
string
verplicht
template.templateBody.section.items.text.actions.type
string
verplicht
Possible values: buy
template.templateBody.section.items.text.actions.postback
object
verplicht
Onderliggende attributen tonen
template.templateBody.section.items.text.actions.postback.handshake
object
Onderliggende attributen tonen
template.templateBody.section.items.text.actions.postback.handshake.packageName
string
verplicht
template.templateBody.section.items.text.actions.postback.handshake.signatureHash
string
verplicht
template.templateBody.section.items.text.actions.postback.handshake.supportedApps
array of object
Onderliggende attributen tonen
template.templateBody.section.items.text.actions.postback.handshake.supportedApps.packageName
string
verplicht
template.templateBody.section.items.text.actions.postback.handshake.supportedApps.signatureHash
string
verplicht
template.templateBody.section.items.text.actions.postback.handshake.text
string
verplicht
template.templateBody.section.items.text.actions.postback.handshake.zeroTapTermsAccepted
boolean
verplicht
template.templateBody.section.items.text.actions.postback.imageUrl
string
template.templateBody.section.items.text.actions.postback.metadata
object
Onderliggende attributen tonen
template.templateBody.section.items.text.actions.postback.metadata.description
object
Onderliggende attributen tonen
template.templateBody.section.items.text.actions.postback.metadata.description.label
string
verplicht
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
verplicht
template.templateBody.section.items.text.actions.type
string
verplicht
Possible values: postback
template.templateBody.section.items.text.attachments
array of object
Onderliggende attributen tonen
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
verplicht
template.templateBody.section.items.text.attachments.inline
boolean
template.templateBody.section.items.text.attachments.mediaUrl
string
verplicht
template.templateBody.section.items.text.metadata
object
Onderliggende attributen tonen
template.templateBody.section.items.text.metadata.apple
object
Onderliggende attributen tonen
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
Onderliggende attributen tonen
template.templateBody.section.items.text.metadata.line.emoji
object
Onderliggende attributen tonen
template.templateBody.section.items.text.metadata.line.emoji.items
array of object
Onderliggende attributen tonen
template.templateBody.section.items.text.metadata.line.emoji.items.emojiId
string
verplicht
template.templateBody.section.items.text.metadata.line.emoji.items.index
integer
verplicht
template.templateBody.section.items.text.metadata.line.emoji.items.length
integer
template.templateBody.section.items.text.metadata.line.emoji.items.productId
string
verplicht
template.templateBody.section.items.text.metadata.paymentDetails
object
Onderliggende attributen tonen
template.templateBody.section.items.text.metadata.paymentDetails.amount
string
verplicht
template.templateBody.section.items.text.metadata.paymentDetails.currency
string
verplicht
template.templateBody.section.items.text.metadata.paymentDetails.sessionIdentifier
string
template.templateBody.section.items.text.metadata.paymentDetails.state
string
verplicht
template.templateBody.section.items.text.metadata.subject
string
template.templateBody.section.items.text.metadata.telegram
object
Onderliggende attributen tonen
template.templateBody.section.items.text.metadata.telegram.parseMode
string
template.templateBody.section.items.text.metadata.whatsapp
object
Onderliggende attributen tonen
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
verplicht
template.templateBody.section.items.text.metadata.whatsapp.sharedContacts
array of object
Onderliggende attributen tonen
template.templateBody.section.items.text.metadata.whatsapp.sharedContacts.origin
string
verplicht
template.templateBody.section.items.text.metadata.whatsapp.sharedContacts.phones
array of object
Onderliggende attributen tonen
template.templateBody.section.items.text.metadata.whatsapp.sharedContacts.phones.phone
string
verplicht
template.templateBody.section.items.text.metadata.whatsapp.sharedContacts.phones.type
string
verplicht
template.templateBody.section.items.text.metadata.whatsapp.sharedContacts.phones.waId
string
verplicht
template.templateBody.section.items.text.metadata.whatsapp.sharedContacts.vcard
string
template.templateBody.section.items.text.text
string
verplicht
template.templateBody.section.items.type
string
verplicht
Possible values: text
template.templateBody.section.items.html
object
verplicht
Onderliggende attributen tonen
template.templateBody.section.items.html.actions
array of object
Onderliggende attributen tonen
template.templateBody.section.items.html.actions.link
object
verplicht
Onderliggende attributen tonen
template.templateBody.section.items.html.actions.link.metadata
object
Onderliggende attributen tonen
template.templateBody.section.items.html.actions.link.metadata.description
object
Onderliggende attributen tonen
template.templateBody.section.items.html.actions.link.metadata.description.label
string
verplicht
template.templateBody.section.items.html.actions.link.text
string
verplicht
template.templateBody.section.items.html.actions.link.url
string
verplicht
template.templateBody.section.items.html.actions.type
string
verplicht
Possible values: link
template.templateBody.section.items.html.actions.reply
object
verplicht
Onderliggende attributen tonen
template.templateBody.section.items.html.actions.reply.imageUrl
string
template.templateBody.section.items.html.actions.reply.metadata
object
Onderliggende attributen tonen
template.templateBody.section.items.html.actions.reply.metadata.description
object
Onderliggende attributen tonen
template.templateBody.section.items.html.actions.reply.metadata.description.label
string
verplicht
template.templateBody.section.items.html.actions.reply.text
string
verplicht
template.templateBody.section.items.html.actions.type
string
verplicht
Possible values: reply
template.templateBody.section.items.html.actions.locationRequest
object
Onderliggende attributen tonen
template.templateBody.section.items.html.actions.locationRequest.text
string
template.templateBody.section.items.html.actions.type
string
verplicht
Possible values: locationRequest
template.templateBody.section.items.html.actions.buy
object
verplicht
Onderliggende attributen tonen
template.templateBody.section.items.html.actions.buy.amountCents
integer
verplicht
template.templateBody.section.items.html.actions.buy.currency
string
verplicht
template.templateBody.section.items.html.actions.buy.text
string
verplicht
template.templateBody.section.items.html.actions.type
string
verplicht
Possible values: buy
template.templateBody.section.items.html.actions.postback
object
verplicht
Onderliggende attributen tonen
template.templateBody.section.items.html.actions.postback.handshake
object
Onderliggende attributen tonen
template.templateBody.section.items.html.actions.postback.handshake.packageName
string
verplicht
template.templateBody.section.items.html.actions.postback.handshake.signatureHash
string
verplicht
template.templateBody.section.items.html.actions.postback.handshake.supportedApps
array of object
Onderliggende attributen tonen
template.templateBody.section.items.html.actions.postback.handshake.supportedApps.packageName
string
verplicht
template.templateBody.section.items.html.actions.postback.handshake.supportedApps.signatureHash
string
verplicht
template.templateBody.section.items.html.actions.postback.handshake.text
string
verplicht
template.templateBody.section.items.html.actions.postback.handshake.zeroTapTermsAccepted
boolean
verplicht
template.templateBody.section.items.html.actions.postback.imageUrl
string
template.templateBody.section.items.html.actions.postback.metadata
object
Onderliggende attributen tonen
template.templateBody.section.items.html.actions.postback.metadata.description
object
Onderliggende attributen tonen
template.templateBody.section.items.html.actions.postback.metadata.description.label
string
verplicht
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
verplicht
template.templateBody.section.items.html.actions.type
string
verplicht
Possible values: postback
template.templateBody.section.items.html.attachments
array of object
Onderliggende attributen tonen
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
verplicht
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
Onderliggende attributen tonen
template.templateBody.section.items.html.metadata.clickTracking
boolean
template.templateBody.section.items.html.metadata.from
object
Onderliggende attributen tonen
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
verplicht
Possible values: html
template.templateBody.section.items.image
object
verplicht
Onderliggende attributen tonen
template.templateBody.section.items.image.actions
array of object
Onderliggende attributen tonen
template.templateBody.section.items.image.actions.link
object
verplicht
Onderliggende attributen tonen
template.templateBody.section.items.image.actions.link.metadata
object
Onderliggende attributen tonen
template.templateBody.section.items.image.actions.link.metadata.description
object
Onderliggende attributen tonen
template.templateBody.section.items.image.actions.link.metadata.description.label
string
verplicht
template.templateBody.section.items.image.actions.link.text
string
verplicht
template.templateBody.section.items.image.actions.link.url
string
verplicht
template.templateBody.section.items.image.actions.type
string
verplicht
Possible values: link
template.templateBody.section.items.image.actions.reply
object
verplicht
Onderliggende attributen tonen
template.templateBody.section.items.image.actions.reply.imageUrl
string
template.templateBody.section.items.image.actions.reply.metadata
object
Onderliggende attributen tonen
template.templateBody.section.items.image.actions.reply.metadata.description
object
Onderliggende attributen tonen
template.templateBody.section.items.image.actions.reply.metadata.description.label
string
verplicht
template.templateBody.section.items.image.actions.reply.text
string
verplicht
template.templateBody.section.items.image.actions.type
string
verplicht
Possible values: reply
template.templateBody.section.items.image.actions.locationRequest
object
Onderliggende attributen tonen
template.templateBody.section.items.image.actions.locationRequest.text
string
template.templateBody.section.items.image.actions.type
string
verplicht
Possible values: locationRequest
template.templateBody.section.items.image.actions.buy
object
verplicht
Onderliggende attributen tonen
template.templateBody.section.items.image.actions.buy.amountCents
integer
verplicht
template.templateBody.section.items.image.actions.buy.currency
string
verplicht
template.templateBody.section.items.image.actions.buy.text
string
verplicht
template.templateBody.section.items.image.actions.type
string
verplicht
Possible values: buy
template.templateBody.section.items.image.actions.postback
object
verplicht
Onderliggende attributen tonen
template.templateBody.section.items.image.actions.postback.handshake
object
Onderliggende attributen tonen
template.templateBody.section.items.image.actions.postback.handshake.packageName
string
verplicht
template.templateBody.section.items.image.actions.postback.handshake.signatureHash
string
verplicht
template.templateBody.section.items.image.actions.postback.handshake.supportedApps
array of object
Onderliggende attributen tonen
template.templateBody.section.items.image.actions.postback.handshake.supportedApps.packageName
string
verplicht
template.templateBody.section.items.image.actions.postback.handshake.supportedApps.signatureHash
string
verplicht
template.templateBody.section.items.image.actions.postback.handshake.text
string
verplicht
template.templateBody.section.items.image.actions.postback.handshake.zeroTapTermsAccepted
boolean
verplicht
template.templateBody.section.items.image.actions.postback.imageUrl
string
template.templateBody.section.items.image.actions.postback.metadata
object
Onderliggende attributen tonen
template.templateBody.section.items.image.actions.postback.metadata.description
object
Onderliggende attributen tonen
template.templateBody.section.items.image.actions.postback.metadata.description.label
string
verplicht
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
verplicht
template.templateBody.section.items.image.actions.type
string
verplicht
Possible values: postback
template.templateBody.section.items.image.images
array of object
verplicht
Onderliggende attributen tonen
template.templateBody.section.items.image.images.altText
string
template.templateBody.section.items.image.images.mediaPreviewUrl
string
template.templateBody.section.items.image.images.mediaUrl
string
verplicht
template.templateBody.section.items.image.metadata
object
Onderliggende attributen tonen
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
Onderliggende attributen tonen
template.templateBody.section.items.image.metadata.telegram.parseMode
string
template.templateBody.section.items.image.text
string
template.templateBody.section.items.type
string
verplicht
Possible values: image
template.templateBody.section.items.gif
object
verplicht
Onderliggende attributen tonen
template.templateBody.section.items.gif.actions
array of object
Onderliggende attributen tonen
template.templateBody.section.items.gif.actions.link
object
verplicht
Onderliggende attributen tonen
template.templateBody.section.items.gif.actions.link.metadata
object
Onderliggende attributen tonen
template.templateBody.section.items.gif.actions.link.metadata.description
object
Onderliggende attributen tonen
template.templateBody.section.items.gif.actions.link.metadata.description.label
string
verplicht
template.templateBody.section.items.gif.actions.link.text
string
verplicht
template.templateBody.section.items.gif.actions.link.url
string
verplicht
template.templateBody.section.items.gif.actions.type
string
verplicht
Possible values: link
template.templateBody.section.items.gif.actions.reply
object
verplicht
Onderliggende attributen tonen
template.templateBody.section.items.gif.actions.reply.imageUrl
string
template.templateBody.section.items.gif.actions.reply.metadata
object
Onderliggende attributen tonen
template.templateBody.section.items.gif.actions.reply.metadata.description
object
Onderliggende attributen tonen
template.templateBody.section.items.gif.actions.reply.metadata.description.label
string
verplicht
template.templateBody.section.items.gif.actions.reply.text
string
verplicht
template.templateBody.section.items.gif.actions.type
string
verplicht
Possible values: reply
template.templateBody.section.items.gif.actions.locationRequest
object
Onderliggende attributen tonen
template.templateBody.section.items.gif.actions.locationRequest.text
string
template.templateBody.section.items.gif.actions.type
string
verplicht
Possible values: locationRequest
template.templateBody.section.items.gif.actions.buy
object
verplicht
Onderliggende attributen tonen
template.templateBody.section.items.gif.actions.buy.amountCents
integer
verplicht
template.templateBody.section.items.gif.actions.buy.currency
string
verplicht
template.templateBody.section.items.gif.actions.buy.text
string
verplicht
template.templateBody.section.items.gif.actions.type
string
verplicht
Possible values: buy
template.templateBody.section.items.gif.actions.postback
object
verplicht
Onderliggende attributen tonen
template.templateBody.section.items.gif.actions.postback.handshake
object
Onderliggende attributen tonen
template.templateBody.section.items.gif.actions.postback.handshake.packageName
string
verplicht
template.templateBody.section.items.gif.actions.postback.handshake.signatureHash
string
verplicht
template.templateBody.section.items.gif.actions.postback.handshake.supportedApps
array of object
Onderliggende attributen tonen
template.templateBody.section.items.gif.actions.postback.handshake.supportedApps.packageName
string
verplicht
template.templateBody.section.items.gif.actions.postback.handshake.supportedApps.signatureHash
string
verplicht
template.templateBody.section.items.gif.actions.postback.handshake.text
string
verplicht
template.templateBody.section.items.gif.actions.postback.handshake.zeroTapTermsAccepted
boolean
verplicht
template.templateBody.section.items.gif.actions.postback.imageUrl
string
template.templateBody.section.items.gif.actions.postback.metadata
object
Onderliggende attributen tonen
template.templateBody.section.items.gif.actions.postback.metadata.description
object
Onderliggende attributen tonen
template.templateBody.section.items.gif.actions.postback.metadata.description.label
string
verplicht
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
verplicht
template.templateBody.section.items.gif.actions.type
string
verplicht
Possible values: postback
template.templateBody.section.items.gif.altText
string
template.templateBody.section.items.gif.mediaUrl
string
verplicht
template.templateBody.section.items.gif.metadata
object
Onderliggende attributen tonen
template.templateBody.section.items.gif.metadata.telegram
object
Onderliggende attributen tonen
template.templateBody.section.items.gif.metadata.telegram.parseMode
string
template.templateBody.section.items.gif.text
string
template.templateBody.section.items.type
string
verplicht
Possible values: gif
template.templateBody.section.items.file
object
verplicht
Onderliggende attributen tonen
template.templateBody.section.items.file.actions
array of object
Onderliggende attributen tonen
template.templateBody.section.items.file.actions.link
object
verplicht
Onderliggende attributen tonen
template.templateBody.section.items.file.actions.link.metadata
object
Onderliggende attributen tonen
template.templateBody.section.items.file.actions.link.metadata.description
object
Onderliggende attributen tonen
template.templateBody.section.items.file.actions.link.metadata.description.label
string
verplicht
template.templateBody.section.items.file.actions.link.text
string
verplicht
template.templateBody.section.items.file.actions.link.url
string
verplicht
template.templateBody.section.items.file.actions.type
string
verplicht
Possible values: link
template.templateBody.section.items.file.actions.reply
object
verplicht
Onderliggende attributen tonen
template.templateBody.section.items.file.actions.reply.imageUrl
string
template.templateBody.section.items.file.actions.reply.metadata
object
Onderliggende attributen tonen
template.templateBody.section.items.file.actions.reply.metadata.description
object
Onderliggende attributen tonen
template.templateBody.section.items.file.actions.reply.metadata.description.label
string
verplicht
template.templateBody.section.items.file.actions.reply.text
string
verplicht
template.templateBody.section.items.file.actions.type
string
verplicht
Possible values: reply
template.templateBody.section.items.file.actions.locationRequest
object
Onderliggende attributen tonen
template.templateBody.section.items.file.actions.locationRequest.text
string
template.templateBody.section.items.file.actions.type
string
verplicht
Possible values: locationRequest
template.templateBody.section.items.file.actions.buy
object
verplicht
Onderliggende attributen tonen
template.templateBody.section.items.file.actions.buy.amountCents
integer
verplicht
template.templateBody.section.items.file.actions.buy.currency
string
verplicht
template.templateBody.section.items.file.actions.buy.text
string
verplicht
template.templateBody.section.items.file.actions.type
string
verplicht
Possible values: buy
template.templateBody.section.items.file.actions.postback
object
verplicht
Onderliggende attributen tonen
template.templateBody.section.items.file.actions.postback.handshake
object
Onderliggende attributen tonen
template.templateBody.section.items.file.actions.postback.handshake.packageName
string
verplicht
template.templateBody.section.items.file.actions.postback.handshake.signatureHash
string
verplicht
template.templateBody.section.items.file.actions.postback.handshake.supportedApps
array of object
Onderliggende attributen tonen
template.templateBody.section.items.file.actions.postback.handshake.supportedApps.packageName
string
verplicht
template.templateBody.section.items.file.actions.postback.handshake.supportedApps.signatureHash
string
verplicht
template.templateBody.section.items.file.actions.postback.handshake.text
string
verplicht
template.templateBody.section.items.file.actions.postback.handshake.zeroTapTermsAccepted
boolean
verplicht
template.templateBody.section.items.file.actions.postback.imageUrl
string
template.templateBody.section.items.file.actions.postback.metadata
object
Onderliggende attributen tonen
template.templateBody.section.items.file.actions.postback.metadata.description
object
Onderliggende attributen tonen
template.templateBody.section.items.file.actions.postback.metadata.description.label
string
verplicht
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
verplicht
template.templateBody.section.items.file.actions.type
string
verplicht
Possible values: postback
template.templateBody.section.items.file.files
array of object
verplicht
Onderliggende attributen tonen
template.templateBody.section.items.file.files.altText
string
template.templateBody.section.items.file.files.contentType
string
verplicht
template.templateBody.section.items.file.files.filename
string
template.templateBody.section.items.file.files.mediaUrl
string
verplicht
template.templateBody.section.items.file.files.metadata
object
Onderliggende attributen tonen
template.templateBody.section.items.file.files.metadata.isAnimated
boolean
template.templateBody.section.items.file.metadata
object
Onderliggende attributen tonen
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
Onderliggende attributen tonen
template.templateBody.section.items.file.metadata.telegram.parseMode
string
template.templateBody.section.items.file.text
string
template.templateBody.section.items.type
string
verplicht
Possible values: file
template.templateBody.section.items.location
object
verplicht
Onderliggende attributen tonen
template.templateBody.section.items.location.coordinates
object
verplicht
Onderliggende attributen tonen
template.templateBody.section.items.location.coordinates.latitude
number
verplicht
template.templateBody.section.items.location.coordinates.longitude
number
verplicht
template.templateBody.section.items.location.location
object
verplicht
Onderliggende attributen tonen
template.templateBody.section.items.location.location.address
string
verplicht
template.templateBody.section.items.location.location.label
string
verplicht
template.templateBody.section.items.type
string
verplicht
Possible values: location
template.templateBody.section.items.carousel
object
verplicht
Onderliggende attributen tonen
template.templateBody.section.items.carousel.items
array of object
Onderliggende attributen tonen
template.templateBody.section.items.carousel.items.actions
array of object
Onderliggende attributen tonen
template.templateBody.section.items.carousel.items.actions.link
object
verplicht
Onderliggende attributen tonen
template.templateBody.section.items.carousel.items.actions.link.metadata
object
Onderliggende attributen tonen
template.templateBody.section.items.carousel.items.actions.link.metadata.description
object
Onderliggende attributen tonen
template.templateBody.section.items.carousel.items.actions.link.metadata.description.label
string
verplicht
template.templateBody.section.items.carousel.items.actions.link.text
string
verplicht
template.templateBody.section.items.carousel.items.actions.link.url
string
verplicht
template.templateBody.section.items.carousel.items.actions.type
string
verplicht
Possible values: link
template.templateBody.section.items.carousel.items.actions.reply
object
verplicht
Onderliggende attributen tonen
template.templateBody.section.items.carousel.items.actions.reply.imageUrl
string
template.templateBody.section.items.carousel.items.actions.reply.metadata
object
Onderliggende attributen tonen
template.templateBody.section.items.carousel.items.actions.reply.metadata.description
object
Onderliggende attributen tonen
template.templateBody.section.items.carousel.items.actions.reply.metadata.description.label
string
verplicht
template.templateBody.section.items.carousel.items.actions.reply.text
string
verplicht
template.templateBody.section.items.carousel.items.actions.type
string
verplicht
Possible values: reply
template.templateBody.section.items.carousel.items.actions.locationRequest
object
Onderliggende attributen tonen
template.templateBody.section.items.carousel.items.actions.locationRequest.text
string
template.templateBody.section.items.carousel.items.actions.type
string
verplicht
Possible values: locationRequest
template.templateBody.section.items.carousel.items.actions.buy
object
verplicht
Onderliggende attributen tonen
template.templateBody.section.items.carousel.items.actions.buy.amountCents
integer
verplicht
template.templateBody.section.items.carousel.items.actions.buy.currency
string
verplicht
template.templateBody.section.items.carousel.items.actions.buy.text
string
verplicht
template.templateBody.section.items.carousel.items.actions.type
string
verplicht
Possible values: buy
template.templateBody.section.items.carousel.items.actions.postback
object
verplicht
Onderliggende attributen tonen
template.templateBody.section.items.carousel.items.actions.postback.handshake
object
Onderliggende attributen tonen
template.templateBody.section.items.carousel.items.actions.postback.handshake.packageName
string
verplicht
template.templateBody.section.items.carousel.items.actions.postback.handshake.signatureHash
string
verplicht
template.templateBody.section.items.carousel.items.actions.postback.handshake.supportedApps
array of object
Onderliggende attributen tonen
template.templateBody.section.items.carousel.items.actions.postback.handshake.supportedApps.packageName
string
verplicht
template.templateBody.section.items.carousel.items.actions.postback.handshake.supportedApps.signatureHash
string
verplicht
template.templateBody.section.items.carousel.items.actions.postback.handshake.text
string
verplicht
template.templateBody.section.items.carousel.items.actions.postback.handshake.zeroTapTermsAccepted
boolean
verplicht
template.templateBody.section.items.carousel.items.actions.postback.imageUrl
string
template.templateBody.section.items.carousel.items.actions.postback.metadata
object
Onderliggende attributen tonen
template.templateBody.section.items.carousel.items.actions.postback.metadata.description
object
Onderliggende attributen tonen
template.templateBody.section.items.carousel.items.actions.postback.metadata.description.label
string
verplicht
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
verplicht
template.templateBody.section.items.carousel.items.actions.type
string
verplicht
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
verplicht
Possible values: carousel
template.templateBody.section.items.list
object
verplicht
Onderliggende attributen tonen
template.templateBody.section.items.list.actions
array of object
Onderliggende attributen tonen
template.templateBody.section.items.list.actions.link
object
verplicht
Onderliggende attributen tonen
template.templateBody.section.items.list.actions.link.metadata
object
Onderliggende attributen tonen
template.templateBody.section.items.list.actions.link.metadata.description
object
Onderliggende attributen tonen
template.templateBody.section.items.list.actions.link.metadata.description.label
string
verplicht
template.templateBody.section.items.list.actions.link.text
string
verplicht
template.templateBody.section.items.list.actions.link.url
string
verplicht
template.templateBody.section.items.list.actions.type
string
verplicht
Possible values: link
template.templateBody.section.items.list.actions.reply
object
verplicht
Onderliggende attributen tonen
template.templateBody.section.items.list.actions.reply.imageUrl
string
template.templateBody.section.items.list.actions.reply.metadata
object
Onderliggende attributen tonen
template.templateBody.section.items.list.actions.reply.metadata.description
object
Onderliggende attributen tonen
template.templateBody.section.items.list.actions.reply.metadata.description.label
string
verplicht
template.templateBody.section.items.list.actions.reply.text
string
verplicht
template.templateBody.section.items.list.actions.type
string
verplicht
Possible values: reply
template.templateBody.section.items.list.actions.locationRequest
object
Onderliggende attributen tonen
template.templateBody.section.items.list.actions.locationRequest.text
string
template.templateBody.section.items.list.actions.type
string
verplicht
Possible values: locationRequest
template.templateBody.section.items.list.actions.buy
object
verplicht
Onderliggende attributen tonen
template.templateBody.section.items.list.actions.buy.amountCents
integer
verplicht
template.templateBody.section.items.list.actions.buy.currency
string
verplicht
template.templateBody.section.items.list.actions.buy.text
string
verplicht
template.templateBody.section.items.list.actions.type
string
verplicht
Possible values: buy
template.templateBody.section.items.list.actions.postback
object
verplicht
Onderliggende attributen tonen
template.templateBody.section.items.list.actions.postback.handshake
object
Onderliggende attributen tonen
template.templateBody.section.items.list.actions.postback.handshake.packageName
string
verplicht
template.templateBody.section.items.list.actions.postback.handshake.signatureHash
string
verplicht
template.templateBody.section.items.list.actions.postback.handshake.supportedApps
array of object
Onderliggende attributen tonen
template.templateBody.section.items.list.actions.postback.handshake.supportedApps.packageName
string
verplicht
template.templateBody.section.items.list.actions.postback.handshake.supportedApps.signatureHash
string
verplicht
template.templateBody.section.items.list.actions.postback.handshake.text
string
verplicht
template.templateBody.section.items.list.actions.postback.handshake.zeroTapTermsAccepted
boolean
verplicht
template.templateBody.section.items.list.actions.postback.imageUrl
string
template.templateBody.section.items.list.actions.postback.metadata
object
Onderliggende attributen tonen
template.templateBody.section.items.list.actions.postback.metadata.description
object
Onderliggende attributen tonen
template.templateBody.section.items.list.actions.postback.metadata.description.label
string
verplicht
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
verplicht
template.templateBody.section.items.list.actions.type
string
verplicht
Possible values: postback
template.templateBody.section.items.list.altText
string
template.templateBody.section.items.list.items
array of object
Onderliggende attributen tonen
template.templateBody.section.items.list.items.actions
array of object
Onderliggende attributen tonen
template.templateBody.section.items.list.items.actions.link
object
verplicht
Onderliggende attributen tonen
template.templateBody.section.items.list.items.actions.link.metadata
object
Onderliggende attributen tonen
template.templateBody.section.items.list.items.actions.link.metadata.description
object
Onderliggende attributen tonen
template.templateBody.section.items.list.items.actions.link.metadata.description.label
string
verplicht
template.templateBody.section.items.list.items.actions.link.text
string
verplicht
template.templateBody.section.items.list.items.actions.link.url
string
verplicht
template.templateBody.section.items.list.items.actions.type
string
verplicht
Possible values: link
template.templateBody.section.items.list.items.actions.reply
object
verplicht
Onderliggende attributen tonen
template.templateBody.section.items.list.items.actions.reply.imageUrl
string
template.templateBody.section.items.list.items.actions.reply.metadata
object
Onderliggende attributen tonen
template.templateBody.section.items.list.items.actions.reply.metadata.description
object
Onderliggende attributen tonen
template.templateBody.section.items.list.items.actions.reply.metadata.description.label
string
verplicht
template.templateBody.section.items.list.items.actions.reply.text
string
verplicht
template.templateBody.section.items.list.items.actions.type
string
verplicht
Possible values: reply
template.templateBody.section.items.list.items.actions.locationRequest
object
Onderliggende attributen tonen
template.templateBody.section.items.list.items.actions.locationRequest.text
string
template.templateBody.section.items.list.items.actions.type
string
verplicht
Possible values: locationRequest
template.templateBody.section.items.list.items.actions.buy
object
verplicht
Onderliggende attributen tonen
template.templateBody.section.items.list.items.actions.buy.amountCents
integer
verplicht
template.templateBody.section.items.list.items.actions.buy.currency
string
verplicht
template.templateBody.section.items.list.items.actions.buy.text
string
verplicht
template.templateBody.section.items.list.items.actions.type
string
verplicht
Possible values: buy
template.templateBody.section.items.list.items.actions.postback
object
verplicht
Onderliggende attributen tonen
template.templateBody.section.items.list.items.actions.postback.handshake
object
Onderliggende attributen tonen
template.templateBody.section.items.list.items.actions.postback.handshake.packageName
string
verplicht
template.templateBody.section.items.list.items.actions.postback.handshake.signatureHash
string
verplicht
template.templateBody.section.items.list.items.actions.postback.handshake.supportedApps
array of object
Onderliggende attributen tonen
template.templateBody.section.items.list.items.actions.postback.handshake.supportedApps.packageName
string
verplicht
template.templateBody.section.items.list.items.actions.postback.handshake.supportedApps.signatureHash
string
verplicht
template.templateBody.section.items.list.items.actions.postback.handshake.text
string
verplicht
template.templateBody.section.items.list.items.actions.postback.handshake.zeroTapTermsAccepted
boolean
verplicht
template.templateBody.section.items.list.items.actions.postback.imageUrl
string
template.templateBody.section.items.list.items.actions.postback.metadata
object
Onderliggende attributen tonen
template.templateBody.section.items.list.items.actions.postback.metadata.description
object
Onderliggende attributen tonen
template.templateBody.section.items.list.items.actions.postback.metadata.description.label
string
verplicht
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
verplicht
template.templateBody.section.items.list.items.actions.type
string
verplicht
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
Onderliggende attributen tonen
template.templateBody.section.items.list.metadata.button
object
Onderliggende attributen tonen
template.templateBody.section.items.list.metadata.button.label
string
verplicht
template.templateBody.section.items.list.metadata.replyMessage
object
Onderliggende attributen tonen
template.templateBody.section.items.list.metadata.replyMessage.text
string
verplicht
template.templateBody.section.items.list.metadata.replyMessage.title
string
verplicht
template.templateBody.section.items.list.text
string
template.templateBody.section.items.list.title
string
template.templateBody.section.items.type
string
verplicht
Possible values: list
template.templateBody.section.items.section
object
verplicht
template.templateBody.section.items.type
string
verplicht
Possible values: section
template.templateBody.section.items.authentication
object
verplicht
Onderliggende attributen tonen
template.templateBody.section.items.authentication.otp
object
Onderliggende attributen tonen
template.templateBody.section.items.authentication.otp.actions
array of object
Onderliggende attributen tonen
template.templateBody.section.items.authentication.otp.actions.link
object
verplicht
Onderliggende attributen tonen
template.templateBody.section.items.authentication.otp.actions.link.metadata
object
Onderliggende attributen tonen
template.templateBody.section.items.authentication.otp.actions.link.metadata.description
object
Onderliggende attributen tonen
template.templateBody.section.items.authentication.otp.actions.link.metadata.description.label
string
verplicht
template.templateBody.section.items.authentication.otp.actions.link.text
string
verplicht
template.templateBody.section.items.authentication.otp.actions.link.url
string
verplicht
template.templateBody.section.items.authentication.otp.actions.type
string
verplicht
Possible values: link
template.templateBody.section.items.authentication.otp.actions.reply
object
verplicht
Onderliggende attributen tonen
template.templateBody.section.items.authentication.otp.actions.reply.imageUrl
string
template.templateBody.section.items.authentication.otp.actions.reply.metadata
object
Onderliggende attributen tonen
template.templateBody.section.items.authentication.otp.actions.reply.metadata.description
object
Onderliggende attributen tonen
template.templateBody.section.items.authentication.otp.actions.reply.metadata.description.label
string
verplicht
template.templateBody.section.items.authentication.otp.actions.reply.text
string
verplicht
template.templateBody.section.items.authentication.otp.actions.type
string
verplicht
Possible values: reply
template.templateBody.section.items.authentication.otp.actions.locationRequest
object
Onderliggende attributen tonen
template.templateBody.section.items.authentication.otp.actions.locationRequest.text
string
template.templateBody.section.items.authentication.otp.actions.type
string
verplicht
Possible values: locationRequest
template.templateBody.section.items.authentication.otp.actions.buy
object
verplicht
Onderliggende attributen tonen
template.templateBody.section.items.authentication.otp.actions.buy.amountCents
integer
verplicht
template.templateBody.section.items.authentication.otp.actions.buy.currency
string
verplicht
template.templateBody.section.items.authentication.otp.actions.buy.text
string
verplicht
template.templateBody.section.items.authentication.otp.actions.type
string
verplicht
Possible values: buy
template.templateBody.section.items.authentication.otp.actions.postback
object
verplicht
Onderliggende attributen tonen
template.templateBody.section.items.authentication.otp.actions.postback.handshake
object
Onderliggende attributen tonen
template.templateBody.section.items.authentication.otp.actions.postback.handshake.packageName
string
verplicht
template.templateBody.section.items.authentication.otp.actions.postback.handshake.signatureHash
string
verplicht
template.templateBody.section.items.authentication.otp.actions.postback.handshake.supportedApps
array of object
Onderliggende attributen tonen
template.templateBody.section.items.authentication.otp.actions.postback.handshake.supportedApps.packageName
string
verplicht
template.templateBody.section.items.authentication.otp.actions.postback.handshake.supportedApps.signatureHash
string
verplicht
template.templateBody.section.items.authentication.otp.actions.postback.handshake.text
string
verplicht
template.templateBody.section.items.authentication.otp.actions.postback.handshake.zeroTapTermsAccepted
boolean
verplicht
template.templateBody.section.items.authentication.otp.actions.postback.imageUrl
string
template.templateBody.section.items.authentication.otp.actions.postback.metadata
object
Onderliggende attributen tonen
template.templateBody.section.items.authentication.otp.actions.postback.metadata.description
object
Onderliggende attributen tonen
template.templateBody.section.items.authentication.otp.actions.postback.metadata.description.label
string
verplicht
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
verplicht
template.templateBody.section.items.authentication.otp.actions.type
string
verplicht
Possible values: postback
template.templateBody.section.items.authentication.otp.disclaimer
boolean
verplicht
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
verplicht
Possible values: authentication
template.templateBody.section.items.action
object
verplicht
Onderliggende attributen tonen
template.templateBody.section.items.action.action
string
verplicht
Possible values: permissionRequest
template.templateBody.section.items.action.permissionRequest
object
verplicht
Onderliggende attributen tonen
template.templateBody.section.items.action.permissionRequest.resource
string
verplicht
Possible values: call
template.templateBody.section.items.type
string
verplicht
Possible values: action
template.templateBody.type
string
verplicht
Possible values: section
template.templateBody.authentication
object
verplicht
Onderliggende attributen tonen
template.templateBody.authentication.otp
object
Onderliggende attributen tonen
template.templateBody.authentication.otp.actions
array of object
Onderliggende attributen tonen
template.templateBody.authentication.otp.actions.link
object
verplicht
Onderliggende attributen tonen
template.templateBody.authentication.otp.actions.link.metadata
object
Onderliggende attributen tonen
template.templateBody.authentication.otp.actions.link.metadata.description
object
Onderliggende attributen tonen
template.templateBody.authentication.otp.actions.link.metadata.description.label
string
verplicht
template.templateBody.authentication.otp.actions.link.text
string
verplicht
template.templateBody.authentication.otp.actions.link.url
string
verplicht
template.templateBody.authentication.otp.actions.type
string
verplicht
Possible values: link
template.templateBody.authentication.otp.actions.reply
object
verplicht
Onderliggende attributen tonen
template.templateBody.authentication.otp.actions.reply.imageUrl
string
template.templateBody.authentication.otp.actions.reply.metadata
object
Onderliggende attributen tonen
template.templateBody.authentication.otp.actions.reply.metadata.description
object
Onderliggende attributen tonen
template.templateBody.authentication.otp.actions.reply.metadata.description.label
string
verplicht
template.templateBody.authentication.otp.actions.reply.text
string
verplicht
template.templateBody.authentication.otp.actions.type
string
verplicht
Possible values: reply
template.templateBody.authentication.otp.actions.locationRequest
object
Onderliggende attributen tonen
template.templateBody.authentication.otp.actions.locationRequest.text
string
template.templateBody.authentication.otp.actions.type
string
verplicht
Possible values: locationRequest
template.templateBody.authentication.otp.actions.buy
object
verplicht
Onderliggende attributen tonen
template.templateBody.authentication.otp.actions.buy.amountCents
integer
verplicht
template.templateBody.authentication.otp.actions.buy.currency
string
verplicht
template.templateBody.authentication.otp.actions.buy.text
string
verplicht
template.templateBody.authentication.otp.actions.type
string
verplicht
Possible values: buy
template.templateBody.authentication.otp.actions.postback
object
verplicht
Onderliggende attributen tonen
template.templateBody.authentication.otp.actions.postback.handshake
object
Onderliggende attributen tonen
template.templateBody.authentication.otp.actions.postback.handshake.packageName
string
verplicht
template.templateBody.authentication.otp.actions.postback.handshake.signatureHash
string
verplicht
template.templateBody.authentication.otp.actions.postback.handshake.supportedApps
array of object
Onderliggende attributen tonen
template.templateBody.authentication.otp.actions.postback.handshake.supportedApps.packageName
string
verplicht
template.templateBody.authentication.otp.actions.postback.handshake.supportedApps.signatureHash
string
verplicht
template.templateBody.authentication.otp.actions.postback.handshake.text
string
verplicht
template.templateBody.authentication.otp.actions.postback.handshake.zeroTapTermsAccepted
boolean
verplicht
template.templateBody.authentication.otp.actions.postback.imageUrl
string
template.templateBody.authentication.otp.actions.postback.metadata
object
Onderliggende attributen tonen
template.templateBody.authentication.otp.actions.postback.metadata.description
object
Onderliggende attributen tonen
template.templateBody.authentication.otp.actions.postback.metadata.description.label
string
verplicht
template.templateBody.authentication.otp.actions.postback.otpType
string
template.templateBody.authentication.otp.actions.postback.payload
string
template.templateBody.authentication.otp.actions.postback.text
string
verplicht
template.templateBody.authentication.otp.actions.type
string
verplicht
Possible values: postback
template.templateBody.authentication.otp.disclaimer
boolean
verplicht
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
verplicht
Possible values: authentication
template.templateBody.action
object
verplicht
Onderliggende attributen tonen
template.templateBody.action.action
string
verplicht
Possible values: permissionRequest
template.templateBody.action.permissionRequest
object
verplicht
Onderliggende attributen tonen
template.templateBody.action.permissionRequest.resource
string
verplicht
Possible values: call
template.templateBody.type
string
verplicht
Possible values: action
template.utmParameters
array of object
Onderliggende attributen tonen
template.utmParameters.key
string
verplicht
template.utmParameters.value
string
verplicht
template.utmParameters.key
string
verplicht
template.utmParameters.reference
string
verplicht
Possible values: platform_name, channel_name
template.variables
object
template.version
string
verplicht
The version of the template.
type
string
Possible values: text, html, image, file, gif, location, carousel, list, section, authentication, action
updatedAt
string
verplicht
Codevoorbeeld
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/conversations/{conversationId}/messages/{messageId}' \
-H 'Authorization: AccessKey YOUR_ACCESS_KEY'Examples
Codevoorbeeld
curl "https://api.bird.com/workspaces/a1405560-c8d3-4b1a-877d-3f449ad95352/conversations/02ec2ac2-ebec-42d3-a5f4-e6f3a9edf418/messages/29d3a7f4-841d-4702-a495-20cab72f2865" \
-H "Authorization: AccessKey abcd"Codevoorbeeld
{
"id": "f48ee7ff-45b1-42a2-838b-ea7632180e80",
"conversationId": "907798f8-fd72-44d5-8042-fcc05c1bb570",
"reference": "",
"sender": {
"id": "68b80b8d-8060-42df-bda3-73505a8fdb84",
"type": "accessKey",
"status": "active",
"displayName": "My first email key",
"avatarUrl": ""
},
"draft": false,
"recipients": [
{
"type": "to",
"id": "8f0b5377-2edc-4116-a8e8-6a475f245a04",
"identifierKey": "emailaddress",
"identifierValue": "john.doe@bird.com",
"platformAddress": "john.doe@bird.com",
"contactAnnotation": {
"name": "John Doe"
}
}
],
"status": "accepted",
"source": "conversations",
"body": {
"type": "text",
"text": {
"text": "Hey, listen!"
}
},
"interactions": null,
"createdAt": "2024-11-28T19:58:03.999Z",
"updatedAt": "2024-11-29T13:14:11.55Z"
}