DokumentationEngagement Platform API
Sign inGet started
Guides
API

Messaging

Sending messages

In order to send a message you must have an active channel and perform an HTTP request to the following endpoint with a valid access key
When you send a message, a contact is automatically created with a contactId matching the receiver's identifier if one doesn't already exist. For instance, sending an email generates a contact with an email identifier, while sending an SMS creates one with a phone number identifier.
POST
/workspaces/{workspaceId}/channels/{channelId}/messages
Send a message to a channel
Anfrage-Payload
sender
object
Untergeordnete Parameter anzeigen
sender.connector
object
erforderlich
The sender of the message. For email messages, the sender is used to override the default sender username.
Untergeordnete Parameter anzeigen
sender.connector.identifierValue
string
erforderlich
The identifier value of the sender.
sender.connector.annotations
object
Annotations are used to add additional information to a message. For email messages, it can be used to specify a custom sender name.
Untergeordnete Parameter anzeigen
sender.connector.annotations.name
string
receiver
object
erforderlich
Untergeordnete Parameter anzeigen
receiver.contacts
array of object
Untergeordnete Parameter anzeigen
receiver.contacts.id
string
The ID of the receiver. This is a reference to a contact.
receiver.contacts.identifierKey
string
The identifier key for finding the contact. For WhatsApp channels with BSUID support, use whatsappbsuid to send to a contact by their Business-Scoped User ID without needing to know the channel's portfolio ID.
receiver.contacts.identifierValue
string
The identifier value for finding the contact.
receiver.contacts.type
string
The type of the receiver.
Possible values: cc, bcc, to
receiver.contacts.identifiers
array of object
Untergeordnete Parameter anzeigen
receiver.contacts.identifiers.identifierKey
string
erforderlich
The identifier key for finding the contact.
receiver.contacts.identifiers.identifierValue
string
erforderlich
The identifier value for finding the contact.
receiver.contacts.platformAddress
string
The value that is used to send the message to the platform.
receiver.contacts.platformAddressSelector
string
An expression that defines how we resolve the platform address (e.g. phone number or email address) from a contact. This is an optional override for the default resolution logic (i.e. sending to the first identifier key-value pair for the relevant platform).
reference
string
A reference to the message. This can be used to identify the message in the channel.
template
object
erforderlich
Untergeordnete Parameter anzeigen
template.name
string
The platform name of the template.
template.projectId
string
the ID of the project from the project from Studio
template.version
string
The version of the template.
template.locale
string
template.attachments
array of object
Untergeordnete Parameter anzeigen
template.attachments.mediaUrl
string
erforderlich
The URL of the attachment.
template.attachments.filename
string
erforderlich
The filename of the attachment.
template.attachments.inline
boolean
template.shortLinks
object
SMS link shortening options.
Untergeordnete Parameter anzeigen
template.shortLinks.enabled
boolean
Enables link shortening for SMS messages.
template.shortLinks.domain
string
The domain to use when shortening links. When set to default, uses the default link shortening domain for the workspace.
template.variables
object
Deprecated: Use parameters instead (string parameter for variables). This property is maintained for backward compatibility but will be removed in a future version.
Untergeordnete Parameter anzeigen
template.variables.default
string
template.utmParameters
array of object
The list of UTM parameters.
Untergeordnete Parameter anzeigen
template.utmParameters.key
string
erforderlich
The name of the parameter in the query string.
template.utmParameters.value
string
erforderlich
The static value of the parameter. Mutually exclusive with Reference.
template.parameters
array of object
Untergeordnete Parameter anzeigen
template.parameters.type
string
erforderlich
Possible values: string
template.parameters.key
string
erforderlich
template.parameters.value
string
template.settings
object
Untergeordnete Parameter anzeigen
template.settings.disallowMmLite
boolean
This is specific for WhatsApp marketing templates and requires MM Lite to be disabled for the WABAID.
meta
object
Untergeordnete Parameter anzeigen
meta.extraInformation
object
Free-form metadata. The useCase key (marketing, otp, transactional, or conversation) classifies the message and affects handling such as routing, frequency capping, email deliverability, and the messaging type/tag used on Meta channels (Messenger, Instagram).
meta.referral
object
Untergeordnete Parameter anzeigen
meta.referral.source
string
meta.referral.title
string
meta.referral.text
string
meta.referral.group
string
meta.referral.metadata
object
Untergeordnete Parameter anzeigen
meta.referral.metadata.source_id
string
meta.referral.metadata.source_url
string
meta.referral.metadata.media_url
string
meta.referral.metadata.tracking_id
string
meta.order
object
The order object contains information about the purchase order.
Untergeordnete Parameter anzeigen
meta.order.products
array of object
Untergeordnete Parameter anzeigen
meta.order.products.externalCatalogId
string
The platform-specific catalog ID of the product.
meta.order.products.externalProductId
string
The platform-specific product ID.
meta.order.products.quantity
integer
The number of items purchased.
meta.order.products.price
object
The price of the product.
Untergeordnete Parameter anzeigen
meta.order.products.price.amount
integer
meta.order.products.price.exponent
integer
meta.order.products.price.currencyCode
string
meta.referredProduct
object
Referred product in an incoming message.
Untergeordnete Parameter anzeigen
meta.referredProduct.externalCatalogId
string
The platform-specific catalog ID of the product.
meta.referredProduct.externalProductId
string
The platform-specific product ID.
meta.email
object
Untergeordnete Parameter anzeigen
meta.email.subject
string
meta.email.headers
object
meta.email.from
object
Untergeordnete Parameter anzeigen
meta.email.from.username
string
meta.email.from.displayName
string
meta.sms
object
Untergeordnete Parameter anzeigen
meta.sms.smartEncoding
boolean
When enabled, attempts to transliterate Unicode characters to GSM-7 equivalents. If the resulting text is fully GSM-7 compatible, fewer message segments may be required. The original message body is preserved; transliteration is only applied when sending.
meta.pushNotifications
object
Untergeordnete Parameter anzeigen
meta.pushNotifications.gatewayTypeOverride
string
Possible values: apns, firebase, web
meta.navigatorId
string
meta.navigatorMessageId
string
meta.flow
object
Untergeordnete Parameter anzeigen
meta.flow.id
string
meta.flow.name
string
meta.flow.stepId
string
meta.flow.runId
string
meta.journey
object
Untergeordnete Parameter anzeigen
meta.journey.id
string
meta.journey.name
string
meta.journey.stepId
string
meta.journey.runId
string
meta.campaign
object
Untergeordnete Parameter anzeigen
meta.campaign.id
string
meta.campaign.name
string
replyTo
object
Untergeordnete Parameter anzeigen
replyTo.id
string
erforderlich
The ID of the message that is being replied to.
replyTo.order
integer
The order of the message in the conversation.
replyTo.type
string
erforderlich
Possible values: message, click, referrals
notification
object
Untergeordnete Parameter anzeigen
notification.url
string
A custom webhook url to send events to. Note: you should have a created webhook subscription. Refer to the Notifications API to learn how to create a webhook subscription.
capFrequency
boolean
If set to true, the frequency capping settings of the platform will be used to either allow or reject the message to a contact. Can only be set to true if the message is sent to a contact and .meta.extraInformation.useCase is marketing.
enableLinkTracking
boolean
If set to true, UTM parameters will be appended to the links in the message. For SMS channels, the shortLinks property must also be included in the request to enable link tracking.
ignoreQuietHours
boolean
If set to true, quiet hours settings will be ignored and the message will be sent as soon as possible.
ignoreGlobalHoldout
boolean
Do not check if the recipient is part of global holdout. To be used to send transactional messages.
tags
array of string
Tags to associate with the message. Tags are converted to lower case and tags that do not exist are automatically created. You can view your created tags in the UI. You can specify up to 10 tags per message.
shortLinks
object
SMS link shortening options. Must be included in the request for SMS channels when enableLinkTracking is set to true. When using templates, please refer to the template level shortLinks instead.
Untergeordnete Parameter anzeigen
shortLinks.domain
string
erforderlich
The domain to use when shortening links. When set to default, uses the default link shortening domain for the workspace.
scheduledFor
string
Scheduled time to send message at. Must be formated as RFC3339 timestamp. When set, the message status will be scheduled until it's sent. Messages scheduled for a time in the past or within 10 minutes of the request may be sent immediately. Messages scheduled farther than 35 days will be rejected.
validity
integer
Validity determines for how many seconds a message is valid. If none is provided, the channel message type will be used to determine it. A promotional, conversational or transactional channel message is valid for 36 hours (129600 seconds). A message sent from a 2FA channel is valid for 10 minutes (600 seconds).
Antwort-Payload
body
object
Untergeordnete Attribute anzeigen
body.text
object
erforderlich
Untergeordnete Attribute anzeigen
body.text.actions
array of object
Untergeordnete Attribute anzeigen
body.text.actions.link
object
erforderlich
Untergeordnete Attribute anzeigen
body.text.actions.link.metadata
object
Untergeordnete Attribute anzeigen
body.text.actions.link.metadata.description
object
Untergeordnete Attribute anzeigen
body.text.actions.link.metadata.description.label
string
erforderlich
body.text.actions.link.text
string
erforderlich
body.text.actions.link.url
string
erforderlich
body.text.actions.type
string
erforderlich
Possible values: link
body.text.attachments
array of object
Untergeordnete Attribute anzeigen
body.text.attachments.content
string
body.text.attachments.contentId
string
body.text.attachments.contentType
string
body.text.attachments.filename
string
erforderlich
body.text.attachments.inline
boolean
body.text.attachments.mediaUrl
string
erforderlich
body.text.metadata
object
Untergeordnete Attribute anzeigen
body.text.metadata.apple
object
Untergeordnete Attribute anzeigen
body.text.metadata.apple.appClipPreview
boolean
body.text.metadata.apple.appClipRegion
string
body.text.metadata.apple.summaryText
string
body.text.metadata.headers
object
body.text.metadata.line
object
Untergeordnete Attribute anzeigen
body.text.metadata.line.emoji
object
Untergeordnete Attribute anzeigen
body.text.metadata.line.emoji.items
array of object
Untergeordnete Attribute anzeigen
body.text.metadata.line.emoji.items.emojiId
string
erforderlich
body.text.metadata.line.emoji.items.index
integer
erforderlich
body.text.metadata.line.emoji.items.length
integer
body.text.metadata.line.emoji.items.productId
string
erforderlich
body.text.metadata.paymentDetails
object
Untergeordnete Attribute anzeigen
body.text.metadata.paymentDetails.amount
string
erforderlich
body.text.metadata.paymentDetails.currency
string
erforderlich
body.text.metadata.paymentDetails.sessionIdentifier
string
body.text.metadata.paymentDetails.state
string
erforderlich
body.text.metadata.subject
string
body.text.metadata.telegram
object
Untergeordnete Attribute anzeigen
body.text.metadata.telegram.parseMode
string
body.text.metadata.whatsapp
object
Untergeordnete Attribute anzeigen
body.text.metadata.whatsapp.callPermissionExpiration
string
body.text.metadata.whatsapp.callPermissionResponse
string
Possible values: accept, reject
body.text.metadata.whatsapp.previewUrl
boolean
erforderlich
body.text.metadata.whatsapp.sharedContacts
array of object
Untergeordnete Attribute anzeigen
body.text.metadata.whatsapp.sharedContacts.origin
string
erforderlich
body.text.metadata.whatsapp.sharedContacts.phones
array of object
Untergeordnete Attribute anzeigen
body.text.metadata.whatsapp.sharedContacts.phones.phone
string
erforderlich
body.text.metadata.whatsapp.sharedContacts.phones.type
string
erforderlich
body.text.metadata.whatsapp.sharedContacts.phones.waId
string
erforderlich
body.text.metadata.whatsapp.sharedContacts.vcard
string
body.text.text
string
erforderlich
body.type
string
erforderlich
Possible values: text
bodyId
string
bodyStorage
object
Untergeordnete Attribute anzeigen
bodyStorage.type
string
erforderlich
Possible values: s3
bodyStorage.s3
object
erforderlich
Untergeordnete Attribute anzeigen
bodyStorage.s3.bucketArn
string
erforderlich
bodyStorage.s3.encryptionKey
string
erforderlich
bodyStorage.s3.key
string
erforderlich
channelId
string
erforderlich
chargeableUnits
integer
context
object
Untergeordnete Attribute anzeigen
context.id
string
context.tagIds
array of string
context.type
string
createdAt
string
erforderlich
details
string
This field is used to store additional information related to the message status.
direction
string
Possible values: incoming, outgoing
failure
object
Untergeordnete Attribute anzeigen
failure.code
integer
omni channel interpretation of the failure to categorise the nature of message error
failure.description
string
human readable description of the error
failure.source
object
Untergeordnete Attribute anzeigen
failure.source.code
string
numerical, text or alphanumeric code that indicates the error or issue while delivering the message in the last step
failure.source.name
string
Possible values: pre-processing, accounting, contact, touchpoint, sms-messagebird, sms-twilio, email-messagebird, whatsapp, facebook, instagram, line, telegram, apple-business-chat, viber, chat, google-business-messages, voice, smtp-messagebird, rcs-google, service
id
string
erforderlich
ignorePersistedEventhooks
boolean
lastStatusAt
string
erforderlich
meta
object
Untergeordnete Attribute anzeigen
meta.campaign
object
Untergeordnete Attribute anzeigen
meta.campaign.id
string
meta.campaign.name
string
meta.campaignId
string
meta.chargeOnceDelivered
boolean
meta.email
object
Untergeordnete Attribute anzeigen
meta.email.from
object
Untergeordnete Attribute anzeigen
meta.email.from.displayName
string
meta.email.from.username
string
meta.email.headers
object
meta.email.subject
string
meta.extraInformation
object
meta.flow
object
Untergeordnete Attribute anzeigen
meta.flow.id
string
meta.flow.name
string
meta.flow.runId
string
meta.flow.scheduleExecutionId
string
meta.flow.stepId
string
meta.formResponse
object
Untergeordnete Attribute anzeigen
meta.formResponse.id
string
erforderlich
meta.formResponse.jsonResponse
string
erforderlich
meta.formResponse.requestIdentifier
string
erforderlich
meta.formResponse.selections
array of object
Untergeordnete Attribute anzeigen
meta.formResponse.selections.items
array of object
Untergeordnete Attribute anzeigen
meta.formResponse.selections.items.identifier
string
erforderlich
meta.formResponse.selections.items.title
string
erforderlich
meta.formResponse.selections.items.type
string
erforderlich
meta.formResponse.selections.items.value
string
erforderlich
meta.formResponse.selections.pageIdentifier
string
erforderlich
meta.formResponse.selections.subtitle
string
erforderlich
meta.formResponse.selections.title
string
erforderlich
meta.formResponse.sessionIdentifier
string
erforderlich
meta.formResponse.template
string
erforderlich
meta.formResponse.version
string
erforderlich
meta.ignoreGlobalHoldout
boolean
meta.ignoreQuietHours
boolean
meta.journey
object
Untergeordnete Attribute anzeigen
meta.journey.id
string
meta.journey.name
string
meta.journey.runId
string
meta.journey.scheduleExecutionId
string
meta.journey.stepId
string
meta.longToShortLinks
object
meta.metaThreadId
string
meta.navigatorId
string
meta.navigatorMessageId
string
meta.order
object
The order object contains information about the purchase order associated with the message.
Untergeordnete Attribute anzeigen
meta.order.products
array of object
Untergeordnete Attribute anzeigen
meta.order.products.externalCatalogId
string
The platform-specific catalog ID of the product.
meta.order.products.externalProductId
string
erforderlich
The platform-specific product ID.
meta.order.products.price
object
erforderlich
Untergeordnete Attribute anzeigen
meta.order.products.price.amount
integer
erforderlich
meta.order.products.price.currencyCode
string
erforderlich
meta.order.products.price.exponent
integer
erforderlich
meta.order.products.quantity
integer
erforderlich
The number of items purchased.
meta.pushNotifications
object
Untergeordnete Attribute anzeigen
meta.pushNotifications.gatewayTypeOverride
string
Possible values: firebase, apns, web
meta.referral
object
Untergeordnete Attribute anzeigen
meta.referral.group
string
meta.referral.metadata
object
Untergeordnete Attribute anzeigen
meta.referral.metadata.caption
string
meta.referral.metadata.mediaType
string
meta.referral.metadata.mediaUrl
string
meta.referral.metadata.sourceId
string
erforderlich
meta.referral.metadata.sourceUrl
string
meta.referral.metadata.timestamp
string
meta.referral.metadata.trackingId
string
meta.referral.metadata.username
string
meta.referral.source
string
erforderlich
meta.referral.text
string
meta.referral.title
string
meta.referredProduct
object
Referred product in an incoming message (e.g. a product shared in a WhatsApp catalog message).
Untergeordnete Attribute anzeigen
meta.referredProduct.externalCatalogId
string
The platform-specific catalog ID of the product.
meta.referredProduct.externalProductId
string
erforderlich
The platform-specific product ID.
meta.renderedContentBlocks
array of string
meta.shortToLongLinks
object
meta.skipThisMessage
string
Possible values: campaignHoldout, globalHoldout, journeyHoldout
meta.sms
object
Untergeordnete Attribute anzeigen
meta.sms.gatewayId
integer
meta.sms.registeredDelivery
string
Possible values: final, intermediate, all, noDlr
meta.sms.smartEncoding
boolean
When enabled, attempts to transliterate Unicode characters to GSM-7 equivalents. If the resulting text is fully GSM-7 compatible, fewer message segments may be required. The original message body is preserved; transliteration is only applied when sending.
meta.sms.smpp
object
Untergeordnete Attribute anzeigen
meta.sms.smpp.segments
array of object
Untergeordnete Attribute anzeigen
meta.sms.smpp.segments.id
string
erforderlich
meta.sms.smpp.segments.registeredDelivery
string
erforderlich
Possible values: final, intermediate, all, noDlr
meta.sms.smpp.userId
string
erforderlich
meta.sms.validity
string
meta.useFallback
boolean
parts
array of object
Untergeordnete Attribute anzeigen
parts.id
string
parts.order
integer
parts.platformReferenceId
string
parts.platformStatusAt
string
parts.rawBody
string
parts.reason
string
parts.status
string
Possible values: accepted, processing, sent, sending_failed, delivered, delivery_failed, deleted, scheduled, skipped, rejected
parts.statusAt
string
platformId
string
platformReferenceId
string
previousMessages
array of object
Untergeordnete Attribute anzeigen
previousMessages.id
string
erforderlich
previousMessages.useCaseType
string
erforderlich
Possible values: unspecified, marketing, otp, transactional, conversation, test
reason
string
receiver
object
erforderlich
Untergeordnete Attribute anzeigen
receiver.connector
object
Untergeordnete Attribute anzeigen
receiver.connector.annotations
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Untergeordnete Attribute anzeigen
receiver.connector.annotations.name
string
receiver.connector.id
string
erforderlich
receiver.connector.identifierValue
string
The identifier value of the sender or receiver connector (e.g. email address or phone number).
receiver.connector.types
array of string
receiver.contacts
array of object
Untergeordnete Attribute anzeigen
receiver.contacts.contactAnnotation
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Untergeordnete Attribute anzeigen
receiver.contacts.contactAnnotation.name
string
receiver.contacts.countryCode
string
receiver.contacts.id
string
The ID of the contact.
receiver.contacts.identifierKey
string
The identifier key for finding the contact (e.g. emailaddress, phonenumber). For WhatsApp channels with BSUID support, use whatsappbsuid to send to a contact by their Business-Scoped User ID.
receiver.contacts.identifierValue
string
The identifier value for finding the contact.
receiver.contacts.identifiers
array of object
Additional identifiers to augment the contact during resolution.
Untergeordnete Attribute anzeigen
receiver.contacts.identifiers.identifierKey
string
erforderlich
The identifier key for finding the contact (e.g. emailaddress, phonenumber).
receiver.contacts.identifiers.identifierValue
string
erforderlich
The identifier value for finding the contact.
receiver.contacts.platformAddress
string
The resolved platform address used to deliver the message (e.g. phone number or email address).
receiver.contacts.platformAddressSelector
string
An expression that defines how we resolve the platform address from a contact. Optional override for the default resolution logic.
receiver.contacts.receiverExpression
string
receiver.contacts.receiverValue
string
receiver.contacts.type
string
The type of the receiver (e.g. to, cc, bcc for email).
receiver.device
object
Untergeordnete Attribute anzeigen
receiver.device.gateway
string
erforderlich
Possible values: firebase, apns, web
receiver.device.id
string
erforderlich
receiver.device.identifierValue
string
erforderlich
receiver.inbox
object
Untergeordnete Attribute anzeigen
receiver.inbox.emailRecipientType
string
receiver.inbox.id
string
erforderlich
receiver.inbox.identifierKey
string
erforderlich
receiver.inbox.identifierValue
string
erforderlich
receiver.inbox.type
string
erforderlich
Possible values: user, group
receiver.userContacts
array of object
Untergeordnete Attribute anzeigen
receiver.userContacts.id
string
erforderlich
receiver.userContacts.identifierKey
string
erforderlich
receiver.userContacts.identifierValue
string
erforderlich
receiver.userContacts.type
string
reference
string
A reference to the message. This can be used to identify the message in the channel.
replyTo
object
Untergeordnete Attribute anzeigen
replyTo.id
string
The ID of the message that is being replied to.
replyTo.order
integer
The order of the message part in the conversation.
replyTo.platformReference
string
replyTo.type
string
Possible values: message, click
schedule
object
Untergeordnete Attribute anzeigen
schedule.reason
string
erforderlich
schedule.scheduledAt
string
erforderlich
scheduledFor
string
Scheduled message send time (RFC3339). Messages scheduled within 10 minutes may be sent immediately; messages scheduled more than 35 days out will be rejected.
sendAt
string
sender
object
erforderlich
Untergeordnete Attribute anzeigen
sender.connector
object
Untergeordnete Attribute anzeigen
sender.connector.annotations
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Untergeordnete Attribute anzeigen
sender.connector.annotations.name
string
sender.connector.id
string
erforderlich
sender.connector.identifierValue
string
The identifier value of the sender or receiver connector (e.g. email address or phone number).
sender.connector.types
array of string
sender.contact
object
Untergeordnete Attribute anzeigen
sender.contact.contactAnnotation
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Untergeordnete Attribute anzeigen
sender.contact.contactAnnotation.name
string
sender.contact.countryCode
string
sender.contact.id
string
The ID of the contact.
sender.contact.identifierKey
string
The identifier key for finding the contact (e.g. emailaddress, phonenumber). For WhatsApp channels with BSUID support, use whatsappbsuid to send to a contact by their Business-Scoped User ID.
sender.contact.identifierValue
string
The identifier value for finding the contact.
sender.contact.identifiers
array of object
Additional identifiers to augment the contact during resolution.
Untergeordnete Attribute anzeigen
sender.contact.identifiers.identifierKey
string
erforderlich
The identifier key for finding the contact (e.g. emailaddress, phonenumber).
sender.contact.identifiers.identifierValue
string
erforderlich
The identifier value for finding the contact.
sender.contact.platformAddress
string
The resolved platform address used to deliver the message (e.g. phone number or email address).
sender.contact.platformAddressSelector
string
An expression that defines how we resolve the platform address from a contact. Optional override for the default resolution logic.
sender.contact.receiverExpression
string
sender.contact.receiverValue
string
sender.contact.type
string
The type of the receiver (e.g. to, cc, bcc for email).
sender.inbox
object
Untergeordnete Attribute anzeigen
sender.inbox.emailRecipientType
string
sender.inbox.id
string
erforderlich
sender.inbox.identifierKey
string
erforderlich
sender.inbox.identifierValue
string
erforderlich
sender.inbox.type
string
erforderlich
Possible values: user, group
sender.userContact
object
Untergeordnete Attribute anzeigen
sender.userContact.id
string
erforderlich
sender.userContact.identifierKey
string
erforderlich
sender.userContact.identifierValue
string
erforderlich
sender.userContact.type
string
shortLinks
object
Untergeordnete Attribute anzeigen
shortLinks.domain
string
erforderlich
The domain to use when shortening links. When set to default, uses the default link shortening domain for the workspace.
status
string
erforderlich
Possible values: accepted, processing, sent, sending_failed, delivered, delivery_failed, deleted, scheduled, skipped, rejected
tagIds
array of string
tags
array of string
Tags to associate with the message. Tags are converted to lower case and automatically created if they don't exist. Up to 10 tags per message.
template
object
Untergeordnete Attribute anzeigen
template.attachments
array of object
Untergeordnete Attribute anzeigen
template.attachments.content
string
template.attachments.contentType
string
template.attachments.filename
string
erforderlich
template.attachments.inline
boolean
erforderlich
template.attachments.mediaUrl
string
erforderlich
template.deployment
object
template.locale
string
erforderlich
template.name
string
The platform name of the template.
template.parameters
array of object
Untergeordnete Attribute anzeigen
template.parameters.key
string
erforderlich
template.parameters.sourceUrl
object
Untergeordnete Attribute anzeigen
template.parameters.sourceUrl.fullyReplaced
boolean
erforderlich
template.parameters.sourceUrl.value
string
erforderlich
template.parameters.type
string
erforderlich
Possible values: string, timeslotList, productSections, productList, number, boolean, sectionList, shippingMethodList, lineItemList, whatsappProductSections, whatsappProductItems, shortLink, object, carouselCards, appleFormPageItems
template.parameters.value
object or array or string or number or boolean
erforderlich
template.projectId
string
erforderlich
The ID of the project from Studio.
template.settings
object
Untergeordnete Attribute anzeigen
template.settings.disallowMmLite
boolean
template.shortLinks
object
Untergeordnete Attribute anzeigen
template.shortLinks.domain
string
erforderlich
The domain to use when shortening links. When set to default, uses the default link shortening domain for the workspace.
template.shortLinks.enabled
boolean
erforderlich
Enables link shortening for SMS messages.
template.templateBody
object
Untergeordnete Attribute anzeigen
template.templateBody.text
object
erforderlich
Untergeordnete Attribute anzeigen
template.templateBody.text.actions
array of object
Untergeordnete Attribute anzeigen
template.templateBody.text.actions.link
object
erforderlich
Untergeordnete Attribute anzeigen
template.templateBody.text.actions.link.metadata
object
Untergeordnete Attribute anzeigen
template.templateBody.text.actions.link.metadata.description
object
Untergeordnete Attribute anzeigen
template.templateBody.text.actions.link.metadata.description.label
string
erforderlich
template.templateBody.text.actions.link.text
string
erforderlich
template.templateBody.text.actions.link.url
string
erforderlich
template.templateBody.text.actions.type
string
erforderlich
Possible values: link
template.templateBody.text.attachments
array of object
Untergeordnete Attribute anzeigen
template.templateBody.text.attachments.content
string
template.templateBody.text.attachments.contentId
string
template.templateBody.text.attachments.contentType
string
template.templateBody.text.attachments.filename
string
erforderlich
template.templateBody.text.attachments.inline
boolean
template.templateBody.text.attachments.mediaUrl
string
erforderlich
template.templateBody.text.metadata
object
Untergeordnete Attribute anzeigen
template.templateBody.text.metadata.apple
object
Untergeordnete Attribute anzeigen
template.templateBody.text.metadata.apple.appClipPreview
boolean
template.templateBody.text.metadata.apple.appClipRegion
string
template.templateBody.text.metadata.apple.summaryText
string
template.templateBody.text.metadata.headers
object
template.templateBody.text.metadata.line
object
Untergeordnete Attribute anzeigen
template.templateBody.text.metadata.line.emoji
object
Untergeordnete Attribute anzeigen
template.templateBody.text.metadata.line.emoji.items
array of object
Untergeordnete Attribute anzeigen
template.templateBody.text.metadata.line.emoji.items.emojiId
string
erforderlich
template.templateBody.text.metadata.line.emoji.items.index
integer
erforderlich
template.templateBody.text.metadata.line.emoji.items.length
integer
template.templateBody.text.metadata.line.emoji.items.productId
string
erforderlich
template.templateBody.text.metadata.paymentDetails
object
Untergeordnete Attribute anzeigen
template.templateBody.text.metadata.paymentDetails.amount
string
erforderlich
template.templateBody.text.metadata.paymentDetails.currency
string
erforderlich
template.templateBody.text.metadata.paymentDetails.sessionIdentifier
string
template.templateBody.text.metadata.paymentDetails.state
string
erforderlich
template.templateBody.text.metadata.subject
string
template.templateBody.text.metadata.telegram
object
Untergeordnete Attribute anzeigen
template.templateBody.text.metadata.telegram.parseMode
string
template.templateBody.text.metadata.whatsapp
object
Untergeordnete Attribute anzeigen
template.templateBody.text.metadata.whatsapp.callPermissionExpiration
string
template.templateBody.text.metadata.whatsapp.callPermissionResponse
string
Possible values: accept, reject
template.templateBody.text.metadata.whatsapp.previewUrl
boolean
erforderlich
template.templateBody.text.metadata.whatsapp.sharedContacts
array of object
Untergeordnete Attribute anzeigen
template.templateBody.text.metadata.whatsapp.sharedContacts.origin
string
erforderlich
template.templateBody.text.metadata.whatsapp.sharedContacts.phones
array of object
Untergeordnete Attribute anzeigen
template.templateBody.text.metadata.whatsapp.sharedContacts.phones.phone
string
erforderlich
template.templateBody.text.metadata.whatsapp.sharedContacts.phones.type
string
erforderlich
template.templateBody.text.metadata.whatsapp.sharedContacts.phones.waId
string
erforderlich
template.templateBody.text.metadata.whatsapp.sharedContacts.vcard
string
template.templateBody.text.text
string
erforderlich
template.templateBody.type
string
erforderlich
Possible values: text
template.utmParameters
array of object
Untergeordnete Attribute anzeigen
template.utmParameters.key
string
erforderlich
template.utmParameters.value
string
erforderlich
template.variables
object
template.version
string
erforderlich
The version of the template.
updatedAt
string
erforderlich
Codebeispiel
curl -X POST 'https://api.bird.com/workspaces/{workspaceId}/channels/{channelId}/messages' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
When sending outbound messages as well as setting the receiver information you must set the message body field in all cases except for sending a message template when you must only set the templatefield.
Multiple recipient messages are only possible through the Email platform. For other platforms, a message with multiple reciever entries will be rejected.

