Message interactions
You can list message interactions on a specific message using the following endpoint. In order to get a Line message, you must have an active Line channel and perform a HTTP request with a valid access key.
GET
/workspaces/{workspaceId}/channels/{channelId}/messages/{messageId}/interactions
List message interactions
Corps de la réponse
results
array of object
Afficher les attributs enfants
results.bodyTemplateProjectId
string
results.channelId
string
obligatoire
results.context
object
obligatoire
Afficher les attributs enfants
results.context.id
string
results.context.tagIds
array of string
results.context.type
string
results.createdAt
string
obligatoire
results.details
string
results.id
string
obligatoire
results.isFirstInteraction
boolean
results.isFirstInteractionIncludingBots
boolean
results.journey
object
Afficher les attributs enfants
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
obligatoire
results.messagePartsCount
integer
obligatoire
results.messageReference
string
obligatoire
results.messageTags
array of string
results.metadata
object
Afficher les attributs enfants
results.metadata.button
object
Afficher les attributs enfants
results.metadata.button.payload
string
obligatoire
results.metadata.conversion
object
Afficher les attributs enfants
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
Afficher les attributs enfants
results.metadata.link.clickType
string
Possible values: link, button
results.metadata.link.name
string
obligatoire
results.metadata.link.url
string
obligatoire
results.metadata.prefetched
boolean
results.metadata.reaction
object
Afficher les attributs enfants
results.metadata.reaction.action
string
obligatoire
Possible values: react, unreact
results.metadata.reaction.emoji
string
obligatoire
results.metadata.renderedContentBlocks
array of string
results.metadata.subscriptionList
object
Afficher les attributs enfants
results.metadata.subscriptionList.subscriptionListId
string
obligatoire
results.notification
object
Afficher les attributs enfants
results.notification.template
string
results.notification.url
string
obligatoire
results.platformId
string
obligatoire
results.platformReferenceId
string
results.receiver
object
obligatoire
Afficher les attributs enfants
results.receiver.connector
object
Afficher les attributs enfants
results.receiver.connector.annotations
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Afficher les attributs enfants
results.receiver.connector.annotations.name
string
results.receiver.connector.id
string
obligatoire
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
Afficher les attributs enfants
results.receiver.contacts.contactAnnotation
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Afficher les attributs enfants
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.
Afficher les attributs enfants
results.receiver.contacts.identifiers.identifierKey
string
obligatoire
The identifier key for finding the contact (e.g. emailaddress, phonenumber).
results.receiver.contacts.identifiers.identifierValue
string
obligatoire
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
Afficher les attributs enfants
results.receiver.device.gateway
string
obligatoire
Possible values: firebase, apns, web
results.receiver.device.id
string
obligatoire
results.receiver.device.identifierValue
string
obligatoire
results.receiver.inbox
object
Afficher les attributs enfants
results.receiver.inbox.emailRecipientType
string
results.receiver.inbox.id
string
obligatoire
results.receiver.inbox.identifierKey
string
obligatoire
results.receiver.inbox.identifierValue
string
obligatoire
results.receiver.inbox.type
string
obligatoire
Possible values: user, group
results.receiver.userContacts
array of object
Afficher les attributs enfants
results.receiver.userContacts.id
string
obligatoire
results.receiver.userContacts.identifierKey
string
obligatoire
results.receiver.userContacts.identifierValue
string
obligatoire
results.receiver.userContacts.type
string
results.type
string
obligatoire
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
Exemple de code
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/channels/{channelId}/messages/{messageId}/interactions' \
-H 'Authorization: AccessKey YOUR_ACCESS_KEY'Line supports the following message interactions:
| Interaction | Description |
|---|---|
| Clicked | A user has clicked a quick reply button |
Additional information about the interactions can be found in the details field and metadata.button object as follows:
| Interaction | details | metadata.button. | Description |
|---|---|---|---|
| Clicked | item_N_clicked |
| Recipient clicked a quick reply button. N = the position of the item in the actions array of the associated message |