List conversation messages
GET
/workspaces/{workspaceId}/conversations/{conversationId}/messages
Lists conversation messages. This will return a maximum of 100 messages per page, with 10 as default. You can use the limit and pageToken query parameters to paginate the results. Learn more about pagination in the Common API Usage pagination section.
路径参数
conversationId
string
The conversation ID
查询参数
limit
integer
pageToken
string
reverse
boolean
dateFrom
string
Filter by created date after this date.
响应载荷
results
array of object
List of messages in the conversation.
显示子属性
results.body
object
显示子属性
results.body.text
object
必填
显示子属性
results.body.text.actions
array of object
显示子属性
results.body.text.actions.link
object
必填
显示子属性
results.body.text.actions.link.metadata
object
显示子属性
results.body.text.actions.link.metadata.description
object
显示子属性
results.body.text.actions.link.metadata.description.label
string
必填
results.body.text.actions.link.text
string
必填
results.body.text.actions.link.url
string
必填
results.body.text.actions.type
string
必填
Possible values: link
results.body.text.actions.reply
object
必填
显示子属性
results.body.text.actions.reply.imageUrl
string
results.body.text.actions.reply.metadata
object
显示子属性
results.body.text.actions.reply.metadata.description
object
显示子属性
results.body.text.actions.reply.metadata.description.label
string
必填
results.body.text.actions.reply.text
string
必填
results.body.text.actions.type
string
必填
Possible values: reply
results.body.text.actions.locationRequest
object
显示子属性
results.body.text.actions.locationRequest.text
string
results.body.text.actions.type
string
必填
Possible values: locationRequest
results.body.text.actions.buy
object
必填
显示子属性
results.body.text.actions.buy.amountCents
integer
必填
results.body.text.actions.buy.currency
string
必填
results.body.text.actions.buy.text
string
必填
results.body.text.actions.type
string
必填
Possible values: buy
results.body.text.actions.postback
object
必填
显示子属性
results.body.text.actions.postback.handshake
object
显示子属性
results.body.text.actions.postback.handshake.packageName
string
必填
results.body.text.actions.postback.handshake.signatureHash
string
必填
results.body.text.actions.postback.handshake.supportedApps
array of object
显示子属性
results.body.text.actions.postback.handshake.supportedApps.packageName
string
必填
results.body.text.actions.postback.handshake.supportedApps.signatureHash
string
必填
results.body.text.actions.postback.handshake.text
string
必填
results.body.text.actions.postback.handshake.zeroTapTermsAccepted
boolean
必填
results.body.text.actions.postback.imageUrl
string
results.body.text.actions.postback.metadata
object
显示子属性
results.body.text.actions.postback.metadata.description
object
显示子属性
results.body.text.actions.postback.metadata.description.label
string
必填
results.body.text.actions.postback.otpType
string
results.body.text.actions.postback.payload
string
results.body.text.actions.postback.text
string
必填
results.body.text.actions.type
string
必填
Possible values: postback
results.body.text.attachments
array of object
显示子属性
results.body.text.attachments.content
string
results.body.text.attachments.contentId
string
results.body.text.attachments.contentType
string
results.body.text.attachments.filename
string
必填
results.body.text.attachments.inline
boolean
results.body.text.attachments.mediaUrl
string
必填
results.body.text.metadata
object
显示子属性
results.body.text.metadata.apple
object
显示子属性
results.body.text.metadata.apple.appClipPreview
boolean
results.body.text.metadata.apple.appClipRegion
string
results.body.text.metadata.apple.summaryText
string
results.body.text.metadata.headers
object
results.body.text.metadata.line
object
显示子属性
results.body.text.metadata.line.emoji
object
显示子属性
results.body.text.metadata.line.emoji.items
array of object
显示子属性
results.body.text.metadata.line.emoji.items.emojiId
string
必填
results.body.text.metadata.line.emoji.items.index
integer
必填
results.body.text.metadata.line.emoji.items.length
integer
results.body.text.metadata.line.emoji.items.productId
string
必填
results.body.text.metadata.paymentDetails
object
显示子属性
results.body.text.metadata.paymentDetails.amount
string
必填
results.body.text.metadata.paymentDetails.currency
string
必填
results.body.text.metadata.paymentDetails.sessionIdentifier
string
results.body.text.metadata.paymentDetails.state
string
必填
results.body.text.metadata.subject
string
results.body.text.metadata.telegram
object
显示子属性
results.body.text.metadata.telegram.parseMode
string
results.body.text.metadata.whatsapp
object
显示子属性
results.body.text.metadata.whatsapp.callPermissionExpiration
string
results.body.text.metadata.whatsapp.callPermissionResponse
string
Possible values: accept, reject
results.body.text.metadata.whatsapp.previewUrl
boolean
必填
results.body.text.metadata.whatsapp.sharedContacts
array of object
显示子属性
results.body.text.metadata.whatsapp.sharedContacts.origin
string
必填
results.body.text.metadata.whatsapp.sharedContacts.phones
array of object
显示子属性
results.body.text.metadata.whatsapp.sharedContacts.phones.phone
string
必填
results.body.text.metadata.whatsapp.sharedContacts.phones.type
string
必填
results.body.text.metadata.whatsapp.sharedContacts.phones.waId
string
必填
results.body.text.metadata.whatsapp.sharedContacts.vcard
string
results.body.text.text
string
必填
results.body.type
string
必填
Possible values: text
results.body.html
object
必填
显示子属性
results.body.html.actions
array of object
显示子属性
results.body.html.actions.link
object
必填
显示子属性
results.body.html.actions.link.metadata
object
显示子属性
results.body.html.actions.link.metadata.description
object
显示子属性
results.body.html.actions.link.metadata.description.label
string
必填
results.body.html.actions.link.text
string
必填
results.body.html.actions.link.url
string
必填
results.body.html.actions.type
string
必填
Possible values: link
results.body.html.actions.reply
object
必填
显示子属性
results.body.html.actions.reply.imageUrl
string
results.body.html.actions.reply.metadata
object
显示子属性
results.body.html.actions.reply.metadata.description
object
显示子属性
results.body.html.actions.reply.metadata.description.label
string
必填
results.body.html.actions.reply.text
string
必填
results.body.html.actions.type
string
必填
Possible values: reply
results.body.html.actions.locationRequest
object
显示子属性
results.body.html.actions.locationRequest.text
string
results.body.html.actions.type
string
必填
Possible values: locationRequest
results.body.html.actions.buy
object
必填
显示子属性
results.body.html.actions.buy.amountCents
integer
必填
results.body.html.actions.buy.currency
string
必填
results.body.html.actions.buy.text
string
必填
results.body.html.actions.type
string
必填
Possible values: buy
results.body.html.actions.postback
object
必填
显示子属性
results.body.html.actions.postback.handshake
object
显示子属性
results.body.html.actions.postback.handshake.packageName
string
必填
results.body.html.actions.postback.handshake.signatureHash
string
必填
results.body.html.actions.postback.handshake.supportedApps
array of object
显示子属性
results.body.html.actions.postback.handshake.supportedApps.packageName
string
必填
results.body.html.actions.postback.handshake.supportedApps.signatureHash
string
必填
results.body.html.actions.postback.handshake.text
string
必填
results.body.html.actions.postback.handshake.zeroTapTermsAccepted
boolean
必填
results.body.html.actions.postback.imageUrl
string
results.body.html.actions.postback.metadata
object
显示子属性
results.body.html.actions.postback.metadata.description
object
显示子属性
results.body.html.actions.postback.metadata.description.label
string
必填
results.body.html.actions.postback.otpType
string
results.body.html.actions.postback.payload
string
results.body.html.actions.postback.text
string
必填
results.body.html.actions.type
string
必填
Possible values: postback
results.body.html.attachments
array of object
显示子属性
results.body.html.attachments.content
string
results.body.html.attachments.contentId
string
results.body.html.attachments.contentType
string
results.body.html.attachments.filename
string
必填
results.body.html.attachments.inline
boolean
results.body.html.attachments.mediaUrl
string
results.body.html.html
string
results.body.html.metadata
object
显示子属性
results.body.html.metadata.clickTracking
boolean
results.body.html.metadata.from
object
显示子属性
results.body.html.metadata.from.displayName
string
results.body.html.metadata.from.username
string
results.body.html.metadata.headers
object
results.body.html.metadata.initialOpenTracking
boolean
results.body.html.metadata.openTracking
boolean
results.body.html.metadata.subject
string
results.body.html.text
string
results.body.type
string
必填
Possible values: html
results.body.image
object
必填
显示子属性
results.body.image.actions
array of object
显示子属性
results.body.image.actions.link
object
必填
显示子属性
results.body.image.actions.link.metadata
object
显示子属性
results.body.image.actions.link.metadata.description
object
显示子属性
results.body.image.actions.link.metadata.description.label
string
必填
results.body.image.actions.link.text
string
必填
results.body.image.actions.link.url
string
必填
results.body.image.actions.type
string
必填
Possible values: link
results.body.image.actions.reply
object
必填
显示子属性
results.body.image.actions.reply.imageUrl
string
results.body.image.actions.reply.metadata
object
显示子属性
results.body.image.actions.reply.metadata.description
object
显示子属性
results.body.image.actions.reply.metadata.description.label
string
必填
results.body.image.actions.reply.text
string
必填
results.body.image.actions.type
string
必填
Possible values: reply
results.body.image.actions.locationRequest
object
显示子属性
results.body.image.actions.locationRequest.text
string
results.body.image.actions.type
string
必填
Possible values: locationRequest
results.body.image.actions.buy
object
必填
显示子属性
results.body.image.actions.buy.amountCents
integer
必填
results.body.image.actions.buy.currency
string
必填
results.body.image.actions.buy.text
string
必填
results.body.image.actions.type
string
必填
Possible values: buy
results.body.image.actions.postback
object
必填
显示子属性
results.body.image.actions.postback.handshake
object
显示子属性
results.body.image.actions.postback.handshake.packageName
string
必填
results.body.image.actions.postback.handshake.signatureHash
string
必填
results.body.image.actions.postback.handshake.supportedApps
array of object
显示子属性
results.body.image.actions.postback.handshake.supportedApps.packageName
string
必填
results.body.image.actions.postback.handshake.supportedApps.signatureHash
string
必填
results.body.image.actions.postback.handshake.text
string
必填
results.body.image.actions.postback.handshake.zeroTapTermsAccepted
boolean
必填
results.body.image.actions.postback.imageUrl
string
results.body.image.actions.postback.metadata
object
显示子属性
results.body.image.actions.postback.metadata.description
object
显示子属性
results.body.image.actions.postback.metadata.description.label
string
必填
results.body.image.actions.postback.otpType
string
results.body.image.actions.postback.payload
string
results.body.image.actions.postback.text
string
必填
results.body.image.actions.type
string
必填
Possible values: postback
results.body.image.images
array of object
必填
显示子属性
results.body.image.images.altText
string
results.body.image.images.mediaPreviewUrl
string
results.body.image.images.mediaUrl
string
必填
results.body.image.metadata
object
显示子属性
results.body.image.metadata.fallbackText
string
results.body.image.metadata.storyType
string
Possible values: mention, reply
results.body.image.metadata.subject
string
results.body.image.metadata.telegram
object
显示子属性
results.body.image.metadata.telegram.parseMode
string
results.body.image.text
string
results.body.type
string
必填
Possible values: image
results.body.gif
object
必填
显示子属性
results.body.gif.actions
array of object
显示子属性
results.body.gif.actions.link
object
必填
显示子属性
results.body.gif.actions.link.metadata
object
显示子属性
results.body.gif.actions.link.metadata.description
object
显示子属性
results.body.gif.actions.link.metadata.description.label
string
必填
results.body.gif.actions.link.text
string
必填
results.body.gif.actions.link.url
string
必填
results.body.gif.actions.type
string
必填
Possible values: link
results.body.gif.actions.reply
object
必填
显示子属性
results.body.gif.actions.reply.imageUrl
string
results.body.gif.actions.reply.metadata
object
显示子属性
results.body.gif.actions.reply.metadata.description
object
显示子属性
results.body.gif.actions.reply.metadata.description.label
string
必填
results.body.gif.actions.reply.text
string
必填
results.body.gif.actions.type
string
必填
Possible values: reply
results.body.gif.actions.locationRequest
object
显示子属性
results.body.gif.actions.locationRequest.text
string
results.body.gif.actions.type
string
必填
Possible values: locationRequest
results.body.gif.actions.buy
object
必填
显示子属性
results.body.gif.actions.buy.amountCents
integer
必填
results.body.gif.actions.buy.currency
string
必填
results.body.gif.actions.buy.text
string
必填
results.body.gif.actions.type
string
必填
Possible values: buy
results.body.gif.actions.postback
object
必填
显示子属性
results.body.gif.actions.postback.handshake
object
显示子属性
results.body.gif.actions.postback.handshake.packageName
string
必填
results.body.gif.actions.postback.handshake.signatureHash
string
必填
results.body.gif.actions.postback.handshake.supportedApps
array of object
显示子属性
results.body.gif.actions.postback.handshake.supportedApps.packageName
string
必填
results.body.gif.actions.postback.handshake.supportedApps.signatureHash
string
必填
results.body.gif.actions.postback.handshake.text
string
必填
results.body.gif.actions.postback.handshake.zeroTapTermsAccepted
boolean
必填
results.body.gif.actions.postback.imageUrl
string
results.body.gif.actions.postback.metadata
object
显示子属性
results.body.gif.actions.postback.metadata.description
object
显示子属性
results.body.gif.actions.postback.metadata.description.label
string
必填
results.body.gif.actions.postback.otpType
string
results.body.gif.actions.postback.payload
string
results.body.gif.actions.postback.text
string
必填
results.body.gif.actions.type
string
必填
Possible values: postback
results.body.gif.altText
string
results.body.gif.mediaUrl
string
必填
results.body.gif.metadata
object
显示子属性
results.body.gif.metadata.telegram
object
显示子属性
results.body.gif.metadata.telegram.parseMode
string
results.body.gif.text
string
results.body.type
string
必填
Possible values: gif
results.body.file
object
必填
显示子属性
results.body.file.actions
array of object
显示子属性
results.body.file.actions.link
object
必填
显示子属性
results.body.file.actions.link.metadata
object
显示子属性
results.body.file.actions.link.metadata.description
object
显示子属性
results.body.file.actions.link.metadata.description.label
string
必填
results.body.file.actions.link.text
string
必填
results.body.file.actions.link.url
string
必填
results.body.file.actions.type
string
必填
Possible values: link
results.body.file.actions.reply
object
必填
显示子属性
results.body.file.actions.reply.imageUrl
string
results.body.file.actions.reply.metadata
object
显示子属性
results.body.file.actions.reply.metadata.description
object
显示子属性
results.body.file.actions.reply.metadata.description.label
string
必填
results.body.file.actions.reply.text
string
必填
results.body.file.actions.type
string
必填
Possible values: reply
results.body.file.actions.locationRequest
object
显示子属性
results.body.file.actions.locationRequest.text
string
results.body.file.actions.type
string
必填
Possible values: locationRequest
results.body.file.actions.buy
object
必填
显示子属性
results.body.file.actions.buy.amountCents
integer
必填
results.body.file.actions.buy.currency
string
必填
results.body.file.actions.buy.text
string
必填
results.body.file.actions.type
string
必填
Possible values: buy
results.body.file.actions.postback
object
必填
显示子属性
results.body.file.actions.postback.handshake
object
显示子属性
results.body.file.actions.postback.handshake.packageName
string
必填
results.body.file.actions.postback.handshake.signatureHash
string
必填
results.body.file.actions.postback.handshake.supportedApps
array of object
显示子属性
results.body.file.actions.postback.handshake.supportedApps.packageName
string
必填
results.body.file.actions.postback.handshake.supportedApps.signatureHash
string
必填
results.body.file.actions.postback.handshake.text
string
必填
results.body.file.actions.postback.handshake.zeroTapTermsAccepted
boolean
必填
results.body.file.actions.postback.imageUrl
string
results.body.file.actions.postback.metadata
object
显示子属性
results.body.file.actions.postback.metadata.description
object
显示子属性
results.body.file.actions.postback.metadata.description.label
string
必填
results.body.file.actions.postback.otpType
string
results.body.file.actions.postback.payload
string
results.body.file.actions.postback.text
string
必填
results.body.file.actions.type
string
必填
Possible values: postback
results.body.file.files
array of object
必填
显示子属性
results.body.file.files.altText
string
results.body.file.files.contentType
string
必填
results.body.file.files.filename
string
results.body.file.files.mediaUrl
string
必填
results.body.file.files.metadata
object
显示子属性
results.body.file.files.metadata.isAnimated
boolean
results.body.file.metadata
object
显示子属性
results.body.file.metadata.fallbackText
string
results.body.file.metadata.storyType
string
Possible values: mention, reply
results.body.file.metadata.subject
string
results.body.file.metadata.telegram
object
显示子属性
results.body.file.metadata.telegram.parseMode
string
results.body.file.text
string
results.body.type
string
必填
Possible values: file
results.body.location
object
必填
显示子属性
results.body.location.coordinates
object
必填
显示子属性
results.body.location.coordinates.latitude
number
必填
results.body.location.coordinates.longitude
number
必填
results.body.location.location
object
必填
显示子属性
results.body.location.location.address
string
必填
results.body.location.location.label
string
必填
results.body.type
string
必填
Possible values: location
results.body.carousel
object
必填
显示子属性
results.body.carousel.items
array of object
显示子属性
results.body.carousel.items.actions
array of object
显示子属性
results.body.carousel.items.actions.link
object
必填
显示子属性
results.body.carousel.items.actions.link.metadata
object
显示子属性
results.body.carousel.items.actions.link.metadata.description
object
显示子属性
results.body.carousel.items.actions.link.metadata.description.label
string
必填
results.body.carousel.items.actions.link.text
string
必填
results.body.carousel.items.actions.link.url
string
必填
results.body.carousel.items.actions.type
string
必填
Possible values: link
results.body.carousel.items.actions.reply
object
必填
显示子属性
results.body.carousel.items.actions.reply.imageUrl
string
results.body.carousel.items.actions.reply.metadata
object
显示子属性
results.body.carousel.items.actions.reply.metadata.description
object
显示子属性
results.body.carousel.items.actions.reply.metadata.description.label
string
必填
results.body.carousel.items.actions.reply.text
string
必填
results.body.carousel.items.actions.type
string
必填
Possible values: reply
results.body.carousel.items.actions.locationRequest
object
显示子属性
results.body.carousel.items.actions.locationRequest.text
string
results.body.carousel.items.actions.type
string
必填
Possible values: locationRequest
results.body.carousel.items.actions.buy
object
必填
显示子属性
results.body.carousel.items.actions.buy.amountCents
integer
必填
results.body.carousel.items.actions.buy.currency
string
必填
results.body.carousel.items.actions.buy.text
string
必填
results.body.carousel.items.actions.type
string
必填
Possible values: buy
results.body.carousel.items.actions.postback
object
必填
显示子属性
results.body.carousel.items.actions.postback.handshake
object
显示子属性
results.body.carousel.items.actions.postback.handshake.packageName
string
必填
results.body.carousel.items.actions.postback.handshake.signatureHash
string
必填
results.body.carousel.items.actions.postback.handshake.supportedApps
array of object
显示子属性
results.body.carousel.items.actions.postback.handshake.supportedApps.packageName
string
必填
results.body.carousel.items.actions.postback.handshake.supportedApps.signatureHash
string
必填
results.body.carousel.items.actions.postback.handshake.text
string
必填
results.body.carousel.items.actions.postback.handshake.zeroTapTermsAccepted
boolean
必填
results.body.carousel.items.actions.postback.imageUrl
string
results.body.carousel.items.actions.postback.metadata
object
显示子属性
results.body.carousel.items.actions.postback.metadata.description
object
显示子属性
results.body.carousel.items.actions.postback.metadata.description.label
string
必填
results.body.carousel.items.actions.postback.otpType
string
results.body.carousel.items.actions.postback.payload
string
results.body.carousel.items.actions.postback.text
string
必填
results.body.carousel.items.actions.type
string
必填
Possible values: postback
results.body.carousel.items.altText
string
results.body.carousel.items.description
string
results.body.carousel.items.mediaUrl
string
results.body.carousel.items.size
integer
results.body.carousel.items.title
string
results.body.carousel.text
string
Optional text displayed above the carousel cards.
results.body.type
string
必填
Possible values: carousel
results.body.list
object
必填
显示子属性
results.body.list.actions
array of object
显示子属性
results.body.list.actions.link
object
必填
显示子属性
results.body.list.actions.link.metadata
object
显示子属性
results.body.list.actions.link.metadata.description
object
显示子属性
results.body.list.actions.link.metadata.description.label
string
必填
results.body.list.actions.link.text
string
必填
results.body.list.actions.link.url
string
必填
results.body.list.actions.type
string
必填
Possible values: link
results.body.list.actions.reply
object
必填
显示子属性
results.body.list.actions.reply.imageUrl
string
results.body.list.actions.reply.metadata
object
显示子属性
results.body.list.actions.reply.metadata.description
object
显示子属性
results.body.list.actions.reply.metadata.description.label
string
必填
results.body.list.actions.reply.text
string
必填
results.body.list.actions.type
string
必填
Possible values: reply
results.body.list.actions.locationRequest
object
显示子属性
results.body.list.actions.locationRequest.text
string
results.body.list.actions.type
string
必填
Possible values: locationRequest
results.body.list.actions.buy
object
必填
显示子属性
results.body.list.actions.buy.amountCents
integer
必填
results.body.list.actions.buy.currency
string
必填
results.body.list.actions.buy.text
string
必填
results.body.list.actions.type
string
必填
Possible values: buy
results.body.list.actions.postback
object
必填
显示子属性
results.body.list.actions.postback.handshake
object
显示子属性
results.body.list.actions.postback.handshake.packageName
string
必填
results.body.list.actions.postback.handshake.signatureHash
string
必填
results.body.list.actions.postback.handshake.supportedApps
array of object
显示子属性
results.body.list.actions.postback.handshake.supportedApps.packageName
string
必填
results.body.list.actions.postback.handshake.supportedApps.signatureHash
string
必填
results.body.list.actions.postback.handshake.text
string
必填
results.body.list.actions.postback.handshake.zeroTapTermsAccepted
boolean
必填
results.body.list.actions.postback.imageUrl
string
results.body.list.actions.postback.metadata
object
显示子属性
results.body.list.actions.postback.metadata.description
object
显示子属性
results.body.list.actions.postback.metadata.description.label
string
必填
results.body.list.actions.postback.otpType
string
results.body.list.actions.postback.payload
string
results.body.list.actions.postback.text
string
必填
results.body.list.actions.type
string
必填
Possible values: postback
results.body.list.altText
string
results.body.list.items
array of object
显示子属性
results.body.list.items.actions
array of object
显示子属性
results.body.list.items.actions.link
object
必填
显示子属性
results.body.list.items.actions.link.metadata
object
显示子属性
results.body.list.items.actions.link.metadata.description
object
显示子属性
results.body.list.items.actions.link.metadata.description.label
string
必填
results.body.list.items.actions.link.text
string
必填
results.body.list.items.actions.link.url
string
必填
results.body.list.items.actions.type
string
必填
Possible values: link
results.body.list.items.actions.reply
object
必填
显示子属性
results.body.list.items.actions.reply.imageUrl
string
results.body.list.items.actions.reply.metadata
object
显示子属性
results.body.list.items.actions.reply.metadata.description
object
显示子属性
results.body.list.items.actions.reply.metadata.description.label
string
必填
results.body.list.items.actions.reply.text
string
必填
results.body.list.items.actions.type
string
必填
Possible values: reply
results.body.list.items.actions.locationRequest
object
显示子属性
results.body.list.items.actions.locationRequest.text
string
results.body.list.items.actions.type
string
必填
Possible values: locationRequest
results.body.list.items.actions.buy
object
必填
显示子属性
results.body.list.items.actions.buy.amountCents
integer
必填
results.body.list.items.actions.buy.currency
string
必填
results.body.list.items.actions.buy.text
string
必填
results.body.list.items.actions.type
string
必填
Possible values: buy
results.body.list.items.actions.postback
object
必填
显示子属性
results.body.list.items.actions.postback.handshake
object
显示子属性
results.body.list.items.actions.postback.handshake.packageName
string
必填
results.body.list.items.actions.postback.handshake.signatureHash
string
必填
results.body.list.items.actions.postback.handshake.supportedApps
array of object
显示子属性
results.body.list.items.actions.postback.handshake.supportedApps.packageName
string
必填
results.body.list.items.actions.postback.handshake.supportedApps.signatureHash
string
必填
results.body.list.items.actions.postback.handshake.text
string
必填
results.body.list.items.actions.postback.handshake.zeroTapTermsAccepted
boolean
必填
results.body.list.items.actions.postback.imageUrl
string
results.body.list.items.actions.postback.metadata
object
显示子属性
results.body.list.items.actions.postback.metadata.description
object
显示子属性
results.body.list.items.actions.postback.metadata.description.label
string
必填
results.body.list.items.actions.postback.otpType
string
results.body.list.items.actions.postback.payload
string
results.body.list.items.actions.postback.text
string
必填
results.body.list.items.actions.type
string
必填
Possible values: postback
results.body.list.items.altText
string
results.body.list.items.description
string
results.body.list.items.mediaUrl
string
results.body.list.items.size
integer
results.body.list.items.title
string
results.body.list.metadata
object
显示子属性
results.body.list.metadata.button
object
显示子属性
results.body.list.metadata.button.label
string
必填
results.body.list.metadata.replyMessage
object
显示子属性
results.body.list.metadata.replyMessage.text
string
必填
results.body.list.metadata.replyMessage.title
string
必填
results.body.list.text
string
results.body.list.title
string
results.body.type
string
必填
Possible values: list
results.body.section
object
必填
显示子属性
results.body.section.configurations
object
results.body.section.items
array of object
显示子属性
results.body.section.items.text
object
必填
显示子属性
results.body.section.items.text.actions
array of object
显示子属性
results.body.section.items.text.actions.link
object
必填
显示子属性
results.body.section.items.text.actions.link.metadata
object
显示子属性
results.body.section.items.text.actions.link.metadata.description
object
显示子属性
results.body.section.items.text.actions.link.metadata.description.label
string
必填
results.body.section.items.text.actions.link.text
string
必填
results.body.section.items.text.actions.link.url
string
必填
results.body.section.items.text.actions.type
string
必填
Possible values: link
results.body.section.items.text.actions.reply
object
必填
显示子属性
results.body.section.items.text.actions.reply.imageUrl
string
results.body.section.items.text.actions.reply.metadata
object
显示子属性
results.body.section.items.text.actions.reply.metadata.description
object
显示子属性
results.body.section.items.text.actions.reply.metadata.description.label
string
必填
results.body.section.items.text.actions.reply.text
string
必填
results.body.section.items.text.actions.type
string
必填
Possible values: reply
results.body.section.items.text.actions.locationRequest
object
显示子属性
results.body.section.items.text.actions.locationRequest.text
string
results.body.section.items.text.actions.type
string
必填
Possible values: locationRequest
results.body.section.items.text.actions.buy
object
必填
显示子属性
results.body.section.items.text.actions.buy.amountCents
integer
必填
results.body.section.items.text.actions.buy.currency
string
必填
results.body.section.items.text.actions.buy.text
string
必填
results.body.section.items.text.actions.type
string
必填
Possible values: buy
results.body.section.items.text.actions.postback
object
必填
显示子属性
results.body.section.items.text.actions.postback.handshake
object
显示子属性
results.body.section.items.text.actions.postback.handshake.packageName
string
必填
results.body.section.items.text.actions.postback.handshake.signatureHash
string
必填
results.body.section.items.text.actions.postback.handshake.supportedApps
array of object
显示子属性
results.body.section.items.text.actions.postback.handshake.supportedApps.packageName
string
必填
results.body.section.items.text.actions.postback.handshake.supportedApps.signatureHash
string
必填
results.body.section.items.text.actions.postback.handshake.text
string
必填
results.body.section.items.text.actions.postback.handshake.zeroTapTermsAccepted
boolean
必填
results.body.section.items.text.actions.postback.imageUrl
string
results.body.section.items.text.actions.postback.metadata
object
显示子属性
results.body.section.items.text.actions.postback.metadata.description
object
显示子属性
results.body.section.items.text.actions.postback.metadata.description.label
string
必填
results.body.section.items.text.actions.postback.otpType
string
results.body.section.items.text.actions.postback.payload
string
results.body.section.items.text.actions.postback.text
string
必填
results.body.section.items.text.actions.type
string
必填
Possible values: postback
results.body.section.items.text.attachments
array of object
显示子属性
results.body.section.items.text.attachments.content
string
results.body.section.items.text.attachments.contentId
string
results.body.section.items.text.attachments.contentType
string
results.body.section.items.text.attachments.filename
string
必填
results.body.section.items.text.attachments.inline
boolean
results.body.section.items.text.attachments.mediaUrl
string
必填
results.body.section.items.text.metadata
object
显示子属性
results.body.section.items.text.metadata.apple
object
显示子属性
results.body.section.items.text.metadata.apple.appClipPreview
boolean
results.body.section.items.text.metadata.apple.appClipRegion
string
results.body.section.items.text.metadata.apple.summaryText
string
results.body.section.items.text.metadata.headers
object
results.body.section.items.text.metadata.line
object
显示子属性
results.body.section.items.text.metadata.line.emoji
object
显示子属性
results.body.section.items.text.metadata.line.emoji.items
array of object
显示子属性
results.body.section.items.text.metadata.line.emoji.items.emojiId
string
必填
results.body.section.items.text.metadata.line.emoji.items.index
integer
必填
results.body.section.items.text.metadata.line.emoji.items.length
integer
results.body.section.items.text.metadata.line.emoji.items.productId
string
必填
results.body.section.items.text.metadata.paymentDetails
object
显示子属性
results.body.section.items.text.metadata.paymentDetails.amount
string
必填
results.body.section.items.text.metadata.paymentDetails.currency
string
必填
results.body.section.items.text.metadata.paymentDetails.sessionIdentifier
string
results.body.section.items.text.metadata.paymentDetails.state
string
必填
results.body.section.items.text.metadata.subject
string
results.body.section.items.text.metadata.telegram
object
显示子属性
results.body.section.items.text.metadata.telegram.parseMode
string
results.body.section.items.text.metadata.whatsapp
object
显示子属性
results.body.section.items.text.metadata.whatsapp.callPermissionExpiration
string
results.body.section.items.text.metadata.whatsapp.callPermissionResponse
string
Possible values: accept, reject
results.body.section.items.text.metadata.whatsapp.previewUrl
boolean
必填
results.body.section.items.text.metadata.whatsapp.sharedContacts
array of object
显示子属性
results.body.section.items.text.metadata.whatsapp.sharedContacts.origin
string
必填
results.body.section.items.text.metadata.whatsapp.sharedContacts.phones
array of object
显示子属性
results.body.section.items.text.metadata.whatsapp.sharedContacts.phones.phone
string
必填
results.body.section.items.text.metadata.whatsapp.sharedContacts.phones.type
string
必填
results.body.section.items.text.metadata.whatsapp.sharedContacts.phones.waId
string
必填
results.body.section.items.text.metadata.whatsapp.sharedContacts.vcard
string
results.body.section.items.text.text
string
必填
results.body.section.items.type
string
必填
Possible values: text
results.body.section.items.html
object
必填
显示子属性
results.body.section.items.html.actions
array of object
显示子属性
results.body.section.items.html.actions.link
object
必填
显示子属性
results.body.section.items.html.actions.link.metadata
object
显示子属性
results.body.section.items.html.actions.link.metadata.description
object
显示子属性
results.body.section.items.html.actions.link.metadata.description.label
string
必填
results.body.section.items.html.actions.link.text
string
必填
results.body.section.items.html.actions.link.url
string
必填
results.body.section.items.html.actions.type
string
必填
Possible values: link
results.body.section.items.html.actions.reply
object
必填
显示子属性
results.body.section.items.html.actions.reply.imageUrl
string
results.body.section.items.html.actions.reply.metadata
object
显示子属性
results.body.section.items.html.actions.reply.metadata.description
object
显示子属性
results.body.section.items.html.actions.reply.metadata.description.label
string
必填
results.body.section.items.html.actions.reply.text
string
必填
results.body.section.items.html.actions.type
string
必填
Possible values: reply
results.body.section.items.html.actions.locationRequest
object
显示子属性
results.body.section.items.html.actions.locationRequest.text
string
results.body.section.items.html.actions.type
string
必填
Possible values: locationRequest
results.body.section.items.html.actions.buy
object
必填
显示子属性
results.body.section.items.html.actions.buy.amountCents
integer
必填
results.body.section.items.html.actions.buy.currency
string
必填
results.body.section.items.html.actions.buy.text
string
必填
results.body.section.items.html.actions.type
string
必填
Possible values: buy
results.body.section.items.html.actions.postback
object
必填
显示子属性
results.body.section.items.html.actions.postback.handshake
object
显示子属性
results.body.section.items.html.actions.postback.handshake.packageName
string
必填
results.body.section.items.html.actions.postback.handshake.signatureHash
string
必填
results.body.section.items.html.actions.postback.handshake.supportedApps
array of object
显示子属性
results.body.section.items.html.actions.postback.handshake.supportedApps.packageName
string
必填
results.body.section.items.html.actions.postback.handshake.supportedApps.signatureHash
string
必填
results.body.section.items.html.actions.postback.handshake.text
string
必填
results.body.section.items.html.actions.postback.handshake.zeroTapTermsAccepted
boolean
必填
results.body.section.items.html.actions.postback.imageUrl
string
results.body.section.items.html.actions.postback.metadata
object
显示子属性
results.body.section.items.html.actions.postback.metadata.description
object
显示子属性
results.body.section.items.html.actions.postback.metadata.description.label
string
必填
results.body.section.items.html.actions.postback.otpType
string
results.body.section.items.html.actions.postback.payload
string
results.body.section.items.html.actions.postback.text
string
必填
results.body.section.items.html.actions.type
string
必填
Possible values: postback
results.body.section.items.html.attachments
array of object
显示子属性
results.body.section.items.html.attachments.content
string
results.body.section.items.html.attachments.contentId
string
results.body.section.items.html.attachments.contentType
string
results.body.section.items.html.attachments.filename
string
必填
results.body.section.items.html.attachments.inline
boolean
results.body.section.items.html.attachments.mediaUrl
string
results.body.section.items.html.html
string
results.body.section.items.html.metadata
object
显示子属性
results.body.section.items.html.metadata.clickTracking
boolean
results.body.section.items.html.metadata.from
object
显示子属性
results.body.section.items.html.metadata.from.displayName
string
results.body.section.items.html.metadata.from.username
string
results.body.section.items.html.metadata.headers
object
results.body.section.items.html.metadata.initialOpenTracking
boolean
results.body.section.items.html.metadata.openTracking
boolean
results.body.section.items.html.metadata.subject
string
results.body.section.items.html.text
string
results.body.section.items.type
string
必填
Possible values: html
results.body.section.items.image
object
必填
显示子属性
results.body.section.items.image.actions
array of object
显示子属性
results.body.section.items.image.actions.link
object
必填
显示子属性
results.body.section.items.image.actions.link.metadata
object
显示子属性
results.body.section.items.image.actions.link.metadata.description
object
显示子属性
results.body.section.items.image.actions.link.metadata.description.label
string
必填
results.body.section.items.image.actions.link.text
string
必填
results.body.section.items.image.actions.link.url
string
必填
results.body.section.items.image.actions.type
string
必填
Possible values: link
results.body.section.items.image.actions.reply
object
必填
显示子属性
results.body.section.items.image.actions.reply.imageUrl
string
results.body.section.items.image.actions.reply.metadata
object
显示子属性
results.body.section.items.image.actions.reply.metadata.description
object
显示子属性
results.body.section.items.image.actions.reply.metadata.description.label
string
必填
results.body.section.items.image.actions.reply.text
string
必填
results.body.section.items.image.actions.type
string
必填
Possible values: reply
results.body.section.items.image.actions.locationRequest
object
显示子属性
results.body.section.items.image.actions.locationRequest.text
string
results.body.section.items.image.actions.type
string
必填
Possible values: locationRequest
results.body.section.items.image.actions.buy
object
必填
显示子属性
results.body.section.items.image.actions.buy.amountCents
integer
必填
results.body.section.items.image.actions.buy.currency
string
必填
results.body.section.items.image.actions.buy.text
string
必填
results.body.section.items.image.actions.type
string
必填
Possible values: buy
results.body.section.items.image.actions.postback
object
必填
显示子属性
results.body.section.items.image.actions.postback.handshake
object
显示子属性
results.body.section.items.image.actions.postback.handshake.packageName
string
必填
results.body.section.items.image.actions.postback.handshake.signatureHash
string
必填
results.body.section.items.image.actions.postback.handshake.supportedApps
array of object
显示子属性
results.body.section.items.image.actions.postback.handshake.supportedApps.packageName
string
必填
results.body.section.items.image.actions.postback.handshake.supportedApps.signatureHash
string
必填
results.body.section.items.image.actions.postback.handshake.text
string
必填
results.body.section.items.image.actions.postback.handshake.zeroTapTermsAccepted
boolean
必填
results.body.section.items.image.actions.postback.imageUrl
string
results.body.section.items.image.actions.postback.metadata
object
显示子属性
results.body.section.items.image.actions.postback.metadata.description
object
显示子属性
results.body.section.items.image.actions.postback.metadata.description.label
string
必填
results.body.section.items.image.actions.postback.otpType
string
results.body.section.items.image.actions.postback.payload
string
results.body.section.items.image.actions.postback.text
string
必填
results.body.section.items.image.actions.type
string
必填
Possible values: postback
results.body.section.items.image.images
array of object
必填
显示子属性
results.body.section.items.image.images.altText
string
results.body.section.items.image.images.mediaPreviewUrl
string
results.body.section.items.image.images.mediaUrl
string
必填
results.body.section.items.image.metadata
object
显示子属性
results.body.section.items.image.metadata.fallbackText
string
results.body.section.items.image.metadata.storyType
string
Possible values: mention, reply
results.body.section.items.image.metadata.subject
string
results.body.section.items.image.metadata.telegram
object
显示子属性
results.body.section.items.image.metadata.telegram.parseMode
string
results.body.section.items.image.text
string
results.body.section.items.type
string
必填
Possible values: image
results.body.section.items.gif
object
必填
显示子属性
results.body.section.items.gif.actions
array of object
显示子属性
results.body.section.items.gif.actions.link
object
必填
显示子属性
results.body.section.items.gif.actions.link.metadata
object
显示子属性
results.body.section.items.gif.actions.link.metadata.description
object
显示子属性
results.body.section.items.gif.actions.link.metadata.description.label
string
必填
results.body.section.items.gif.actions.link.text
string
必填
results.body.section.items.gif.actions.link.url
string
必填
results.body.section.items.gif.actions.type
string
必填
Possible values: link
results.body.section.items.gif.actions.reply
object
必填
显示子属性
results.body.section.items.gif.actions.reply.imageUrl
string
results.body.section.items.gif.actions.reply.metadata
object
显示子属性
results.body.section.items.gif.actions.reply.metadata.description
object
显示子属性
results.body.section.items.gif.actions.reply.metadata.description.label
string
必填
results.body.section.items.gif.actions.reply.text
string
必填
results.body.section.items.gif.actions.type
string
必填
Possible values: reply
results.body.section.items.gif.actions.locationRequest
object
显示子属性
results.body.section.items.gif.actions.locationRequest.text
string
results.body.section.items.gif.actions.type
string
必填
Possible values: locationRequest
results.body.section.items.gif.actions.buy
object
必填
显示子属性
results.body.section.items.gif.actions.buy.amountCents
integer
必填
results.body.section.items.gif.actions.buy.currency
string
必填
results.body.section.items.gif.actions.buy.text
string
必填
results.body.section.items.gif.actions.type
string
必填
Possible values: buy
results.body.section.items.gif.actions.postback
object
必填
显示子属性
results.body.section.items.gif.actions.postback.handshake
object
显示子属性
results.body.section.items.gif.actions.postback.handshake.packageName
string
必填
results.body.section.items.gif.actions.postback.handshake.signatureHash
string
必填
results.body.section.items.gif.actions.postback.handshake.supportedApps
array of object
显示子属性
results.body.section.items.gif.actions.postback.handshake.supportedApps.packageName
string
必填
results.body.section.items.gif.actions.postback.handshake.supportedApps.signatureHash
string
必填
results.body.section.items.gif.actions.postback.handshake.text
string
必填
results.body.section.items.gif.actions.postback.handshake.zeroTapTermsAccepted
boolean
必填
results.body.section.items.gif.actions.postback.imageUrl
string
results.body.section.items.gif.actions.postback.metadata
object
显示子属性
results.body.section.items.gif.actions.postback.metadata.description
object
显示子属性
results.body.section.items.gif.actions.postback.metadata.description.label
string
必填
results.body.section.items.gif.actions.postback.otpType
string
results.body.section.items.gif.actions.postback.payload
string
results.body.section.items.gif.actions.postback.text
string
必填
results.body.section.items.gif.actions.type
string
必填
Possible values: postback
results.body.section.items.gif.altText
string
results.body.section.items.gif.mediaUrl
string
必填
results.body.section.items.gif.metadata
object
显示子属性
results.body.section.items.gif.metadata.telegram
object
显示子属性
results.body.section.items.gif.metadata.telegram.parseMode
string
results.body.section.items.gif.text
string
results.body.section.items.type
string
必填
Possible values: gif
results.body.section.items.file
object
必填
显示子属性
results.body.section.items.file.actions
array of object
显示子属性
results.body.section.items.file.actions.link
object
必填
显示子属性
results.body.section.items.file.actions.link.metadata
object
显示子属性
results.body.section.items.file.actions.link.metadata.description
object
显示子属性
results.body.section.items.file.actions.link.metadata.description.label
string
必填
results.body.section.items.file.actions.link.text
string
必填
results.body.section.items.file.actions.link.url
string
必填
results.body.section.items.file.actions.type
string
必填
Possible values: link
results.body.section.items.file.actions.reply
object
必填
显示子属性
results.body.section.items.file.actions.reply.imageUrl
string
results.body.section.items.file.actions.reply.metadata
object
显示子属性
results.body.section.items.file.actions.reply.metadata.description
object
显示子属性
results.body.section.items.file.actions.reply.metadata.description.label
string
必填
results.body.section.items.file.actions.reply.text
string
必填
results.body.section.items.file.actions.type
string
必填
Possible values: reply
results.body.section.items.file.actions.locationRequest
object
显示子属性
results.body.section.items.file.actions.locationRequest.text
string
results.body.section.items.file.actions.type
string
必填
Possible values: locationRequest
results.body.section.items.file.actions.buy
object
必填
显示子属性
results.body.section.items.file.actions.buy.amountCents
integer
必填
results.body.section.items.file.actions.buy.currency
string
必填
results.body.section.items.file.actions.buy.text
string
必填
results.body.section.items.file.actions.type
string
必填
Possible values: buy
results.body.section.items.file.actions.postback
object
必填
显示子属性
results.body.section.items.file.actions.postback.handshake
object
显示子属性
results.body.section.items.file.actions.postback.handshake.packageName
string
必填
results.body.section.items.file.actions.postback.handshake.signatureHash
string
必填
results.body.section.items.file.actions.postback.handshake.supportedApps
array of object
显示子属性
results.body.section.items.file.actions.postback.handshake.supportedApps.packageName
string
必填
results.body.section.items.file.actions.postback.handshake.supportedApps.signatureHash
string
必填
results.body.section.items.file.actions.postback.handshake.text
string
必填
results.body.section.items.file.actions.postback.handshake.zeroTapTermsAccepted
boolean
必填
results.body.section.items.file.actions.postback.imageUrl
string
results.body.section.items.file.actions.postback.metadata
object
显示子属性
results.body.section.items.file.actions.postback.metadata.description
object
显示子属性
results.body.section.items.file.actions.postback.metadata.description.label
string
必填
results.body.section.items.file.actions.postback.otpType
string
results.body.section.items.file.actions.postback.payload
string
results.body.section.items.file.actions.postback.text
string
必填
results.body.section.items.file.actions.type
string
必填
Possible values: postback
results.body.section.items.file.files
array of object
必填
显示子属性
results.body.section.items.file.files.altText
string
results.body.section.items.file.files.contentType
string
必填
results.body.section.items.file.files.filename
string
results.body.section.items.file.files.mediaUrl
string
必填
results.body.section.items.file.files.metadata
object
显示子属性
results.body.section.items.file.files.metadata.isAnimated
boolean
results.body.section.items.file.metadata
object
显示子属性
results.body.section.items.file.metadata.fallbackText
string
results.body.section.items.file.metadata.storyType
string
Possible values: mention, reply
results.body.section.items.file.metadata.subject
string
results.body.section.items.file.metadata.telegram
object
显示子属性
results.body.section.items.file.metadata.telegram.parseMode
string
results.body.section.items.file.text
string
results.body.section.items.type
string
必填
Possible values: file
results.body.section.items.location
object
必填
显示子属性
results.body.section.items.location.coordinates
object
必填
显示子属性
results.body.section.items.location.coordinates.latitude
number
必填
results.body.section.items.location.coordinates.longitude
number
必填
results.body.section.items.location.location
object
必填
显示子属性
results.body.section.items.location.location.address
string
必填
results.body.section.items.location.location.label
string
必填
results.body.section.items.type
string
必填
Possible values: location
results.body.section.items.carousel
object
必填
显示子属性
results.body.section.items.carousel.items
array of object
显示子属性
results.body.section.items.carousel.items.actions
array of object
显示子属性
results.body.section.items.carousel.items.actions.link
object
必填
显示子属性
results.body.section.items.carousel.items.actions.link.metadata
object
显示子属性
results.body.section.items.carousel.items.actions.link.metadata.description
object
显示子属性
results.body.section.items.carousel.items.actions.link.metadata.description.label
string
必填
results.body.section.items.carousel.items.actions.link.text
string
必填
results.body.section.items.carousel.items.actions.link.url
string
必填
results.body.section.items.carousel.items.actions.type
string
必填
Possible values: link
results.body.section.items.carousel.items.actions.reply
object
必填
显示子属性
results.body.section.items.carousel.items.actions.reply.imageUrl
string
results.body.section.items.carousel.items.actions.reply.metadata
object
显示子属性
results.body.section.items.carousel.items.actions.reply.metadata.description
object
显示子属性
results.body.section.items.carousel.items.actions.reply.metadata.description.label
string
必填
results.body.section.items.carousel.items.actions.reply.text
string
必填
results.body.section.items.carousel.items.actions.type
string
必填
Possible values: reply
results.body.section.items.carousel.items.actions.locationRequest
object
显示子属性
results.body.section.items.carousel.items.actions.locationRequest.text
string
results.body.section.items.carousel.items.actions.type
string
必填
Possible values: locationRequest
results.body.section.items.carousel.items.actions.buy
object
必填
显示子属性
results.body.section.items.carousel.items.actions.buy.amountCents
integer
必填
results.body.section.items.carousel.items.actions.buy.currency
string
必填
results.body.section.items.carousel.items.actions.buy.text
string
必填
results.body.section.items.carousel.items.actions.type
string
必填
Possible values: buy
results.body.section.items.carousel.items.actions.postback
object
必填
显示子属性
results.body.section.items.carousel.items.actions.postback.handshake
object
显示子属性
results.body.section.items.carousel.items.actions.postback.handshake.packageName
string
必填
results.body.section.items.carousel.items.actions.postback.handshake.signatureHash
string
必填
results.body.section.items.carousel.items.actions.postback.handshake.supportedApps
array of object
显示子属性
results.body.section.items.carousel.items.actions.postback.handshake.supportedApps.packageName
string
必填
results.body.section.items.carousel.items.actions.postback.handshake.supportedApps.signatureHash
string
必填
results.body.section.items.carousel.items.actions.postback.handshake.text
string
必填
results.body.section.items.carousel.items.actions.postback.handshake.zeroTapTermsAccepted
boolean
必填
results.body.section.items.carousel.items.actions.postback.imageUrl
string
results.body.section.items.carousel.items.actions.postback.metadata
object
显示子属性
results.body.section.items.carousel.items.actions.postback.metadata.description
object
显示子属性
results.body.section.items.carousel.items.actions.postback.metadata.description.label
string
必填
results.body.section.items.carousel.items.actions.postback.otpType
string
results.body.section.items.carousel.items.actions.postback.payload
string
results.body.section.items.carousel.items.actions.postback.text
string
必填
results.body.section.items.carousel.items.actions.type
string
必填
Possible values: postback
results.body.section.items.carousel.items.altText
string
results.body.section.items.carousel.items.description
string
results.body.section.items.carousel.items.mediaUrl
string
results.body.section.items.carousel.items.size
integer
results.body.section.items.carousel.items.title
string
results.body.section.items.carousel.text
string
Optional text displayed above the carousel cards.
results.body.section.items.type
string
必填
Possible values: carousel
results.body.section.items.list
object
必填
显示子属性
results.body.section.items.list.actions
array of object
显示子属性
results.body.section.items.list.actions.link
object
必填
显示子属性
results.body.section.items.list.actions.link.metadata
object
显示子属性
results.body.section.items.list.actions.link.metadata.description
object
显示子属性
results.body.section.items.list.actions.link.metadata.description.label
string
必填
results.body.section.items.list.actions.link.text
string
必填
results.body.section.items.list.actions.link.url
string
必填
results.body.section.items.list.actions.type
string
必填
Possible values: link
results.body.section.items.list.actions.reply
object
必填
显示子属性
results.body.section.items.list.actions.reply.imageUrl
string
results.body.section.items.list.actions.reply.metadata
object
显示子属性
results.body.section.items.list.actions.reply.metadata.description
object
显示子属性
results.body.section.items.list.actions.reply.metadata.description.label
string
必填
results.body.section.items.list.actions.reply.text
string
必填
results.body.section.items.list.actions.type
string
必填
Possible values: reply
results.body.section.items.list.actions.locationRequest
object
显示子属性
results.body.section.items.list.actions.locationRequest.text
string
results.body.section.items.list.actions.type
string
必填
Possible values: locationRequest
results.body.section.items.list.actions.buy
object
必填
显示子属性
results.body.section.items.list.actions.buy.amountCents
integer
必填
results.body.section.items.list.actions.buy.currency
string
必填
results.body.section.items.list.actions.buy.text
string
必填
results.body.section.items.list.actions.type
string
必填
Possible values: buy
results.body.section.items.list.actions.postback
object
必填
显示子属性
results.body.section.items.list.actions.postback.handshake
object
显示子属性
results.body.section.items.list.actions.postback.handshake.packageName
string
必填
results.body.section.items.list.actions.postback.handshake.signatureHash
string
必填
results.body.section.items.list.actions.postback.handshake.supportedApps
array of object
显示子属性
results.body.section.items.list.actions.postback.handshake.supportedApps.packageName
string
必填
results.body.section.items.list.actions.postback.handshake.supportedApps.signatureHash
string
必填
results.body.section.items.list.actions.postback.handshake.text
string
必填
results.body.section.items.list.actions.postback.handshake.zeroTapTermsAccepted
boolean
必填
results.body.section.items.list.actions.postback.imageUrl
string
results.body.section.items.list.actions.postback.metadata
object
显示子属性
results.body.section.items.list.actions.postback.metadata.description
object
显示子属性
results.body.section.items.list.actions.postback.metadata.description.label
string
必填
results.body.section.items.list.actions.postback.otpType
string
results.body.section.items.list.actions.postback.payload
string
results.body.section.items.list.actions.postback.text
string
必填
results.body.section.items.list.actions.type
string
必填
Possible values: postback
results.body.section.items.list.altText
string
results.body.section.items.list.items
array of object
显示子属性
results.body.section.items.list.items.actions
array of object
显示子属性
results.body.section.items.list.items.actions.link
object
必填
显示子属性
results.body.section.items.list.items.actions.link.metadata
object
显示子属性
results.body.section.items.list.items.actions.link.metadata.description
object
显示子属性
results.body.section.items.list.items.actions.link.metadata.description.label
string
必填
results.body.section.items.list.items.actions.link.text
string
必填
results.body.section.items.list.items.actions.link.url
string
必填
results.body.section.items.list.items.actions.type
string
必填
Possible values: link
results.body.section.items.list.items.actions.reply
object
必填
显示子属性
results.body.section.items.list.items.actions.reply.imageUrl
string
results.body.section.items.list.items.actions.reply.metadata
object
显示子属性
results.body.section.items.list.items.actions.reply.metadata.description
object
显示子属性
results.body.section.items.list.items.actions.reply.metadata.description.label
string
必填
results.body.section.items.list.items.actions.reply.text
string
必填
results.body.section.items.list.items.actions.type
string
必填
Possible values: reply
results.body.section.items.list.items.actions.locationRequest
object
显示子属性
results.body.section.items.list.items.actions.locationRequest.text
string
results.body.section.items.list.items.actions.type
string
必填
Possible values: locationRequest
results.body.section.items.list.items.actions.buy
object
必填
显示子属性
results.body.section.items.list.items.actions.buy.amountCents
integer
必填
results.body.section.items.list.items.actions.buy.currency
string
必填
results.body.section.items.list.items.actions.buy.text
string
必填
results.body.section.items.list.items.actions.type
string
必填
Possible values: buy
results.body.section.items.list.items.actions.postback
object
必填
显示子属性
results.body.section.items.list.items.actions.postback.handshake
object
显示子属性
results.body.section.items.list.items.actions.postback.handshake.packageName
string
必填
results.body.section.items.list.items.actions.postback.handshake.signatureHash
string
必填
results.body.section.items.list.items.actions.postback.handshake.supportedApps
array of object
显示子属性
results.body.section.items.list.items.actions.postback.handshake.supportedApps.packageName
string
必填
results.body.section.items.list.items.actions.postback.handshake.supportedApps.signatureHash
string
必填
results.body.section.items.list.items.actions.postback.handshake.text
string
必填
results.body.section.items.list.items.actions.postback.handshake.zeroTapTermsAccepted
boolean
必填
results.body.section.items.list.items.actions.postback.imageUrl
string
results.body.section.items.list.items.actions.postback.metadata
object
显示子属性
results.body.section.items.list.items.actions.postback.metadata.description
object
显示子属性
results.body.section.items.list.items.actions.postback.metadata.description.label
string
必填
results.body.section.items.list.items.actions.postback.otpType
string
results.body.section.items.list.items.actions.postback.payload
string
results.body.section.items.list.items.actions.postback.text
string
必填
results.body.section.items.list.items.actions.type
string
必填
Possible values: postback
results.body.section.items.list.items.altText
string
results.body.section.items.list.items.description
string
results.body.section.items.list.items.mediaUrl
string
results.body.section.items.list.items.size
integer
results.body.section.items.list.items.title
string
results.body.section.items.list.metadata
object
显示子属性
results.body.section.items.list.metadata.button
object
显示子属性
results.body.section.items.list.metadata.button.label
string
必填
results.body.section.items.list.metadata.replyMessage
object
显示子属性
results.body.section.items.list.metadata.replyMessage.text
string
必填
results.body.section.items.list.metadata.replyMessage.title
string
必填
results.body.section.items.list.text
string
results.body.section.items.list.title
string
results.body.section.items.type
string
必填
Possible values: list
results.body.section.items.section
object
必填
results.body.section.items.type
string
必填
Possible values: section
results.body.section.items.authentication
object
必填
显示子属性
results.body.section.items.authentication.otp
object
显示子属性
results.body.section.items.authentication.otp.actions
array of object
显示子属性
results.body.section.items.authentication.otp.actions.link
object
必填
显示子属性
results.body.section.items.authentication.otp.actions.link.metadata
object
显示子属性
results.body.section.items.authentication.otp.actions.link.metadata.description
object
显示子属性
results.body.section.items.authentication.otp.actions.link.metadata.description.label
string
必填
results.body.section.items.authentication.otp.actions.link.text
string
必填
results.body.section.items.authentication.otp.actions.link.url
string
必填
results.body.section.items.authentication.otp.actions.type
string
必填
Possible values: link
results.body.section.items.authentication.otp.actions.reply
object
必填
显示子属性
results.body.section.items.authentication.otp.actions.reply.imageUrl
string
results.body.section.items.authentication.otp.actions.reply.metadata
object
显示子属性
results.body.section.items.authentication.otp.actions.reply.metadata.description
object
显示子属性
results.body.section.items.authentication.otp.actions.reply.metadata.description.label
string
必填
results.body.section.items.authentication.otp.actions.reply.text
string
必填
results.body.section.items.authentication.otp.actions.type
string
必填
Possible values: reply
results.body.section.items.authentication.otp.actions.locationRequest
object
显示子属性
results.body.section.items.authentication.otp.actions.locationRequest.text
string
results.body.section.items.authentication.otp.actions.type
string
必填
Possible values: locationRequest
results.body.section.items.authentication.otp.actions.buy
object
必填
显示子属性
results.body.section.items.authentication.otp.actions.buy.amountCents
integer
必填
results.body.section.items.authentication.otp.actions.buy.currency
string
必填
results.body.section.items.authentication.otp.actions.buy.text
string
必填
results.body.section.items.authentication.otp.actions.type
string
必填
Possible values: buy
results.body.section.items.authentication.otp.actions.postback
object
必填
显示子属性
results.body.section.items.authentication.otp.actions.postback.handshake
object
显示子属性
results.body.section.items.authentication.otp.actions.postback.handshake.packageName
string
必填
results.body.section.items.authentication.otp.actions.postback.handshake.signatureHash
string
必填
results.body.section.items.authentication.otp.actions.postback.handshake.supportedApps
array of object
显示子属性
results.body.section.items.authentication.otp.actions.postback.handshake.supportedApps.packageName
string
必填
results.body.section.items.authentication.otp.actions.postback.handshake.supportedApps.signatureHash
string
必填
results.body.section.items.authentication.otp.actions.postback.handshake.text
string
必填
results.body.section.items.authentication.otp.actions.postback.handshake.zeroTapTermsAccepted
boolean
必填
results.body.section.items.authentication.otp.actions.postback.imageUrl
string
results.body.section.items.authentication.otp.actions.postback.metadata
object
显示子属性
results.body.section.items.authentication.otp.actions.postback.metadata.description
object
显示子属性
results.body.section.items.authentication.otp.actions.postback.metadata.description.label
string
必填
results.body.section.items.authentication.otp.actions.postback.otpType
string
results.body.section.items.authentication.otp.actions.postback.payload
string
results.body.section.items.authentication.otp.actions.postback.text
string
必填
results.body.section.items.authentication.otp.actions.type
string
必填
Possible values: postback
results.body.section.items.authentication.otp.disclaimer
boolean
必填
Whether to add a security disclaimer to the authentication body.
results.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.
results.body.section.items.type
string
必填
Possible values: authentication
results.body.section.items.action
object
必填
显示子属性
results.body.section.items.action.action
string
必填
Possible values: permissionRequest
results.body.section.items.action.permissionRequest
object
必填
显示子属性
results.body.section.items.action.permissionRequest.resource
string
必填
Possible values: call
results.body.section.items.type
string
必填
Possible values: action
results.body.type
string
必填
Possible values: section
results.body.authentication
object
必填
显示子属性
results.body.authentication.otp
object
显示子属性
results.body.authentication.otp.actions
array of object
显示子属性
results.body.authentication.otp.actions.link
object
必填
显示子属性
results.body.authentication.otp.actions.link.metadata
object
显示子属性
results.body.authentication.otp.actions.link.metadata.description
object
显示子属性
results.body.authentication.otp.actions.link.metadata.description.label
string
必填
results.body.authentication.otp.actions.link.text
string
必填
results.body.authentication.otp.actions.link.url
string
必填
results.body.authentication.otp.actions.type
string
必填
Possible values: link
results.body.authentication.otp.actions.reply
object
必填
显示子属性
results.body.authentication.otp.actions.reply.imageUrl
string
results.body.authentication.otp.actions.reply.metadata
object
显示子属性
results.body.authentication.otp.actions.reply.metadata.description
object
显示子属性
results.body.authentication.otp.actions.reply.metadata.description.label
string
必填
results.body.authentication.otp.actions.reply.text
string
必填
results.body.authentication.otp.actions.type
string
必填
Possible values: reply
results.body.authentication.otp.actions.locationRequest
object
显示子属性
results.body.authentication.otp.actions.locationRequest.text
string
results.body.authentication.otp.actions.type
string
必填
Possible values: locationRequest
results.body.authentication.otp.actions.buy
object
必填
显示子属性
results.body.authentication.otp.actions.buy.amountCents
integer
必填
results.body.authentication.otp.actions.buy.currency
string
必填
results.body.authentication.otp.actions.buy.text
string
必填
results.body.authentication.otp.actions.type
string
必填
Possible values: buy
results.body.authentication.otp.actions.postback
object
必填
显示子属性
results.body.authentication.otp.actions.postback.handshake
object
显示子属性
results.body.authentication.otp.actions.postback.handshake.packageName
string
必填
results.body.authentication.otp.actions.postback.handshake.signatureHash
string
必填
results.body.authentication.otp.actions.postback.handshake.supportedApps
array of object
显示子属性
results.body.authentication.otp.actions.postback.handshake.supportedApps.packageName
string
必填
results.body.authentication.otp.actions.postback.handshake.supportedApps.signatureHash
string
必填
results.body.authentication.otp.actions.postback.handshake.text
string
必填
results.body.authentication.otp.actions.postback.handshake.zeroTapTermsAccepted
boolean
必填
results.body.authentication.otp.actions.postback.imageUrl
string
results.body.authentication.otp.actions.postback.metadata
object
显示子属性
results.body.authentication.otp.actions.postback.metadata.description
object
显示子属性
results.body.authentication.otp.actions.postback.metadata.description.label
string
必填
results.body.authentication.otp.actions.postback.otpType
string
results.body.authentication.otp.actions.postback.payload
string
results.body.authentication.otp.actions.postback.text
string
必填
results.body.authentication.otp.actions.type
string
必填
Possible values: postback
results.body.authentication.otp.disclaimer
boolean
必填
Whether to add a security disclaimer to the authentication body.
results.body.authentication.otp.expirationTime
integer
The number of seconds after which the authentication code expires. If not set, no expiration notification is sent.
results.body.type
string
必填
Possible values: authentication
results.body.action
object
必填
显示子属性
results.body.action.action
string
必填
Possible values: permissionRequest
results.body.action.permissionRequest
object
必填
显示子属性
results.body.action.permissionRequest.resource
string
必填
Possible values: call
results.body.type
string
必填
Possible values: action
results.channelId
string
results.conversationCreatedAt
string
results.conversationId
string
必填
results.createdAt
string
必填
results.draft
boolean
必填
Whether this message is a draft.
results.draftMeta
object
Metadata for draft messages.
显示子属性
results.draftMeta.creatorType
string
必填
Possible values: user, bot
results.id
string
必填
A unique identifier for this message.
results.interactions
array of object
A list of interactions associated with the message (e.g. read receipts, clicks, reactions).
显示子属性
results.interactions.bodyTemplateProjectId
string
results.interactions.channelId
string
必填
results.interactions.context
object
必填
显示子属性
results.interactions.context.id
string
results.interactions.context.tagIds
array of string
results.interactions.context.type
string
results.interactions.createdAt
string
必填
results.interactions.details
string
results.interactions.id
string
必填
results.interactions.isFirstInteraction
boolean
results.interactions.isFirstInteractionIncludingBots
boolean
results.interactions.journey
object
显示子属性
results.interactions.journey.id
string
results.interactions.journey.name
string
results.interactions.journey.runId
string
results.interactions.journey.scheduleExecutionId
string
results.interactions.journey.stepId
string
results.interactions.messageCreatedAt
string
results.interactions.messageId
string
必填
results.interactions.messagePartsCount
integer
必填
results.interactions.messageReference
string
必填
results.interactions.messageTags
array of string
results.interactions.metadata
object
显示子属性
results.interactions.metadata.button
object
显示子属性
results.interactions.metadata.button.payload
string
必填
results.interactions.metadata.conversion
object
显示子属性
results.interactions.metadata.conversion.method
string
Method of entering the code
Possible values: unknown, manual, auto
results.interactions.metadata.conversion.status
string
Status of the conversion
Possible values: converted, canceled, not_converted, incorrect_code, resent, received_after_expiration
results.interactions.metadata.conversion.timestamp
string
Timestamp of when the conversion was recorded
results.interactions.metadata.conversion.type
string
Type of conversion
Possible values: otp, url, promo_code
results.interactions.metadata.extraInformation
object
results.interactions.metadata.link
object
显示子属性
results.interactions.metadata.link.clickType
string
Possible values: link, button
results.interactions.metadata.link.name
string
必填
results.interactions.metadata.link.url
string
必填
results.interactions.metadata.prefetched
boolean
results.interactions.metadata.reaction
object
显示子属性
results.interactions.metadata.reaction.action
string
必填
Possible values: react, unreact
results.interactions.metadata.reaction.emoji
string
必填
results.interactions.metadata.renderedContentBlocks
array of string
results.interactions.metadata.subscriptionList
object
显示子属性
results.interactions.metadata.subscriptionList.subscriptionListId
string
必填
results.interactions.notification
object
显示子属性
results.interactions.notification.template
string
results.interactions.notification.url
string
必填
results.interactions.platformId
string
必填
results.interactions.platformReferenceId
string
results.interactions.receiver
object
必填
显示子属性
results.interactions.receiver.connector
object
显示子属性
results.interactions.receiver.connector.annotations
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
显示子属性
results.interactions.receiver.connector.annotations.name
string
results.interactions.receiver.connector.id
string
必填
results.interactions.receiver.connector.identifierValue
string
The identifier value of the sender or receiver connector (e.g. email address or phone number).
results.interactions.receiver.connector.types
array of string
results.interactions.receiver.contacts
array of object
显示子属性
results.interactions.receiver.contacts.contactAnnotation
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
显示子属性
results.interactions.receiver.contacts.contactAnnotation.name
string
results.interactions.receiver.contacts.countryCode
string
results.interactions.receiver.contacts.id
string
The ID of the contact.
results.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.
results.interactions.receiver.contacts.identifierValue
string
The identifier value for finding the contact.
results.interactions.receiver.contacts.identifiers
array of object
Additional identifiers to augment the contact during resolution.
显示子属性
results.interactions.receiver.contacts.identifiers.identifierKey
string
必填
The identifier key for finding the contact (e.g. emailaddress, phonenumber).
results.interactions.receiver.contacts.identifiers.identifierValue
string
必填
The identifier value for finding the contact.
results.interactions.receiver.contacts.platformAddress
string
The resolved platform address used to deliver the message (e.g. phone number or email address).
results.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.
results.interactions.receiver.contacts.receiverExpression
string
results.interactions.receiver.contacts.receiverValue
string
results.interactions.receiver.contacts.type
string
The type of the receiver (e.g. to, cc, bcc for email).
results.interactions.receiver.device
object
显示子属性
results.interactions.receiver.device.gateway
string
必填
Possible values: firebase, apns, web
results.interactions.receiver.device.id
string
必填
results.interactions.receiver.device.identifierValue
string
必填
results.interactions.receiver.inbox
object
显示子属性
results.interactions.receiver.inbox.emailRecipientType
string
results.interactions.receiver.inbox.id
string
必填
results.interactions.receiver.inbox.identifierKey
string
必填
results.interactions.receiver.inbox.identifierValue
string
必填
results.interactions.receiver.inbox.type
string
必填
Possible values: user, group
results.interactions.receiver.userContacts
array of object
显示子属性
results.interactions.receiver.userContacts.id
string
必填
results.interactions.receiver.userContacts.identifierKey
string
必填
results.interactions.receiver.userContacts.identifierValue
string
必填
results.interactions.receiver.userContacts.type
string
results.interactions.type
string
必填
Possible values: invalid, read, opened, clicked, reported-as-spam, unsubscribe-request, delete, reaction, subscribe-request, subscribe-consent, conversion
results.interactions.useCaseType
string
Possible values: unspecified, marketing, otp, transactional, conversation, test
results.meta
object
显示子属性
results.meta.campaign
object
显示子属性
results.meta.campaign.id
string
results.meta.campaign.name
string
results.meta.campaignId
string
results.meta.chargeOnceDelivered
boolean
results.meta.email
object
显示子属性
results.meta.email.from
object
显示子属性
results.meta.email.from.displayName
string
results.meta.email.from.username
string
results.meta.email.headers
object
results.meta.email.subject
string
results.meta.extraInformation
object
results.meta.flow
object
显示子属性
results.meta.flow.id
string
results.meta.flow.name
string
results.meta.flow.runId
string
results.meta.flow.scheduleExecutionId
string
results.meta.flow.stepId
string
results.meta.formResponse
object
显示子属性
results.meta.formResponse.id
string
必填
results.meta.formResponse.jsonResponse
string
必填
results.meta.formResponse.requestIdentifier
string
必填
results.meta.formResponse.selections
array of object
显示子属性
results.meta.formResponse.selections.items
array of object
显示子属性
results.meta.formResponse.selections.items.identifier
string
必填
results.meta.formResponse.selections.items.title
string
必填
results.meta.formResponse.selections.items.type
string
必填
results.meta.formResponse.selections.items.value
string
必填
results.meta.formResponse.selections.pageIdentifier
string
必填
results.meta.formResponse.selections.subtitle
string
必填
results.meta.formResponse.selections.title
string
必填
results.meta.formResponse.sessionIdentifier
string
必填
results.meta.formResponse.template
string
必填
results.meta.formResponse.version
string
必填
results.meta.ignoreGlobalHoldout
boolean
results.meta.ignoreQuietHours
boolean
results.meta.journey
object
显示子属性
results.meta.journey.id
string
results.meta.journey.name
string
results.meta.journey.runId
string
results.meta.journey.scheduleExecutionId
string
results.meta.journey.stepId
string
results.meta.longToShortLinks
object
results.meta.metaThreadId
string
results.meta.navigatorId
string
results.meta.navigatorMessageId
string
results.meta.order
object
The order object contains information about the purchase order associated with the message.
显示子属性
results.meta.order.products
array of object
显示子属性
results.meta.order.products.externalCatalogId
string
The platform-specific catalog ID of the product.
results.meta.order.products.externalProductId
string
必填
The platform-specific product ID.
results.meta.order.products.price
object
必填
显示子属性
results.meta.order.products.price.amount
integer
必填
results.meta.order.products.price.currencyCode
string
必填
results.meta.order.products.price.exponent
integer
必填
results.meta.order.products.quantity
integer
必填
The number of items purchased.
results.meta.pushNotifications
object
显示子属性
results.meta.pushNotifications.gatewayTypeOverride
string
Possible values: firebase, apns, web
results.meta.referral
object
显示子属性
results.meta.referral.group
string
results.meta.referral.metadata
object
显示子属性
results.meta.referral.metadata.caption
string
results.meta.referral.metadata.mediaType
string
results.meta.referral.metadata.mediaUrl
string
results.meta.referral.metadata.sourceId
string
必填
results.meta.referral.metadata.sourceUrl
string
results.meta.referral.metadata.timestamp
string
results.meta.referral.metadata.trackingId
string
results.meta.referral.metadata.username
string
results.meta.referral.source
string
必填
results.meta.referral.text
string
results.meta.referral.title
string
results.meta.referredProduct
object
Referred product in an incoming message (e.g. a product shared in a WhatsApp catalog message).
显示子属性
results.meta.referredProduct.externalCatalogId
string
The platform-specific catalog ID of the product.
results.meta.referredProduct.externalProductId
string
必填
The platform-specific product ID.
results.meta.renderedContentBlocks
array of string
results.meta.shortToLongLinks
object
results.meta.skipThisMessage
string
Possible values: campaignHoldout, globalHoldout, journeyHoldout
results.meta.sms
object
显示子属性
results.meta.sms.gatewayId
integer
results.meta.sms.registeredDelivery
string
Possible values: final, intermediate, all, noDlr
results.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.
results.meta.sms.smpp
object
显示子属性
results.meta.sms.smpp.segments
array of object
显示子属性
results.meta.sms.smpp.segments.id
string
必填
results.meta.sms.smpp.segments.registeredDelivery
string
必填
Possible values: final, intermediate, all, noDlr
results.meta.sms.smpp.userId
string
必填
results.meta.sms.validity
string
results.meta.useFallback
boolean
results.reason
string
Failure reason. Populated when status is sending_failed or delivery_failed.
results.receiver
object
显示子属性
results.receiver.connector
object
显示子属性
results.receiver.connector.annotations
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
显示子属性
results.receiver.connector.annotations.name
string
results.receiver.connector.id
string
必填
results.receiver.connector.identifierValue
string
The identifier value of the sender or receiver connector (e.g. email address or phone number).
results.receiver.connector.types
array of string
results.receiver.contacts
array of object
显示子属性
results.receiver.contacts.contactAnnotation
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
显示子属性
results.receiver.contacts.contactAnnotation.name
string
results.receiver.contacts.countryCode
string
results.receiver.contacts.id
string
The ID of the contact.
results.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.
results.receiver.contacts.identifierValue
string
The identifier value for finding the contact.
results.receiver.contacts.identifiers
array of object
Additional identifiers to augment the contact during resolution.
显示子属性
results.receiver.contacts.identifiers.identifierKey
string
必填
The identifier key for finding the contact (e.g. emailaddress, phonenumber).
results.receiver.contacts.identifiers.identifierValue
string
必填
The identifier value for finding the contact.
results.receiver.contacts.platformAddress
string
The resolved platform address used to deliver the message (e.g. phone number or email address).
results.receiver.contacts.platformAddressSelector
string
An expression that defines how we resolve the platform address from a contact. Optional override for the default resolution logic.
results.receiver.contacts.receiverExpression
string
results.receiver.contacts.receiverValue
string
results.receiver.contacts.type
string
The type of the receiver (e.g. to, cc, bcc for email).
results.receiver.device
object
显示子属性
results.receiver.device.gateway
string
必填
Possible values: firebase, apns, web
results.receiver.device.id
string
必填
results.receiver.device.identifierValue
string
必填
results.receiver.inbox
object
显示子属性
results.receiver.inbox.emailRecipientType
string
results.receiver.inbox.id
string
必填
results.receiver.inbox.identifierKey
string
必填
results.receiver.inbox.identifierValue
string
必填
results.receiver.inbox.type
string
必填
Possible values: user, group
results.receiver.userContacts
array of object
显示子属性
results.receiver.userContacts.id
string
必填
results.receiver.userContacts.identifierKey
string
必填
results.receiver.userContacts.identifierValue
string
必填
results.receiver.userContacts.type
string
results.receiverTypes
array of string
Receiver types for the message (to/cc/bcc). Currently only used for inbound email messages.
results.recipients
array of object
显示子属性
results.recipients.contactAnnotation
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
显示子属性
results.recipients.contactAnnotation.name
string
results.recipients.countryCode
string
results.recipients.id
string
The ID of the contact.
results.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.
results.recipients.identifierValue
string
The identifier value for finding the contact.
results.recipients.identifiers
array of object
Additional identifiers to augment the contact during resolution.
显示子属性
results.recipients.identifiers.identifierKey
string
必填
The identifier key for finding the contact (e.g. emailaddress, phonenumber).
results.recipients.identifiers.identifierValue
string
必填
The identifier value for finding the contact.
results.recipients.platformAddress
string
The resolved platform address used to deliver the message (e.g. phone number or email address).
results.recipients.platformAddressSelector
string
An expression that defines how we resolve the platform address from a contact. Optional override for the default resolution logic.
results.recipients.receiverExpression
string
results.recipients.receiverValue
string
results.recipients.type
string
The type of the receiver (e.g. to, cc, bcc for email).
results.reference
string
必填
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.
results.replyTo
object
显示子属性
results.replyTo.id
string
The ID of the message that is being replied to.
results.replyTo.order
integer
The order of the message part in the conversation.
results.replyTo.platformReference
string
results.replyTo.type
string
Possible values: message, click
results.resourceUri
string
results.sender
object
必填
显示子属性
results.sender.email
string
results.sender.name
string
results.sender.avatarUrl
string
results.sender.contact
object
显示子属性
results.sender.contact.identifierKey
string
必填
results.sender.contact.identifierValue
string
必填
results.sender.contact.platformAddress
string
results.sender.contact.platformAddressSelector
string
results.sender.conversationId
string
results.sender.createdAt
string
results.sender.displayName
string
results.sender.id
string
必填
results.sender.resourceUri
string
results.sender.status
string
Possible values: invited, pending, active, inactive
results.sender.type
string
必填
Possible values: user, contact, agent, flow, bot, accessKey, channel, connector, collaborationAutomation
results.sender.updatedAt
string
results.source
string
必填
Possible values: conversations, channels, bots, external
results.status
string
必填
Possible values: accepted, processing, sent, sending_failed, delivered, delivery_failed, deleted
results.template
object
显示子属性
results.template.attachments
array of object
显示子属性
results.template.attachments.content
string
results.template.attachments.contentType
string
results.template.attachments.filename
string
必填
results.template.attachments.inline
boolean
必填
results.template.attachments.mediaUrl
string
必填
results.template.deployment
object
results.template.locale
string
必填
results.template.name
string
The platform name of the template.
results.template.parameters
array of object
显示子属性
results.template.parameters.key
string
必填
results.template.parameters.sourceUrl
object
显示子属性
results.template.parameters.sourceUrl.fullyReplaced
boolean
必填
results.template.parameters.sourceUrl.value
string
必填
results.template.parameters.type
string
必填
Possible values: string, timeslotList, productSections, productList, number, boolean, sectionList, shippingMethodList, lineItemList, whatsappProductSections, whatsappProductItems, shortLink, object, carouselCards, appleFormPageItems
results.template.parameters.value
object or array or string or number or boolean
必填
results.template.projectId
string
必填
The ID of the project from Studio.
results.template.settings
object
显示子属性
results.template.settings.disallowMmLite
boolean
results.template.shortLinks
object
显示子属性
results.template.shortLinks.domain
string
必填
The domain to use when shortening links. When set to default, uses the default link shortening domain for the workspace.
results.template.shortLinks.enabled
boolean
必填
Enables link shortening for SMS messages.
results.template.templateBody
object
显示子属性
results.template.templateBody.text
object
必填
显示子属性
results.template.templateBody.text.actions
array of object
显示子属性
results.template.templateBody.text.actions.link
object
必填
显示子属性
results.template.templateBody.text.actions.link.metadata
object
显示子属性
results.template.templateBody.text.actions.link.metadata.description
object
显示子属性
results.template.templateBody.text.actions.link.metadata.description.label
string
必填
results.template.templateBody.text.actions.link.text
string
必填
results.template.templateBody.text.actions.link.url
string
必填
results.template.templateBody.text.actions.type
string
必填
Possible values: link
results.template.templateBody.text.actions.reply
object
必填
显示子属性
results.template.templateBody.text.actions.reply.imageUrl
string
results.template.templateBody.text.actions.reply.metadata
object
显示子属性
results.template.templateBody.text.actions.reply.metadata.description
object
显示子属性
results.template.templateBody.text.actions.reply.metadata.description.label
string
必填
results.template.templateBody.text.actions.reply.text
string
必填
results.template.templateBody.text.actions.type
string
必填
Possible values: reply
results.template.templateBody.text.actions.locationRequest
object
显示子属性
results.template.templateBody.text.actions.locationRequest.text
string
results.template.templateBody.text.actions.type
string
必填
Possible values: locationRequest
results.template.templateBody.text.actions.buy
object
必填
显示子属性
results.template.templateBody.text.actions.buy.amountCents
integer
必填
results.template.templateBody.text.actions.buy.currency
string
必填
results.template.templateBody.text.actions.buy.text
string
必填
results.template.templateBody.text.actions.type
string
必填
Possible values: buy
results.template.templateBody.text.actions.postback
object
必填
显示子属性
results.template.templateBody.text.actions.postback.handshake
object
显示子属性
results.template.templateBody.text.actions.postback.handshake.packageName
string
必填
results.template.templateBody.text.actions.postback.handshake.signatureHash
string
必填
results.template.templateBody.text.actions.postback.handshake.supportedApps
array of object
显示子属性
results.template.templateBody.text.actions.postback.handshake.supportedApps.packageName
string
必填
results.template.templateBody.text.actions.postback.handshake.supportedApps.signatureHash
string
必填
results.template.templateBody.text.actions.postback.handshake.text
string
必填
results.template.templateBody.text.actions.postback.handshake.zeroTapTermsAccepted
boolean
必填
results.template.templateBody.text.actions.postback.imageUrl
string
results.template.templateBody.text.actions.postback.metadata
object
显示子属性
results.template.templateBody.text.actions.postback.metadata.description
object
显示子属性
results.template.templateBody.text.actions.postback.metadata.description.label
string
必填
results.template.templateBody.text.actions.postback.otpType
string
results.template.templateBody.text.actions.postback.payload
string
results.template.templateBody.text.actions.postback.text
string
必填
results.template.templateBody.text.actions.type
string
必填
Possible values: postback
results.template.templateBody.text.attachments
array of object
显示子属性
results.template.templateBody.text.attachments.content
string
results.template.templateBody.text.attachments.contentId
string
results.template.templateBody.text.attachments.contentType
string
results.template.templateBody.text.attachments.filename
string
必填
results.template.templateBody.text.attachments.inline
boolean
results.template.templateBody.text.attachments.mediaUrl
string
必填
results.template.templateBody.text.metadata
object
显示子属性
results.template.templateBody.text.metadata.apple
object
显示子属性
results.template.templateBody.text.metadata.apple.appClipPreview
boolean
results.template.templateBody.text.metadata.apple.appClipRegion
string
results.template.templateBody.text.metadata.apple.summaryText
string
results.template.templateBody.text.metadata.headers
object
results.template.templateBody.text.metadata.line
object
显示子属性
results.template.templateBody.text.metadata.line.emoji
object
显示子属性
results.template.templateBody.text.metadata.line.emoji.items
array of object
显示子属性
results.template.templateBody.text.metadata.line.emoji.items.emojiId
string
必填
results.template.templateBody.text.metadata.line.emoji.items.index
integer
必填
results.template.templateBody.text.metadata.line.emoji.items.length
integer
results.template.templateBody.text.metadata.line.emoji.items.productId
string
必填
results.template.templateBody.text.metadata.paymentDetails
object
显示子属性
results.template.templateBody.text.metadata.paymentDetails.amount
string
必填
results.template.templateBody.text.metadata.paymentDetails.currency
string
必填
results.template.templateBody.text.metadata.paymentDetails.sessionIdentifier
string
results.template.templateBody.text.metadata.paymentDetails.state
string
必填
results.template.templateBody.text.metadata.subject
string
results.template.templateBody.text.metadata.telegram
object
显示子属性
results.template.templateBody.text.metadata.telegram.parseMode
string
results.template.templateBody.text.metadata.whatsapp
object
显示子属性
results.template.templateBody.text.metadata.whatsapp.callPermissionExpiration
string
results.template.templateBody.text.metadata.whatsapp.callPermissionResponse
string
Possible values: accept, reject
results.template.templateBody.text.metadata.whatsapp.previewUrl
boolean
必填
results.template.templateBody.text.metadata.whatsapp.sharedContacts
array of object
显示子属性
results.template.templateBody.text.metadata.whatsapp.sharedContacts.origin
string
必填
results.template.templateBody.text.metadata.whatsapp.sharedContacts.phones
array of object
显示子属性
results.template.templateBody.text.metadata.whatsapp.sharedContacts.phones.phone
string
必填
results.template.templateBody.text.metadata.whatsapp.sharedContacts.phones.type
string
必填
results.template.templateBody.text.metadata.whatsapp.sharedContacts.phones.waId
string
必填
results.template.templateBody.text.metadata.whatsapp.sharedContacts.vcard
string
results.template.templateBody.text.text
string
必填
results.template.templateBody.type
string
必填
Possible values: text
results.template.templateBody.html
object
必填
显示子属性
results.template.templateBody.html.actions
array of object
显示子属性
results.template.templateBody.html.actions.link
object
必填
显示子属性
results.template.templateBody.html.actions.link.metadata
object
显示子属性
results.template.templateBody.html.actions.link.metadata.description
object
显示子属性
results.template.templateBody.html.actions.link.metadata.description.label
string
必填
results.template.templateBody.html.actions.link.text
string
必填
results.template.templateBody.html.actions.link.url
string
必填
results.template.templateBody.html.actions.type
string
必填
Possible values: link
results.template.templateBody.html.actions.reply
object
必填
显示子属性
results.template.templateBody.html.actions.reply.imageUrl
string
results.template.templateBody.html.actions.reply.metadata
object
显示子属性
results.template.templateBody.html.actions.reply.metadata.description
object
显示子属性
results.template.templateBody.html.actions.reply.metadata.description.label
string
必填
results.template.templateBody.html.actions.reply.text
string
必填
results.template.templateBody.html.actions.type
string
必填
Possible values: reply
results.template.templateBody.html.actions.locationRequest
object
显示子属性
results.template.templateBody.html.actions.locationRequest.text
string
results.template.templateBody.html.actions.type
string
必填
Possible values: locationRequest
results.template.templateBody.html.actions.buy
object
必填
显示子属性
results.template.templateBody.html.actions.buy.amountCents
integer
必填
results.template.templateBody.html.actions.buy.currency
string
必填
results.template.templateBody.html.actions.buy.text
string
必填
results.template.templateBody.html.actions.type
string
必填
Possible values: buy
results.template.templateBody.html.actions.postback
object
必填
显示子属性
results.template.templateBody.html.actions.postback.handshake
object
显示子属性
results.template.templateBody.html.actions.postback.handshake.packageName
string
必填
results.template.templateBody.html.actions.postback.handshake.signatureHash
string
必填
results.template.templateBody.html.actions.postback.handshake.supportedApps
array of object
显示子属性
results.template.templateBody.html.actions.postback.handshake.supportedApps.packageName
string
必填
results.template.templateBody.html.actions.postback.handshake.supportedApps.signatureHash
string
必填
results.template.templateBody.html.actions.postback.handshake.text
string
必填
results.template.templateBody.html.actions.postback.handshake.zeroTapTermsAccepted
boolean
必填
results.template.templateBody.html.actions.postback.imageUrl
string
results.template.templateBody.html.actions.postback.metadata
object
显示子属性
results.template.templateBody.html.actions.postback.metadata.description
object
显示子属性
results.template.templateBody.html.actions.postback.metadata.description.label
string
必填
results.template.templateBody.html.actions.postback.otpType
string
results.template.templateBody.html.actions.postback.payload
string
results.template.templateBody.html.actions.postback.text
string
必填
results.template.templateBody.html.actions.type
string
必填
Possible values: postback
results.template.templateBody.html.attachments
array of object
显示子属性
results.template.templateBody.html.attachments.content
string
results.template.templateBody.html.attachments.contentId
string
results.template.templateBody.html.attachments.contentType
string
results.template.templateBody.html.attachments.filename
string
必填
results.template.templateBody.html.attachments.inline
boolean
results.template.templateBody.html.attachments.mediaUrl
string
results.template.templateBody.html.html
string
results.template.templateBody.html.metadata
object
显示子属性
results.template.templateBody.html.metadata.clickTracking
boolean
results.template.templateBody.html.metadata.from
object
显示子属性
results.template.templateBody.html.metadata.from.displayName
string
results.template.templateBody.html.metadata.from.username
string
results.template.templateBody.html.metadata.headers
object
results.template.templateBody.html.metadata.initialOpenTracking
boolean
results.template.templateBody.html.metadata.openTracking
boolean
results.template.templateBody.html.metadata.subject
string
results.template.templateBody.html.text
string
results.template.templateBody.type
string
必填
Possible values: html
results.template.templateBody.image
object
必填
显示子属性
results.template.templateBody.image.actions
array of object
显示子属性
results.template.templateBody.image.actions.link
object
必填
显示子属性
results.template.templateBody.image.actions.link.metadata
object
显示子属性
results.template.templateBody.image.actions.link.metadata.description
object
显示子属性
results.template.templateBody.image.actions.link.metadata.description.label
string
必填
results.template.templateBody.image.actions.link.text
string
必填
results.template.templateBody.image.actions.link.url
string
必填
results.template.templateBody.image.actions.type
string
必填
Possible values: link
results.template.templateBody.image.actions.reply
object
必填
显示子属性
results.template.templateBody.image.actions.reply.imageUrl
string
results.template.templateBody.image.actions.reply.metadata
object
显示子属性
results.template.templateBody.image.actions.reply.metadata.description
object
显示子属性
results.template.templateBody.image.actions.reply.metadata.description.label
string
必填
results.template.templateBody.image.actions.reply.text
string
必填
results.template.templateBody.image.actions.type
string
必填
Possible values: reply
results.template.templateBody.image.actions.locationRequest
object
显示子属性
results.template.templateBody.image.actions.locationRequest.text
string
results.template.templateBody.image.actions.type
string
必填
Possible values: locationRequest
results.template.templateBody.image.actions.buy
object
必填
显示子属性
results.template.templateBody.image.actions.buy.amountCents
integer
必填
results.template.templateBody.image.actions.buy.currency
string
必填
results.template.templateBody.image.actions.buy.text
string
必填
results.template.templateBody.image.actions.type
string
必填
Possible values: buy
results.template.templateBody.image.actions.postback
object
必填
显示子属性
results.template.templateBody.image.actions.postback.handshake
object
显示子属性
results.template.templateBody.image.actions.postback.handshake.packageName
string
必填
results.template.templateBody.image.actions.postback.handshake.signatureHash
string
必填
results.template.templateBody.image.actions.postback.handshake.supportedApps
array of object
显示子属性
results.template.templateBody.image.actions.postback.handshake.supportedApps.packageName
string
必填
results.template.templateBody.image.actions.postback.handshake.supportedApps.signatureHash
string
必填
results.template.templateBody.image.actions.postback.handshake.text
string
必填
results.template.templateBody.image.actions.postback.handshake.zeroTapTermsAccepted
boolean
必填
results.template.templateBody.image.actions.postback.imageUrl
string
results.template.templateBody.image.actions.postback.metadata
object
显示子属性
results.template.templateBody.image.actions.postback.metadata.description
object
显示子属性
results.template.templateBody.image.actions.postback.metadata.description.label
string
必填
results.template.templateBody.image.actions.postback.otpType
string
results.template.templateBody.image.actions.postback.payload
string
results.template.templateBody.image.actions.postback.text
string
必填
results.template.templateBody.image.actions.type
string
必填
Possible values: postback
results.template.templateBody.image.images
array of object
必填
显示子属性
results.template.templateBody.image.images.altText
string
results.template.templateBody.image.images.mediaPreviewUrl
string
results.template.templateBody.image.images.mediaUrl
string
必填
results.template.templateBody.image.metadata
object
显示子属性
results.template.templateBody.image.metadata.fallbackText
string
results.template.templateBody.image.metadata.storyType
string
Possible values: mention, reply
results.template.templateBody.image.metadata.subject
string
results.template.templateBody.image.metadata.telegram
object
显示子属性
results.template.templateBody.image.metadata.telegram.parseMode
string
results.template.templateBody.image.text
string
results.template.templateBody.type
string
必填
Possible values: image
results.template.templateBody.gif
object
必填
显示子属性
results.template.templateBody.gif.actions
array of object
显示子属性
results.template.templateBody.gif.actions.link
object
必填
显示子属性
results.template.templateBody.gif.actions.link.metadata
object
显示子属性
results.template.templateBody.gif.actions.link.metadata.description
object
显示子属性
results.template.templateBody.gif.actions.link.metadata.description.label
string
必填
results.template.templateBody.gif.actions.link.text
string
必填
results.template.templateBody.gif.actions.link.url
string
必填
results.template.templateBody.gif.actions.type
string
必填
Possible values: link
results.template.templateBody.gif.actions.reply
object
必填
显示子属性
results.template.templateBody.gif.actions.reply.imageUrl
string
results.template.templateBody.gif.actions.reply.metadata
object
显示子属性
results.template.templateBody.gif.actions.reply.metadata.description
object
显示子属性
results.template.templateBody.gif.actions.reply.metadata.description.label
string
必填
results.template.templateBody.gif.actions.reply.text
string
必填
results.template.templateBody.gif.actions.type
string
必填
Possible values: reply
results.template.templateBody.gif.actions.locationRequest
object
显示子属性
results.template.templateBody.gif.actions.locationRequest.text
string
results.template.templateBody.gif.actions.type
string
必填
Possible values: locationRequest
results.template.templateBody.gif.actions.buy
object
必填
显示子属性
results.template.templateBody.gif.actions.buy.amountCents
integer
必填
results.template.templateBody.gif.actions.buy.currency
string
必填
results.template.templateBody.gif.actions.buy.text
string
必填
results.template.templateBody.gif.actions.type
string
必填
Possible values: buy
results.template.templateBody.gif.actions.postback
object
必填
显示子属性
results.template.templateBody.gif.actions.postback.handshake
object
显示子属性
results.template.templateBody.gif.actions.postback.handshake.packageName
string
必填
results.template.templateBody.gif.actions.postback.handshake.signatureHash
string
必填
results.template.templateBody.gif.actions.postback.handshake.supportedApps
array of object
显示子属性
results.template.templateBody.gif.actions.postback.handshake.supportedApps.packageName
string
必填
results.template.templateBody.gif.actions.postback.handshake.supportedApps.signatureHash
string
必填
results.template.templateBody.gif.actions.postback.handshake.text
string
必填
results.template.templateBody.gif.actions.postback.handshake.zeroTapTermsAccepted
boolean
必填
results.template.templateBody.gif.actions.postback.imageUrl
string
results.template.templateBody.gif.actions.postback.metadata
object
显示子属性
results.template.templateBody.gif.actions.postback.metadata.description
object
显示子属性
results.template.templateBody.gif.actions.postback.metadata.description.label
string
必填
results.template.templateBody.gif.actions.postback.otpType
string
results.template.templateBody.gif.actions.postback.payload
string
results.template.templateBody.gif.actions.postback.text
string
必填
results.template.templateBody.gif.actions.type
string
必填
Possible values: postback
results.template.templateBody.gif.altText
string
results.template.templateBody.gif.mediaUrl
string
必填
results.template.templateBody.gif.metadata
object
显示子属性
results.template.templateBody.gif.metadata.telegram
object
显示子属性
results.template.templateBody.gif.metadata.telegram.parseMode
string
results.template.templateBody.gif.text
string
results.template.templateBody.type
string
必填
Possible values: gif
results.template.templateBody.file
object
必填
显示子属性
results.template.templateBody.file.actions
array of object
显示子属性
results.template.templateBody.file.actions.link
object
必填
显示子属性
results.template.templateBody.file.actions.link.metadata
object
显示子属性
results.template.templateBody.file.actions.link.metadata.description
object
显示子属性
results.template.templateBody.file.actions.link.metadata.description.label
string
必填
results.template.templateBody.file.actions.link.text
string
必填
results.template.templateBody.file.actions.link.url
string
必填
results.template.templateBody.file.actions.type
string
必填
Possible values: link
results.template.templateBody.file.actions.reply
object
必填
显示子属性
results.template.templateBody.file.actions.reply.imageUrl
string
results.template.templateBody.file.actions.reply.metadata
object
显示子属性
results.template.templateBody.file.actions.reply.metadata.description
object
显示子属性
results.template.templateBody.file.actions.reply.metadata.description.label
string
必填
results.template.templateBody.file.actions.reply.text
string
必填
results.template.templateBody.file.actions.type
string
必填
Possible values: reply
results.template.templateBody.file.actions.locationRequest
object
显示子属性
results.template.templateBody.file.actions.locationRequest.text
string
results.template.templateBody.file.actions.type
string
必填
Possible values: locationRequest
results.template.templateBody.file.actions.buy
object
必填
显示子属性
results.template.templateBody.file.actions.buy.amountCents
integer
必填
results.template.templateBody.file.actions.buy.currency
string
必填
results.template.templateBody.file.actions.buy.text
string
必填
results.template.templateBody.file.actions.type
string
必填
Possible values: buy
results.template.templateBody.file.actions.postback
object
必填
显示子属性
results.template.templateBody.file.actions.postback.handshake
object
显示子属性
results.template.templateBody.file.actions.postback.handshake.packageName
string
必填
results.template.templateBody.file.actions.postback.handshake.signatureHash
string
必填
results.template.templateBody.file.actions.postback.handshake.supportedApps
array of object
显示子属性
results.template.templateBody.file.actions.postback.handshake.supportedApps.packageName
string
必填
results.template.templateBody.file.actions.postback.handshake.supportedApps.signatureHash
string
必填
results.template.templateBody.file.actions.postback.handshake.text
string
必填
results.template.templateBody.file.actions.postback.handshake.zeroTapTermsAccepted
boolean
必填
results.template.templateBody.file.actions.postback.imageUrl
string
results.template.templateBody.file.actions.postback.metadata
object
显示子属性
results.template.templateBody.file.actions.postback.metadata.description
object
显示子属性
results.template.templateBody.file.actions.postback.metadata.description.label
string
必填
results.template.templateBody.file.actions.postback.otpType
string
results.template.templateBody.file.actions.postback.payload
string
results.template.templateBody.file.actions.postback.text
string
必填
results.template.templateBody.file.actions.type
string
必填
Possible values: postback
results.template.templateBody.file.files
array of object
必填
显示子属性
results.template.templateBody.file.files.altText
string
results.template.templateBody.file.files.contentType
string
必填
results.template.templateBody.file.files.filename
string
results.template.templateBody.file.files.mediaUrl
string
必填
results.template.templateBody.file.files.metadata
object
显示子属性
results.template.templateBody.file.files.metadata.isAnimated
boolean
results.template.templateBody.file.metadata
object
显示子属性
results.template.templateBody.file.metadata.fallbackText
string
results.template.templateBody.file.metadata.storyType
string
Possible values: mention, reply
results.template.templateBody.file.metadata.subject
string
results.template.templateBody.file.metadata.telegram
object
显示子属性
results.template.templateBody.file.metadata.telegram.parseMode
string
results.template.templateBody.file.text
string
results.template.templateBody.type
string
必填
Possible values: file
results.template.templateBody.location
object
必填
显示子属性
results.template.templateBody.location.coordinates
object
必填
显示子属性
results.template.templateBody.location.coordinates.latitude
number
必填
results.template.templateBody.location.coordinates.longitude
number
必填
results.template.templateBody.location.location
object
必填
显示子属性
results.template.templateBody.location.location.address
string
必填
results.template.templateBody.location.location.label
string
必填
results.template.templateBody.type
string
必填
Possible values: location
results.template.templateBody.carousel
object
必填
显示子属性
results.template.templateBody.carousel.items
array of object
显示子属性
results.template.templateBody.carousel.items.actions
array of object
显示子属性
results.template.templateBody.carousel.items.actions.link
object
必填
显示子属性
results.template.templateBody.carousel.items.actions.link.metadata
object
显示子属性
results.template.templateBody.carousel.items.actions.link.metadata.description
object
显示子属性
results.template.templateBody.carousel.items.actions.link.metadata.description.label
string
必填
results.template.templateBody.carousel.items.actions.link.text
string
必填
results.template.templateBody.carousel.items.actions.link.url
string
必填
results.template.templateBody.carousel.items.actions.type
string
必填
Possible values: link
results.template.templateBody.carousel.items.actions.reply
object
必填
显示子属性
results.template.templateBody.carousel.items.actions.reply.imageUrl
string
results.template.templateBody.carousel.items.actions.reply.metadata
object
显示子属性
results.template.templateBody.carousel.items.actions.reply.metadata.description
object
显示子属性
results.template.templateBody.carousel.items.actions.reply.metadata.description.label
string
必填
results.template.templateBody.carousel.items.actions.reply.text
string
必填
results.template.templateBody.carousel.items.actions.type
string
必填
Possible values: reply
results.template.templateBody.carousel.items.actions.locationRequest
object
显示子属性
results.template.templateBody.carousel.items.actions.locationRequest.text
string
results.template.templateBody.carousel.items.actions.type
string
必填
Possible values: locationRequest
results.template.templateBody.carousel.items.actions.buy
object
必填
显示子属性
results.template.templateBody.carousel.items.actions.buy.amountCents
integer
必填
results.template.templateBody.carousel.items.actions.buy.currency
string
必填
results.template.templateBody.carousel.items.actions.buy.text
string
必填
results.template.templateBody.carousel.items.actions.type
string
必填
Possible values: buy
results.template.templateBody.carousel.items.actions.postback
object
必填
显示子属性
results.template.templateBody.carousel.items.actions.postback.handshake
object
显示子属性
results.template.templateBody.carousel.items.actions.postback.handshake.packageName
string
必填
results.template.templateBody.carousel.items.actions.postback.handshake.signatureHash
string
必填
results.template.templateBody.carousel.items.actions.postback.handshake.supportedApps
array of object
显示子属性
results.template.templateBody.carousel.items.actions.postback.handshake.supportedApps.packageName
string
必填
results.template.templateBody.carousel.items.actions.postback.handshake.supportedApps.signatureHash
string
必填
results.template.templateBody.carousel.items.actions.postback.handshake.text
string
必填
results.template.templateBody.carousel.items.actions.postback.handshake.zeroTapTermsAccepted
boolean
必填
results.template.templateBody.carousel.items.actions.postback.imageUrl
string
results.template.templateBody.carousel.items.actions.postback.metadata
object
显示子属性
results.template.templateBody.carousel.items.actions.postback.metadata.description
object
显示子属性
results.template.templateBody.carousel.items.actions.postback.metadata.description.label
string
必填
results.template.templateBody.carousel.items.actions.postback.otpType
string
results.template.templateBody.carousel.items.actions.postback.payload
string
results.template.templateBody.carousel.items.actions.postback.text
string
必填
results.template.templateBody.carousel.items.actions.type
string
必填
Possible values: postback
results.template.templateBody.carousel.items.altText
string
results.template.templateBody.carousel.items.description
string
results.template.templateBody.carousel.items.mediaUrl
string
results.template.templateBody.carousel.items.size
integer
results.template.templateBody.carousel.items.title
string
results.template.templateBody.carousel.text
string
Optional text displayed above the carousel cards.
results.template.templateBody.type
string
必填
Possible values: carousel
results.template.templateBody.list
object
必填
显示子属性
results.template.templateBody.list.actions
array of object
显示子属性
results.template.templateBody.list.actions.link
object
必填
显示子属性
results.template.templateBody.list.actions.link.metadata
object
显示子属性
results.template.templateBody.list.actions.link.metadata.description
object
显示子属性
results.template.templateBody.list.actions.link.metadata.description.label
string
必填
results.template.templateBody.list.actions.link.text
string
必填
results.template.templateBody.list.actions.link.url
string
必填
results.template.templateBody.list.actions.type
string
必填
Possible values: link
results.template.templateBody.list.actions.reply
object
必填
显示子属性
results.template.templateBody.list.actions.reply.imageUrl
string
results.template.templateBody.list.actions.reply.metadata
object
显示子属性
results.template.templateBody.list.actions.reply.metadata.description
object
显示子属性
results.template.templateBody.list.actions.reply.metadata.description.label
string
必填
results.template.templateBody.list.actions.reply.text
string
必填
results.template.templateBody.list.actions.type
string
必填
Possible values: reply
results.template.templateBody.list.actions.locationRequest
object
显示子属性
results.template.templateBody.list.actions.locationRequest.text
string
results.template.templateBody.list.actions.type
string
必填
Possible values: locationRequest
results.template.templateBody.list.actions.buy
object
必填
显示子属性
results.template.templateBody.list.actions.buy.amountCents
integer
必填
results.template.templateBody.list.actions.buy.currency
string
必填
results.template.templateBody.list.actions.buy.text
string
必填
results.template.templateBody.list.actions.type
string
必填
Possible values: buy
results.template.templateBody.list.actions.postback
object
必填
显示子属性
results.template.templateBody.list.actions.postback.handshake
object
显示子属性
results.template.templateBody.list.actions.postback.handshake.packageName
string
必填
results.template.templateBody.list.actions.postback.handshake.signatureHash
string
必填
results.template.templateBody.list.actions.postback.handshake.supportedApps
array of object
显示子属性
results.template.templateBody.list.actions.postback.handshake.supportedApps.packageName
string
必填
results.template.templateBody.list.actions.postback.handshake.supportedApps.signatureHash
string
必填
results.template.templateBody.list.actions.postback.handshake.text
string
必填
results.template.templateBody.list.actions.postback.handshake.zeroTapTermsAccepted
boolean
必填
results.template.templateBody.list.actions.postback.imageUrl
string
results.template.templateBody.list.actions.postback.metadata
object
显示子属性
results.template.templateBody.list.actions.postback.metadata.description
object
显示子属性
results.template.templateBody.list.actions.postback.metadata.description.label
string
必填
results.template.templateBody.list.actions.postback.otpType
string
results.template.templateBody.list.actions.postback.payload
string
results.template.templateBody.list.actions.postback.text
string
必填
results.template.templateBody.list.actions.type
string
必填
Possible values: postback
results.template.templateBody.list.altText
string
results.template.templateBody.list.items
array of object
显示子属性
results.template.templateBody.list.items.actions
array of object
显示子属性
results.template.templateBody.list.items.actions.link
object
必填
显示子属性
results.template.templateBody.list.items.actions.link.metadata
object
显示子属性
results.template.templateBody.list.items.actions.link.metadata.description
object
显示子属性
results.template.templateBody.list.items.actions.link.metadata.description.label
string
必填
results.template.templateBody.list.items.actions.link.text
string
必填
results.template.templateBody.list.items.actions.link.url
string
必填
results.template.templateBody.list.items.actions.type
string
必填
Possible values: link
results.template.templateBody.list.items.actions.reply
object
必填
显示子属性
results.template.templateBody.list.items.actions.reply.imageUrl
string
results.template.templateBody.list.items.actions.reply.metadata
object
显示子属性
results.template.templateBody.list.items.actions.reply.metadata.description
object
显示子属性
results.template.templateBody.list.items.actions.reply.metadata.description.label
string
必填
results.template.templateBody.list.items.actions.reply.text
string
必填
results.template.templateBody.list.items.actions.type
string
必填
Possible values: reply
results.template.templateBody.list.items.actions.locationRequest
object
显示子属性
results.template.templateBody.list.items.actions.locationRequest.text
string
results.template.templateBody.list.items.actions.type
string
必填
Possible values: locationRequest
results.template.templateBody.list.items.actions.buy
object
必填
显示子属性
results.template.templateBody.list.items.actions.buy.amountCents
integer
必填
results.template.templateBody.list.items.actions.buy.currency
string
必填
results.template.templateBody.list.items.actions.buy.text
string
必填
results.template.templateBody.list.items.actions.type
string
必填
Possible values: buy
results.template.templateBody.list.items.actions.postback
object
必填
显示子属性
results.template.templateBody.list.items.actions.postback.handshake
object
显示子属性
results.template.templateBody.list.items.actions.postback.handshake.packageName
string
必填
results.template.templateBody.list.items.actions.postback.handshake.signatureHash
string
必填
results.template.templateBody.list.items.actions.postback.handshake.supportedApps
array of object
显示子属性
results.template.templateBody.list.items.actions.postback.handshake.supportedApps.packageName
string
必填
results.template.templateBody.list.items.actions.postback.handshake.supportedApps.signatureHash
string
必填
results.template.templateBody.list.items.actions.postback.handshake.text
string
必填
results.template.templateBody.list.items.actions.postback.handshake.zeroTapTermsAccepted
boolean
必填
results.template.templateBody.list.items.actions.postback.imageUrl
string
results.template.templateBody.list.items.actions.postback.metadata
object
显示子属性
results.template.templateBody.list.items.actions.postback.metadata.description
object
显示子属性
results.template.templateBody.list.items.actions.postback.metadata.description.label
string
必填
results.template.templateBody.list.items.actions.postback.otpType
string
results.template.templateBody.list.items.actions.postback.payload
string
results.template.templateBody.list.items.actions.postback.text
string
必填
results.template.templateBody.list.items.actions.type
string
必填
Possible values: postback
results.template.templateBody.list.items.altText
string
results.template.templateBody.list.items.description
string
results.template.templateBody.list.items.mediaUrl
string
results.template.templateBody.list.items.size
integer
results.template.templateBody.list.items.title
string
results.template.templateBody.list.metadata
object
显示子属性
results.template.templateBody.list.metadata.button
object
显示子属性
results.template.templateBody.list.metadata.button.label
string
必填
results.template.templateBody.list.metadata.replyMessage
object
显示子属性
results.template.templateBody.list.metadata.replyMessage.text
string
必填
results.template.templateBody.list.metadata.replyMessage.title
string
必填
results.template.templateBody.list.text
string
results.template.templateBody.list.title
string
results.template.templateBody.type
string
必填
Possible values: list
results.template.templateBody.section
object
必填
显示子属性
results.template.templateBody.section.configurations
object
results.template.templateBody.section.items
array of object
显示子属性
results.template.templateBody.section.items.text
object
必填
显示子属性
results.template.templateBody.section.items.text.actions
array of object
显示子属性
results.template.templateBody.section.items.text.actions.link
object
必填
显示子属性
results.template.templateBody.section.items.text.actions.link.metadata
object
显示子属性
results.template.templateBody.section.items.text.actions.link.metadata.description
object
显示子属性
results.template.templateBody.section.items.text.actions.link.metadata.description.label
string
必填
results.template.templateBody.section.items.text.actions.link.text
string
必填
results.template.templateBody.section.items.text.actions.link.url
string
必填
results.template.templateBody.section.items.text.actions.type
string
必填
Possible values: link
results.template.templateBody.section.items.text.actions.reply
object
必填
显示子属性
results.template.templateBody.section.items.text.actions.reply.imageUrl
string
results.template.templateBody.section.items.text.actions.reply.metadata
object
显示子属性
results.template.templateBody.section.items.text.actions.reply.metadata.description
object
显示子属性
results.template.templateBody.section.items.text.actions.reply.metadata.description.label
string
必填
results.template.templateBody.section.items.text.actions.reply.text
string
必填
results.template.templateBody.section.items.text.actions.type
string
必填
Possible values: reply
results.template.templateBody.section.items.text.actions.locationRequest
object
显示子属性
results.template.templateBody.section.items.text.actions.locationRequest.text
string
results.template.templateBody.section.items.text.actions.type
string
必填
Possible values: locationRequest
results.template.templateBody.section.items.text.actions.buy
object
必填
显示子属性
results.template.templateBody.section.items.text.actions.buy.amountCents
integer
必填
results.template.templateBody.section.items.text.actions.buy.currency
string
必填
results.template.templateBody.section.items.text.actions.buy.text
string
必填
results.template.templateBody.section.items.text.actions.type
string
必填
Possible values: buy
results.template.templateBody.section.items.text.actions.postback
object
必填
显示子属性
results.template.templateBody.section.items.text.actions.postback.handshake
object
显示子属性
results.template.templateBody.section.items.text.actions.postback.handshake.packageName
string
必填
results.template.templateBody.section.items.text.actions.postback.handshake.signatureHash
string
必填
results.template.templateBody.section.items.text.actions.postback.handshake.supportedApps
array of object
显示子属性
results.template.templateBody.section.items.text.actions.postback.handshake.supportedApps.packageName
string
必填
results.template.templateBody.section.items.text.actions.postback.handshake.supportedApps.signatureHash
string
必填
results.template.templateBody.section.items.text.actions.postback.handshake.text
string
必填
results.template.templateBody.section.items.text.actions.postback.handshake.zeroTapTermsAccepted
boolean
必填
results.template.templateBody.section.items.text.actions.postback.imageUrl
string
results.template.templateBody.section.items.text.actions.postback.metadata
object
显示子属性
results.template.templateBody.section.items.text.actions.postback.metadata.description
object
显示子属性
results.template.templateBody.section.items.text.actions.postback.metadata.description.label
string
必填
results.template.templateBody.section.items.text.actions.postback.otpType
string
results.template.templateBody.section.items.text.actions.postback.payload
string
results.template.templateBody.section.items.text.actions.postback.text
string
必填
results.template.templateBody.section.items.text.actions.type
string
必填
Possible values: postback
results.template.templateBody.section.items.text.attachments
array of object
显示子属性
results.template.templateBody.section.items.text.attachments.content
string
results.template.templateBody.section.items.text.attachments.contentId
string
results.template.templateBody.section.items.text.attachments.contentType
string
results.template.templateBody.section.items.text.attachments.filename
string
必填
results.template.templateBody.section.items.text.attachments.inline
boolean
results.template.templateBody.section.items.text.attachments.mediaUrl
string
必填
results.template.templateBody.section.items.text.metadata
object
显示子属性
results.template.templateBody.section.items.text.metadata.apple
object
显示子属性
results.template.templateBody.section.items.text.metadata.apple.appClipPreview
boolean
results.template.templateBody.section.items.text.metadata.apple.appClipRegion
string
results.template.templateBody.section.items.text.metadata.apple.summaryText
string
results.template.templateBody.section.items.text.metadata.headers
object
results.template.templateBody.section.items.text.metadata.line
object
显示子属性
results.template.templateBody.section.items.text.metadata.line.emoji
object
显示子属性
results.template.templateBody.section.items.text.metadata.line.emoji.items
array of object
显示子属性
results.template.templateBody.section.items.text.metadata.line.emoji.items.emojiId
string
必填
results.template.templateBody.section.items.text.metadata.line.emoji.items.index
integer
必填
results.template.templateBody.section.items.text.metadata.line.emoji.items.length
integer
results.template.templateBody.section.items.text.metadata.line.emoji.items.productId
string
必填
results.template.templateBody.section.items.text.metadata.paymentDetails
object
显示子属性
results.template.templateBody.section.items.text.metadata.paymentDetails.amount
string
必填
results.template.templateBody.section.items.text.metadata.paymentDetails.currency
string
必填
results.template.templateBody.section.items.text.metadata.paymentDetails.sessionIdentifier
string
results.template.templateBody.section.items.text.metadata.paymentDetails.state
string
必填
results.template.templateBody.section.items.text.metadata.subject
string
results.template.templateBody.section.items.text.metadata.telegram
object
显示子属性
results.template.templateBody.section.items.text.metadata.telegram.parseMode
string
results.template.templateBody.section.items.text.metadata.whatsapp
object
显示子属性
results.template.templateBody.section.items.text.metadata.whatsapp.callPermissionExpiration
string
results.template.templateBody.section.items.text.metadata.whatsapp.callPermissionResponse
string
Possible values: accept, reject
results.template.templateBody.section.items.text.metadata.whatsapp.previewUrl
boolean
必填
results.template.templateBody.section.items.text.metadata.whatsapp.sharedContacts
array of object
显示子属性
results.template.templateBody.section.items.text.metadata.whatsapp.sharedContacts.origin
string
必填
results.template.templateBody.section.items.text.metadata.whatsapp.sharedContacts.phones
array of object
显示子属性
results.template.templateBody.section.items.text.metadata.whatsapp.sharedContacts.phones.phone
string
必填
results.template.templateBody.section.items.text.metadata.whatsapp.sharedContacts.phones.type
string
必填
results.template.templateBody.section.items.text.metadata.whatsapp.sharedContacts.phones.waId
string
必填
results.template.templateBody.section.items.text.metadata.whatsapp.sharedContacts.vcard
string
results.template.templateBody.section.items.text.text
string
必填
results.template.templateBody.section.items.type
string
必填
Possible values: text
results.template.templateBody.section.items.html
object
必填
显示子属性
results.template.templateBody.section.items.html.actions
array of object
显示子属性
results.template.templateBody.section.items.html.actions.link
object
必填
显示子属性
results.template.templateBody.section.items.html.actions.link.metadata
object
显示子属性
results.template.templateBody.section.items.html.actions.link.metadata.description
object
显示子属性
results.template.templateBody.section.items.html.actions.link.metadata.description.label
string
必填
results.template.templateBody.section.items.html.actions.link.text
string
必填
results.template.templateBody.section.items.html.actions.link.url
string
必填
results.template.templateBody.section.items.html.actions.type
string
必填
Possible values: link
results.template.templateBody.section.items.html.actions.reply
object
必填
显示子属性
results.template.templateBody.section.items.html.actions.reply.imageUrl
string
results.template.templateBody.section.items.html.actions.reply.metadata
object
显示子属性
results.template.templateBody.section.items.html.actions.reply.metadata.description
object
显示子属性
results.template.templateBody.section.items.html.actions.reply.metadata.description.label
string
必填
results.template.templateBody.section.items.html.actions.reply.text
string
必填
results.template.templateBody.section.items.html.actions.type
string
必填
Possible values: reply
results.template.templateBody.section.items.html.actions.locationRequest
object
显示子属性
results.template.templateBody.section.items.html.actions.locationRequest.text
string
results.template.templateBody.section.items.html.actions.type
string
必填
Possible values: locationRequest
results.template.templateBody.section.items.html.actions.buy
object
必填
显示子属性
results.template.templateBody.section.items.html.actions.buy.amountCents
integer
必填
results.template.templateBody.section.items.html.actions.buy.currency
string
必填
results.template.templateBody.section.items.html.actions.buy.text
string
必填
results.template.templateBody.section.items.html.actions.type
string
必填
Possible values: buy
results.template.templateBody.section.items.html.actions.postback
object
必填
显示子属性
results.template.templateBody.section.items.html.actions.postback.handshake
object
显示子属性
results.template.templateBody.section.items.html.actions.postback.handshake.packageName
string
必填
results.template.templateBody.section.items.html.actions.postback.handshake.signatureHash
string
必填
results.template.templateBody.section.items.html.actions.postback.handshake.supportedApps
array of object
显示子属性
results.template.templateBody.section.items.html.actions.postback.handshake.supportedApps.packageName
string
必填
results.template.templateBody.section.items.html.actions.postback.handshake.supportedApps.signatureHash
string
必填
results.template.templateBody.section.items.html.actions.postback.handshake.text
string
必填
results.template.templateBody.section.items.html.actions.postback.handshake.zeroTapTermsAccepted
boolean
必填
results.template.templateBody.section.items.html.actions.postback.imageUrl
string
results.template.templateBody.section.items.html.actions.postback.metadata
object
显示子属性
results.template.templateBody.section.items.html.actions.postback.metadata.description
object
显示子属性
results.template.templateBody.section.items.html.actions.postback.metadata.description.label
string
必填
results.template.templateBody.section.items.html.actions.postback.otpType
string
results.template.templateBody.section.items.html.actions.postback.payload
string
results.template.templateBody.section.items.html.actions.postback.text
string
必填
results.template.templateBody.section.items.html.actions.type
string
必填
Possible values: postback
results.template.templateBody.section.items.html.attachments
array of object
显示子属性
results.template.templateBody.section.items.html.attachments.content
string
results.template.templateBody.section.items.html.attachments.contentId
string
results.template.templateBody.section.items.html.attachments.contentType
string
results.template.templateBody.section.items.html.attachments.filename
string
必填
results.template.templateBody.section.items.html.attachments.inline
boolean
results.template.templateBody.section.items.html.attachments.mediaUrl
string
results.template.templateBody.section.items.html.html
string
results.template.templateBody.section.items.html.metadata
object
显示子属性
results.template.templateBody.section.items.html.metadata.clickTracking
boolean
results.template.templateBody.section.items.html.metadata.from
object
显示子属性
results.template.templateBody.section.items.html.metadata.from.displayName
string
results.template.templateBody.section.items.html.metadata.from.username
string
results.template.templateBody.section.items.html.metadata.headers
object
results.template.templateBody.section.items.html.metadata.initialOpenTracking
boolean
results.template.templateBody.section.items.html.metadata.openTracking
boolean
results.template.templateBody.section.items.html.metadata.subject
string
results.template.templateBody.section.items.html.text
string
results.template.templateBody.section.items.type
string
必填
Possible values: html
results.template.templateBody.section.items.image
object
必填
显示子属性
results.template.templateBody.section.items.image.actions
array of object
显示子属性
results.template.templateBody.section.items.image.actions.link
object
必填
显示子属性
results.template.templateBody.section.items.image.actions.link.metadata
object
显示子属性
results.template.templateBody.section.items.image.actions.link.metadata.description
object
显示子属性
results.template.templateBody.section.items.image.actions.link.metadata.description.label
string
必填
results.template.templateBody.section.items.image.actions.link.text
string
必填
results.template.templateBody.section.items.image.actions.link.url
string
必填
results.template.templateBody.section.items.image.actions.type
string
必填
Possible values: link
results.template.templateBody.section.items.image.actions.reply
object
必填
显示子属性
results.template.templateBody.section.items.image.actions.reply.imageUrl
string
results.template.templateBody.section.items.image.actions.reply.metadata
object
显示子属性
results.template.templateBody.section.items.image.actions.reply.metadata.description
object
显示子属性
results.template.templateBody.section.items.image.actions.reply.metadata.description.label
string
必填
results.template.templateBody.section.items.image.actions.reply.text
string
必填
results.template.templateBody.section.items.image.actions.type
string
必填
Possible values: reply
results.template.templateBody.section.items.image.actions.locationRequest
object
显示子属性
results.template.templateBody.section.items.image.actions.locationRequest.text
string
results.template.templateBody.section.items.image.actions.type
string
必填
Possible values: locationRequest
results.template.templateBody.section.items.image.actions.buy
object
必填
显示子属性
results.template.templateBody.section.items.image.actions.buy.amountCents
integer
必填
results.template.templateBody.section.items.image.actions.buy.currency
string
必填
results.template.templateBody.section.items.image.actions.buy.text
string
必填
results.template.templateBody.section.items.image.actions.type
string
必填
Possible values: buy
results.template.templateBody.section.items.image.actions.postback
object
必填
显示子属性
results.template.templateBody.section.items.image.actions.postback.handshake
object
显示子属性
results.template.templateBody.section.items.image.actions.postback.handshake.packageName
string
必填
results.template.templateBody.section.items.image.actions.postback.handshake.signatureHash
string
必填
results.template.templateBody.section.items.image.actions.postback.handshake.supportedApps
array of object
显示子属性
results.template.templateBody.section.items.image.actions.postback.handshake.supportedApps.packageName
string
必填
results.template.templateBody.section.items.image.actions.postback.handshake.supportedApps.signatureHash
string
必填
results.template.templateBody.section.items.image.actions.postback.handshake.text
string
必填
results.template.templateBody.section.items.image.actions.postback.handshake.zeroTapTermsAccepted
boolean
必填
results.template.templateBody.section.items.image.actions.postback.imageUrl
string
results.template.templateBody.section.items.image.actions.postback.metadata
object
显示子属性
results.template.templateBody.section.items.image.actions.postback.metadata.description
object
显示子属性
results.template.templateBody.section.items.image.actions.postback.metadata.description.label
string
必填
results.template.templateBody.section.items.image.actions.postback.otpType
string
results.template.templateBody.section.items.image.actions.postback.payload
string
results.template.templateBody.section.items.image.actions.postback.text
string
必填
results.template.templateBody.section.items.image.actions.type
string
必填
Possible values: postback
results.template.templateBody.section.items.image.images
array of object
必填
显示子属性
results.template.templateBody.section.items.image.images.altText
string
results.template.templateBody.section.items.image.images.mediaPreviewUrl
string
results.template.templateBody.section.items.image.images.mediaUrl
string
必填
results.template.templateBody.section.items.image.metadata
object
显示子属性
results.template.templateBody.section.items.image.metadata.fallbackText
string
results.template.templateBody.section.items.image.metadata.storyType
string
Possible values: mention, reply
results.template.templateBody.section.items.image.metadata.subject
string
results.template.templateBody.section.items.image.metadata.telegram
object
显示子属性
results.template.templateBody.section.items.image.metadata.telegram.parseMode
string
results.template.templateBody.section.items.image.text
string
results.template.templateBody.section.items.type
string
必填
Possible values: image
results.template.templateBody.section.items.gif
object
必填
显示子属性
results.template.templateBody.section.items.gif.actions
array of object
显示子属性
results.template.templateBody.section.items.gif.actions.link
object
必填
显示子属性
results.template.templateBody.section.items.gif.actions.link.metadata
object
显示子属性
results.template.templateBody.section.items.gif.actions.link.metadata.description
object
显示子属性
results.template.templateBody.section.items.gif.actions.link.metadata.description.label
string
必填
results.template.templateBody.section.items.gif.actions.link.text
string
必填
results.template.templateBody.section.items.gif.actions.link.url
string
必填
results.template.templateBody.section.items.gif.actions.type
string
必填
Possible values: link
results.template.templateBody.section.items.gif.actions.reply
object
必填
显示子属性
results.template.templateBody.section.items.gif.actions.reply.imageUrl
string
results.template.templateBody.section.items.gif.actions.reply.metadata
object
显示子属性
results.template.templateBody.section.items.gif.actions.reply.metadata.description
object
显示子属性
results.template.templateBody.section.items.gif.actions.reply.metadata.description.label
string
必填
results.template.templateBody.section.items.gif.actions.reply.text
string
必填
results.template.templateBody.section.items.gif.actions.type
string
必填
Possible values: reply
results.template.templateBody.section.items.gif.actions.locationRequest
object
显示子属性
results.template.templateBody.section.items.gif.actions.locationRequest.text
string
results.template.templateBody.section.items.gif.actions.type
string
必填
Possible values: locationRequest
results.template.templateBody.section.items.gif.actions.buy
object
必填
显示子属性
results.template.templateBody.section.items.gif.actions.buy.amountCents
integer
必填
results.template.templateBody.section.items.gif.actions.buy.currency
string
必填
results.template.templateBody.section.items.gif.actions.buy.text
string
必填
results.template.templateBody.section.items.gif.actions.type
string
必填
Possible values: buy
results.template.templateBody.section.items.gif.actions.postback
object
必填
显示子属性
results.template.templateBody.section.items.gif.actions.postback.handshake
object
显示子属性
results.template.templateBody.section.items.gif.actions.postback.handshake.packageName
string
必填
results.template.templateBody.section.items.gif.actions.postback.handshake.signatureHash
string
必填
results.template.templateBody.section.items.gif.actions.postback.handshake.supportedApps
array of object
显示子属性
results.template.templateBody.section.items.gif.actions.postback.handshake.supportedApps.packageName
string
必填
results.template.templateBody.section.items.gif.actions.postback.handshake.supportedApps.signatureHash
string
必填
results.template.templateBody.section.items.gif.actions.postback.handshake.text
string
必填
results.template.templateBody.section.items.gif.actions.postback.handshake.zeroTapTermsAccepted
boolean
必填
results.template.templateBody.section.items.gif.actions.postback.imageUrl
string
results.template.templateBody.section.items.gif.actions.postback.metadata
object
显示子属性
results.template.templateBody.section.items.gif.actions.postback.metadata.description
object
显示子属性
results.template.templateBody.section.items.gif.actions.postback.metadata.description.label
string
必填
results.template.templateBody.section.items.gif.actions.postback.otpType
string
results.template.templateBody.section.items.gif.actions.postback.payload
string
results.template.templateBody.section.items.gif.actions.postback.text
string
必填
results.template.templateBody.section.items.gif.actions.type
string
必填
Possible values: postback
results.template.templateBody.section.items.gif.altText
string
results.template.templateBody.section.items.gif.mediaUrl
string
必填
results.template.templateBody.section.items.gif.metadata
object
显示子属性
results.template.templateBody.section.items.gif.metadata.telegram
object
显示子属性
results.template.templateBody.section.items.gif.metadata.telegram.parseMode
string
results.template.templateBody.section.items.gif.text
string
results.template.templateBody.section.items.type
string
必填
Possible values: gif
results.template.templateBody.section.items.file
object
必填
显示子属性
results.template.templateBody.section.items.file.actions
array of object
显示子属性
results.template.templateBody.section.items.file.actions.link
object
必填
显示子属性
results.template.templateBody.section.items.file.actions.link.metadata
object
显示子属性
results.template.templateBody.section.items.file.actions.link.metadata.description
object
显示子属性
results.template.templateBody.section.items.file.actions.link.metadata.description.label
string
必填
results.template.templateBody.section.items.file.actions.link.text
string
必填
results.template.templateBody.section.items.file.actions.link.url
string
必填
results.template.templateBody.section.items.file.actions.type
string
必填
Possible values: link
results.template.templateBody.section.items.file.actions.reply
object
必填
显示子属性
results.template.templateBody.section.items.file.actions.reply.imageUrl
string
results.template.templateBody.section.items.file.actions.reply.metadata
object
显示子属性
results.template.templateBody.section.items.file.actions.reply.metadata.description
object
显示子属性
results.template.templateBody.section.items.file.actions.reply.metadata.description.label
string
必填
results.template.templateBody.section.items.file.actions.reply.text
string
必填
results.template.templateBody.section.items.file.actions.type
string
必填
Possible values: reply
results.template.templateBody.section.items.file.actions.locationRequest
object
显示子属性
results.template.templateBody.section.items.file.actions.locationRequest.text
string
results.template.templateBody.section.items.file.actions.type
string
必填
Possible values: locationRequest
results.template.templateBody.section.items.file.actions.buy
object
必填
显示子属性
results.template.templateBody.section.items.file.actions.buy.amountCents
integer
必填
results.template.templateBody.section.items.file.actions.buy.currency
string
必填
results.template.templateBody.section.items.file.actions.buy.text
string
必填
results.template.templateBody.section.items.file.actions.type
string
必填
Possible values: buy
results.template.templateBody.section.items.file.actions.postback
object
必填
显示子属性
results.template.templateBody.section.items.file.actions.postback.handshake
object
显示子属性
results.template.templateBody.section.items.file.actions.postback.handshake.packageName
string
必填
results.template.templateBody.section.items.file.actions.postback.handshake.signatureHash
string
必填
results.template.templateBody.section.items.file.actions.postback.handshake.supportedApps
array of object
显示子属性
results.template.templateBody.section.items.file.actions.postback.handshake.supportedApps.packageName
string
必填
results.template.templateBody.section.items.file.actions.postback.handshake.supportedApps.signatureHash
string
必填
results.template.templateBody.section.items.file.actions.postback.handshake.text
string
必填
results.template.templateBody.section.items.file.actions.postback.handshake.zeroTapTermsAccepted
boolean
必填
results.template.templateBody.section.items.file.actions.postback.imageUrl
string
results.template.templateBody.section.items.file.actions.postback.metadata
object
显示子属性
results.template.templateBody.section.items.file.actions.postback.metadata.description
object
显示子属性
results.template.templateBody.section.items.file.actions.postback.metadata.description.label
string
必填
results.template.templateBody.section.items.file.actions.postback.otpType
string
results.template.templateBody.section.items.file.actions.postback.payload
string
results.template.templateBody.section.items.file.actions.postback.text
string
必填
results.template.templateBody.section.items.file.actions.type
string
必填
Possible values: postback
results.template.templateBody.section.items.file.files
array of object
必填
显示子属性
results.template.templateBody.section.items.file.files.altText
string
results.template.templateBody.section.items.file.files.contentType
string
必填
results.template.templateBody.section.items.file.files.filename
string
results.template.templateBody.section.items.file.files.mediaUrl
string
必填
results.template.templateBody.section.items.file.files.metadata
object
显示子属性
results.template.templateBody.section.items.file.files.metadata.isAnimated
boolean
results.template.templateBody.section.items.file.metadata
object
显示子属性
results.template.templateBody.section.items.file.metadata.fallbackText
string
results.template.templateBody.section.items.file.metadata.storyType
string
Possible values: mention, reply
results.template.templateBody.section.items.file.metadata.subject
string
results.template.templateBody.section.items.file.metadata.telegram
object
显示子属性
results.template.templateBody.section.items.file.metadata.telegram.parseMode
string
results.template.templateBody.section.items.file.text
string
results.template.templateBody.section.items.type
string
必填
Possible values: file
results.template.templateBody.section.items.location
object
必填
显示子属性
results.template.templateBody.section.items.location.coordinates
object
必填
显示子属性
results.template.templateBody.section.items.location.coordinates.latitude
number
必填
results.template.templateBody.section.items.location.coordinates.longitude
number
必填
results.template.templateBody.section.items.location.location
object
必填
显示子属性
results.template.templateBody.section.items.location.location.address
string
必填
results.template.templateBody.section.items.location.location.label
string
必填
results.template.templateBody.section.items.type
string
必填
Possible values: location
results.template.templateBody.section.items.carousel
object
必填
显示子属性
results.template.templateBody.section.items.carousel.items
array of object
显示子属性
results.template.templateBody.section.items.carousel.items.actions
array of object
显示子属性
results.template.templateBody.section.items.carousel.items.actions.link
object
必填
显示子属性
results.template.templateBody.section.items.carousel.items.actions.link.metadata
object
显示子属性
results.template.templateBody.section.items.carousel.items.actions.link.metadata.description
object
显示子属性
results.template.templateBody.section.items.carousel.items.actions.link.metadata.description.label
string
必填
results.template.templateBody.section.items.carousel.items.actions.link.text
string
必填
results.template.templateBody.section.items.carousel.items.actions.link.url
string
必填
results.template.templateBody.section.items.carousel.items.actions.type
string
必填
Possible values: link
results.template.templateBody.section.items.carousel.items.actions.reply
object
必填
显示子属性
results.template.templateBody.section.items.carousel.items.actions.reply.imageUrl
string
results.template.templateBody.section.items.carousel.items.actions.reply.metadata
object
显示子属性
results.template.templateBody.section.items.carousel.items.actions.reply.metadata.description
object
显示子属性
results.template.templateBody.section.items.carousel.items.actions.reply.metadata.description.label
string
必填
results.template.templateBody.section.items.carousel.items.actions.reply.text
string
必填
results.template.templateBody.section.items.carousel.items.actions.type
string
必填
Possible values: reply
results.template.templateBody.section.items.carousel.items.actions.locationRequest
object
显示子属性
results.template.templateBody.section.items.carousel.items.actions.locationRequest.text
string
results.template.templateBody.section.items.carousel.items.actions.type
string
必填
Possible values: locationRequest
results.template.templateBody.section.items.carousel.items.actions.buy
object
必填
显示子属性
results.template.templateBody.section.items.carousel.items.actions.buy.amountCents
integer
必填
results.template.templateBody.section.items.carousel.items.actions.buy.currency
string
必填
results.template.templateBody.section.items.carousel.items.actions.buy.text
string
必填
results.template.templateBody.section.items.carousel.items.actions.type
string
必填
Possible values: buy
results.template.templateBody.section.items.carousel.items.actions.postback
object
必填
显示子属性
results.template.templateBody.section.items.carousel.items.actions.postback.handshake
object
显示子属性
results.template.templateBody.section.items.carousel.items.actions.postback.handshake.packageName
string
必填
results.template.templateBody.section.items.carousel.items.actions.postback.handshake.signatureHash
string
必填
results.template.templateBody.section.items.carousel.items.actions.postback.handshake.supportedApps
array of object
显示子属性
results.template.templateBody.section.items.carousel.items.actions.postback.handshake.supportedApps.packageName
string
必填
results.template.templateBody.section.items.carousel.items.actions.postback.handshake.supportedApps.signatureHash
string
必填
results.template.templateBody.section.items.carousel.items.actions.postback.handshake.text
string
必填
results.template.templateBody.section.items.carousel.items.actions.postback.handshake.zeroTapTermsAccepted
boolean
必填
results.template.templateBody.section.items.carousel.items.actions.postback.imageUrl
string
results.template.templateBody.section.items.carousel.items.actions.postback.metadata
object
显示子属性
results.template.templateBody.section.items.carousel.items.actions.postback.metadata.description
object
显示子属性
results.template.templateBody.section.items.carousel.items.actions.postback.metadata.description.label
string
必填
results.template.templateBody.section.items.carousel.items.actions.postback.otpType
string
results.template.templateBody.section.items.carousel.items.actions.postback.payload
string
results.template.templateBody.section.items.carousel.items.actions.postback.text
string
必填
results.template.templateBody.section.items.carousel.items.actions.type
string
必填
Possible values: postback
results.template.templateBody.section.items.carousel.items.altText
string
results.template.templateBody.section.items.carousel.items.description
string
results.template.templateBody.section.items.carousel.items.mediaUrl
string
results.template.templateBody.section.items.carousel.items.size
integer
results.template.templateBody.section.items.carousel.items.title
string
results.template.templateBody.section.items.carousel.text
string
Optional text displayed above the carousel cards.
results.template.templateBody.section.items.type
string
必填
Possible values: carousel
results.template.templateBody.section.items.list
object
必填
显示子属性
results.template.templateBody.section.items.list.actions
array of object
显示子属性
results.template.templateBody.section.items.list.actions.link
object
必填
显示子属性
results.template.templateBody.section.items.list.actions.link.metadata
object
显示子属性
results.template.templateBody.section.items.list.actions.link.metadata.description
object
显示子属性
results.template.templateBody.section.items.list.actions.link.metadata.description.label
string
必填
results.template.templateBody.section.items.list.actions.link.text
string
必填
results.template.templateBody.section.items.list.actions.link.url
string
必填
results.template.templateBody.section.items.list.actions.type
string
必填
Possible values: link
results.template.templateBody.section.items.list.actions.reply
object
必填
显示子属性
results.template.templateBody.section.items.list.actions.reply.imageUrl
string
results.template.templateBody.section.items.list.actions.reply.metadata
object
显示子属性
results.template.templateBody.section.items.list.actions.reply.metadata.description
object
显示子属性
results.template.templateBody.section.items.list.actions.reply.metadata.description.label
string
必填
results.template.templateBody.section.items.list.actions.reply.text
string
必填
results.template.templateBody.section.items.list.actions.type
string
必填
Possible values: reply
results.template.templateBody.section.items.list.actions.locationRequest
object
显示子属性
results.template.templateBody.section.items.list.actions.locationRequest.text
string
results.template.templateBody.section.items.list.actions.type
string
必填
Possible values: locationRequest
results.template.templateBody.section.items.list.actions.buy
object
必填
显示子属性
results.template.templateBody.section.items.list.actions.buy.amountCents
integer
必填
results.template.templateBody.section.items.list.actions.buy.currency
string
必填
results.template.templateBody.section.items.list.actions.buy.text
string
必填
results.template.templateBody.section.items.list.actions.type
string
必填
Possible values: buy
results.template.templateBody.section.items.list.actions.postback
object
必填
显示子属性
results.template.templateBody.section.items.list.actions.postback.handshake
object
显示子属性
results.template.templateBody.section.items.list.actions.postback.handshake.packageName
string
必填
results.template.templateBody.section.items.list.actions.postback.handshake.signatureHash
string
必填
results.template.templateBody.section.items.list.actions.postback.handshake.supportedApps
array of object
显示子属性
results.template.templateBody.section.items.list.actions.postback.handshake.supportedApps.packageName
string
必填
results.template.templateBody.section.items.list.actions.postback.handshake.supportedApps.signatureHash
string
必填
results.template.templateBody.section.items.list.actions.postback.handshake.text
string
必填
results.template.templateBody.section.items.list.actions.postback.handshake.zeroTapTermsAccepted
boolean
必填
results.template.templateBody.section.items.list.actions.postback.imageUrl
string
results.template.templateBody.section.items.list.actions.postback.metadata
object
显示子属性
results.template.templateBody.section.items.list.actions.postback.metadata.description
object
显示子属性
results.template.templateBody.section.items.list.actions.postback.metadata.description.label
string
必填
results.template.templateBody.section.items.list.actions.postback.otpType
string
results.template.templateBody.section.items.list.actions.postback.payload
string
results.template.templateBody.section.items.list.actions.postback.text
string
必填
results.template.templateBody.section.items.list.actions.type
string
必填
Possible values: postback
results.template.templateBody.section.items.list.altText
string
results.template.templateBody.section.items.list.items
array of object
显示子属性
results.template.templateBody.section.items.list.items.actions
array of object
显示子属性
results.template.templateBody.section.items.list.items.actions.link
object
必填
显示子属性
results.template.templateBody.section.items.list.items.actions.link.metadata
object
显示子属性
results.template.templateBody.section.items.list.items.actions.link.metadata.description
object
显示子属性
results.template.templateBody.section.items.list.items.actions.link.metadata.description.label
string
必填
results.template.templateBody.section.items.list.items.actions.link.text
string
必填
results.template.templateBody.section.items.list.items.actions.link.url
string
必填
results.template.templateBody.section.items.list.items.actions.type
string
必填
Possible values: link
results.template.templateBody.section.items.list.items.actions.reply
object
必填
显示子属性
results.template.templateBody.section.items.list.items.actions.reply.imageUrl
string
results.template.templateBody.section.items.list.items.actions.reply.metadata
object
显示子属性
results.template.templateBody.section.items.list.items.actions.reply.metadata.description
object
显示子属性
results.template.templateBody.section.items.list.items.actions.reply.metadata.description.label
string
必填
results.template.templateBody.section.items.list.items.actions.reply.text
string
必填
results.template.templateBody.section.items.list.items.actions.type
string
必填
Possible values: reply
results.template.templateBody.section.items.list.items.actions.locationRequest
object
显示子属性
results.template.templateBody.section.items.list.items.actions.locationRequest.text
string
results.template.templateBody.section.items.list.items.actions.type
string
必填
Possible values: locationRequest
results.template.templateBody.section.items.list.items.actions.buy
object
必填
显示子属性
results.template.templateBody.section.items.list.items.actions.buy.amountCents
integer
必填
results.template.templateBody.section.items.list.items.actions.buy.currency
string
必填
results.template.templateBody.section.items.list.items.actions.buy.text
string
必填
results.template.templateBody.section.items.list.items.actions.type
string
必填
Possible values: buy
results.template.templateBody.section.items.list.items.actions.postback
object
必填
显示子属性
results.template.templateBody.section.items.list.items.actions.postback.handshake
object
显示子属性
results.template.templateBody.section.items.list.items.actions.postback.handshake.packageName
string
必填
results.template.templateBody.section.items.list.items.actions.postback.handshake.signatureHash
string
必填
results.template.templateBody.section.items.list.items.actions.postback.handshake.supportedApps
array of object
显示子属性
results.template.templateBody.section.items.list.items.actions.postback.handshake.supportedApps.packageName
string
必填
results.template.templateBody.section.items.list.items.actions.postback.handshake.supportedApps.signatureHash
string
必填
results.template.templateBody.section.items.list.items.actions.postback.handshake.text
string
必填
results.template.templateBody.section.items.list.items.actions.postback.handshake.zeroTapTermsAccepted
boolean
必填
results.template.templateBody.section.items.list.items.actions.postback.imageUrl
string
results.template.templateBody.section.items.list.items.actions.postback.metadata
object
显示子属性
results.template.templateBody.section.items.list.items.actions.postback.metadata.description
object
显示子属性
results.template.templateBody.section.items.list.items.actions.postback.metadata.description.label
string
必填
results.template.templateBody.section.items.list.items.actions.postback.otpType
string
results.template.templateBody.section.items.list.items.actions.postback.payload
string
results.template.templateBody.section.items.list.items.actions.postback.text
string
必填
results.template.templateBody.section.items.list.items.actions.type
string
必填
Possible values: postback
results.template.templateBody.section.items.list.items.altText
string
results.template.templateBody.section.items.list.items.description
string
results.template.templateBody.section.items.list.items.mediaUrl
string
results.template.templateBody.section.items.list.items.size
integer
results.template.templateBody.section.items.list.items.title
string
results.template.templateBody.section.items.list.metadata
object
显示子属性
results.template.templateBody.section.items.list.metadata.button
object
显示子属性
results.template.templateBody.section.items.list.metadata.button.label
string
必填
results.template.templateBody.section.items.list.metadata.replyMessage
object
显示子属性
results.template.templateBody.section.items.list.metadata.replyMessage.text
string
必填
results.template.templateBody.section.items.list.metadata.replyMessage.title
string
必填
results.template.templateBody.section.items.list.text
string
results.template.templateBody.section.items.list.title
string
results.template.templateBody.section.items.type
string
必填
Possible values: list
results.template.templateBody.section.items.section
object
必填
results.template.templateBody.section.items.type
string
必填
Possible values: section
results.template.templateBody.section.items.authentication
object
必填
显示子属性
results.template.templateBody.section.items.authentication.otp
object
显示子属性
results.template.templateBody.section.items.authentication.otp.actions
array of object
显示子属性
results.template.templateBody.section.items.authentication.otp.actions.link
object
必填
显示子属性
results.template.templateBody.section.items.authentication.otp.actions.link.metadata
object
显示子属性
results.template.templateBody.section.items.authentication.otp.actions.link.metadata.description
object
显示子属性
results.template.templateBody.section.items.authentication.otp.actions.link.metadata.description.label
string
必填
results.template.templateBody.section.items.authentication.otp.actions.link.text
string
必填
results.template.templateBody.section.items.authentication.otp.actions.link.url
string
必填
results.template.templateBody.section.items.authentication.otp.actions.type
string
必填
Possible values: link
results.template.templateBody.section.items.authentication.otp.actions.reply
object
必填
显示子属性
results.template.templateBody.section.items.authentication.otp.actions.reply.imageUrl
string
results.template.templateBody.section.items.authentication.otp.actions.reply.metadata
object
显示子属性
results.template.templateBody.section.items.authentication.otp.actions.reply.metadata.description
object
显示子属性
results.template.templateBody.section.items.authentication.otp.actions.reply.metadata.description.label
string
必填
results.template.templateBody.section.items.authentication.otp.actions.reply.text
string
必填
results.template.templateBody.section.items.authentication.otp.actions.type
string
必填
Possible values: reply
results.template.templateBody.section.items.authentication.otp.actions.locationRequest
object
显示子属性
results.template.templateBody.section.items.authentication.otp.actions.locationRequest.text
string
results.template.templateBody.section.items.authentication.otp.actions.type
string
必填
Possible values: locationRequest
results.template.templateBody.section.items.authentication.otp.actions.buy
object
必填
显示子属性
results.template.templateBody.section.items.authentication.otp.actions.buy.amountCents
integer
必填
results.template.templateBody.section.items.authentication.otp.actions.buy.currency
string
必填
results.template.templateBody.section.items.authentication.otp.actions.buy.text
string
必填
results.template.templateBody.section.items.authentication.otp.actions.type
string
必填
Possible values: buy
results.template.templateBody.section.items.authentication.otp.actions.postback
object
必填
显示子属性
results.template.templateBody.section.items.authentication.otp.actions.postback.handshake
object
显示子属性
results.template.templateBody.section.items.authentication.otp.actions.postback.handshake.packageName
string
必填
results.template.templateBody.section.items.authentication.otp.actions.postback.handshake.signatureHash
string
必填
results.template.templateBody.section.items.authentication.otp.actions.postback.handshake.supportedApps
array of object
显示子属性
results.template.templateBody.section.items.authentication.otp.actions.postback.handshake.supportedApps.packageName
string
必填
results.template.templateBody.section.items.authentication.otp.actions.postback.handshake.supportedApps.signatureHash
string
必填
results.template.templateBody.section.items.authentication.otp.actions.postback.handshake.text
string
必填
results.template.templateBody.section.items.authentication.otp.actions.postback.handshake.zeroTapTermsAccepted
boolean
必填
results.template.templateBody.section.items.authentication.otp.actions.postback.imageUrl
string
results.template.templateBody.section.items.authentication.otp.actions.postback.metadata
object
显示子属性
results.template.templateBody.section.items.authentication.otp.actions.postback.metadata.description
object
显示子属性
results.template.templateBody.section.items.authentication.otp.actions.postback.metadata.description.label
string
必填
results.template.templateBody.section.items.authentication.otp.actions.postback.otpType
string
results.template.templateBody.section.items.authentication.otp.actions.postback.payload
string
results.template.templateBody.section.items.authentication.otp.actions.postback.text
string
必填
results.template.templateBody.section.items.authentication.otp.actions.type
string
必填
Possible values: postback
results.template.templateBody.section.items.authentication.otp.disclaimer
boolean
必填
Whether to add a security disclaimer to the authentication body.
results.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.
results.template.templateBody.section.items.type
string
必填
Possible values: authentication
results.template.templateBody.section.items.action
object
必填
显示子属性
results.template.templateBody.section.items.action.action
string
必填
Possible values: permissionRequest
results.template.templateBody.section.items.action.permissionRequest
object
必填
显示子属性
results.template.templateBody.section.items.action.permissionRequest.resource
string
必填
Possible values: call
results.template.templateBody.section.items.type
string
必填
Possible values: action
results.template.templateBody.type
string
必填
Possible values: section
results.template.templateBody.authentication
object
必填
显示子属性
results.template.templateBody.authentication.otp
object
显示子属性
results.template.templateBody.authentication.otp.actions
array of object
显示子属性
results.template.templateBody.authentication.otp.actions.link
object
必填
显示子属性
results.template.templateBody.authentication.otp.actions.link.metadata
object
显示子属性
results.template.templateBody.authentication.otp.actions.link.metadata.description
object
显示子属性
results.template.templateBody.authentication.otp.actions.link.metadata.description.label
string
必填
results.template.templateBody.authentication.otp.actions.link.text
string
必填
results.template.templateBody.authentication.otp.actions.link.url
string
必填
results.template.templateBody.authentication.otp.actions.type
string
必填
Possible values: link
results.template.templateBody.authentication.otp.actions.reply
object
必填
显示子属性
results.template.templateBody.authentication.otp.actions.reply.imageUrl
string
results.template.templateBody.authentication.otp.actions.reply.metadata
object
显示子属性
results.template.templateBody.authentication.otp.actions.reply.metadata.description
object
显示子属性
results.template.templateBody.authentication.otp.actions.reply.metadata.description.label
string
必填
results.template.templateBody.authentication.otp.actions.reply.text
string
必填
results.template.templateBody.authentication.otp.actions.type
string
必填
Possible values: reply
results.template.templateBody.authentication.otp.actions.locationRequest
object
显示子属性
results.template.templateBody.authentication.otp.actions.locationRequest.text
string
results.template.templateBody.authentication.otp.actions.type
string
必填
Possible values: locationRequest
results.template.templateBody.authentication.otp.actions.buy
object
必填
显示子属性
results.template.templateBody.authentication.otp.actions.buy.amountCents
integer
必填
results.template.templateBody.authentication.otp.actions.buy.currency
string
必填
results.template.templateBody.authentication.otp.actions.buy.text
string
必填
results.template.templateBody.authentication.otp.actions.type
string
必填
Possible values: buy
results.template.templateBody.authentication.otp.actions.postback
object
必填
显示子属性
results.template.templateBody.authentication.otp.actions.postback.handshake
object
显示子属性
results.template.templateBody.authentication.otp.actions.postback.handshake.packageName
string
必填
results.template.templateBody.authentication.otp.actions.postback.handshake.signatureHash
string
必填
results.template.templateBody.authentication.otp.actions.postback.handshake.supportedApps
array of object
显示子属性
results.template.templateBody.authentication.otp.actions.postback.handshake.supportedApps.packageName
string
必填
results.template.templateBody.authentication.otp.actions.postback.handshake.supportedApps.signatureHash
string
必填
results.template.templateBody.authentication.otp.actions.postback.handshake.text
string
必填
results.template.templateBody.authentication.otp.actions.postback.handshake.zeroTapTermsAccepted
boolean
必填
results.template.templateBody.authentication.otp.actions.postback.imageUrl
string
results.template.templateBody.authentication.otp.actions.postback.metadata
object
显示子属性
results.template.templateBody.authentication.otp.actions.postback.metadata.description
object
显示子属性
results.template.templateBody.authentication.otp.actions.postback.metadata.description.label
string
必填
results.template.templateBody.authentication.otp.actions.postback.otpType
string
results.template.templateBody.authentication.otp.actions.postback.payload
string
results.template.templateBody.authentication.otp.actions.postback.text
string
必填
results.template.templateBody.authentication.otp.actions.type
string
必填
Possible values: postback
results.template.templateBody.authentication.otp.disclaimer
boolean
必填
Whether to add a security disclaimer to the authentication body.
results.template.templateBody.authentication.otp.expirationTime
integer
The number of seconds after which the authentication code expires. If not set, no expiration notification is sent.
results.template.templateBody.type
string
必填
Possible values: authentication
results.template.templateBody.action
object
必填
显示子属性
results.template.templateBody.action.action
string
必填
Possible values: permissionRequest
results.template.templateBody.action.permissionRequest
object
必填
显示子属性
results.template.templateBody.action.permissionRequest.resource
string
必填
Possible values: call
results.template.templateBody.type
string
必填
Possible values: action
results.template.utmParameters
array of object
显示子属性
results.template.utmParameters.key
string
必填
results.template.utmParameters.value
string
必填
results.template.utmParameters.key
string
必填
results.template.utmParameters.reference
string
必填
Possible values: platform_name, channel_name
results.template.variables
object
results.template.version
string
必填
The version of the template.
results.type
string
Possible values: text, html, image, file, gif, location, carousel, list, section, authentication, action
results.updatedAt
string
必填
nextPageToken
string
The token that can be passed as pageToken in URL to retrieve the next set of results. If missing, no more results to display.
total
integer
totalType
string
Possible values: ``, equal, greaterThanOrEqual
代码示例
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/conversations/{conversationId}/messages' \
-H 'Authorization: AccessKey YOUR_ACCESS_KEY'Examples
代码示例
curl "https://api.bird.com/workspaces/a1405560-c8d3-4b1a-877d-3f449ad95352/conversations/16e1df9e-c6ac-406b-b1ce-13f34d0dea08/messages" \
-H "Authorization: AccessKey abcd"代码示例
{
"results": [
{
"id": "0c854061-6026-48c7-a2e8-bffb6458727b",
"conversationId": "16e1df9e-c6ac-406b-b1ce-13f34d0dea08",
"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": "some.customer@example.com",
"platformAddress": "some.customer@example.com",
"contactAnnotation": {
"name": "John Doe"
}
}
],
"status": "delivered",
"source": "conversations",
"body": {
"type": "text",
"text": {
"text": "Hey, listen!"
}
},
"interactions": null,
"createdAt": "2024-11-25T20:12:10.514Z",
"updatedAt": "2024-11-25T20:12:35.281Z"
},
{
"id": "3e75a9d2-2a54-45ac-856a-bbe02f874332",
"conversationId": "16e1df9e-c6ac-406b-b1ce-13f34d0dea08",
"reference": "3e75a9d2-2a54-45ac-856a-bbe02f874332",
"sender": {
"id": "8f0b5377-2edc-4116-a8e8-6a475f245a04",
"type": "contact",
"status": "active",
"displayName": "John Doe",
"avatarUrl": "",
"contact": {
"identifierKey": "emailaddress",
"identifierValue": "some.customer@example.com",
"platformAddress": "some.customer@example.com",
}
},
"draft": false,
"status": "delivered",
"source": "channels",
"body": {
"type": "html",
"html": {
"text": "test\r\n",
"html": "<p>test</p>"
}
},
"interactions": null,
"createdAt": "2024-11-25T19:31:47.264Z",
"updatedAt": "2024-11-25T19:31:47.264Z",
"meta": {
"extraInformation": {
"email_headers": "eyJTdWJqZWN0IjpbInRlc3QiXX0="
}
},
"receiverTypes": [
"to"
]
}
]
}Note: if the conversation has more than 10 messages, the results may be paginated. Please refer to Pagination on how to use nextPageToken.