Body

Codebeispiel
{
 "receiver": {
   "contacts": [
     {
       "identifierValue": "+31612345678"
     }
   ]
 },
 "body": {...},
}

Template

Codebeispiel
{
 "receiver": {
   "contacts": [
     {
       "identifierValue": "+31612345678"
     }
   ]
 },
 "template": {...},
}

Uploading media

When sending messages that contain media links these must be publicly accessible. Otherwise you can upload media by creating requesting a pre-signed media URL. Firstly make a POST request to the following endpoint with the content type of the media you will be uploading set in the request body.
There are two methods for generating a presigned URL: one is channel-independent, allowing it to be used across any channel, while the other restricts usage to a specified channel ID.
POST
/workspaces/{workspaceId}/channel-media/presigned-upload
Create a presigned media upload
Anfrage-Payload
contentType
string
erforderlich
Antwort-Payload
mediaUrl
string
erforderlich
uploadUrl
string
erforderlich
uploadMethod
string
erforderlich
uploadFormData
object
erforderlich
Codebeispiel
curl -X POST 'https://api.bird.com/workspaces/{workspaceId}/channel-media/presigned-upload' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'

Example

Codebeispiel
curl -X POST "https://api.bird.com/workspaces/42263973-4f1c-40db-bf0e-cea7e4bfa1a2/channel-media/presigned-upload" \
-H "Content-Type: application/json" \
-H "Authorization: AccessKey abcd" \
-d '{
"contentType": "image/jpeg"
}'
Codebeispiel
"image/gif", 
"image/jpeg", 
"image/png",  
"image/webp", 
"image/svg+xml",
POST
/workspaces/{workspaceId}/channels/{channelId}/presigned-upload
Create a presigned media upload
Anfrage-Payload
contentType
string
erforderlich
Antwort-Payload
mediaUrl
string
erforderlich
uploadUrl
string
erforderlich
uploadMethod
string
erforderlich
uploadFormData
object
erforderlich
Codebeispiel
curl -X POST 'https://api.bird.com/workspaces/{workspaceId}/channels/{channelId}/presigned-upload' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
From the response you will get the following details:
mediaUrl: This will be the URL you set in any message bodies where you send the uploaded media
uploadUrl: This is the URL you will need to make a request to to upload your media file
uploadMethod: This is the HTTP method to make an upload i.e. POST
uploadFormData: Set this as the fields in form-data of your POST request along with an additional field called file. This should include your file data. An example using CURL
No need to specify any AccessKey on the below call as all the required data is provided in the form data.

