DokumentasiEngagement Platform API
Sign inGet started
Guides
API

Create conversation message

When sending messages through the Conversations API, the participant type must always be one of accessKey, flow, or contact, with accessKey being the most common usage. The value of participantId depends on participantType as shown below:
Participant typeDescriptionMeaning of participant ID
accessKeyA Bird API access key. This is what you'll commonly use when sending messages through the Conversations APIAccess key ID
contactA Bird contactContact ID
flowA Bird flowFlow ID
POST
/workspaces/{workspaceId}/conversations/{conversationId}/messages
Sends a message in a conversation. The message content can be comprised of either body or template. Attempting to send as a participant that hasn't been added to the conversation results in an error unless the option addMissingParticipants is set to true. Attempting to send messages in a closed conversation results in an error.
Parameter path
conversationId
string
The conversation ID
Payload permintaan
A message specifying its contents through a body field.
draft
boolean
Whether this message is a draft.
reference
string
A customizable ID assigned to messages you send. This can be used to correlate messages with data from your own integrating services. Must be globally unique within a workspace.
sender
object
Message sender information for email.
Tampilkan parameter turunan
sender.name
string
wajib
Sender name shown in the email "From" header.
sender.email
string
Sender email address.
sender.emailReplyToAddress
string
Sender email address to reply to.
participantId
string
wajib
Participant ID.
replyToMessageId
string
Message ID to reply to. Only used for email channels, other channel types must use replyTo.
participantType
string
wajib
Participant type. When sending messages through the Conversations API, the participant be one of accessKey, flow, or contact.
Possible values: user, contact, agent, flow, bot, accessKey, channel, connector, collaborationAutomation
participantContactIdentifierKey
string
The key of the contact identifier to use for the participant. This is used when the participant is not a user in the system.
participantContactIdentifierValue
string
recipients
array of object
List of recipients.
Tampilkan parameter turunan
Create a new recipient by specifying an identifier key and identifier value. For more information on identifier keys and values, please refer to the "Conversation Participants" page.
recipients.identifierKey
string
Identifier key of the contact depending on which channel is being used.
recipients.identifierValue
string
wajib
Identifier of the contact, such as a phone number or email address.
recipients.platformAddressSelector
string
An expression to determine the contact's platform address (such as email or phone number) dynamically when sending messages in advanced use cases.
recipients.type
string
wajib
Whether the email address is in the email's "To", "CC", or "BCC" headers.
Possible values: to, cc, bcc
addMissingParticipants
boolean
If enabled, conveniently adds missing participants to the conversation without requiring additional API calls to /participants. It's recommended to set this to true.
body
object
wajib
Tampilkan parameter turunan
body.text
object
wajib
Tampilkan parameter turunan
body.text.actions
array of object
Tampilkan parameter turunan
body.text.actions.link
object
wajib
Tampilkan parameter turunan
body.text.actions.link.metadata
object
Tampilkan parameter turunan
body.text.actions.link.metadata.description
object
Tampilkan parameter turunan
body.text.actions.link.metadata.description.label
string
wajib
body.text.actions.link.text
string
wajib
body.text.actions.link.url
string
wajib
body.text.actions.type
string
wajib
Possible values: link
body.text.attachments
array of object
Tampilkan parameter turunan
body.text.attachments.content
string
body.text.attachments.contentId
string
body.text.attachments.contentType
string
body.text.attachments.filename
string
wajib
body.text.attachments.inline
boolean
body.text.attachments.mediaUrl
string
wajib
body.text.metadata
object
Tampilkan parameter turunan
body.text.metadata.apple
object
Tampilkan parameter turunan
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
Tampilkan parameter turunan
body.text.metadata.line.emoji
object
Tampilkan parameter turunan
body.text.metadata.line.emoji.items
array of object
Tampilkan parameter turunan
body.text.metadata.line.emoji.items.emojiId
string
wajib
body.text.metadata.line.emoji.items.index
integer
wajib
body.text.metadata.line.emoji.items.length
integer
body.text.metadata.line.emoji.items.productId
string
wajib
body.text.metadata.paymentDetails
object
Tampilkan parameter turunan
body.text.metadata.paymentDetails.amount
string
wajib
body.text.metadata.paymentDetails.currency
string
wajib
body.text.metadata.paymentDetails.sessionIdentifier
string
body.text.metadata.paymentDetails.state
string
wajib
body.text.metadata.subject
string
body.text.metadata.telegram
object
Tampilkan parameter turunan
body.text.metadata.telegram.parseMode
string
body.text.metadata.whatsapp
object
Tampilkan parameter turunan
body.text.metadata.whatsapp.callPermissionExpiration
string
body.text.metadata.whatsapp.callPermissionResponse
string
Possible values: accept, reject
body.text.metadata.whatsapp.previewUrl
boolean
wajib
body.text.metadata.whatsapp.sharedContacts
array of object
Tampilkan parameter turunan
body.text.metadata.whatsapp.sharedContacts.origin
string
wajib
body.text.metadata.whatsapp.sharedContacts.phones
array of object
Tampilkan parameter turunan
body.text.metadata.whatsapp.sharedContacts.phones.phone
string
wajib
body.text.metadata.whatsapp.sharedContacts.phones.type
string
wajib
body.text.metadata.whatsapp.sharedContacts.phones.waId
string
wajib
body.text.metadata.whatsapp.sharedContacts.vcard
string
body.text.text
string
wajib
body.type
string
wajib
Possible values: text
replyTo
object
Tampilkan parameter turunan
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
appendPreviousMessage
boolean
channelId
string
Channel ID.
participants
array of object
When creating a new conversation, this is the list of participants.
Tampilkan parameter turunan
Create a participant of the type user, access key, flow, agent, bot, or action rule.
participants.id
string
wajib
The ID of the user, access key, flow, agent, bot, or action rule.
participants.type
string
wajib
Participant type.
Possible values: user, accessKey, flow, agent, bot, collaborationAutomation
name
string
When creating a new conversation, this is the subject of the email.
description
string
When creating a new conversation, this is the description associated with it.
visibility
string
Possible values: public, private, direct, group
accessibility
string
Possible values: open, invite-only, request-to-join, private
attributes
object
A free-form object containing conversation attributes. You can use this field to store custom information along with the conversation.
meta
object
Message metadata fields that might be populated depending on the channel being used.
Tampilkan parameter turunan
meta.email
object
Metadata fields for email messages.
Tampilkan parameter turunan
meta.email.subject
string
Email subject line.
meta.email.headers
object
Additional email headers.
meta.email.from
object
Email From address.
Tampilkan parameter turunan
meta.email.from.username
string
The username part of the adress, e.g. for the address john.doe@bird.com, this value will be john.doe.
meta.email.from.displayName
string
The display name of an email participant.
meta.extraInformation
object
A free-form object that might contain additional metadata fields. Messages sent through the Conversations API are automatically classified with the conversation useCase, so on Meta channels (Messenger, Instagram) they are delivered with Meta's HUMAN_AGENT tag (the 7-day human-agent window).
meta.referral
object
This represents a social media post or an ad that was referenced when starting the conversation.
Tampilkan parameter turunan
meta.referral.source
string
meta.referral.title
string
meta.referral.text
string
meta.referral.group
string
meta.referral.metadata
object
Tampilkan parameter turunan
meta.referral.metadata.sourceId
string
The ID of the social media post or ad.
meta.referral.metadata.sourceUrl
string
The URL of the social media post or ad.
meta.referral.metadata.mediaType
string
Type of media used in the post or ad.
meta.referral.metadata.mediaUrl
string
Link to the media associated with the referral post or ad.
meta.referral.metadata.caption
string
Caption associated with the referral post or ad.
meta.referral.metadata.username
string
Username who created the referral post or ad.
meta.referral.metadata.timestamp
string
Timestamp when the referral post or ad was created.
meta.referral.metadata.trackingId
string
Payload respons
body
object
Tampilkan atribut turunan
body.text
object
wajib
Tampilkan atribut turunan
body.text.actions
array of object
Tampilkan atribut turunan
body.text.actions.link
object
wajib
Tampilkan atribut turunan
body.text.actions.link.metadata
object
Tampilkan atribut turunan
body.text.actions.link.metadata.description
object
Tampilkan atribut turunan
body.text.actions.link.metadata.description.label
string
wajib
body.text.actions.link.text
string
wajib
body.text.actions.link.url
string
wajib
body.text.actions.type
string
wajib
Possible values: link
body.text.attachments
array of object
Tampilkan atribut turunan
body.text.attachments.content
string
body.text.attachments.contentId
string
body.text.attachments.contentType
string
body.text.attachments.filename
string
wajib
body.text.attachments.inline
boolean
body.text.attachments.mediaUrl
string
wajib
body.text.metadata
object
Tampilkan atribut turunan
body.text.metadata.apple
object
Tampilkan atribut turunan
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
Tampilkan atribut turunan
body.text.metadata.line.emoji
object
Tampilkan atribut turunan
body.text.metadata.line.emoji.items
array of object
Tampilkan atribut turunan
body.text.metadata.line.emoji.items.emojiId
string
wajib
body.text.metadata.line.emoji.items.index
integer
wajib
body.text.metadata.line.emoji.items.length
integer
body.text.metadata.line.emoji.items.productId
string
wajib
body.text.metadata.paymentDetails
object
Tampilkan atribut turunan
body.text.metadata.paymentDetails.amount
string
wajib
body.text.metadata.paymentDetails.currency
string
wajib
body.text.metadata.paymentDetails.sessionIdentifier
string
body.text.metadata.paymentDetails.state
string
wajib
body.text.metadata.subject
string
body.text.metadata.telegram
object
Tampilkan atribut turunan
body.text.metadata.telegram.parseMode
string
body.text.metadata.whatsapp
object
Tampilkan atribut turunan
body.text.metadata.whatsapp.callPermissionExpiration
string
body.text.metadata.whatsapp.callPermissionResponse
string
Possible values: accept, reject
body.text.metadata.whatsapp.previewUrl
boolean
wajib
body.text.metadata.whatsapp.sharedContacts
array of object
Tampilkan atribut turunan
body.text.metadata.whatsapp.sharedContacts.origin
string
wajib
body.text.metadata.whatsapp.sharedContacts.phones
array of object
Tampilkan atribut turunan
body.text.metadata.whatsapp.sharedContacts.phones.phone
string
wajib
body.text.metadata.whatsapp.sharedContacts.phones.type
string
wajib
body.text.metadata.whatsapp.sharedContacts.phones.waId
string
wajib
body.text.metadata.whatsapp.sharedContacts.vcard
string
body.text.text
string
wajib
body.type
string
wajib
Possible values: text
channelId
string
conversationCreatedAt
string
conversationId
string
wajib
createdAt
string
wajib
draft
boolean
wajib
Whether this message is a draft.
draftMeta
object
Metadata for draft messages.
Tampilkan atribut turunan
draftMeta.creatorType
string
wajib
Possible values: user, bot
id
string
wajib
A unique identifier for this message.
interactions
array of object
A list of interactions associated with the message (e.g. read receipts, clicks, reactions).
Tampilkan atribut turunan
interactions.bodyTemplateProjectId
string
interactions.channelId
string
wajib
interactions.context
object
wajib
Tampilkan atribut turunan
interactions.context.id
string
interactions.context.tagIds
array of string
interactions.context.type
string
interactions.createdAt
string
wajib
interactions.details
string
interactions.id
string
wajib
interactions.isFirstInteraction
boolean
interactions.isFirstInteractionIncludingBots
boolean
interactions.journey
object
Tampilkan atribut turunan
interactions.journey.id
string
interactions.journey.name
string
interactions.journey.runId
string
interactions.journey.scheduleExecutionId
string
interactions.journey.stepId
string
interactions.messageCreatedAt
string
interactions.messageId
string
wajib
interactions.messagePartsCount
integer
wajib
interactions.messageReference
string
wajib
interactions.messageTags
array of string
interactions.metadata
object
Tampilkan atribut turunan
interactions.metadata.button
object
Tampilkan atribut turunan
interactions.metadata.button.payload
string
wajib
interactions.metadata.conversion
object
Tampilkan atribut turunan
interactions.metadata.conversion.method
string
Method of entering the code
Possible values: unknown, manual, auto
interactions.metadata.conversion.status
string
Status of the conversion
Possible values: converted, canceled, not_converted, incorrect_code, resent, received_after_expiration
interactions.metadata.conversion.timestamp
string
Timestamp of when the conversion was recorded
interactions.metadata.conversion.type
string
Type of conversion
Possible values: otp, url, promo_code
interactions.metadata.extraInformation
object
interactions.metadata.link
object
Tampilkan atribut turunan
interactions.metadata.link.clickType
string
Possible values: link, button
interactions.metadata.link.name
string
wajib
interactions.metadata.link.url
string
wajib
interactions.metadata.prefetched
boolean
interactions.metadata.reaction
object
Tampilkan atribut turunan
interactions.metadata.reaction.action
string
wajib
Possible values: react, unreact
interactions.metadata.reaction.emoji
string
wajib
interactions.metadata.renderedContentBlocks
array of string
interactions.metadata.subscriptionList
object
Tampilkan atribut turunan
interactions.metadata.subscriptionList.subscriptionListId
string
wajib
interactions.notification
object
Tampilkan atribut turunan
interactions.notification.template
string
interactions.notification.url
string
wajib
interactions.platformId
string
wajib
interactions.platformReferenceId
string
interactions.receiver
object
wajib
Tampilkan atribut turunan
interactions.receiver.connector
object
Tampilkan atribut turunan
interactions.receiver.connector.annotations
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Tampilkan atribut turunan
interactions.receiver.connector.annotations.name
string
interactions.receiver.connector.id
string
wajib
interactions.receiver.connector.identifierValue
string
The identifier value of the sender or receiver connector (e.g. email address or phone number).
interactions.receiver.connector.types
array of string
interactions.receiver.contacts
array of object
Tampilkan atribut turunan
interactions.receiver.contacts.contactAnnotation
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Tampilkan atribut turunan
interactions.receiver.contacts.contactAnnotation.name
string
interactions.receiver.contacts.countryCode
string
interactions.receiver.contacts.id
string
The ID of the contact.
interactions.receiver.contacts.identifierKey
string
The identifier key for finding the contact (e.g. emailaddress, phonenumber). For WhatsApp channels with BSUID support, use whatsappbsuid to send to a contact by their Business-Scoped User ID.
interactions.receiver.contacts.identifierValue
string
The identifier value for finding the contact.
interactions.receiver.contacts.identifiers
array of object
Additional identifiers to augment the contact during resolution.
Tampilkan atribut turunan
interactions.receiver.contacts.identifiers.identifierKey
string
wajib
The identifier key for finding the contact (e.g. emailaddress, phonenumber).
interactions.receiver.contacts.identifiers.identifierValue
string
wajib
The identifier value for finding the contact.
interactions.receiver.contacts.platformAddress
string
The resolved platform address used to deliver the message (e.g. phone number or email address).
interactions.receiver.contacts.platformAddressSelector
string
An expression that defines how we resolve the platform address from a contact. Optional override for the default resolution logic.
interactions.receiver.contacts.receiverExpression
string
interactions.receiver.contacts.receiverValue
string
interactions.receiver.contacts.type
string
The type of the receiver (e.g. to, cc, bcc for email).
interactions.receiver.device
object
Tampilkan atribut turunan
interactions.receiver.device.gateway
string
wajib
Possible values: firebase, apns, web
interactions.receiver.device.id
string
wajib
interactions.receiver.device.identifierValue
string
wajib
interactions.receiver.inbox
object
Tampilkan atribut turunan
interactions.receiver.inbox.emailRecipientType
string
interactions.receiver.inbox.id
string
wajib
interactions.receiver.inbox.identifierKey
string
wajib
interactions.receiver.inbox.identifierValue
string
wajib
interactions.receiver.inbox.type
string
wajib
Possible values: user, group
interactions.receiver.userContacts
array of object
Tampilkan atribut turunan
interactions.receiver.userContacts.id
string
wajib
interactions.receiver.userContacts.identifierKey
string
wajib
interactions.receiver.userContacts.identifierValue
string
wajib
interactions.receiver.userContacts.type
string
interactions.type
string
wajib
Possible values: invalid, read, opened, clicked, reported-as-spam, unsubscribe-request, delete, reaction, subscribe-request, subscribe-consent, conversion
interactions.useCaseType
string
Possible values: unspecified, marketing, otp, transactional, conversation, test
meta
object
Tampilkan atribut turunan
meta.campaign
object
Tampilkan atribut turunan
meta.campaign.id
string
meta.campaign.name
string
meta.campaignId
string
meta.chargeOnceDelivered
boolean
meta.email
object
Tampilkan atribut turunan
meta.email.from
object
Tampilkan atribut turunan
meta.email.from.displayName
string
meta.email.from.username
string
meta.email.headers
object
meta.email.subject
string
meta.extraInformation
object
meta.flow
object
Tampilkan atribut turunan
meta.flow.id
string
meta.flow.name
string
meta.flow.runId
string
meta.flow.scheduleExecutionId
string
meta.flow.stepId
string
meta.formResponse
object
Tampilkan atribut turunan
meta.formResponse.id
string
wajib
meta.formResponse.jsonResponse
string
wajib
meta.formResponse.requestIdentifier
string
wajib
meta.formResponse.selections
array of object
Tampilkan atribut turunan
meta.formResponse.selections.items
array of object
Tampilkan atribut turunan
meta.formResponse.selections.items.identifier
string
wajib
meta.formResponse.selections.items.title
string
wajib
meta.formResponse.selections.items.type
string
wajib
meta.formResponse.selections.items.value
string
wajib
meta.formResponse.selections.pageIdentifier
string
wajib
meta.formResponse.selections.subtitle
string
wajib
meta.formResponse.selections.title
string
wajib
meta.formResponse.sessionIdentifier
string
wajib
meta.formResponse.template
string
wajib
meta.formResponse.version
string
wajib
meta.ignoreGlobalHoldout
boolean
meta.ignoreQuietHours
boolean
meta.journey
object
Tampilkan atribut turunan
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.
Tampilkan atribut turunan
meta.order.products
array of object
Tampilkan atribut turunan
meta.order.products.externalCatalogId
string
The platform-specific catalog ID of the product.
meta.order.products.externalProductId
string
wajib
The platform-specific product ID.
meta.order.products.price
object
wajib
Tampilkan atribut turunan
meta.order.products.price.amount
integer
wajib
meta.order.products.price.currencyCode
string
wajib
meta.order.products.price.exponent
integer
wajib
meta.order.products.quantity
integer
wajib
The number of items purchased.
meta.pushNotifications
object
Tampilkan atribut turunan
meta.pushNotifications.gatewayTypeOverride
string
Possible values: firebase, apns, web
meta.referral
object
Tampilkan atribut turunan
meta.referral.group
string
meta.referral.metadata
object
Tampilkan atribut turunan
meta.referral.metadata.caption
string
meta.referral.metadata.mediaType
string
meta.referral.metadata.mediaUrl
string
meta.referral.metadata.sourceId
string
wajib
meta.referral.metadata.sourceUrl
string
meta.referral.metadata.timestamp
string
meta.referral.metadata.trackingId
string
meta.referral.metadata.username
string
meta.referral.source
string
wajib
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).
Tampilkan atribut turunan
meta.referredProduct.externalCatalogId
string
The platform-specific catalog ID of the product.
meta.referredProduct.externalProductId
string
wajib
The platform-specific product ID.
meta.renderedContentBlocks
array of string
meta.shortToLongLinks
object
meta.skipThisMessage
string
Possible values: campaignHoldout, globalHoldout, journeyHoldout
meta.sms
object
Tampilkan atribut turunan
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
Tampilkan atribut turunan
meta.sms.smpp.segments
array of object
Tampilkan atribut turunan
meta.sms.smpp.segments.id
string
wajib
meta.sms.smpp.segments.registeredDelivery
string
wajib
Possible values: final, intermediate, all, noDlr
meta.sms.smpp.userId
string
wajib
meta.sms.validity
string
meta.useFallback
boolean
reason
string
Failure reason. Populated when status is sending_failed or delivery_failed.
receiver
object
Tampilkan atribut turunan
receiver.connector
object
Tampilkan atribut turunan
receiver.connector.annotations
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Tampilkan atribut turunan
receiver.connector.annotations.name
string
receiver.connector.id
string
wajib
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
Tampilkan atribut turunan
receiver.contacts.contactAnnotation
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Tampilkan atribut turunan
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.
Tampilkan atribut turunan
receiver.contacts.identifiers.identifierKey
string
wajib
The identifier key for finding the contact (e.g. emailaddress, phonenumber).
receiver.contacts.identifiers.identifierValue
string
wajib
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
Tampilkan atribut turunan
receiver.device.gateway
string
wajib
Possible values: firebase, apns, web
receiver.device.id
string
wajib
receiver.device.identifierValue
string
wajib
receiver.inbox
object
Tampilkan atribut turunan
receiver.inbox.emailRecipientType
string
receiver.inbox.id
string
wajib
receiver.inbox.identifierKey
string
wajib
receiver.inbox.identifierValue
string
wajib
receiver.inbox.type
string
wajib
Possible values: user, group
receiver.userContacts
array of object
Tampilkan atribut turunan
receiver.userContacts.id
string
wajib
receiver.userContacts.identifierKey
string
wajib
receiver.userContacts.identifierValue
string
wajib
receiver.userContacts.type
string
receiverTypes
array of string
Receiver types for the message (to/cc/bcc). Currently only used for inbound email messages.
recipients
array of object
Tampilkan atribut turunan
recipients.contactAnnotation
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Tampilkan atribut turunan
recipients.contactAnnotation.name
string
recipients.countryCode
string
recipients.id
string
The ID of the contact.
recipients.identifierKey
string
The identifier key for finding the contact (e.g. emailaddress, phonenumber). For WhatsApp channels with BSUID support, use whatsappbsuid to send to a contact by their Business-Scoped User ID.
recipients.identifierValue
string
The identifier value for finding the contact.
recipients.identifiers
array of object
Additional identifiers to augment the contact during resolution.
Tampilkan atribut turunan
recipients.identifiers.identifierKey
string
wajib
The identifier key for finding the contact (e.g. emailaddress, phonenumber).
recipients.identifiers.identifierValue
string
wajib
The identifier value for finding the contact.
recipients.platformAddress
string
The resolved platform address used to deliver the message (e.g. phone number or email address).
recipients.platformAddressSelector
string
An expression that defines how we resolve the platform address from a contact. Optional override for the default resolution logic.
recipients.receiverExpression
string
recipients.receiverValue
string
recipients.type
string
The type of the receiver (e.g. to, cc, bcc for email).
reference
string
wajib
A customizable ID assigned to messages you send. Can be used to correlate messages with data from your own services. Must be globally unique within a workspace.
replyTo
object
Tampilkan atribut turunan
replyTo.id
string
The ID of the message that is being replied to.
replyTo.order
integer
The order of the message part in the conversation.
replyTo.platformReference
string
replyTo.type
string
Possible values: message, click
resourceUri
string
sender
object
wajib
Tampilkan atribut turunan
sender.email
string
sender.name
string
sender.avatarUrl
string
sender.contact
object
Tampilkan atribut turunan
sender.contact.identifierKey
string
wajib
sender.contact.identifierValue
string
wajib
sender.contact.platformAddress
string
sender.contact.platformAddressSelector
string
sender.conversationId
string
sender.createdAt
string
sender.displayName
string
sender.id
string
wajib
sender.resourceUri
string
sender.status
string
Possible values: invited, pending, active, inactive
sender.type
string
wajib
Possible values: user, contact, agent, flow, bot, accessKey, channel, connector, collaborationAutomation
sender.updatedAt
string
source
string
wajib
Possible values: conversations, channels, bots, external
status
string
wajib
Possible values: accepted, processing, sent, sending_failed, delivered, delivery_failed, deleted
template
object
Tampilkan atribut turunan
template.attachments
array of object
Tampilkan atribut turunan
template.attachments.content
string
template.attachments.contentType
string
template.attachments.filename
string
wajib
template.attachments.inline
boolean
wajib
template.attachments.mediaUrl
string
wajib
template.deployment
object
template.locale
string
wajib
template.name
string
The platform name of the template.
template.parameters
array of object
Tampilkan atribut turunan
template.parameters.key
string
wajib
template.parameters.sourceUrl
object
Tampilkan atribut turunan
template.parameters.sourceUrl.fullyReplaced
boolean
wajib
template.parameters.sourceUrl.value
string
wajib
template.parameters.type
string
wajib
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
wajib
template.projectId
string
wajib
The ID of the project from Studio.
template.settings
object
Tampilkan atribut turunan
template.settings.disallowMmLite
boolean
template.shortLinks
object
Tampilkan atribut turunan
template.shortLinks.domain
string
wajib
The domain to use when shortening links. When set to default, uses the default link shortening domain for the workspace.
template.shortLinks.enabled
boolean
wajib
Enables link shortening for SMS messages.
template.templateBody
object
Tampilkan atribut turunan
template.templateBody.text
object
wajib
Tampilkan atribut turunan
template.templateBody.text.actions
array of object
Tampilkan atribut turunan
template.templateBody.text.actions.link
object
wajib
Tampilkan atribut turunan
template.templateBody.text.actions.link.metadata
object
Tampilkan atribut turunan
template.templateBody.text.actions.link.metadata.description
object
Tampilkan atribut turunan
template.templateBody.text.actions.link.metadata.description.label
string
wajib
template.templateBody.text.actions.link.text
string
wajib
template.templateBody.text.actions.link.url
string
wajib
template.templateBody.text.actions.type
string
wajib
Possible values: link
template.templateBody.text.attachments
array of object
Tampilkan atribut turunan
template.templateBody.text.attachments.content
string
template.templateBody.text.attachments.contentId
string
template.templateBody.text.attachments.contentType
string
template.templateBody.text.attachments.filename
string
wajib
template.templateBody.text.attachments.inline
boolean
template.templateBody.text.attachments.mediaUrl
string
wajib
template.templateBody.text.metadata
object
Tampilkan atribut turunan
template.templateBody.text.metadata.apple
object
Tampilkan atribut turunan
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
Tampilkan atribut turunan
template.templateBody.text.metadata.line.emoji
object
Tampilkan atribut turunan
template.templateBody.text.metadata.line.emoji.items
array of object
Tampilkan atribut turunan
template.templateBody.text.metadata.line.emoji.items.emojiId
string
wajib
template.templateBody.text.metadata.line.emoji.items.index
integer
wajib
template.templateBody.text.metadata.line.emoji.items.length
integer
template.templateBody.text.metadata.line.emoji.items.productId
string
wajib
template.templateBody.text.metadata.paymentDetails
object
Tampilkan atribut turunan
template.templateBody.text.metadata.paymentDetails.amount
string
wajib
template.templateBody.text.metadata.paymentDetails.currency
string
wajib
template.templateBody.text.metadata.paymentDetails.sessionIdentifier
string
template.templateBody.text.metadata.paymentDetails.state
string
wajib
template.templateBody.text.metadata.subject
string
template.templateBody.text.metadata.telegram
object
Tampilkan atribut turunan
template.templateBody.text.metadata.telegram.parseMode
string
template.templateBody.text.metadata.whatsapp
object
Tampilkan atribut turunan
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
wajib
template.templateBody.text.metadata.whatsapp.sharedContacts
array of object
Tampilkan atribut turunan
template.templateBody.text.metadata.whatsapp.sharedContacts.origin
string
wajib
template.templateBody.text.metadata.whatsapp.sharedContacts.phones
array of object
Tampilkan atribut turunan
template.templateBody.text.metadata.whatsapp.sharedContacts.phones.phone
string
wajib
template.templateBody.text.metadata.whatsapp.sharedContacts.phones.type
string
wajib
template.templateBody.text.metadata.whatsapp.sharedContacts.phones.waId
string
wajib
template.templateBody.text.metadata.whatsapp.sharedContacts.vcard
string
template.templateBody.text.text
string
wajib
template.templateBody.type
string
wajib
Possible values: text
template.utmParameters
array of object
Tampilkan atribut turunan
template.utmParameters.key
string
wajib
template.utmParameters.value
string
wajib
template.variables
object
template.version
string
wajib
The version of the template.
type
string
Possible values: text, html, image, file, gif, location, carousel, list, section, authentication, action
updatedAt
string
wajib
Contoh kode
curl -X POST 'https://api.bird.com/workspaces/{workspaceId}/conversations/{conversationId}/messages' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'

