Get conversation message

Get a message

GEThttps://api.bird.com/workspaces/{workspaceId}/conversations/{conversationId}/messages/{messageId}

Path parameters

workspaceId*string (uuid)

The workspace ID

conversationId*any of

The conversation ID

messageId*string (uuid)

The message ID

Response

Body

id*string

conversationIdstring

referencestring

sender*ConversationParticipant

draft*boolean

recipientsnullable array of MessageRecipient

status*Conversations_MessageStatus (enum)

acceptedprocessingsentsending_faileddelivereddelivery_faileddeleted

source*enum

conversationsexternal

templatenullable Conversations_Template (object)

bodyMessageBody

reasonstring

interactionsnullable array of object

createdAt*string (date-time)

updatedAt*string (date-time)

metaMessageMeta

receiverTypesarray of enum

ReceiverTypes list of types of receivers for the message. It can be to, cc and bcc at the moment. Currently only use for inbound email platforms messages.

Request

Response

Examples

curl "https://api.bird.com/workspaces/a1405560-c8d3-4b1a-877d-3f449ad95352/conversations/02ec2ac2-ebec-42d3-a5f4-e6f3a9edf418/messages/29d3a7f4-841d-4702-a495-20cab72f2865" \
-H "Authorization: AccessKey abcd"

{
  "id": "f48ee7ff-45b1-42a2-838b-ea7632180e80",
  "conversationId": "907798f8-fd72-44d5-8042-fcc05c1bb570",
  "reference": "",
  "sender": {
    "id": "68b80b8d-8060-42df-bda3-73505a8fdb84",
    "type": "accessKey",
    "status": "active",
    "displayName": "My first email key",
    "avatarUrl": ""
  },
  "draft": false,
  "recipients": [
    {
      "type": "to",
      "id": "8f0b5377-2edc-4116-a8e8-6a475f245a04",
      "identifierKey": "emailaddress",
      "identifierValue": "john.doe@bird.com",
      "platformAddress": "john.doe@bird.com",
      "contactAnnotation": {
        "name": "John Doe"
      }
    }
  ],
  "status": "accepted",
  "source": "conversations",
  "body": {
    "type": "text",
    "text": {
      "text": "Hey, listen!"
    }
  },
  "interactions": null,
  "createdAt": "2024-11-28T19:58:03.999Z",
  "updatedAt": "2024-11-29T13:14:11.55Z"
}

Last updated 3 days ago

{ "id": "text", "conversationId": "text", "reference": "text", "sender": { "id": "text", "displayName": "text", "avatarUrl": "text", "contact": { "identifierKey": "text", "identifierValue": "text", "platformAddress": "text", "platformAddressSelector": "text" }, "type": "user", "status": "pending" }, "draft": false, "recipients": [ { "id": "text", "type": "to", "identifierKey": "text", "identifierValue": "text", "platformAddress": "text", "platformAddressSelector": "text", "contactAnnotation": { "name": "text" } } ], "status": "accepted", "source": "conversations", "template": { "name": "text", "projectId": "text", "version": "text", "locale": "text", "attachments": [ { "mediaUrl": "https://example.com", "filename": "text", "inline": false } ], "shortLinks": { "enabled": false, "domain": "text" }, "variables": { "default": "text" }, "utmParameters": [ { "key": "text", "value": "text" } ], "parameters": [ { "type": "string", "key": "text", "value": "text" } ] }, "body": { "type": "text", "text": { "text": "text", "attachments": [ { "mediaUrl": "https://example.com", "filename": "text", "inline": false } ], "actions": [ { "type": "link", "link": { "text": "text", "url": "text" } } ], "metadata": { "subject": "text", "whatsapp": { "previewUrl": false }, "line": { "emoji": { "items": [ { "index": 0, "productId": "text", "emojiId": "text", "length": 0 } ] } }, "telegram": { "parseMode": "Markdown" } } } }, "reason": "text", "interactions": [ { "id": "123e4567-e89b-12d3-a456-426614174000", "type": "read", "createdAt": "2024-12-03T14:40:16.135Z", "reason": "text", "metadata": { "link": { "name": "text", "url": "text" }, "button": { "payload": "text" }, "reaction": { "emoji": "text", "action": "text"