DocumentatieEngagement Platform API
Sign inGet started
Guides
API

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.
Padparameters
conversationId
string
The conversation ID
Queryparameters
limit
integer
pageToken
string
reverse
boolean
dateFrom
string
Filter by created date after this date.
Antwoord-payload
results
array of object
List of messages in the conversation.
Onderliggende attributen tonen
results.body
object
Onderliggende attributen tonen
results.body.text
object
verplicht
Onderliggende attributen tonen
results.body.text.actions
array of object
Onderliggende attributen tonen
results.body.text.actions.link
object
verplicht
Onderliggende attributen tonen
results.body.text.actions.link.metadata
object
Onderliggende attributen tonen
results.body.text.actions.link.metadata.description
object
Onderliggende attributen tonen
results.body.text.actions.link.metadata.description.label
string
verplicht
results.body.text.actions.link.text
string
verplicht
results.body.text.actions.link.url
string
verplicht
results.body.text.actions.type
string
verplicht
Possible values: link
results.body.text.attachments
array of object
Onderliggende attributen tonen
results.body.text.attachments.content
string
results.body.text.attachments.contentId
string
results.body.text.attachments.contentType
string
results.body.text.attachments.filename
string
verplicht
results.body.text.attachments.inline
boolean
results.body.text.attachments.mediaUrl
string
verplicht
results.body.text.metadata
object
Onderliggende attributen tonen
results.body.text.metadata.apple
object
Onderliggende attributen tonen
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
Onderliggende attributen tonen
results.body.text.metadata.line.emoji
object
Onderliggende attributen tonen
results.body.text.metadata.line.emoji.items
array of object
Onderliggende attributen tonen
results.body.text.metadata.line.emoji.items.emojiId
string
verplicht
results.body.text.metadata.line.emoji.items.index
integer
verplicht
results.body.text.metadata.line.emoji.items.length
integer
results.body.text.metadata.line.emoji.items.productId
string
verplicht
results.body.text.metadata.paymentDetails
object
Onderliggende attributen tonen
results.body.text.metadata.paymentDetails.amount
string
verplicht
results.body.text.metadata.paymentDetails.currency
string
verplicht
results.body.text.metadata.paymentDetails.sessionIdentifier
string
results.body.text.metadata.paymentDetails.state
string
verplicht
results.body.text.metadata.subject
string
results.body.text.metadata.telegram
object
Onderliggende attributen tonen
results.body.text.metadata.telegram.parseMode
string
results.body.text.metadata.whatsapp
object
Onderliggende attributen tonen
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
verplicht
results.body.text.metadata.whatsapp.sharedContacts
array of object
Onderliggende attributen tonen
results.body.text.metadata.whatsapp.sharedContacts.origin
string
verplicht
results.body.text.metadata.whatsapp.sharedContacts.phones
array of object
Onderliggende attributen tonen
results.body.text.metadata.whatsapp.sharedContacts.phones.phone
string
verplicht
results.body.text.metadata.whatsapp.sharedContacts.phones.type
string
verplicht
results.body.text.metadata.whatsapp.sharedContacts.phones.waId
string
verplicht
results.body.text.metadata.whatsapp.sharedContacts.vcard
string
results.body.text.text
string
verplicht
results.body.type
string
verplicht
Possible values: text
results.channelId
string
results.conversationCreatedAt
string
results.conversationId
string
verplicht
results.createdAt
string
verplicht
results.draft
boolean
verplicht
Whether this message is a draft.
results.draftMeta
object
Metadata for draft messages.
Onderliggende attributen tonen
results.draftMeta.creatorType
string
verplicht
Possible values: user, bot
results.id
string
verplicht
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).
Onderliggende attributen tonen
results.interactions.bodyTemplateProjectId
string
results.interactions.channelId
string
verplicht
results.interactions.context
object
verplicht
Onderliggende attributen tonen
results.interactions.context.id
string
results.interactions.context.tagIds
array of string
results.interactions.context.type
string
results.interactions.createdAt
string
verplicht
results.interactions.details
string
results.interactions.id
string
verplicht
results.interactions.isFirstInteraction
boolean
results.interactions.isFirstInteractionIncludingBots
boolean
results.interactions.journey
object
Onderliggende attributen tonen
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
verplicht
results.interactions.messagePartsCount
integer
verplicht
results.interactions.messageReference
string
verplicht
results.interactions.messageTags
array of string
results.interactions.metadata
object
Onderliggende attributen tonen
results.interactions.metadata.button
object
Onderliggende attributen tonen
results.interactions.metadata.button.payload
string
verplicht
results.interactions.metadata.conversion
object
Onderliggende attributen tonen
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
Onderliggende attributen tonen
results.interactions.metadata.link.clickType
string
Possible values: link, button
results.interactions.metadata.link.name
string
verplicht
results.interactions.metadata.link.url
string
verplicht
results.interactions.metadata.prefetched
boolean
results.interactions.metadata.reaction
object
Onderliggende attributen tonen
results.interactions.metadata.reaction.action
string
verplicht
Possible values: react, unreact
results.interactions.metadata.reaction.emoji
string
verplicht
results.interactions.metadata.renderedContentBlocks
array of string
results.interactions.metadata.subscriptionList
object
Onderliggende attributen tonen
results.interactions.metadata.subscriptionList.subscriptionListId
string
verplicht
results.interactions.notification
object
Onderliggende attributen tonen
results.interactions.notification.template
string
results.interactions.notification.url
string
verplicht
results.interactions.platformId
string
verplicht
results.interactions.platformReferenceId
string
results.interactions.receiver
object
verplicht
Onderliggende attributen tonen
results.interactions.receiver.connector
object
Onderliggende attributen tonen
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.
Onderliggende attributen tonen
results.interactions.receiver.connector.annotations.name
string
results.interactions.receiver.connector.id
string
verplicht
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
Onderliggende attributen tonen
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.
Onderliggende attributen tonen
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.
Onderliggende attributen tonen
results.interactions.receiver.contacts.identifiers.identifierKey
string
verplicht
The identifier key for finding the contact (e.g. emailaddress, phonenumber).
results.interactions.receiver.contacts.identifiers.identifierValue
string
verplicht
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
Onderliggende attributen tonen
results.interactions.receiver.device.gateway
string
verplicht
Possible values: firebase, apns, web
results.interactions.receiver.device.id
string
verplicht
results.interactions.receiver.device.identifierValue
string
verplicht
results.interactions.receiver.inbox
object
Onderliggende attributen tonen
results.interactions.receiver.inbox.emailRecipientType
string
results.interactions.receiver.inbox.id
string
verplicht
results.interactions.receiver.inbox.identifierKey
string
verplicht
results.interactions.receiver.inbox.identifierValue
string
verplicht
results.interactions.receiver.inbox.type
string
verplicht
Possible values: user, group
results.interactions.receiver.userContacts
array of object
Onderliggende attributen tonen
results.interactions.receiver.userContacts.id
string
verplicht
results.interactions.receiver.userContacts.identifierKey
string
verplicht
results.interactions.receiver.userContacts.identifierValue
string
verplicht
results.interactions.receiver.userContacts.type
string
results.interactions.type
string
verplicht
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
Onderliggende attributen tonen
results.meta.campaign
object
Onderliggende attributen tonen
results.meta.campaign.id
string
results.meta.campaign.name
string
results.meta.campaignId
string
results.meta.chargeOnceDelivered
boolean
results.meta.email
object
Onderliggende attributen tonen
results.meta.email.from
object
Onderliggende attributen tonen
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
Onderliggende attributen tonen
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
Onderliggende attributen tonen
results.meta.formResponse.id
string
verplicht
results.meta.formResponse.jsonResponse
string
verplicht
results.meta.formResponse.requestIdentifier
string
verplicht
results.meta.formResponse.selections
array of object
Onderliggende attributen tonen
results.meta.formResponse.selections.items
array of object
Onderliggende attributen tonen
results.meta.formResponse.selections.items.identifier
string
verplicht
results.meta.formResponse.selections.items.title
string
verplicht
results.meta.formResponse.selections.items.type
string
verplicht
results.meta.formResponse.selections.items.value
string
verplicht
results.meta.formResponse.selections.pageIdentifier
string
verplicht
results.meta.formResponse.selections.subtitle
string
verplicht
results.meta.formResponse.selections.title
string
verplicht
results.meta.formResponse.sessionIdentifier
string
verplicht
results.meta.formResponse.template
string
verplicht
results.meta.formResponse.version
string
verplicht
results.meta.ignoreGlobalHoldout
boolean
results.meta.ignoreQuietHours
boolean
results.meta.journey
object
Onderliggende attributen tonen
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.
Onderliggende attributen tonen
results.meta.order.products
array of object
Onderliggende attributen tonen
results.meta.order.products.externalCatalogId
string
The platform-specific catalog ID of the product.
results.meta.order.products.externalProductId
string
verplicht
The platform-specific product ID.
results.meta.order.products.price
object
verplicht
Onderliggende attributen tonen
results.meta.order.products.price.amount
integer
verplicht
results.meta.order.products.price.currencyCode
string
verplicht
results.meta.order.products.price.exponent
integer
verplicht
results.meta.order.products.quantity
integer
verplicht
The number of items purchased.
results.meta.pushNotifications
object
Onderliggende attributen tonen
results.meta.pushNotifications.gatewayTypeOverride
string
Possible values: firebase, apns, web
results.meta.referral
object
Onderliggende attributen tonen
results.meta.referral.group
string
results.meta.referral.metadata
object
Onderliggende attributen tonen
results.meta.referral.metadata.caption
string
results.meta.referral.metadata.mediaType
string
results.meta.referral.metadata.mediaUrl
string
results.meta.referral.metadata.sourceId
string
verplicht
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
verplicht
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).
Onderliggende attributen tonen
results.meta.referredProduct.externalCatalogId
string
The platform-specific catalog ID of the product.
results.meta.referredProduct.externalProductId
string
verplicht
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
Onderliggende attributen tonen
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
Onderliggende attributen tonen
results.meta.sms.smpp.segments
array of object
Onderliggende attributen tonen
results.meta.sms.smpp.segments.id
string
verplicht
results.meta.sms.smpp.segments.registeredDelivery
string
verplicht
Possible values: final, intermediate, all, noDlr
results.meta.sms.smpp.userId
string
verplicht
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
Onderliggende attributen tonen
results.receiver.connector
object
Onderliggende attributen tonen
results.receiver.connector.annotations
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Onderliggende attributen tonen
results.receiver.connector.annotations.name
string
results.receiver.connector.id
string
verplicht
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
Onderliggende attributen tonen
results.receiver.contacts.contactAnnotation
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Onderliggende attributen tonen
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.
Onderliggende attributen tonen
results.receiver.contacts.identifiers.identifierKey
string
verplicht
The identifier key for finding the contact (e.g. emailaddress, phonenumber).
results.receiver.contacts.identifiers.identifierValue
string
verplicht
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
Onderliggende attributen tonen
results.receiver.device.gateway
string
verplicht
Possible values: firebase, apns, web
results.receiver.device.id
string
verplicht
results.receiver.device.identifierValue
string
verplicht
results.receiver.inbox
object
Onderliggende attributen tonen
results.receiver.inbox.emailRecipientType
string
results.receiver.inbox.id
string
verplicht
results.receiver.inbox.identifierKey
string
verplicht
results.receiver.inbox.identifierValue
string
verplicht
results.receiver.inbox.type
string
verplicht
Possible values: user, group
results.receiver.userContacts
array of object
Onderliggende attributen tonen
results.receiver.userContacts.id
string
verplicht
results.receiver.userContacts.identifierKey
string
verplicht
results.receiver.userContacts.identifierValue
string
verplicht
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
Onderliggende attributen tonen
results.recipients.contactAnnotation
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Onderliggende attributen tonen
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.
Onderliggende attributen tonen
results.recipients.identifiers.identifierKey
string
verplicht
The identifier key for finding the contact (e.g. emailaddress, phonenumber).
results.recipients.identifiers.identifierValue
string
verplicht
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
verplicht
A customizable ID assigned to messages you send. Can be used to correlate messages with data from your own services. Must be globally unique within a workspace.
results.replyTo
object
Onderliggende attributen tonen
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
verplicht
Onderliggende attributen tonen
results.sender.email
string
results.sender.name
string
results.sender.avatarUrl
string
results.sender.contact
object
Onderliggende attributen tonen
results.sender.contact.identifierKey
string
verplicht
results.sender.contact.identifierValue
string
verplicht
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
verplicht
results.sender.resourceUri
string
results.sender.status
string
Possible values: invited, pending, active, inactive
results.sender.type
string
verplicht
Possible values: user, contact, agent, flow, bot, accessKey, channel, connector, collaborationAutomation
results.sender.updatedAt
string
results.source
string
verplicht
Possible values: conversations, channels, bots, external
results.status
string
verplicht
Possible values: accepted, processing, sent, sending_failed, delivered, delivery_failed, deleted
results.template
object
Onderliggende attributen tonen
results.template.attachments
array of object
Onderliggende attributen tonen
results.template.attachments.content
string
results.template.attachments.contentType
string
results.template.attachments.filename
string
verplicht
results.template.attachments.inline
boolean
verplicht
results.template.attachments.mediaUrl
string
verplicht
results.template.deployment
object
results.template.locale
string
verplicht
results.template.name
string
The platform name of the template.
results.template.parameters
array of object
Onderliggende attributen tonen
results.template.parameters.key
string
verplicht
results.template.parameters.sourceUrl
object
Onderliggende attributen tonen
results.template.parameters.sourceUrl.fullyReplaced
boolean
verplicht
results.template.parameters.sourceUrl.value
string
verplicht
results.template.parameters.type
string
verplicht
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
verplicht
results.template.projectId
string
verplicht
The ID of the project from Studio.
results.template.settings
object
Onderliggende attributen tonen
results.template.settings.disallowMmLite
boolean
results.template.shortLinks
object
Onderliggende attributen tonen
results.template.shortLinks.domain
string
verplicht
The domain to use when shortening links. When set to default, uses the default link shortening domain for the workspace.
results.template.shortLinks.enabled
boolean
verplicht
Enables link shortening for SMS messages.
results.template.templateBody
object
Onderliggende attributen tonen
results.template.templateBody.text
object
verplicht
Onderliggende attributen tonen
results.template.templateBody.text.actions
array of object
Onderliggende attributen tonen
results.template.templateBody.text.actions.link
object
verplicht
Onderliggende attributen tonen
results.template.templateBody.text.actions.link.metadata
object
Onderliggende attributen tonen
results.template.templateBody.text.actions.link.metadata.description
object
Onderliggende attributen tonen
results.template.templateBody.text.actions.link.metadata.description.label
string
verplicht
results.template.templateBody.text.actions.link.text
string
verplicht
results.template.templateBody.text.actions.link.url
string
verplicht
results.template.templateBody.text.actions.type
string
verplicht
Possible values: link
results.template.templateBody.text.attachments
array of object
Onderliggende attributen tonen
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
verplicht
results.template.templateBody.text.attachments.inline
boolean
results.template.templateBody.text.attachments.mediaUrl
string
verplicht
results.template.templateBody.text.metadata
object
Onderliggende attributen tonen
results.template.templateBody.text.metadata.apple
object
Onderliggende attributen tonen
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
Onderliggende attributen tonen
results.template.templateBody.text.metadata.line.emoji
object
Onderliggende attributen tonen
results.template.templateBody.text.metadata.line.emoji.items
array of object
Onderliggende attributen tonen
results.template.templateBody.text.metadata.line.emoji.items.emojiId
string
verplicht
results.template.templateBody.text.metadata.line.emoji.items.index
integer
verplicht
results.template.templateBody.text.metadata.line.emoji.items.length
integer
results.template.templateBody.text.metadata.line.emoji.items.productId
string
verplicht
results.template.templateBody.text.metadata.paymentDetails
object
Onderliggende attributen tonen
results.template.templateBody.text.metadata.paymentDetails.amount
string
verplicht
results.template.templateBody.text.metadata.paymentDetails.currency
string
verplicht
results.template.templateBody.text.metadata.paymentDetails.sessionIdentifier
string
results.template.templateBody.text.metadata.paymentDetails.state
string
verplicht
results.template.templateBody.text.metadata.subject
string
results.template.templateBody.text.metadata.telegram
object
Onderliggende attributen tonen
results.template.templateBody.text.metadata.telegram.parseMode
string
results.template.templateBody.text.metadata.whatsapp
object
Onderliggende attributen tonen
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
verplicht
results.template.templateBody.text.metadata.whatsapp.sharedContacts
array of object
Onderliggende attributen tonen
results.template.templateBody.text.metadata.whatsapp.sharedContacts.origin
string
verplicht
results.template.templateBody.text.metadata.whatsapp.sharedContacts.phones
array of object
Onderliggende attributen tonen
results.template.templateBody.text.metadata.whatsapp.sharedContacts.phones.phone
string
verplicht
results.template.templateBody.text.metadata.whatsapp.sharedContacts.phones.type
string
verplicht
results.template.templateBody.text.metadata.whatsapp.sharedContacts.phones.waId
string
verplicht
results.template.templateBody.text.metadata.whatsapp.sharedContacts.vcard
string
results.template.templateBody.text.text
string
verplicht
results.template.templateBody.type
string
verplicht
Possible values: text
results.template.utmParameters
array of object
Onderliggende attributen tonen
results.template.utmParameters.key
string
verplicht
results.template.utmParameters.value
string
verplicht
results.template.variables
object
results.template.version
string
verplicht
The version of the template.
results.type
string
Possible values: text, html, image, file, gif, location, carousel, list, section, authentication, action
results.updatedAt
string
verplicht
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
Codevoorbeeld
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/conversations/{conversationId}/messages' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'

Examples

Codevoorbeeld
curl "https://api.bird.com/workspaces/a1405560-c8d3-4b1a-877d-3f449ad95352/conversations/16e1df9e-c6ac-406b-b1ce-13f34d0dea08/messages" \
-H "Authorization: AccessKey abcd"
Note: if the conversation has more than 10 messages, the results may be paginated. Please refer to Pagination on how to use nextPageToken.