Examples

Sending a simple message

Contoh kode
curl -X POST "https://api.bird.com/workspaces/a1405560-c8d3-4b1a-877d-3f449ad95352/conversations/16e1df9e-c6ac-406b-b1ce-13f34d0dea08/messages" \
-H "Content-Type: application/json" \
-H "Authorization: AccessKey abcd" \
-d '{
  "participantType": "accessKey",
  "participantId": "0c0defe3-c98d-46d9-a9bf-febc1e08aa0c",
  "addMissingParticipants": true,
  "recipients": [
    {
      "type": "to",
      "identifierKey": "emailaddress",
      "identifierValue": "some.customer@example.com"
    }
  ],
  "body": {
    "type": "text",
    "text": {
      "text": "Hey, listen!"
    }
  }
}'

Sending a template message

Contoh kode
curl -X POST "https://api.bird.com/workspaces/a1405560-c8d3-4b1a-877d-3f449ad95352/conversations/16e1df9e-c6ac-406b-b1ce-13f34d0dea08/messages" \
-H "Content-Type: application/json" \
-H "Authorization: AccessKey abcd" \
-d '{
  "participantType": "accessKey",
  "participantId": "68b80b8d-8060-42df-bda3-73505a8fdb84",
  "recipients": [
    {
      "identifierKey": "emailaddress",
      "identifierValue": "john.doe@bird.com",
      "type": "to"
    }
  ],
  "template": {
    "projectId": "5d9084b3-7cdb-4c87-bf7c-8871a1f21695",
    "version": "b33761d9-ece1-48e3-b542-b5bbf93bd8c3",
    "locale": "en",
    "parameters": [
      {
        "type": "string",
        "key": "myVariable",
        "value": "yay"
      }
    ]
  },
  "addMissingParticipants": true
}'