Example

Codebeispiel
  curl -L -X POST "https://channels--message-media--151603429280--euw1.s3.eu-west-1.amazonaws.com" \
  -F Content-Type='image/jpeg' \
  -F acl='private' \
  -F bucket='text' \
  -F key='text' \
  -F policy='text' \
  -F x-amz-algorithm='AWS4-HMAC-SHA256' \
  -F x-amz-credential='text' \
  -F x-amz-date='text' \
  -F x-amz-meta-allowed-paths='text' \
  -F x-amz-security-token='text' \
  -F x-amz-signature='text' \
  -F file=@image.jpeg
Once you have uploaded the file using the mediaUrl, this should be used as the URL when sending messages with media.

Retrieving messages

Retrieve a list of messages of a channel

GET
/workspaces/{workspaceId}/channels/{channelId}/messages
It retrieves a list of messages from a given channel ID
Abfrageparameter
limit
integer
Limits the number of results to return.
pageToken
string
The cursor that keeps track of the current position in the results.
reverse
boolean
Reverses the order in which the results are returned.
platform
Filter based on platform name
direction
string
Possible values: incoming, outgoing
id
array
navigatorId
string
messageType
array
status
array
startAt
string
Start date for the query
endAt
string
End date for the query
from
array
sender identifier for the message
to
array
recipient identifier for the message
failureCode
array
failureSourceCode
array
failureSourceName
array
countryCode
array
usedPlatform
Filter based on the platform the message was delivered over (known values are sms, whatsapp, rcs and mms). Matching is case-insensitive. The reserved value none selects messages without a reported delivery platform.
tag
array
Filter based on tag
emailSubject
string
Full text search on email subject
batchId
string
The ID for a batch
Antwort-Payload
startAt
string
endAt
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.
results
array of object
erforderlich
Untergeordnete Attribute anzeigen
results.body
object
Untergeordnete Attribute anzeigen
results.body.text
object
erforderlich
Untergeordnete Attribute anzeigen
results.body.text.actions
array of object
Untergeordnete Attribute anzeigen
results.body.text.actions.link
object
erforderlich
Untergeordnete Attribute anzeigen
results.body.text.actions.link.metadata
object
Untergeordnete Attribute anzeigen
results.body.text.actions.link.metadata.description
object
Untergeordnete Attribute anzeigen
results.body.text.actions.link.metadata.description.label
string
erforderlich
results.body.text.actions.link.text
string
erforderlich
results.body.text.actions.link.url
string
erforderlich
results.body.text.actions.type
string
erforderlich
Possible values: link
results.body.text.attachments
array of object
Untergeordnete Attribute anzeigen
results.body.text.attachments.content
string
results.body.text.attachments.contentId
string
results.body.text.attachments.contentType
string
results.body.text.attachments.filename
string
erforderlich
results.body.text.attachments.inline
boolean
results.body.text.attachments.mediaUrl
string
erforderlich
results.body.text.metadata
object
Untergeordnete Attribute anzeigen
results.body.text.metadata.apple
object
Untergeordnete Attribute anzeigen
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
Untergeordnete Attribute anzeigen
results.body.text.metadata.line.emoji
object
Untergeordnete Attribute anzeigen
results.body.text.metadata.line.emoji.items
array of object
Untergeordnete Attribute anzeigen
results.body.text.metadata.line.emoji.items.emojiId
string
erforderlich
results.body.text.metadata.line.emoji.items.index
integer
erforderlich
results.body.text.metadata.line.emoji.items.length
integer
results.body.text.metadata.line.emoji.items.productId
string
erforderlich
results.body.text.metadata.paymentDetails
object
Untergeordnete Attribute anzeigen
results.body.text.metadata.paymentDetails.amount
string
erforderlich
results.body.text.metadata.paymentDetails.currency
string
erforderlich
results.body.text.metadata.paymentDetails.sessionIdentifier
string
results.body.text.metadata.paymentDetails.state
string
erforderlich
results.body.text.metadata.subject
string
results.body.text.metadata.telegram
object
Untergeordnete Attribute anzeigen
results.body.text.metadata.telegram.parseMode
string
results.body.text.metadata.whatsapp
object
Untergeordnete Attribute anzeigen
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
erforderlich
results.body.text.metadata.whatsapp.sharedContacts
array of object
Untergeordnete Attribute anzeigen
results.body.text.metadata.whatsapp.sharedContacts.origin
string
erforderlich
results.body.text.metadata.whatsapp.sharedContacts.phones
array of object
Untergeordnete Attribute anzeigen
results.body.text.metadata.whatsapp.sharedContacts.phones.phone
string
erforderlich
results.body.text.metadata.whatsapp.sharedContacts.phones.type
string
erforderlich
results.body.text.metadata.whatsapp.sharedContacts.phones.waId
string
erforderlich
results.body.text.metadata.whatsapp.sharedContacts.vcard
string
results.body.text.text
string
erforderlich
results.body.type
string
erforderlich
Possible values: text
results.bodyId
string
results.bodyStorage
object
Untergeordnete Attribute anzeigen
results.bodyStorage.type
string
erforderlich
Possible values: s3
results.bodyStorage.s3
object
erforderlich
Untergeordnete Attribute anzeigen
results.bodyStorage.s3.bucketArn
string
erforderlich
results.bodyStorage.s3.encryptionKey
string
erforderlich
results.bodyStorage.s3.key
string
erforderlich
results.channelId
string
erforderlich
results.chargeableUnits
integer
results.context
object
Untergeordnete Attribute anzeigen
results.context.id
string
results.context.tagIds
array of string
results.context.type
string
results.createdAt
string
erforderlich
results.details
string
This field is used to store additional information related to the message status.
results.direction
string
Possible values: incoming, outgoing
results.failure
object
Untergeordnete Attribute anzeigen
results.failure.code
integer
omni channel interpretation of the failure to categorise the nature of message error
results.failure.description
string
human readable description of the error
results.failure.source
object
Untergeordnete Attribute anzeigen
results.failure.source.code
string
numerical, text or alphanumeric code that indicates the error or issue while delivering the message in the last step
results.failure.source.name
string
Possible values: pre-processing, accounting, contact, touchpoint, sms-messagebird, sms-twilio, email-messagebird, whatsapp, facebook, instagram, line, telegram, apple-business-chat, viber, chat, google-business-messages, voice, smtp-messagebird, rcs-google, service
results.id
string
erforderlich
results.ignorePersistedEventhooks
boolean
results.lastStatusAt
string
erforderlich
results.meta
object
Untergeordnete Attribute anzeigen
results.meta.campaign
object
Untergeordnete Attribute anzeigen
results.meta.campaign.id
string
results.meta.campaign.name
string
results.meta.campaignId
string
results.meta.chargeOnceDelivered
boolean
results.meta.email
object
Untergeordnete Attribute anzeigen
results.meta.email.from
object
Untergeordnete Attribute anzeigen
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
Untergeordnete Attribute anzeigen
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
Untergeordnete Attribute anzeigen
results.meta.formResponse.id
string
erforderlich
results.meta.formResponse.jsonResponse
string
erforderlich
results.meta.formResponse.requestIdentifier
string
erforderlich
results.meta.formResponse.selections
array of object
Untergeordnete Attribute anzeigen
results.meta.formResponse.selections.items
array of object
Untergeordnete Attribute anzeigen
results.meta.formResponse.selections.items.identifier
string
erforderlich
results.meta.formResponse.selections.items.title
string
erforderlich
results.meta.formResponse.selections.items.type
string
erforderlich
results.meta.formResponse.selections.items.value
string
erforderlich
results.meta.formResponse.selections.pageIdentifier
string
erforderlich
results.meta.formResponse.selections.subtitle
string
erforderlich
results.meta.formResponse.selections.title
string
erforderlich
results.meta.formResponse.sessionIdentifier
string
erforderlich
results.meta.formResponse.template
string
erforderlich
results.meta.formResponse.version
string
erforderlich
results.meta.ignoreGlobalHoldout
boolean
results.meta.ignoreQuietHours
boolean
results.meta.journey
object
Untergeordnete Attribute anzeigen
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.
Untergeordnete Attribute anzeigen
results.meta.order.products
array of object
Untergeordnete Attribute anzeigen
results.meta.order.products.externalCatalogId
string
The platform-specific catalog ID of the product.
results.meta.order.products.externalProductId
string
erforderlich
The platform-specific product ID.
results.meta.order.products.price
object
erforderlich
Untergeordnete Attribute anzeigen
results.meta.order.products.price.amount
integer
erforderlich
results.meta.order.products.price.currencyCode
string
erforderlich
results.meta.order.products.price.exponent
integer
erforderlich
results.meta.order.products.quantity
integer
erforderlich
The number of items purchased.
results.meta.pushNotifications
object
Untergeordnete Attribute anzeigen
results.meta.pushNotifications.gatewayTypeOverride
string
Possible values: firebase, apns, web
results.meta.referral
object
Untergeordnete Attribute anzeigen
results.meta.referral.group
string
results.meta.referral.metadata
object
Untergeordnete Attribute anzeigen
results.meta.referral.metadata.caption
string
results.meta.referral.metadata.mediaType
string
results.meta.referral.metadata.mediaUrl
string
results.meta.referral.metadata.sourceId
string
erforderlich
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
erforderlich
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).
Untergeordnete Attribute anzeigen
results.meta.referredProduct.externalCatalogId
string
The platform-specific catalog ID of the product.
results.meta.referredProduct.externalProductId
string
erforderlich
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
Untergeordnete Attribute anzeigen
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
Untergeordnete Attribute anzeigen
results.meta.sms.smpp.segments
array of object
Untergeordnete Attribute anzeigen
results.meta.sms.smpp.segments.id
string
erforderlich
results.meta.sms.smpp.segments.registeredDelivery
string
erforderlich
Possible values: final, intermediate, all, noDlr
results.meta.sms.smpp.userId
string
erforderlich
results.meta.sms.validity
string
results.meta.useFallback
boolean
results.parts
array of object
Untergeordnete Attribute anzeigen
results.parts.id
string
results.parts.order
integer
results.parts.platformReferenceId
string
results.parts.platformStatusAt
string
results.parts.rawBody
string
results.parts.reason
string
results.parts.status
string
Possible values: accepted, processing, sent, sending_failed, delivered, delivery_failed, deleted, scheduled, skipped, rejected
results.parts.statusAt
string
results.platformId
string
results.platformReferenceId
string
results.previousMessages
array of object
Untergeordnete Attribute anzeigen
results.previousMessages.id
string
erforderlich
results.previousMessages.useCaseType
string
erforderlich
Possible values: unspecified, marketing, otp, transactional, conversation, test
results.reason
string
results.receiver
object
erforderlich
Untergeordnete Attribute anzeigen
results.receiver.connector
object
Untergeordnete Attribute anzeigen
results.receiver.connector.annotations
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Untergeordnete Attribute anzeigen
results.receiver.connector.annotations.name
string
results.receiver.connector.id
string
erforderlich
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
Untergeordnete Attribute anzeigen
results.receiver.contacts.contactAnnotation
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Untergeordnete Attribute anzeigen
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.
Untergeordnete Attribute anzeigen
results.receiver.contacts.identifiers.identifierKey
string
erforderlich
The identifier key for finding the contact (e.g. emailaddress, phonenumber).
results.receiver.contacts.identifiers.identifierValue
string
erforderlich
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
Untergeordnete Attribute anzeigen
results.receiver.device.gateway
string
erforderlich
Possible values: firebase, apns, web
results.receiver.device.id
string
erforderlich
results.receiver.device.identifierValue
string
erforderlich
results.receiver.inbox
object
Untergeordnete Attribute anzeigen
results.receiver.inbox.emailRecipientType
string
results.receiver.inbox.id
string
erforderlich
results.receiver.inbox.identifierKey
string
erforderlich
results.receiver.inbox.identifierValue
string
erforderlich
results.receiver.inbox.type
string
erforderlich
Possible values: user, group
results.receiver.userContacts
array of object
Untergeordnete Attribute anzeigen
results.receiver.userContacts.id
string
erforderlich
results.receiver.userContacts.identifierKey
string
erforderlich
results.receiver.userContacts.identifierValue
string
erforderlich
results.receiver.userContacts.type
string
results.reference
string
A reference to the message. This can be used to identify the message in the channel.
results.replyTo
object
Untergeordnete Attribute anzeigen
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.schedule
object
Untergeordnete Attribute anzeigen
results.schedule.reason
string
erforderlich
results.schedule.scheduledAt
string
erforderlich
results.scheduledFor
string
Scheduled message send time (RFC3339). Messages scheduled within 10 minutes may be sent immediately; messages scheduled more than 35 days out will be rejected.
results.sendAt
string
results.sender
object
erforderlich
Untergeordnete Attribute anzeigen
results.sender.connector
object
Untergeordnete Attribute anzeigen
results.sender.connector.annotations
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Untergeordnete Attribute anzeigen
results.sender.connector.annotations.name
string
results.sender.connector.id
string
erforderlich
results.sender.connector.identifierValue
string
The identifier value of the sender or receiver connector (e.g. email address or phone number).
results.sender.connector.types
array of string
results.sender.contact
object
Untergeordnete Attribute anzeigen
results.sender.contact.contactAnnotation
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Untergeordnete Attribute anzeigen
results.sender.contact.contactAnnotation.name
string
results.sender.contact.countryCode
string
results.sender.contact.id
string
The ID of the contact.
results.sender.contact.identifierKey
string
The identifier key for finding the contact (e.g. emailaddress, phonenumber). For WhatsApp channels with BSUID support, use whatsappbsuid to send to a contact by their Business-Scoped User ID.
results.sender.contact.identifierValue
string
The identifier value for finding the contact.
results.sender.contact.identifiers
array of object
Additional identifiers to augment the contact during resolution.
Untergeordnete Attribute anzeigen
results.sender.contact.identifiers.identifierKey
string
erforderlich
The identifier key for finding the contact (e.g. emailaddress, phonenumber).
results.sender.contact.identifiers.identifierValue
string
erforderlich
The identifier value for finding the contact.
results.sender.contact.platformAddress
string
The resolved platform address used to deliver the message (e.g. phone number or email address).
results.sender.contact.platformAddressSelector
string
An expression that defines how we resolve the platform address from a contact. Optional override for the default resolution logic.
results.sender.contact.receiverExpression
string
results.sender.contact.receiverValue
string
results.sender.contact.type
string
The type of the receiver (e.g. to, cc, bcc for email).
results.sender.inbox
object
Untergeordnete Attribute anzeigen
results.sender.inbox.emailRecipientType
string
results.sender.inbox.id
string
erforderlich
results.sender.inbox.identifierKey
string
erforderlich
results.sender.inbox.identifierValue
string
erforderlich
results.sender.inbox.type
string
erforderlich
Possible values: user, group
results.sender.userContact
object
Untergeordnete Attribute anzeigen
results.sender.userContact.id
string
erforderlich
results.sender.userContact.identifierKey
string
erforderlich
results.sender.userContact.identifierValue
string
erforderlich
results.sender.userContact.type
string
results.shortLinks
object
Untergeordnete Attribute anzeigen
results.shortLinks.domain
string
erforderlich
The domain to use when shortening links. When set to default, uses the default link shortening domain for the workspace.
results.status
string
erforderlich
Possible values: accepted, processing, sent, sending_failed, delivered, delivery_failed, deleted, scheduled, skipped, rejected
results.tagIds
array of string
results.tags
array of string
Tags to associate with the message. Tags are converted to lower case and automatically created if they don't exist. Up to 10 tags per message.
results.template
object
Untergeordnete Attribute anzeigen
results.template.attachments
array of object
Untergeordnete Attribute anzeigen
results.template.attachments.content
string
results.template.attachments.contentType
string
results.template.attachments.filename
string
erforderlich
results.template.attachments.inline
boolean
erforderlich
results.template.attachments.mediaUrl
string
erforderlich
results.template.deployment
object
results.template.locale
string
erforderlich
results.template.name
string
The platform name of the template.
results.template.parameters
array of object
Untergeordnete Attribute anzeigen
results.template.parameters.key
string
erforderlich
results.template.parameters.sourceUrl
object
Untergeordnete Attribute anzeigen
results.template.parameters.sourceUrl.fullyReplaced
boolean
erforderlich
results.template.parameters.sourceUrl.value
string
erforderlich
results.template.parameters.type
string
erforderlich
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
erforderlich
results.template.projectId
string
erforderlich
The ID of the project from Studio.
results.template.settings
object
Untergeordnete Attribute anzeigen
results.template.settings.disallowMmLite
boolean
results.template.shortLinks
object
Untergeordnete Attribute anzeigen
results.template.shortLinks.domain
string
erforderlich
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
erforderlich
Enables link shortening for SMS messages.
results.template.templateBody
object
Untergeordnete Attribute anzeigen
results.template.templateBody.text
object
erforderlich
Untergeordnete Attribute anzeigen
results.template.templateBody.text.actions
array of object
Untergeordnete Attribute anzeigen
results.template.templateBody.text.actions.link
object
erforderlich
Untergeordnete Attribute anzeigen
results.template.templateBody.text.actions.link.metadata
object
Untergeordnete Attribute anzeigen
results.template.templateBody.text.actions.link.metadata.description
object
Untergeordnete Attribute anzeigen
results.template.templateBody.text.actions.link.metadata.description.label
string
erforderlich
results.template.templateBody.text.actions.link.text
string
erforderlich
results.template.templateBody.text.actions.link.url
string
erforderlich
results.template.templateBody.text.actions.type
string
erforderlich
Possible values: link
results.template.templateBody.text.attachments
array of object
Untergeordnete Attribute anzeigen
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
erforderlich
results.template.templateBody.text.attachments.inline
boolean
results.template.templateBody.text.attachments.mediaUrl
string
erforderlich
results.template.templateBody.text.metadata
object
Untergeordnete Attribute anzeigen
results.template.templateBody.text.metadata.apple
object
Untergeordnete Attribute anzeigen
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
Untergeordnete Attribute anzeigen
results.template.templateBody.text.metadata.line.emoji
object
Untergeordnete Attribute anzeigen
results.template.templateBody.text.metadata.line.emoji.items
array of object
Untergeordnete Attribute anzeigen
results.template.templateBody.text.metadata.line.emoji.items.emojiId
string
erforderlich
results.template.templateBody.text.metadata.line.emoji.items.index
integer
erforderlich
results.template.templateBody.text.metadata.line.emoji.items.length
integer
results.template.templateBody.text.metadata.line.emoji.items.productId
string
erforderlich
results.template.templateBody.text.metadata.paymentDetails
object
Untergeordnete Attribute anzeigen
results.template.templateBody.text.metadata.paymentDetails.amount
string
erforderlich
results.template.templateBody.text.metadata.paymentDetails.currency
string
erforderlich
results.template.templateBody.text.metadata.paymentDetails.sessionIdentifier
string
results.template.templateBody.text.metadata.paymentDetails.state
string
erforderlich
results.template.templateBody.text.metadata.subject
string
results.template.templateBody.text.metadata.telegram
object
Untergeordnete Attribute anzeigen
results.template.templateBody.text.metadata.telegram.parseMode
string
results.template.templateBody.text.metadata.whatsapp
object
Untergeordnete Attribute anzeigen
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
erforderlich
results.template.templateBody.text.metadata.whatsapp.sharedContacts
array of object
Untergeordnete Attribute anzeigen
results.template.templateBody.text.metadata.whatsapp.sharedContacts.origin
string
erforderlich
results.template.templateBody.text.metadata.whatsapp.sharedContacts.phones
array of object
Untergeordnete Attribute anzeigen
results.template.templateBody.text.metadata.whatsapp.sharedContacts.phones.phone
string
erforderlich
results.template.templateBody.text.metadata.whatsapp.sharedContacts.phones.type
string
erforderlich
results.template.templateBody.text.metadata.whatsapp.sharedContacts.phones.waId
string
erforderlich
results.template.templateBody.text.metadata.whatsapp.sharedContacts.vcard
string
results.template.templateBody.text.text
string
erforderlich
results.template.templateBody.type
string
erforderlich
Possible values: text
results.template.utmParameters
array of object
Untergeordnete Attribute anzeigen
results.template.utmParameters.key
string
erforderlich
results.template.utmParameters.value
string
erforderlich
results.template.variables
object
results.template.version
string
erforderlich
The version of the template.
results.updatedAt
string
erforderlich
Codebeispiel
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/channels/{channelId}/messages' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'

