DocumentatieEngagement Platform API
Sign inGet started
Guides
API

Sending messages

In order to send an Apple Messages message, you must have an active Apple Messages channel and perform a HTTP request to the following endpoint with a valid access key
POST
/workspaces/{workspaceId}/channels/{channelId}/messages
Send a message to a channel
Verzoek-payload
sender
object
Onderliggende parameters tonen
sender.connector
object
verplicht
The sender of the message. For email messages, the sender is used to override the default sender username.
Onderliggende parameters tonen
sender.connector.identifierValue
string
verplicht
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.
Onderliggende parameters tonen
sender.connector.annotations.name
string
receiver
object
verplicht
Onderliggende parameters tonen
receiver.contacts
array of object
Onderliggende parameters tonen
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
Onderliggende parameters tonen
receiver.contacts.identifiers.identifierKey
string
verplicht
The identifier key for finding the contact.
receiver.contacts.identifiers.identifierValue
string
verplicht
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
verplicht
Onderliggende parameters tonen
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
Onderliggende parameters tonen
template.attachments.mediaUrl
string
verplicht
The URL of the attachment.
template.attachments.filename
string
verplicht
The filename of the attachment.
template.attachments.inline
boolean
template.shortLinks
object
SMS link shortening options.
Onderliggende parameters tonen
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.
Onderliggende parameters tonen
template.variables.default
string
template.utmParameters
array of object
The list of UTM parameters.
Onderliggende parameters tonen
template.utmParameters.key
string
verplicht
The name of the parameter in the query string.
template.utmParameters.value
string
verplicht
The static value of the parameter. Mutually exclusive with Reference.
template.parameters
array of object
Onderliggende parameters tonen
template.parameters.type
string
verplicht
Possible values: string
template.parameters.key
string
verplicht
template.parameters.value
string
template.settings
object
Onderliggende parameters tonen
template.settings.disallowMmLite
boolean
This is specific for WhatsApp marketing templates and requires MM Lite to be disabled for the WABAID.
meta
object
Onderliggende parameters tonen
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
Onderliggende parameters tonen
meta.referral.source
string
meta.referral.title
string
meta.referral.text
string
meta.referral.group
string
meta.referral.metadata
object
Onderliggende parameters tonen
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.
Onderliggende parameters tonen
meta.order.products
array of object
Onderliggende parameters tonen
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.
Onderliggende parameters tonen
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.
Onderliggende parameters tonen
meta.referredProduct.externalCatalogId
string
The platform-specific catalog ID of the product.
meta.referredProduct.externalProductId
string
The platform-specific product ID.
meta.email
object
Onderliggende parameters tonen
meta.email.subject
string
meta.email.headers
object
meta.email.from
object
Onderliggende parameters tonen
meta.email.from.username
string
meta.email.from.displayName
string
meta.sms
object
Onderliggende parameters tonen
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
Onderliggende parameters tonen
meta.pushNotifications.gatewayTypeOverride
string
Possible values: apns, firebase, web
meta.navigatorId
string
meta.navigatorMessageId
string
meta.flow
object
Onderliggende parameters tonen
meta.flow.id
string
meta.flow.name
string
meta.flow.stepId
string
meta.flow.runId
string
meta.journey
object
Onderliggende parameters tonen
meta.journey.id
string
meta.journey.name
string
meta.journey.stepId
string
meta.journey.runId
string
meta.campaign
object
Onderliggende parameters tonen
meta.campaign.id
string
meta.campaign.name
string
replyTo
object
Onderliggende parameters tonen
replyTo.id
string
verplicht
The ID of the message that is being replied to.
replyTo.order
integer
The order of the message in the conversation.
replyTo.type
string
verplicht
Possible values: message, click, referrals
notification
object
Onderliggende parameters tonen
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.
Onderliggende parameters tonen
shortLinks.domain
string
verplicht
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).
Antwoord-payload
body
object
Onderliggende attributen tonen
body.text
object
verplicht
Onderliggende attributen tonen
body.text.actions
array of object
Onderliggende attributen tonen
body.text.actions.link
object
verplicht
Onderliggende attributen tonen
body.text.actions.link.metadata
object
Onderliggende attributen tonen
body.text.actions.link.metadata.description
object
Onderliggende attributen tonen
body.text.actions.link.metadata.description.label
string
verplicht
body.text.actions.link.text
string
verplicht
body.text.actions.link.url
string
verplicht
body.text.actions.type
string
verplicht
Possible values: link
body.text.attachments
array of object
Onderliggende attributen tonen
body.text.attachments.content
string
body.text.attachments.contentId
string
body.text.attachments.contentType
string
body.text.attachments.filename
string
verplicht
body.text.attachments.inline
boolean
body.text.attachments.mediaUrl
string
verplicht
body.text.metadata
object
Onderliggende attributen tonen
body.text.metadata.apple
object
Onderliggende attributen tonen
body.text.metadata.apple.appClipPreview
boolean
body.text.metadata.apple.appClipRegion
string
body.text.metadata.apple.summaryText
string
body.text.metadata.headers
object
body.text.metadata.line
object
Onderliggende attributen tonen
body.text.metadata.line.emoji
object
Onderliggende attributen tonen
body.text.metadata.line.emoji.items
array of object
Onderliggende attributen tonen
body.text.metadata.line.emoji.items.emojiId
string
verplicht
body.text.metadata.line.emoji.items.index
integer
verplicht
body.text.metadata.line.emoji.items.length
integer
body.text.metadata.line.emoji.items.productId
string
verplicht
body.text.metadata.paymentDetails
object
Onderliggende attributen tonen
body.text.metadata.paymentDetails.amount
string
verplicht
body.text.metadata.paymentDetails.currency
string
verplicht
body.text.metadata.paymentDetails.sessionIdentifier
string
body.text.metadata.paymentDetails.state
string
verplicht
body.text.metadata.subject
string
body.text.metadata.telegram
object
Onderliggende attributen tonen
body.text.metadata.telegram.parseMode
string
body.text.metadata.whatsapp
object
Onderliggende attributen tonen
body.text.metadata.whatsapp.callPermissionExpiration
string
body.text.metadata.whatsapp.callPermissionResponse
string
Possible values: accept, reject
body.text.metadata.whatsapp.previewUrl
boolean
verplicht
body.text.metadata.whatsapp.sharedContacts
array of object
Onderliggende attributen tonen
body.text.metadata.whatsapp.sharedContacts.origin
string
verplicht
body.text.metadata.whatsapp.sharedContacts.phones
array of object
Onderliggende attributen tonen
body.text.metadata.whatsapp.sharedContacts.phones.phone
string
verplicht
body.text.metadata.whatsapp.sharedContacts.phones.type
string
verplicht
body.text.metadata.whatsapp.sharedContacts.phones.waId
string
verplicht
body.text.metadata.whatsapp.sharedContacts.vcard
string
body.text.text
string
verplicht
body.type
string
verplicht
Possible values: text
bodyId
string
bodyStorage
object
Onderliggende attributen tonen
bodyStorage.type
string
verplicht
Possible values: s3
bodyStorage.s3
object
verplicht
Onderliggende attributen tonen
bodyStorage.s3.bucketArn
string
verplicht
bodyStorage.s3.encryptionKey
string
verplicht
bodyStorage.s3.key
string
verplicht
channelId
string
verplicht
chargeableUnits
integer
context
object
Onderliggende attributen tonen
context.id
string
context.tagIds
array of string
context.type
string
createdAt
string
verplicht
details
string
This field is used to store additional information related to the message status.
direction
string
Possible values: incoming, outgoing
failure
object
Onderliggende attributen tonen
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
Onderliggende attributen tonen
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
verplicht
ignorePersistedEventhooks
boolean
lastStatusAt
string
verplicht
meta
object
Onderliggende attributen tonen
meta.campaign
object
Onderliggende attributen tonen
meta.campaign.id
string
meta.campaign.name
string
meta.campaignId
string
meta.chargeOnceDelivered
boolean
meta.email
object
Onderliggende attributen tonen
meta.email.from
object
Onderliggende attributen tonen
meta.email.from.displayName
string
meta.email.from.username
string
meta.email.headers
object
meta.email.subject
string
meta.extraInformation
object
meta.flow
object
Onderliggende attributen tonen
meta.flow.id
string
meta.flow.name
string
meta.flow.runId
string
meta.flow.scheduleExecutionId
string
meta.flow.stepId
string
meta.formResponse
object
Onderliggende attributen tonen
meta.formResponse.id
string
verplicht
meta.formResponse.jsonResponse
string
verplicht
meta.formResponse.requestIdentifier
string
verplicht
meta.formResponse.selections
array of object
Onderliggende attributen tonen
meta.formResponse.selections.items
array of object
Onderliggende attributen tonen
meta.formResponse.selections.items.identifier
string
verplicht
meta.formResponse.selections.items.title
string
verplicht
meta.formResponse.selections.items.type
string
verplicht
meta.formResponse.selections.items.value
string
verplicht
meta.formResponse.selections.pageIdentifier
string
verplicht
meta.formResponse.selections.subtitle
string
verplicht
meta.formResponse.selections.title
string
verplicht
meta.formResponse.sessionIdentifier
string
verplicht
meta.formResponse.template
string
verplicht
meta.formResponse.version
string
verplicht
meta.ignoreGlobalHoldout
boolean
meta.ignoreQuietHours
boolean
meta.journey
object
Onderliggende attributen tonen
meta.journey.id
string
meta.journey.name
string
meta.journey.runId
string
meta.journey.scheduleExecutionId
string
meta.journey.stepId
string
meta.longToShortLinks
object
meta.metaThreadId
string
meta.navigatorId
string
meta.navigatorMessageId
string
meta.order
object
The order object contains information about the purchase order associated with the message.
Onderliggende attributen tonen
meta.order.products
array of object
Onderliggende attributen tonen
meta.order.products.externalCatalogId
string
The platform-specific catalog ID of the product.
meta.order.products.externalProductId
string
verplicht
The platform-specific product ID.
meta.order.products.price
object
verplicht
Onderliggende attributen tonen
meta.order.products.price.amount
integer
verplicht
meta.order.products.price.currencyCode
string
verplicht
meta.order.products.price.exponent
integer
verplicht
meta.order.products.quantity
integer
verplicht
The number of items purchased.
meta.pushNotifications
object
Onderliggende attributen tonen
meta.pushNotifications.gatewayTypeOverride
string
Possible values: firebase, apns, web
meta.referral
object
Onderliggende attributen tonen
meta.referral.group
string
meta.referral.metadata
object
Onderliggende attributen tonen
meta.referral.metadata.caption
string
meta.referral.metadata.mediaType
string
meta.referral.metadata.mediaUrl
string
meta.referral.metadata.sourceId
string
verplicht
meta.referral.metadata.sourceUrl
string
meta.referral.metadata.timestamp
string
meta.referral.metadata.trackingId
string
meta.referral.metadata.username
string
meta.referral.source
string
verplicht
meta.referral.text
string
meta.referral.title
string
meta.referredProduct
object
Referred product in an incoming message (e.g. a product shared in a WhatsApp catalog message).
Onderliggende attributen tonen
meta.referredProduct.externalCatalogId
string
The platform-specific catalog ID of the product.
meta.referredProduct.externalProductId
string
verplicht
The platform-specific product ID.
meta.renderedContentBlocks
array of string
meta.shortToLongLinks
object
meta.skipThisMessage
string
Possible values: campaignHoldout, globalHoldout, journeyHoldout
meta.sms
object
Onderliggende attributen tonen
meta.sms.gatewayId
integer
meta.sms.registeredDelivery
string
Possible values: final, intermediate, all, noDlr
meta.sms.smartEncoding
boolean
When enabled, attempts to transliterate Unicode characters to GSM-7 equivalents. If the resulting text is fully GSM-7 compatible, fewer message segments may be required. The original message body is preserved; transliteration is only applied when sending.
meta.sms.smpp
object
Onderliggende attributen tonen
meta.sms.smpp.segments
array of object
Onderliggende attributen tonen
meta.sms.smpp.segments.id
string
verplicht
meta.sms.smpp.segments.registeredDelivery
string
verplicht
Possible values: final, intermediate, all, noDlr
meta.sms.smpp.userId
string
verplicht
meta.sms.validity
string
meta.useFallback
boolean
parts
array of object
Onderliggende attributen tonen
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
Onderliggende attributen tonen
previousMessages.id
string
verplicht
previousMessages.useCaseType
string
verplicht
Possible values: unspecified, marketing, otp, transactional, conversation, test
reason
string
receiver
object
verplicht
Onderliggende attributen tonen
receiver.connector
object
Onderliggende attributen tonen
receiver.connector.annotations
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Onderliggende attributen tonen
receiver.connector.annotations.name
string
receiver.connector.id
string
verplicht
receiver.connector.identifierValue
string
The identifier value of the sender or receiver connector (e.g. email address or phone number).
receiver.connector.types
array of string
receiver.contacts
array of object
Onderliggende attributen tonen
receiver.contacts.contactAnnotation
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Onderliggende attributen tonen
receiver.contacts.contactAnnotation.name
string
receiver.contacts.countryCode
string
receiver.contacts.id
string
The ID of the contact.
receiver.contacts.identifierKey
string
The identifier key for finding the contact (e.g. emailaddress, phonenumber). For WhatsApp channels with BSUID support, use whatsappbsuid to send to a contact by their Business-Scoped User ID.
receiver.contacts.identifierValue
string
The identifier value for finding the contact.
receiver.contacts.identifiers
array of object
Additional identifiers to augment the contact during resolution.
Onderliggende attributen tonen
receiver.contacts.identifiers.identifierKey
string
verplicht
The identifier key for finding the contact (e.g. emailaddress, phonenumber).
receiver.contacts.identifiers.identifierValue
string
verplicht
The identifier value for finding the contact.
receiver.contacts.platformAddress
string
The resolved platform address used to deliver the message (e.g. phone number or email address).
receiver.contacts.platformAddressSelector
string
An expression that defines how we resolve the platform address from a contact. Optional override for the default resolution logic.
receiver.contacts.receiverExpression
string
receiver.contacts.receiverValue
string
receiver.contacts.type
string
The type of the receiver (e.g. to, cc, bcc for email).
receiver.device
object
Onderliggende attributen tonen
receiver.device.gateway
string
verplicht
Possible values: firebase, apns, web
receiver.device.id
string
verplicht
receiver.device.identifierValue
string
verplicht
receiver.inbox
object
Onderliggende attributen tonen
receiver.inbox.emailRecipientType
string
receiver.inbox.id
string
verplicht
receiver.inbox.identifierKey
string
verplicht
receiver.inbox.identifierValue
string
verplicht
receiver.inbox.type
string
verplicht
Possible values: user, group
receiver.userContacts
array of object
Onderliggende attributen tonen
receiver.userContacts.id
string
verplicht
receiver.userContacts.identifierKey
string
verplicht
receiver.userContacts.identifierValue
string
verplicht
receiver.userContacts.type
string
reference
string
A reference to the message. This can be used to identify the message in the channel.
replyTo
object
Onderliggende attributen tonen
replyTo.id
string
The ID of the message that is being replied to.
replyTo.order
integer
The order of the message part in the conversation.
replyTo.platformReference
string
replyTo.type
string
Possible values: message, click
schedule
object
Onderliggende attributen tonen
schedule.reason
string
verplicht
schedule.scheduledAt
string
verplicht
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
verplicht
Onderliggende attributen tonen
sender.connector
object
Onderliggende attributen tonen
sender.connector.annotations
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Onderliggende attributen tonen
sender.connector.annotations.name
string
sender.connector.id
string
verplicht
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
Onderliggende attributen tonen
sender.contact.contactAnnotation
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Onderliggende attributen tonen
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.
Onderliggende attributen tonen
sender.contact.identifiers.identifierKey
string
verplicht
The identifier key for finding the contact (e.g. emailaddress, phonenumber).
sender.contact.identifiers.identifierValue
string
verplicht
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
Onderliggende attributen tonen
sender.inbox.emailRecipientType
string
sender.inbox.id
string
verplicht
sender.inbox.identifierKey
string
verplicht
sender.inbox.identifierValue
string
verplicht
sender.inbox.type
string
verplicht
Possible values: user, group
sender.userContact
object
Onderliggende attributen tonen
sender.userContact.id
string
verplicht
sender.userContact.identifierKey
string
verplicht
sender.userContact.identifierValue
string
verplicht
sender.userContact.type
string
shortLinks
object
Onderliggende attributen tonen
shortLinks.domain
string
verplicht
The domain to use when shortening links. When set to default, uses the default link shortening domain for the workspace.
status
string
verplicht
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
Onderliggende attributen tonen
template.attachments
array of object
Onderliggende attributen tonen
template.attachments.content
string
template.attachments.contentType
string
template.attachments.filename
string
verplicht
template.attachments.inline
boolean
verplicht
template.attachments.mediaUrl
string
verplicht
template.deployment
object
template.locale
string
verplicht
template.name
string
The platform name of the template.
template.parameters
array of object
Onderliggende attributen tonen
template.parameters.key
string
verplicht
template.parameters.sourceUrl
object
Onderliggende attributen tonen
template.parameters.sourceUrl.fullyReplaced
boolean
verplicht
template.parameters.sourceUrl.value
string
verplicht
template.parameters.type
string
verplicht
Possible values: string, timeslotList, productSections, productList, number, boolean, sectionList, shippingMethodList, lineItemList, whatsappProductSections, whatsappProductItems, shortLink, object, carouselCards, appleFormPageItems
template.parameters.value
object or array or string or number or boolean
verplicht
template.projectId
string
verplicht
The ID of the project from Studio.
template.settings
object
Onderliggende attributen tonen
template.settings.disallowMmLite
boolean
template.shortLinks
object
Onderliggende attributen tonen
template.shortLinks.domain
string
verplicht
The domain to use when shortening links. When set to default, uses the default link shortening domain for the workspace.
template.shortLinks.enabled
boolean
verplicht
Enables link shortening for SMS messages.
template.templateBody
object
Onderliggende attributen tonen
template.templateBody.text
object
verplicht
Onderliggende attributen tonen
template.templateBody.text.actions
array of object
Onderliggende attributen tonen
template.templateBody.text.actions.link
object
verplicht
Onderliggende attributen tonen
template.templateBody.text.actions.link.metadata
object
Onderliggende attributen tonen
template.templateBody.text.actions.link.metadata.description
object
Onderliggende attributen tonen
template.templateBody.text.actions.link.metadata.description.label
string
verplicht
template.templateBody.text.actions.link.text
string
verplicht
template.templateBody.text.actions.link.url
string
verplicht
template.templateBody.text.actions.type
string
verplicht
Possible values: link
template.templateBody.text.attachments
array of object
Onderliggende attributen tonen
template.templateBody.text.attachments.content
string
template.templateBody.text.attachments.contentId
string
template.templateBody.text.attachments.contentType
string
template.templateBody.text.attachments.filename
string
verplicht
template.templateBody.text.attachments.inline
boolean
template.templateBody.text.attachments.mediaUrl
string
verplicht
template.templateBody.text.metadata
object
Onderliggende attributen tonen
template.templateBody.text.metadata.apple
object
Onderliggende attributen tonen
template.templateBody.text.metadata.apple.appClipPreview
boolean
template.templateBody.text.metadata.apple.appClipRegion
string
template.templateBody.text.metadata.apple.summaryText
string
template.templateBody.text.metadata.headers
object
template.templateBody.text.metadata.line
object
Onderliggende attributen tonen
template.templateBody.text.metadata.line.emoji
object
Onderliggende attributen tonen
template.templateBody.text.metadata.line.emoji.items
array of object
Onderliggende attributen tonen
template.templateBody.text.metadata.line.emoji.items.emojiId
string
verplicht
template.templateBody.text.metadata.line.emoji.items.index
integer
verplicht
template.templateBody.text.metadata.line.emoji.items.length
integer
template.templateBody.text.metadata.line.emoji.items.productId
string
verplicht
template.templateBody.text.metadata.paymentDetails
object
Onderliggende attributen tonen
template.templateBody.text.metadata.paymentDetails.amount
string
verplicht
template.templateBody.text.metadata.paymentDetails.currency
string
verplicht
template.templateBody.text.metadata.paymentDetails.sessionIdentifier
string
template.templateBody.text.metadata.paymentDetails.state
string
verplicht
template.templateBody.text.metadata.subject
string
template.templateBody.text.metadata.telegram
object
Onderliggende attributen tonen
template.templateBody.text.metadata.telegram.parseMode
string
template.templateBody.text.metadata.whatsapp
object
Onderliggende attributen tonen
template.templateBody.text.metadata.whatsapp.callPermissionExpiration
string
template.templateBody.text.metadata.whatsapp.callPermissionResponse
string
Possible values: accept, reject
template.templateBody.text.metadata.whatsapp.previewUrl
boolean
verplicht
template.templateBody.text.metadata.whatsapp.sharedContacts
array of object
Onderliggende attributen tonen
template.templateBody.text.metadata.whatsapp.sharedContacts.origin
string
verplicht
template.templateBody.text.metadata.whatsapp.sharedContacts.phones
array of object
Onderliggende attributen tonen
template.templateBody.text.metadata.whatsapp.sharedContacts.phones.phone
string
verplicht
template.templateBody.text.metadata.whatsapp.sharedContacts.phones.type
string
verplicht
template.templateBody.text.metadata.whatsapp.sharedContacts.phones.waId
string
verplicht
template.templateBody.text.metadata.whatsapp.sharedContacts.vcard
string
template.templateBody.text.text
string
verplicht
template.templateBody.type
string
verplicht
Possible values: text
template.utmParameters
array of object
Onderliggende attributen tonen
template.utmParameters.key
string
verplicht
template.utmParameters.value
string
verplicht
template.variables
object
template.version
string
verplicht
The version of the template.
updatedAt
string
verplicht
Codevoorbeeld
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 message body field in all cases except for sending a message template when you must only set the template field
Body
Codevoorbeeld
{
 "receiver": {
   "contacts": [
     {
       "identifierKey": "applebc-BUSINESS_ACCOUNT_ID",
       "identifierValue": "urn:mbid:EXAMPLE_PARTICIPANT_ID"
     }
   ]
 },
 "body": {...}
}
Template
Codevoorbeeld
{
 "receiver": {
   "contacts": [
     {
       "identifierKey": "applebc-BUSINESS_ACCOUNT_ID",
       "identifierValue": "urn:mbid:EXAMPLE_PARTICIPANT_ID"
     }
   ]
 },
 "template": {...}
}
You can send messages to users who have opted in to receiving messages from your Apple Messages business and have not closed the conversation with you. You can check if the conversation is open by making a request as follows. If a 200 is returned it means the conversation window is open. In addition this will return the latest capabilities of the user device (which determines what messages they can receive).
GET
/workspaces/{workspaceId}/channels/{channelId}/contacts/{contactId}
Retrieve channel information for a given contact.
Queryparameters
contactIdentifierValue
string
The receiver identifier value.
Antwoord-payload
serviceWindowExpireAt
string
verplicht
isPermanentSession
boolean
metadata
object
Codevoorbeeld
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/channels/{channelId}/contacts/{contactId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
The Channels API supports many of the features of Apple Messages; however, due to the omni-channel nature of the API, there may be some differences between the Channels API message and the native Apple API. Here is an overview of the Apple message types and Channels API message types:
Apple Messages API TypeChannels API
TextText
Rich linkText with links
AttachmentImage / File
Apple Maps LinkLocation
Quick ReplyText + actions / Images + actions / File +actions
List PickerTemplate
Time PickerTemplate
Apple PayTemplate
AuthenticationTemplate
iMessage AppTemplate
FormTemplate

Outbound Messages

Text

Text message

{
"type": "text",
"text": {
"text": "Single text message"
}
}

Text with links

Sending a text message containing a link will split the message into a text + rich link and any text after. The link must use HTTPS — plain-HTTP links are sent as regular text because Apple rejects payloads containing them. To ensure the card renders with a visual ensure the URL you are sending has og:image or og:video tags set; the preview image is converted to PNG automatically (maximum 200 KB).
{
"type": "text",
"text": {
"text": "Single text message with a rich link: https://www.apple.com and text after"
}
}

Text with reply buttons

{
"type": "text",
"text": {
"text": "Single text message",
"actions": [
{
"type": "reply",
"reply": {
"text": "Reply action 1"
}
},
{
"type": "reply",
"reply": {
"text": "Reply action 2"
}
}
]
}
}

Text with postback actions

{
"type": "text",
"text": {
"text": "Single text message with reply and postback actions",
"actions": [
{
"type": "postback",
"postback": {
"text": "Postback action 1",
"payload": "postback-payload-1"
}
},
{
"type": "postback",
"postback": {
"text": "Postback action 2",
"payload": "postback-payload-2"
}
}
]
}
}

Text with reply actions and summaryText

Setting text.metadata.summaryText will show the Summary Text in the users message list preview
{
"type": "text",
"text": {
"text": "Single text message",
"metadata": {
"apple": {
"summaryText": "Customised summaryText"
}
},
"actions": [
{
"type": "reply",
"reply": {
"text": "Reply action 1"
}
},
{
"type": "reply",
"reply": {
"text": "Reply action 2"
}
}
]
}
}

Image

Single image message

{
"type": "image",
"image": {
"images": [
{
"mediaUrl": "https://bird.com/images/image1.jpg"
}
]
}
}

Single image message with text

{
"type": "image",
"image": {
"images": [
{
"mediaUrl": "https://bird.com/images/image1.jpg"
}
],
"text": "Single image message"
}
}

Single image message with reply actions

{
"type": "image",
"image": {
"images": [
{
"mediaUrl": "https://bird.com/images/image1.jpg"
}
],
"text": "Single image message",
"actions": [
{
"type": "reply",
"reply": {
"text": "Reply action 1"
}
},
{
"type": "reply",
"reply": {
"text": "Reply action 2"
}
}
]
}
}

Single image message with postback actions

{
"type": "image",
"image": {
"images": [
{
"mediaUrl": "https://bird.com/images/image1.jpg"
}
],
"text": "Single image message",
"actions": [
{
"type": "postback",
"postback": {
"payload": "postback-payload-1",
"text": "Postback option 1"
}
},
{
"postback": {
"payload": "postback-payload-2",
"text": "Postback option 2"
},
"type": "postback"
}
]
}
}

File

Single file message

{
"type": "file",
"file": {
"files": [
{
"contentType": "video/mp4",
"mediaUrl": "mediaUrl": "https://bird.com/videos/video1.mp4"
}
]
}
}

Single file message with text

{
"type": "file",
"file": {
"text": "Single file message",
"files": [
{
"contentType": "video/mp4",
"mediaUrl": "https://bird.com/videos/video1.mp4"
}
]
}
}

Single file message with reply actions

{
"type": "file",
"file": {
"text": "Single file message",
"actions": [
{
"type": "reply",
"reply": {
"text": "Reply action 1"
}
},
{
"type": "reply",
"reply": {
"text": "Reply action 2"
}
}
],
"files": [
{
"contentType": "video/mp4",
"mediaUrl": "https://bird.com/videos/video1.mp4" }
]
}
}

Single file message with postback actions

{
"type": "file",
"file": {
"text": "Single file message",
"actions": [
{
"type": "postback",
"postback": {
"payload": "postback-payload-1",
"text": "Postback option 1"
}
},
{
"postback": {
"payload": "postback-payload-2",
"text": "Postback option 2"
},
"type": "postback"
}
],
"files": [
{
"contentType": "video/mp4",
"mediaUrl": "https://bird.com/videos/video1.mp4"
}
]
}
}

Location

with coordinates
{
"type": "location",
"location": {
"coordinates": {
"latitude": 37.3346438,
"longitude": -122.0115469
},
"location": {
"label": "Apple Park Way"
}
}
}
with text
{
"type": "text",
"text": {
"text": "Visit us here: https://maps.apple.com/place?map=explore&address=Apple+Park+Way%2C+Cupertino%2C+CA++95014%2C+United+States&coordinate=37.334644%2C-122.011547&name=Apple+Park+Way"
}
}

Template

Basic text template with variable

{ "projectId":"ce6a2fd6-b2fa-4f5a-a2cd-f3bd15883318",
"version":"latest",
"locale":"en",
"parameters":[
{
"type":"string",
"key":"name",
"value":"Robert"
}
]
}

List picker template with section list variable

{ "projectId":"ce6a2fd6-b2fa-4f5a-a2cd-f3bd15883318",
"version":"latest",
"locale":"en",
"parameters":[
{
"type":"sectionList",
"key":"listpicker",
"value": {
"sections": [
{
"id": "iphone-section",
"multipleSelection": false,
"title": "iPhone Models",
"items": [
{
"id": "iphone-pro-item",
"type": "reply-action",
"replyAction": {
"text": "iPhone Pro - Premium performance",
"imageUrl": "https://bird.com/images/image1.jpg",
"payload": "iphone_pro_selected",
"subTitle": "Pro camera system and titanium design"
}
},
{
"id": "iphone-air-item",
"type": "reply-action",
"replyAction": {
"text": "iPhone Air - Ultra lightweight",
"imageUrl": "https://bird.com/images/image2.jpg",
"payload": "iphone_air_selected",
"subTitle": "Sleek design with incredible portability"
}
},
{
"id": "iphone-17-item",
"type": "reply-action",
"replyAction": {
"text": "iPhone 17 - Latest innovation",
"imageUrl": "https://bird.com/images/image3.jpg",
"payload": "iphone_17_selected",
"subTitle": "Next generation features and performance"
}
}
]
}
]
}
}
]
}

Time picker template with time slot list variable

{ "projectId":"ce6a2fd6-b2fa-4f5a-a2cd-f3bd15883318",
"version":"latest",
"locale":"en",
"parameters":[
{
"type":"string",
"key":"timeslot",
"value": {
"timeslots": [
{
"id": "slot-1",
"startTime": "2025-11-24T09:00:00Z",
"duration": 30
},
{
"id": "slot-2",
"startTime": "2025-11-24T14:00:00Z",
"duration": 30
},
{
"id": "slot-3",
"startTime": "2025-11-25T10:00:00Z",
"duration": 30
},
{
"id": "slot-4",
"startTime": "2025-11-25T15:30:00Z",
"duration": 30
},
{
"id": "slot-5",
"startTime": "2025-11-26T11:00:00Z",
"duration": 30
},
{
"id": "slot-6",
"startTime": "2025-11-27T09:30:00Z",
"duration": 30
},
{
"id": "slot-7",
"startTime": "2025-11-27T16:00:00Z",
"duration": 30
},
{
"id": "slot-8",
"startTime": "2025-11-28T10:00:00Z",
"duration": 30
}
]
}
}
]
}

Form template with dynamic select

"template": {
"projectId": "ce6a2fd6-b2fa-4f5a-a2cd-f3bd15883318",
"version": "latest",
"locale": "en",
"parameters": [
{
"type": "appleFormPageItems",
"key": "Select",
"value": {
"items": [
{
"identifier": "iphone-pro",
"title": "iPhone Pro - Premium performance",
"value": "iphone_pro",
"imageUrl": "https://bird.com/images/image1.jpg"
},
{
"identifier": "iphone-air",
"title": "iPhone Air - Ultra lightweight",
"value": "iphone_air",
"imageUrl": "https://bird.com/images/image2.jpg"
},
{
"identifier": "iphone-17",
"title": "iPhone 17 - Latest innovation",
"value": "iphone_17",
"imageUrl": "https://bird.com/images/image3.jpg"
}
]
}
}
]
}

Form template with dynamic picker

"template": {
"projectId": "ce6a2fd6-b2fa-4f5a-a2cd-f3bd15883318",
"version": "latest",
"locale": "en",
"parameters": [
{
"type": "appleFormPageItems",
"key": "Select",
"value": {
"items": [
{
"identifier": "iphone-pro",
"title": "iPhone Pro - Premium performance",
"value": "iphone_pro"
},
{
"identifier": "iphone-air",
"title": "iPhone Air - Ultra lightweight",
"value": "iphone_air"
},
{
"identifier": "iphone-17",
"title": "iPhone 17 - Latest innovation",
"value": "iphone_17"
}
]
}
}
]
}