Retrieve list of messages of a workspace

GET
/workspaces/{workspaceId}/channels/messages
It retrieves a list of messages from a given workspace ID
Abfrageparameter
limit
integer
Limits the number of results to return.
channelId
array
The ID for a channel
pageToken
string
The cursor that keeps track of the current position in the results.
reverse
boolean
Reverses the order in which the results are returned.
platform
Filter based on platform name
direction
string
Possible values: incoming, outgoing
id
array
messageType
array
status
array
startAt
string
Start date for the query
endAt
string
End date for the query
from
array
sender identifier for the message
to
array
recipient identifier for the message
failureCode
array
failureSourceCode
array
failureSourceName
array
countryCode
array
usedPlatform
Filter based on the platform the message was delivered over (known values are sms, whatsapp, rcs and mms). Matching is case-insensitive. The reserved value none selects messages without a reported delivery platform.
tag
array
Filter based on tag
emailSubject
string
Full text search on email subject
batchId
string
The ID for a batch
Antwort-Payload
startAt
string
endAt
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.
results
array of object
erforderlich
Untergeordnete Attribute anzeigen
results.body
object
Untergeordnete Attribute anzeigen
results.body.text
object
erforderlich
Untergeordnete Attribute anzeigen
results.body.text.actions
array of object
Untergeordnete Attribute anzeigen
results.body.text.actions.link
object
erforderlich
Untergeordnete Attribute anzeigen
results.body.text.actions.link.metadata
object
Untergeordnete Attribute anzeigen
results.body.text.actions.link.metadata.description
object
Untergeordnete Attribute anzeigen
results.body.text.actions.link.metadata.description.label
string
erforderlich
results.body.text.actions.link.text
string
erforderlich
results.body.text.actions.link.url
string
erforderlich
results.body.text.actions.type
string
erforderlich
Possible values: link
results.body.text.attachments
array of object
Untergeordnete Attribute anzeigen
results.body.text.attachments.content
string
results.body.text.attachments.contentId
string
results.body.text.attachments.contentType
string
results.body.text.attachments.filename
string
erforderlich
results.body.text.attachments.inline
boolean
results.body.text.attachments.mediaUrl
string
erforderlich
results.body.text.metadata
object
Untergeordnete Attribute anzeigen
results.body.text.metadata.apple
object
Untergeordnete Attribute anzeigen
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
Untergeordnete Attribute anzeigen
results.body.text.metadata.line.emoji
object
Untergeordnete Attribute anzeigen
results.body.text.metadata.line.emoji.items
array of object
Untergeordnete Attribute anzeigen
results.body.text.metadata.line.emoji.items.emojiId
string
erforderlich
results.body.text.metadata.line.emoji.items.index
integer
erforderlich
results.body.text.metadata.line.emoji.items.length
integer
results.body.text.metadata.line.emoji.items.productId
string
erforderlich
results.body.text.metadata.paymentDetails
object
Untergeordnete Attribute anzeigen
results.body.text.metadata.paymentDetails.amount
string
erforderlich
results.body.text.metadata.paymentDetails.currency
string
erforderlich
results.body.text.metadata.paymentDetails.sessionIdentifier
string
results.body.text.metadata.paymentDetails.state
string
erforderlich
results.body.text.metadata.subject
string
results.body.text.metadata.telegram
object
Untergeordnete Attribute anzeigen
results.body.text.metadata.telegram.parseMode
string
results.body.text.metadata.whatsapp
object
Untergeordnete Attribute anzeigen
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
erforderlich
results.body.text.metadata.whatsapp.sharedContacts
array of object
Untergeordnete Attribute anzeigen
results.body.text.metadata.whatsapp.sharedContacts.origin
string
erforderlich
results.body.text.metadata.whatsapp.sharedContacts.phones
array of object
Untergeordnete Attribute anzeigen
results.body.text.metadata.whatsapp.sharedContacts.phones.phone
string
erforderlich
results.body.text.metadata.whatsapp.sharedContacts.phones.type
string
erforderlich
results.body.text.metadata.whatsapp.sharedContacts.phones.waId
string
erforderlich
results.body.text.metadata.whatsapp.sharedContacts.vcard
string
results.body.text.text
string
erforderlich
results.body.type
string
erforderlich
Possible values: text
results.bodyId
string
results.bodyStorage
object
Untergeordnete Attribute anzeigen
results.bodyStorage.type
string
erforderlich
Possible values: s3
results.bodyStorage.s3
object
erforderlich
Untergeordnete Attribute anzeigen
results.bodyStorage.s3.bucketArn
string
erforderlich
results.bodyStorage.s3.encryptionKey
string
erforderlich
results.bodyStorage.s3.key
string
erforderlich
results.channelId
string
erforderlich
results.chargeableUnits
integer
results.context
object
Untergeordnete Attribute anzeigen
results.context.id
string
results.context.tagIds
array of string
results.context.type
string
results.createdAt
string
erforderlich
results.details
string
This field is used to store additional information related to the message status.
results.direction
string
Possible values: incoming, outgoing
results.failure
object
Untergeordnete Attribute anzeigen
results.failure.code
integer
omni channel interpretation of the failure to categorise the nature of message error
results.failure.description
string
human readable description of the error
results.failure.source
object
Untergeordnete Attribute anzeigen
results.failure.source.code
string
numerical, text or alphanumeric code that indicates the error or issue while delivering the message in the last step
results.failure.source.name
string
Possible values: pre-processing, accounting, contact, touchpoint, sms-messagebird, sms-twilio, email-messagebird, whatsapp, facebook, instagram, line, telegram, apple-business-chat, viber, chat, google-business-messages, voice, smtp-messagebird, rcs-google, service
results.id
string
erforderlich
results.ignorePersistedEventhooks
boolean
results.lastStatusAt
string
erforderlich
results.meta
object
Untergeordnete Attribute anzeigen
results.meta.campaign
object
Untergeordnete Attribute anzeigen
results.meta.campaign.id
string
results.meta.campaign.name
string
results.meta.campaignId
string
results.meta.chargeOnceDelivered
boolean
results.meta.email
object
Untergeordnete Attribute anzeigen
results.meta.email.from
object
Untergeordnete Attribute anzeigen
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
Untergeordnete Attribute anzeigen
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
Untergeordnete Attribute anzeigen
results.meta.formResponse.id
string
erforderlich
results.meta.formResponse.jsonResponse
string
erforderlich
results.meta.formResponse.requestIdentifier
string
erforderlich
results.meta.formResponse.selections
array of object
Untergeordnete Attribute anzeigen
results.meta.formResponse.selections.items
array of object
Untergeordnete Attribute anzeigen
results.meta.formResponse.selections.items.identifier
string
erforderlich
results.meta.formResponse.selections.items.title
string
erforderlich
results.meta.formResponse.selections.items.type
string
erforderlich
results.meta.formResponse.selections.items.value
string
erforderlich
results.meta.formResponse.selections.pageIdentifier
string
erforderlich
results.meta.formResponse.selections.subtitle
string
erforderlich
results.meta.formResponse.selections.title
string
erforderlich
results.meta.formResponse.sessionIdentifier
string
erforderlich
results.meta.formResponse.template
string
erforderlich
results.meta.formResponse.version
string
erforderlich
results.meta.ignoreGlobalHoldout
boolean
results.meta.ignoreQuietHours
boolean
results.meta.journey
object
Untergeordnete Attribute anzeigen
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.
Untergeordnete Attribute anzeigen
results.meta.order.products
array of object
Untergeordnete Attribute anzeigen
results.meta.order.products.externalCatalogId
string
The platform-specific catalog ID of the product.
results.meta.order.products.externalProductId
string
erforderlich
The platform-specific product ID.
results.meta.order.products.price
object
erforderlich
Untergeordnete Attribute anzeigen
results.meta.order.products.price.amount
integer
erforderlich
results.meta.order.products.price.currencyCode
string
erforderlich
results.meta.order.products.price.exponent
integer
erforderlich
results.meta.order.products.quantity
integer
erforderlich
The number of items purchased.
results.meta.pushNotifications
object
Untergeordnete Attribute anzeigen
results.meta.pushNotifications.gatewayTypeOverride
string
Possible values: firebase, apns, web
results.meta.referral
object
Untergeordnete Attribute anzeigen
results.meta.referral.group
string
results.meta.referral.metadata
object
Untergeordnete Attribute anzeigen
results.meta.referral.metadata.caption
string
results.meta.referral.metadata.mediaType
string
results.meta.referral.metadata.mediaUrl
string
results.meta.referral.metadata.sourceId
string
erforderlich
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
erforderlich
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).
Untergeordnete Attribute anzeigen
results.meta.referredProduct.externalCatalogId
string
The platform-specific catalog ID of the product.
results.meta.referredProduct.externalProductId
string
erforderlich
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
Untergeordnete Attribute anzeigen
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
Untergeordnete Attribute anzeigen
results.meta.sms.smpp.segments
array of object
Untergeordnete Attribute anzeigen
results.meta.sms.smpp.segments.id
string
erforderlich
results.meta.sms.smpp.segments.registeredDelivery
string
erforderlich
Possible values: final, intermediate, all, noDlr
results.meta.sms.smpp.userId
string
erforderlich
results.meta.sms.validity
string
results.meta.useFallback
boolean
results.parts
array of object
Untergeordnete Attribute anzeigen
results.parts.id
string
results.parts.order
integer
results.parts.platformReferenceId
string
results.parts.platformStatusAt
string
results.parts.rawBody
string
results.parts.reason
string
results.parts.status
string
Possible values: accepted, processing, sent, sending_failed, delivered, delivery_failed, deleted, scheduled, skipped, rejected
results.parts.statusAt
string
results.platformId
string
results.platformReferenceId
string
results.previousMessages
array of object
Untergeordnete Attribute anzeigen
results.previousMessages.id
string
erforderlich
results.previousMessages.useCaseType
string
erforderlich
Possible values: unspecified, marketing, otp, transactional, conversation, test
results.reason
string
results.receiver
object
erforderlich
Untergeordnete Attribute anzeigen
results.receiver.connector
object
Untergeordnete Attribute anzeigen
results.receiver.connector.annotations
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Untergeordnete Attribute anzeigen
results.receiver.connector.annotations.name
string
results.receiver.connector.id
string
erforderlich
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
Untergeordnete Attribute anzeigen
results.receiver.contacts.contactAnnotation
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Untergeordnete Attribute anzeigen
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.
Untergeordnete Attribute anzeigen
results.receiver.contacts.identifiers.identifierKey
string
erforderlich
The identifier key for finding the contact (e.g. emailaddress, phonenumber).
results.receiver.contacts.identifiers.identifierValue
string
erforderlich
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
Untergeordnete Attribute anzeigen
results.receiver.device.gateway
string
erforderlich
Possible values: firebase, apns, web
results.receiver.device.id
string
erforderlich
results.receiver.device.identifierValue
string
erforderlich
results.receiver.inbox
object
Untergeordnete Attribute anzeigen
results.receiver.inbox.emailRecipientType
string
results.receiver.inbox.id
string
erforderlich
results.receiver.inbox.identifierKey
string
erforderlich
results.receiver.inbox.identifierValue
string
erforderlich
results.receiver.inbox.type
string
erforderlich
Possible values: user, group
results.receiver.userContacts
array of object
Untergeordnete Attribute anzeigen
results.receiver.userContacts.id
string
erforderlich
results.receiver.userContacts.identifierKey
string
erforderlich
results.receiver.userContacts.identifierValue
string
erforderlich
results.receiver.userContacts.type
string
results.reference
string
A reference to the message. This can be used to identify the message in the channel.
results.replyTo
object
Untergeordnete Attribute anzeigen
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.schedule
object
Untergeordnete Attribute anzeigen
results.schedule.reason
string
erforderlich
results.schedule.scheduledAt
string
erforderlich
results.scheduledFor
string
Scheduled message send time (RFC3339). Messages scheduled within 10 minutes may be sent immediately; messages scheduled more than 35 days out will be rejected.
results.sendAt
string
results.sender
object
erforderlich
Untergeordnete Attribute anzeigen
results.sender.connector
object
Untergeordnete Attribute anzeigen
results.sender.connector.annotations
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Untergeordnete Attribute anzeigen
results.sender.connector.annotations.name
string
results.sender.connector.id
string
erforderlich
results.sender.connector.identifierValue
string
The identifier value of the sender or receiver connector (e.g. email address or phone number).
results.sender.connector.types
array of string
results.sender.contact
object
Untergeordnete Attribute anzeigen
results.sender.contact.contactAnnotation
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Untergeordnete Attribute anzeigen
results.sender.contact.contactAnnotation.name
string
results.sender.contact.countryCode
string
results.sender.contact.id
string
The ID of the contact.
results.sender.contact.identifierKey
string
The identifier key for finding the contact (e.g. emailaddress, phonenumber). For WhatsApp channels with BSUID support, use whatsappbsuid to send to a contact by their Business-Scoped User ID.
results.sender.contact.identifierValue
string
The identifier value for finding the contact.
results.sender.contact.identifiers
array of object
Additional identifiers to augment the contact during resolution.
Untergeordnete Attribute anzeigen
results.sender.contact.identifiers.identifierKey
string
erforderlich
The identifier key for finding the contact (e.g. emailaddress, phonenumber).
results.sender.contact.identifiers.identifierValue
string
erforderlich
The identifier value for finding the contact.
results.sender.contact.platformAddress
string
The resolved platform address used to deliver the message (e.g. phone number or email address).
results.sender.contact.platformAddressSelector
string
An expression that defines how we resolve the platform address from a contact. Optional override for the default resolution logic.
results.sender.contact.receiverExpression
string
results.sender.contact.receiverValue
string
results.sender.contact.type
string
The type of the receiver (e.g. to, cc, bcc for email).
results.sender.inbox
object
Untergeordnete Attribute anzeigen
results.sender.inbox.emailRecipientType
string
results.sender.inbox.id
string
erforderlich
results.sender.inbox.identifierKey
string
erforderlich
results.sender.inbox.identifierValue
string
erforderlich
results.sender.inbox.type
string
erforderlich
Possible values: user, group
results.sender.userContact
object
Untergeordnete Attribute anzeigen
results.sender.userContact.id
string
erforderlich
results.sender.userContact.identifierKey
string
erforderlich
results.sender.userContact.identifierValue
string
erforderlich
results.sender.userContact.type
string
results.shortLinks
object
Untergeordnete Attribute anzeigen
results.shortLinks.domain
string
erforderlich
The domain to use when shortening links. When set to default, uses the default link shortening domain for the workspace.
results.status
string
erforderlich
Possible values: accepted, processing, sent, sending_failed, delivered, delivery_failed, deleted, scheduled, skipped, rejected
results.tagIds
array of string
results.tags
array of string
Tags to associate with the message. Tags are converted to lower case and automatically created if they don't exist. Up to 10 tags per message.
results.template
object
Untergeordnete Attribute anzeigen
results.template.attachments
array of object
Untergeordnete Attribute anzeigen
results.template.attachments.content
string
results.template.attachments.contentType
string
results.template.attachments.filename
string
erforderlich
results.template.attachments.inline
boolean
erforderlich
results.template.attachments.mediaUrl
string
erforderlich
results.template.deployment
object
results.template.locale
string
erforderlich
results.template.name
string
The platform name of the template.
results.template.parameters
array of object
Untergeordnete Attribute anzeigen
results.template.parameters.key
string
erforderlich
results.template.parameters.sourceUrl
object
Untergeordnete Attribute anzeigen
results.template.parameters.sourceUrl.fullyReplaced
boolean
erforderlich
results.template.parameters.sourceUrl.value
string
erforderlich
results.template.parameters.type
string
erforderlich
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
erforderlich
results.template.projectId
string
erforderlich
The ID of the project from Studio.
results.template.settings
object
Untergeordnete Attribute anzeigen
results.template.settings.disallowMmLite
boolean
results.template.shortLinks
object
Untergeordnete Attribute anzeigen
results.template.shortLinks.domain
string
erforderlich
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
erforderlich
Enables link shortening for SMS messages.
results.template.templateBody
object
Untergeordnete Attribute anzeigen
results.template.templateBody.text
object
erforderlich
Untergeordnete Attribute anzeigen
results.template.templateBody.text.actions
array of object
Untergeordnete Attribute anzeigen
results.template.templateBody.text.actions.link
object
erforderlich
Untergeordnete Attribute anzeigen
results.template.templateBody.text.actions.link.metadata
object
Untergeordnete Attribute anzeigen
results.template.templateBody.text.actions.link.metadata.description
object
Untergeordnete Attribute anzeigen
results.template.templateBody.text.actions.link.metadata.description.label
string
erforderlich
results.template.templateBody.text.actions.link.text
string
erforderlich
results.template.templateBody.text.actions.link.url
string
erforderlich
results.template.templateBody.text.actions.type
string
erforderlich
Possible values: link
results.template.templateBody.text.attachments
array of object
Untergeordnete Attribute anzeigen
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
erforderlich
results.template.templateBody.text.attachments.inline
boolean
results.template.templateBody.text.attachments.mediaUrl
string
erforderlich
results.template.templateBody.text.metadata
object
Untergeordnete Attribute anzeigen
results.template.templateBody.text.metadata.apple
object
Untergeordnete Attribute anzeigen
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
Untergeordnete Attribute anzeigen
results.template.templateBody.text.metadata.line.emoji
object
Untergeordnete Attribute anzeigen
results.template.templateBody.text.metadata.line.emoji.items
array of object
Untergeordnete Attribute anzeigen
results.template.templateBody.text.metadata.line.emoji.items.emojiId
string
erforderlich
results.template.templateBody.text.metadata.line.emoji.items.index
integer
erforderlich
results.template.templateBody.text.metadata.line.emoji.items.length
integer
results.template.templateBody.text.metadata.line.emoji.items.productId
string
erforderlich
results.template.templateBody.text.metadata.paymentDetails
object
Untergeordnete Attribute anzeigen
results.template.templateBody.text.metadata.paymentDetails.amount
string
erforderlich
results.template.templateBody.text.metadata.paymentDetails.currency
string
erforderlich
results.template.templateBody.text.metadata.paymentDetails.sessionIdentifier
string
results.template.templateBody.text.metadata.paymentDetails.state
string
erforderlich
results.template.templateBody.text.metadata.subject
string
results.template.templateBody.text.metadata.telegram
object
Untergeordnete Attribute anzeigen
results.template.templateBody.text.metadata.telegram.parseMode
string
results.template.templateBody.text.metadata.whatsapp
object
Untergeordnete Attribute anzeigen
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
erforderlich
results.template.templateBody.text.metadata.whatsapp.sharedContacts
array of object
Untergeordnete Attribute anzeigen
results.template.templateBody.text.metadata.whatsapp.sharedContacts.origin
string
erforderlich
results.template.templateBody.text.metadata.whatsapp.sharedContacts.phones
array of object
Untergeordnete Attribute anzeigen
results.template.templateBody.text.metadata.whatsapp.sharedContacts.phones.phone
string
erforderlich
results.template.templateBody.text.metadata.whatsapp.sharedContacts.phones.type
string
erforderlich
results.template.templateBody.text.metadata.whatsapp.sharedContacts.phones.waId
string
erforderlich
results.template.templateBody.text.metadata.whatsapp.sharedContacts.vcard
string
results.template.templateBody.text.text
string
erforderlich
results.template.templateBody.type
string
erforderlich
Possible values: text
results.template.utmParameters
array of object
Untergeordnete Attribute anzeigen
results.template.utmParameters.key
string
erforderlich
results.template.utmParameters.value
string
erforderlich
results.template.variables
object
results.template.version
string
erforderlich
The version of the template.
results.updatedAt
string
erforderlich
Codebeispiel
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/channels/messages' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'

Retrieve a single message

GET
/workspaces/{workspaceId}/channels/{channelId}/messages/{messageId}
Get a channel message
Antwort-Payload
body
object
Untergeordnete Attribute anzeigen
body.text
object
erforderlich
Untergeordnete Attribute anzeigen
body.text.actions
array of object
Untergeordnete Attribute anzeigen
body.text.actions.link
object
erforderlich
Untergeordnete Attribute anzeigen
body.text.actions.link.metadata
object
Untergeordnete Attribute anzeigen
body.text.actions.link.metadata.description
object
Untergeordnete Attribute anzeigen
body.text.actions.link.metadata.description.label
string
erforderlich
body.text.actions.link.text
string
erforderlich
body.text.actions.link.url
string
erforderlich
body.text.actions.type
string
erforderlich
Possible values: link
body.text.attachments
array of object
Untergeordnete Attribute anzeigen
body.text.attachments.content
string
body.text.attachments.contentId
string
body.text.attachments.contentType
string
body.text.attachments.filename
string
erforderlich
body.text.attachments.inline
boolean
body.text.attachments.mediaUrl
string
erforderlich
body.text.metadata
object
Untergeordnete Attribute anzeigen
body.text.metadata.apple
object
Untergeordnete Attribute anzeigen
body.text.metadata.apple.appClipPreview
boolean
body.text.metadata.apple.appClipRegion
string
body.text.metadata.apple.summaryText
string
body.text.metadata.headers
object
body.text.metadata.line
object
Untergeordnete Attribute anzeigen
body.text.metadata.line.emoji
object
Untergeordnete Attribute anzeigen
body.text.metadata.line.emoji.items
array of object
Untergeordnete Attribute anzeigen
body.text.metadata.line.emoji.items.emojiId
string
erforderlich
body.text.metadata.line.emoji.items.index
integer
erforderlich
body.text.metadata.line.emoji.items.length
integer
body.text.metadata.line.emoji.items.productId
string
erforderlich
body.text.metadata.paymentDetails
object
Untergeordnete Attribute anzeigen
body.text.metadata.paymentDetails.amount
string
erforderlich
body.text.metadata.paymentDetails.currency
string
erforderlich
body.text.metadata.paymentDetails.sessionIdentifier
string
body.text.metadata.paymentDetails.state
string
erforderlich
body.text.metadata.subject
string
body.text.metadata.telegram
object
Untergeordnete Attribute anzeigen
body.text.metadata.telegram.parseMode
string
body.text.metadata.whatsapp
object
Untergeordnete Attribute anzeigen
body.text.metadata.whatsapp.callPermissionExpiration
string
body.text.metadata.whatsapp.callPermissionResponse
string
Possible values: accept, reject
body.text.metadata.whatsapp.previewUrl
boolean
erforderlich
body.text.metadata.whatsapp.sharedContacts
array of object
Untergeordnete Attribute anzeigen
body.text.metadata.whatsapp.sharedContacts.origin
string
erforderlich
body.text.metadata.whatsapp.sharedContacts.phones
array of object
Untergeordnete Attribute anzeigen
body.text.metadata.whatsapp.sharedContacts.phones.phone
string
erforderlich
body.text.metadata.whatsapp.sharedContacts.phones.type
string
erforderlich
body.text.metadata.whatsapp.sharedContacts.phones.waId
string
erforderlich
body.text.metadata.whatsapp.sharedContacts.vcard
string
body.text.text
string
erforderlich
body.type
string
erforderlich
Possible values: text
bodyId
string
bodyStorage
object
Untergeordnete Attribute anzeigen
bodyStorage.type
string
erforderlich
Possible values: s3
bodyStorage.s3
object
erforderlich
Untergeordnete Attribute anzeigen
bodyStorage.s3.bucketArn
string
erforderlich
bodyStorage.s3.encryptionKey
string
erforderlich
bodyStorage.s3.key
string
erforderlich
channelId
string
erforderlich
chargeableUnits
integer
context
object
Untergeordnete Attribute anzeigen
context.id
string
context.tagIds
array of string
context.type
string
createdAt
string
erforderlich
details
string
This field is used to store additional information related to the message status.
direction
string
Possible values: incoming, outgoing
failure
object
Untergeordnete Attribute anzeigen
failure.code
integer
omni channel interpretation of the failure to categorise the nature of message error
failure.description
string
human readable description of the error
failure.source
object
Untergeordnete Attribute anzeigen
failure.source.code
string
numerical, text or alphanumeric code that indicates the error or issue while delivering the message in the last step
failure.source.name
string
Possible values: pre-processing, accounting, contact, touchpoint, sms-messagebird, sms-twilio, email-messagebird, whatsapp, facebook, instagram, line, telegram, apple-business-chat, viber, chat, google-business-messages, voice, smtp-messagebird, rcs-google, service
id
string
erforderlich
ignorePersistedEventhooks
boolean
lastStatusAt
string
erforderlich
meta
object
Untergeordnete Attribute anzeigen
meta.campaign
object
Untergeordnete Attribute anzeigen
meta.campaign.id
string
meta.campaign.name
string
meta.campaignId
string
meta.chargeOnceDelivered
boolean
meta.email
object
Untergeordnete Attribute anzeigen
meta.email.from
object
Untergeordnete Attribute anzeigen
meta.email.from.displayName
string
meta.email.from.username
string
meta.email.headers
object
meta.email.subject
string
meta.extraInformation
object
meta.flow
object
Untergeordnete Attribute anzeigen
meta.flow.id
string
meta.flow.name
string
meta.flow.runId
string
meta.flow.scheduleExecutionId
string
meta.flow.stepId
string
meta.formResponse
object
Untergeordnete Attribute anzeigen
meta.formResponse.id
string
erforderlich
meta.formResponse.jsonResponse
string
erforderlich
meta.formResponse.requestIdentifier
string
erforderlich
meta.formResponse.selections
array of object
Untergeordnete Attribute anzeigen
meta.formResponse.selections.items
array of object
Untergeordnete Attribute anzeigen
meta.formResponse.selections.items.identifier
string
erforderlich
meta.formResponse.selections.items.title
string
erforderlich
meta.formResponse.selections.items.type
string
erforderlich
meta.formResponse.selections.items.value
string
erforderlich
meta.formResponse.selections.pageIdentifier
string
erforderlich
meta.formResponse.selections.subtitle
string
erforderlich
meta.formResponse.selections.title
string
erforderlich
meta.formResponse.sessionIdentifier
string
erforderlich
meta.formResponse.template
string
erforderlich
meta.formResponse.version
string
erforderlich
meta.ignoreGlobalHoldout
boolean
meta.ignoreQuietHours
boolean
meta.journey
object
Untergeordnete Attribute anzeigen
meta.journey.id
string
meta.journey.name
string
meta.journey.runId
string
meta.journey.scheduleExecutionId
string
meta.journey.stepId
string
meta.longToShortLinks
object
meta.metaThreadId
string
meta.navigatorId
string
meta.navigatorMessageId
string
meta.order
object
The order object contains information about the purchase order associated with the message.
Untergeordnete Attribute anzeigen
meta.order.products
array of object
Untergeordnete Attribute anzeigen
meta.order.products.externalCatalogId
string
The platform-specific catalog ID of the product.
meta.order.products.externalProductId
string
erforderlich
The platform-specific product ID.
meta.order.products.price
object
erforderlich
Untergeordnete Attribute anzeigen
meta.order.products.price.amount
integer
erforderlich
meta.order.products.price.currencyCode
string
erforderlich
meta.order.products.price.exponent
integer
erforderlich
meta.order.products.quantity
integer
erforderlich
The number of items purchased.
meta.pushNotifications
object
Untergeordnete Attribute anzeigen
meta.pushNotifications.gatewayTypeOverride
string
Possible values: firebase, apns, web
meta.referral
object
Untergeordnete Attribute anzeigen
meta.referral.group
string
meta.referral.metadata
object
Untergeordnete Attribute anzeigen
meta.referral.metadata.caption
string
meta.referral.metadata.mediaType
string
meta.referral.metadata.mediaUrl
string
meta.referral.metadata.sourceId
string
erforderlich
meta.referral.metadata.sourceUrl
string
meta.referral.metadata.timestamp
string
meta.referral.metadata.trackingId
string
meta.referral.metadata.username
string
meta.referral.source
string
erforderlich
meta.referral.text
string
meta.referral.title
string
meta.referredProduct
object
Referred product in an incoming message (e.g. a product shared in a WhatsApp catalog message).
Untergeordnete Attribute anzeigen
meta.referredProduct.externalCatalogId
string
The platform-specific catalog ID of the product.
meta.referredProduct.externalProductId
string
erforderlich
The platform-specific product ID.
meta.renderedContentBlocks
array of string
meta.shortToLongLinks
object
meta.skipThisMessage
string
Possible values: campaignHoldout, globalHoldout, journeyHoldout
meta.sms
object
Untergeordnete Attribute anzeigen
meta.sms.gatewayId
integer
meta.sms.registeredDelivery
string
Possible values: final, intermediate, all, noDlr
meta.sms.smartEncoding
boolean
When enabled, attempts to transliterate Unicode characters to GSM-7 equivalents. If the resulting text is fully GSM-7 compatible, fewer message segments may be required. The original message body is preserved; transliteration is only applied when sending.
meta.sms.smpp
object
Untergeordnete Attribute anzeigen
meta.sms.smpp.segments
array of object
Untergeordnete Attribute anzeigen
meta.sms.smpp.segments.id
string
erforderlich
meta.sms.smpp.segments.registeredDelivery
string
erforderlich
Possible values: final, intermediate, all, noDlr
meta.sms.smpp.userId
string
erforderlich
meta.sms.validity
string
meta.useFallback
boolean
parts
array of object
Untergeordnete Attribute anzeigen
parts.id
string
parts.order
integer
parts.platformReferenceId
string
parts.platformStatusAt
string
parts.rawBody
string
parts.reason
string
parts.status
string
Possible values: accepted, processing, sent, sending_failed, delivered, delivery_failed, deleted, scheduled, skipped, rejected
parts.statusAt
string
platformId
string
platformReferenceId
string
previousMessages
array of object
Untergeordnete Attribute anzeigen
previousMessages.id
string
erforderlich
previousMessages.useCaseType
string
erforderlich
Possible values: unspecified, marketing, otp, transactional, conversation, test
reason
string
receiver
object
erforderlich
Untergeordnete Attribute anzeigen
receiver.connector
object
Untergeordnete Attribute anzeigen
receiver.connector.annotations
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Untergeordnete Attribute anzeigen
receiver.connector.annotations.name
string
receiver.connector.id
string
erforderlich
receiver.connector.identifierValue
string
The identifier value of the sender or receiver connector (e.g. email address or phone number).
receiver.connector.types
array of string
receiver.contacts
array of object
Untergeordnete Attribute anzeigen
receiver.contacts.contactAnnotation
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Untergeordnete Attribute anzeigen
receiver.contacts.contactAnnotation.name
string
receiver.contacts.countryCode
string
receiver.contacts.id
string
The ID of the contact.
receiver.contacts.identifierKey
string
The identifier key for finding the contact (e.g. emailaddress, phonenumber). For WhatsApp channels with BSUID support, use whatsappbsuid to send to a contact by their Business-Scoped User ID.
receiver.contacts.identifierValue
string
The identifier value for finding the contact.
receiver.contacts.identifiers
array of object
Additional identifiers to augment the contact during resolution.
Untergeordnete Attribute anzeigen
receiver.contacts.identifiers.identifierKey
string
erforderlich
The identifier key for finding the contact (e.g. emailaddress, phonenumber).
receiver.contacts.identifiers.identifierValue
string
erforderlich
The identifier value for finding the contact.
receiver.contacts.platformAddress
string
The resolved platform address used to deliver the message (e.g. phone number or email address).
receiver.contacts.platformAddressSelector
string
An expression that defines how we resolve the platform address from a contact. Optional override for the default resolution logic.
receiver.contacts.receiverExpression
string
receiver.contacts.receiverValue
string
receiver.contacts.type
string
The type of the receiver (e.g. to, cc, bcc for email).
receiver.device
object
Untergeordnete Attribute anzeigen
receiver.device.gateway
string
erforderlich
Possible values: firebase, apns, web
receiver.device.id
string
erforderlich
receiver.device.identifierValue
string
erforderlich
receiver.inbox
object
Untergeordnete Attribute anzeigen
receiver.inbox.emailRecipientType
string
receiver.inbox.id
string
erforderlich
receiver.inbox.identifierKey
string
erforderlich
receiver.inbox.identifierValue
string
erforderlich
receiver.inbox.type
string
erforderlich
Possible values: user, group
receiver.userContacts
array of object
Untergeordnete Attribute anzeigen
receiver.userContacts.id
string
erforderlich
receiver.userContacts.identifierKey
string
erforderlich
receiver.userContacts.identifierValue
string
erforderlich
receiver.userContacts.type
string
reference
string
A reference to the message. This can be used to identify the message in the channel.
replyTo
object
Untergeordnete Attribute anzeigen
replyTo.id
string
The ID of the message that is being replied to.
replyTo.order
integer
The order of the message part in the conversation.
replyTo.platformReference
string
replyTo.type
string
Possible values: message, click
schedule
object
Untergeordnete Attribute anzeigen
schedule.reason
string
erforderlich
schedule.scheduledAt
string
erforderlich
scheduledFor
string
Scheduled message send time (RFC3339). Messages scheduled within 10 minutes may be sent immediately; messages scheduled more than 35 days out will be rejected.
sendAt
string
sender
object
erforderlich
Untergeordnete Attribute anzeigen
sender.connector
object
Untergeordnete Attribute anzeigen
sender.connector.annotations
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Untergeordnete Attribute anzeigen
sender.connector.annotations.name
string
sender.connector.id
string
erforderlich
sender.connector.identifierValue
string
The identifier value of the sender or receiver connector (e.g. email address or phone number).
sender.connector.types
array of string
sender.contact
object
Untergeordnete Attribute anzeigen
sender.contact.contactAnnotation
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Untergeordnete Attribute anzeigen
sender.contact.contactAnnotation.name
string
sender.contact.countryCode
string
sender.contact.id
string
The ID of the contact.
sender.contact.identifierKey
string
The identifier key for finding the contact (e.g. emailaddress, phonenumber). For WhatsApp channels with BSUID support, use whatsappbsuid to send to a contact by their Business-Scoped User ID.
sender.contact.identifierValue
string
The identifier value for finding the contact.
sender.contact.identifiers
array of object
Additional identifiers to augment the contact during resolution.
Untergeordnete Attribute anzeigen
sender.contact.identifiers.identifierKey
string
erforderlich
The identifier key for finding the contact (e.g. emailaddress, phonenumber).
sender.contact.identifiers.identifierValue
string
erforderlich
The identifier value for finding the contact.
sender.contact.platformAddress
string
The resolved platform address used to deliver the message (e.g. phone number or email address).
sender.contact.platformAddressSelector
string
An expression that defines how we resolve the platform address from a contact. Optional override for the default resolution logic.
sender.contact.receiverExpression
string
sender.contact.receiverValue
string
sender.contact.type
string
The type of the receiver (e.g. to, cc, bcc for email).
sender.inbox
object
Untergeordnete Attribute anzeigen
sender.inbox.emailRecipientType
string
sender.inbox.id
string
erforderlich
sender.inbox.identifierKey
string
erforderlich
sender.inbox.identifierValue
string
erforderlich
sender.inbox.type
string
erforderlich
Possible values: user, group
sender.userContact
object
Untergeordnete Attribute anzeigen
sender.userContact.id
string
erforderlich
sender.userContact.identifierKey
string
erforderlich
sender.userContact.identifierValue
string
erforderlich
sender.userContact.type
string
shortLinks
object
Untergeordnete Attribute anzeigen
shortLinks.domain
string
erforderlich
The domain to use when shortening links. When set to default, uses the default link shortening domain for the workspace.
status
string
erforderlich
Possible values: accepted, processing, sent, sending_failed, delivered, delivery_failed, deleted, scheduled, skipped, rejected
tagIds
array of string
tags
array of string
Tags to associate with the message. Tags are converted to lower case and automatically created if they don't exist. Up to 10 tags per message.
template
object
Untergeordnete Attribute anzeigen
template.attachments
array of object
Untergeordnete Attribute anzeigen
template.attachments.content
string
template.attachments.contentType
string
template.attachments.filename
string
erforderlich
template.attachments.inline
boolean
erforderlich
template.attachments.mediaUrl
string
erforderlich
template.deployment
object
template.locale
string
erforderlich
template.name
string
The platform name of the template.
template.parameters
array of object
Untergeordnete Attribute anzeigen
template.parameters.key
string
erforderlich
template.parameters.sourceUrl
object
Untergeordnete Attribute anzeigen
template.parameters.sourceUrl.fullyReplaced
boolean
erforderlich
template.parameters.sourceUrl.value
string
erforderlich
template.parameters.type
string
erforderlich
Possible values: string, timeslotList, productSections, productList, number, boolean, sectionList, shippingMethodList, lineItemList, whatsappProductSections, whatsappProductItems, shortLink, object, carouselCards, appleFormPageItems
template.parameters.value
object or array or string or number or boolean
erforderlich
template.projectId
string
erforderlich
The ID of the project from Studio.
template.settings
object
Untergeordnete Attribute anzeigen
template.settings.disallowMmLite
boolean
template.shortLinks
object
Untergeordnete Attribute anzeigen
template.shortLinks.domain
string
erforderlich
The domain to use when shortening links. When set to default, uses the default link shortening domain for the workspace.
template.shortLinks.enabled
boolean
erforderlich
Enables link shortening for SMS messages.
template.templateBody
object
Untergeordnete Attribute anzeigen
template.templateBody.text
object
erforderlich
Untergeordnete Attribute anzeigen
template.templateBody.text.actions
array of object
Untergeordnete Attribute anzeigen
template.templateBody.text.actions.link
object
erforderlich
Untergeordnete Attribute anzeigen
template.templateBody.text.actions.link.metadata
object
Untergeordnete Attribute anzeigen
template.templateBody.text.actions.link.metadata.description
object
Untergeordnete Attribute anzeigen
template.templateBody.text.actions.link.metadata.description.label
string
erforderlich
template.templateBody.text.actions.link.text
string
erforderlich
template.templateBody.text.actions.link.url
string
erforderlich
template.templateBody.text.actions.type
string
erforderlich
Possible values: link
template.templateBody.text.attachments
array of object
Untergeordnete Attribute anzeigen
template.templateBody.text.attachments.content
string
template.templateBody.text.attachments.contentId
string
template.templateBody.text.attachments.contentType
string
template.templateBody.text.attachments.filename
string
erforderlich
template.templateBody.text.attachments.inline
boolean
template.templateBody.text.attachments.mediaUrl
string
erforderlich
template.templateBody.text.metadata
object
Untergeordnete Attribute anzeigen
template.templateBody.text.metadata.apple
object
Untergeordnete Attribute anzeigen
template.templateBody.text.metadata.apple.appClipPreview
boolean
template.templateBody.text.metadata.apple.appClipRegion
string
template.templateBody.text.metadata.apple.summaryText
string
template.templateBody.text.metadata.headers
object
template.templateBody.text.metadata.line
object
Untergeordnete Attribute anzeigen
template.templateBody.text.metadata.line.emoji
object
Untergeordnete Attribute anzeigen
template.templateBody.text.metadata.line.emoji.items
array of object
Untergeordnete Attribute anzeigen
template.templateBody.text.metadata.line.emoji.items.emojiId
string
erforderlich
template.templateBody.text.metadata.line.emoji.items.index
integer
erforderlich
template.templateBody.text.metadata.line.emoji.items.length
integer
template.templateBody.text.metadata.line.emoji.items.productId
string
erforderlich
template.templateBody.text.metadata.paymentDetails
object
Untergeordnete Attribute anzeigen
template.templateBody.text.metadata.paymentDetails.amount
string
erforderlich
template.templateBody.text.metadata.paymentDetails.currency
string
erforderlich
template.templateBody.text.metadata.paymentDetails.sessionIdentifier
string
template.templateBody.text.metadata.paymentDetails.state
string
erforderlich
template.templateBody.text.metadata.subject
string
template.templateBody.text.metadata.telegram
object
Untergeordnete Attribute anzeigen
template.templateBody.text.metadata.telegram.parseMode
string
template.templateBody.text.metadata.whatsapp
object
Untergeordnete Attribute anzeigen
template.templateBody.text.metadata.whatsapp.callPermissionExpiration
string
template.templateBody.text.metadata.whatsapp.callPermissionResponse
string
Possible values: accept, reject
template.templateBody.text.metadata.whatsapp.previewUrl
boolean
erforderlich
template.templateBody.text.metadata.whatsapp.sharedContacts
array of object
Untergeordnete Attribute anzeigen
template.templateBody.text.metadata.whatsapp.sharedContacts.origin
string
erforderlich
template.templateBody.text.metadata.whatsapp.sharedContacts.phones
array of object
Untergeordnete Attribute anzeigen
template.templateBody.text.metadata.whatsapp.sharedContacts.phones.phone
string
erforderlich
template.templateBody.text.metadata.whatsapp.sharedContacts.phones.type
string
erforderlich
template.templateBody.text.metadata.whatsapp.sharedContacts.phones.waId
string
erforderlich
template.templateBody.text.metadata.whatsapp.sharedContacts.vcard
string
template.templateBody.text.text
string
erforderlich
template.templateBody.type
string
erforderlich
Possible values: text
template.utmParameters
array of object
Untergeordnete Attribute anzeigen
template.utmParameters.key
string
erforderlich
template.utmParameters.value
string
erforderlich
template.variables
object
template.version
string
erforderlich
The version of the template.
updatedAt
string
erforderlich
Codebeispiel
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/channels/{channelId}/messages/{messageId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'

Retrieve all message interactions on a message

GET
/workspaces/{workspaceId}/channels/{channelId}/messages/{messageId}/interactions
List message interactions
Antwort-Payload
results
array of object
Untergeordnete Attribute anzeigen
results.bodyTemplateProjectId
string
results.channelId
string
erforderlich
results.context
object
erforderlich
Untergeordnete Attribute anzeigen
results.context.id
string
results.context.tagIds
array of string
results.context.type
string
results.createdAt
string
erforderlich
results.details
string
results.id
string
erforderlich
results.isFirstInteraction
boolean
results.isFirstInteractionIncludingBots
boolean
results.journey
object
Untergeordnete Attribute anzeigen
results.journey.id
string
results.journey.name
string
results.journey.runId
string
results.journey.scheduleExecutionId
string
results.journey.stepId
string
results.messageCreatedAt
string
results.messageId
string
erforderlich
results.messagePartsCount
integer
erforderlich
results.messageReference
string
erforderlich
results.messageTags
array of string
results.metadata
object
Untergeordnete Attribute anzeigen
results.metadata.button
object
Untergeordnete Attribute anzeigen
results.metadata.button.payload
string
erforderlich
results.metadata.conversion
object
Untergeordnete Attribute anzeigen
results.metadata.conversion.method
string
Method of entering the code
Possible values: unknown, manual, auto
results.metadata.conversion.status
string
Status of the conversion
Possible values: converted, canceled, not_converted, incorrect_code, resent, received_after_expiration
results.metadata.conversion.timestamp
string
Timestamp of when the conversion was recorded
results.metadata.conversion.type
string
Type of conversion
Possible values: otp, url, promo_code
results.metadata.extraInformation
object
results.metadata.link
object
Untergeordnete Attribute anzeigen
results.metadata.link.clickType
string
Possible values: link, button
results.metadata.link.name
string
erforderlich
results.metadata.link.url
string
erforderlich
results.metadata.prefetched
boolean
results.metadata.reaction
object
Untergeordnete Attribute anzeigen
results.metadata.reaction.action
string
erforderlich
Possible values: react, unreact
results.metadata.reaction.emoji
string
erforderlich
results.metadata.renderedContentBlocks
array of string
results.metadata.subscriptionList
object
Untergeordnete Attribute anzeigen
results.metadata.subscriptionList.subscriptionListId
string
erforderlich
results.notification
object
Untergeordnete Attribute anzeigen
results.notification.template
string
results.notification.url
string
erforderlich
results.platformId
string
erforderlich
results.platformReferenceId
string
results.receiver
object
erforderlich
Untergeordnete Attribute anzeigen
results.receiver.connector
object
Untergeordnete Attribute anzeigen
results.receiver.connector.annotations
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Untergeordnete Attribute anzeigen
results.receiver.connector.annotations.name
string
results.receiver.connector.id
string
erforderlich
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
Untergeordnete Attribute anzeigen
results.receiver.contacts.contactAnnotation
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Untergeordnete Attribute anzeigen
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.
Untergeordnete Attribute anzeigen
results.receiver.contacts.identifiers.identifierKey
string
erforderlich
The identifier key for finding the contact (e.g. emailaddress, phonenumber).
results.receiver.contacts.identifiers.identifierValue
string
erforderlich
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
Untergeordnete Attribute anzeigen
results.receiver.device.gateway
string
erforderlich
Possible values: firebase, apns, web
results.receiver.device.id
string
erforderlich
results.receiver.device.identifierValue
string
erforderlich
results.receiver.inbox
object
Untergeordnete Attribute anzeigen
results.receiver.inbox.emailRecipientType
string
results.receiver.inbox.id
string
erforderlich
results.receiver.inbox.identifierKey
string
erforderlich
results.receiver.inbox.identifierValue
string
erforderlich
results.receiver.inbox.type
string
erforderlich
Possible values: user, group
results.receiver.userContacts
array of object
Untergeordnete Attribute anzeigen
results.receiver.userContacts.id
string
erforderlich
results.receiver.userContacts.identifierKey
string
erforderlich
results.receiver.userContacts.identifierValue
string
erforderlich
results.receiver.userContacts.type
string
results.type
string
erforderlich
Possible values: invalid, read, opened, clicked, reported-as-spam, unsubscribe-request, delete, reaction, subscribe-request, subscribe-consent, conversion
results.useCaseType
string
Possible values: unspecified, marketing, otp, transactional, conversation, test
Codebeispiel
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/channels/{channelId}/messages/{messageId}/interactions' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'

Retrieving media

Retrieve pre-signed media uploads

For media that you have uploaded to be sent in a channels message you can retrieve this as follows

Example

Codebeispiel
curl -L -X GET "https://media.api.bird.com/workspaces/42263973-4f1c-40db-bf0e-cea7e4bfa1a2/media/d30aee15-6ac6-408c-89b6-2906df15ca7b" \
-H "Authorization: AccessKey abcd" \
--output downloadimage.jpeg

Retrieve media from incoming messages

For media sent to your channel you can download this media from the following endpoint
The endpoint is in the message under mediaUrl.
Codebeispiel
curl -L -X GET "https://media.api.bird.com/workspaces/{workspaceId}/messages/{messageID}/media/{fileId}" \
-H "Authorization: AccessKey abcd" \
--output downloadimage.jpeg