# Messages ## Get all messages in a thread **get** `/v3/messages/{messageId}/thread` Retrieve all messages in a conversation thread. Given any message ID in the thread, returns the originator message and all replies in chronological order. If the message is not part of a thread, returns just that single message. Supports pagination and configurable ordering. ### Path Parameters - `messageId: string` ### Query Parameters - `cursor: optional string` Pagination cursor from previous next_cursor response - `limit: optional number` Maximum number of messages to return - `order: optional "asc" or "desc"` Sort order for messages (asc = oldest first, desc = newest first) - `"asc"` - `"desc"` ### Returns - `messages: array of Message` Messages in the thread, ordered by the specified order parameter - `id: string` Unique identifier for the message - `chat_id: string` ID of the chat this message belongs to - `created_at: string` When the message was created - `is_delivered: boolean` Whether the message has been delivered - `is_from_me: boolean` Whether this message was sent by the authenticated user - `is_read: boolean` Whether the message has been read - `updated_at: string` When the message was last updated - `delivered_at: optional string` When the message was delivered - `effect: optional MessageEffect` iMessage effect applied to a message (screen or bubble effect) - `name: optional string` Name of the effect. Common values: - Screen effects: confetti, fireworks, lasers, sparkles, celebration, hearts, love, balloons, happy_birthday, echo, spotlight - Bubble effects: slam, loud, gentle, invisible - `type: optional "screen" or "bubble"` Type of effect - `"screen"` - `"bubble"` - `from: optional string` DEPRECATED: Use from_handle instead. Phone number of the message sender. - `from_handle: optional ChatHandle` The sender of this message as a full handle object - `id: string` Unique identifier for this handle - `handle: string` Phone number (E.164) or email address of the participant - `joined_at: string` When this participant joined the chat - `service: ServiceType` Messaging service type - `"iMessage"` - `"SMS"` - `"RCS"` - `is_me: optional boolean` Whether this handle belongs to the sender (your phone number) - `left_at: optional string` When they left (if applicable) - `status: optional "active" or "left" or "removed"` Participant status - `"active"` - `"left"` - `"removed"` - `parts: optional array of TextPartResponse or MediaPartResponse or LinkPartResponse` Message parts in order (text, media, and link) - `TextPartResponse object { reactions, type, value, text_decorations }` A text message part - `reactions: array of Reaction` Reactions on this message part - `handle: ChatHandle` - `is_me: boolean` Whether this reaction is from the current user - `type: ReactionType` Type of reaction. Standard iMessage tapbacks are love, like, dislike, laugh, emphasize, question. Custom emoji reactions have type "custom" with the actual emoji in the custom_emoji field. Sticker reactions have type "sticker" with sticker attachment details in the sticker field. - `"love"` - `"like"` - `"dislike"` - `"laugh"` - `"emphasize"` - `"question"` - `"custom"` - `"sticker"` - `custom_emoji: optional string` Custom emoji if type is "custom", null otherwise - `sticker: optional object { file_name, height, mime_type, 2 more }` Sticker attachment details when reaction_type is "sticker". Null for non-sticker reactions. - `file_name: optional string` Filename of the sticker - `height: optional number` Sticker image height in pixels - `mime_type: optional string` MIME type of the sticker image - `url: optional string` Presigned URL for downloading the sticker image (expires in 1 hour). - `width: optional number` Sticker image width in pixels - `type: "text"` Indicates this is a text message part - `"text"` - `value: string` The text content - `text_decorations: optional array of TextDecoration` Text decorations applied to character ranges in the value - `range: array of number` Character range `[start, end)` in the `value` string where the decoration applies. `start` is inclusive, `end` is exclusive. *Characters are measured as UTF-16 code units. Most characters count as 1; some emoji count as 2.* - `animation: optional "big" or "small" or "shake" or 5 more` Animated text effect to apply. Mutually exclusive with `style`. - `"big"` - `"small"` - `"shake"` - `"nod"` - `"explode"` - `"ripple"` - `"bloom"` - `"jitter"` - `style: optional "bold" or "italic" or "strikethrough" or "underline"` Text style to apply. Mutually exclusive with `animation`. - `"bold"` - `"italic"` - `"strikethrough"` - `"underline"` - `MediaPartResponse object { id, filename, mime_type, 4 more }` A media attachment part - `id: string` Unique attachment identifier - `filename: string` Original filename - `mime_type: string` MIME type of the file - `reactions: array of Reaction` Reactions on this message part - `handle: ChatHandle` - `is_me: boolean` Whether this reaction is from the current user - `type: ReactionType` Type of reaction. Standard iMessage tapbacks are love, like, dislike, laugh, emphasize, question. Custom emoji reactions have type "custom" with the actual emoji in the custom_emoji field. Sticker reactions have type "sticker" with sticker attachment details in the sticker field. - `custom_emoji: optional string` Custom emoji if type is "custom", null otherwise - `sticker: optional object { file_name, height, mime_type, 2 more }` Sticker attachment details when reaction_type is "sticker". Null for non-sticker reactions. - `size_bytes: number` File size in bytes - `type: "media"` Indicates this is a media attachment part - `"media"` - `url: string` Presigned URL for downloading the attachment (expires in 1 hour). - `LinkPartResponse object { reactions, type, value }` A rich link preview part - `reactions: array of Reaction` Reactions on this message part - `handle: ChatHandle` - `is_me: boolean` Whether this reaction is from the current user - `type: ReactionType` Type of reaction. Standard iMessage tapbacks are love, like, dislike, laugh, emphasize, question. Custom emoji reactions have type "custom" with the actual emoji in the custom_emoji field. Sticker reactions have type "sticker" with sticker attachment details in the sticker field. - `custom_emoji: optional string` Custom emoji if type is "custom", null otherwise - `sticker: optional object { file_name, height, mime_type, 2 more }` Sticker attachment details when reaction_type is "sticker". Null for non-sticker reactions. - `type: "link"` Indicates this is a rich link preview part - `"link"` - `value: string` The URL - `preferred_service: optional ServiceType` Messaging service type - `read_at: optional string` When the message was read - `reply_to: optional ReplyTo` Indicates this message is a threaded reply to another message - `message_id: string` The ID of the message to reply to - `part_index: optional number` The specific message part to reply to (0-based index). Defaults to 0 (first part) if not provided. Use this when replying to a specific part of a multipart message. - `sent_at: optional string` When the message was sent - `service: optional ServiceType` Messaging service type - `next_cursor: optional string` Cursor for fetching the next page of results (null if no more results) ### Example ```http curl https://api.linqapp.com/api/partner/v3/messages/$MESSAGE_ID/thread \ -H "Authorization: Bearer $LINQ_API_V3_API_KEY" ``` #### Response ```json { "messages": [ { "id": "69a37c7d-af4f-4b5e-af42-e28e98ce873a", "chat_id": "94c6bf33-31d9-40e3-a0e9-f94250ecedb9", "created_at": "2024-01-15T10:30:00Z", "is_delivered": true, "is_from_me": true, "is_read": false, "updated_at": "2024-01-15T10:30:00Z", "delivered_at": "2024-01-15T10:30:10Z", "effect": { "name": "confetti", "type": "screen" }, "from": "+12052535597", "from_handle": { "id": "550e8400-e29b-41d4-a716-446655440000", "handle": "+15551234567", "joined_at": "2025-05-21T15:30:00.000-05:00", "service": "iMessage", "is_me": false, "left_at": "2019-12-27T18:11:19.117Z", "status": "active" }, "parts": [ { "reactions": [ { "handle": { "id": "69a37c7d-af4f-4b5e-af42-e28e98ce873a", "handle": "+15551234567", "joined_at": "2025-05-21T15:30:00.000-05:00", "service": "iMessage", "is_me": false, "left_at": "2019-12-27T18:11:19.117Z", "status": "active" }, "is_me": false, "type": "love", "custom_emoji": null, "sticker": { "file_name": "sticker.png", "height": 420, "mime_type": "image/png", "url": "https://cdn.linqapp.com/attachments/a1b2c3d4/sticker.png?signature=...", "width": 420 } } ], "type": "text", "value": "Hello!", "text_decorations": [ { "range": [ 0, 5 ], "animation": "shake", "style": "bold" } ] } ], "preferred_service": "iMessage", "read_at": "2024-01-15T10:35:00Z", "reply_to": { "message_id": "550e8400-e29b-41d4-a716-446655440000", "part_index": 0 }, "sent_at": "2024-01-15T10:30:05Z", "service": "iMessage" } ], "next_cursor": "eyJpZCI6IjEyMzQ1Njc4OTAiLCJ0cyI6MTYzMDUwMDAwMH0=" } ``` ## Get a message by ID **get** `/v3/messages/{messageId}` Retrieve a specific message by its ID. This endpoint returns the full message details including text, attachments, reactions, and metadata. ### Path Parameters - `messageId: string` ### Returns - `Message object { id, chat_id, created_at, 14 more }` - `id: string` Unique identifier for the message - `chat_id: string` ID of the chat this message belongs to - `created_at: string` When the message was created - `is_delivered: boolean` Whether the message has been delivered - `is_from_me: boolean` Whether this message was sent by the authenticated user - `is_read: boolean` Whether the message has been read - `updated_at: string` When the message was last updated - `delivered_at: optional string` When the message was delivered - `effect: optional MessageEffect` iMessage effect applied to a message (screen or bubble effect) - `name: optional string` Name of the effect. Common values: - Screen effects: confetti, fireworks, lasers, sparkles, celebration, hearts, love, balloons, happy_birthday, echo, spotlight - Bubble effects: slam, loud, gentle, invisible - `type: optional "screen" or "bubble"` Type of effect - `"screen"` - `"bubble"` - `from: optional string` DEPRECATED: Use from_handle instead. Phone number of the message sender. - `from_handle: optional ChatHandle` The sender of this message as a full handle object - `id: string` Unique identifier for this handle - `handle: string` Phone number (E.164) or email address of the participant - `joined_at: string` When this participant joined the chat - `service: ServiceType` Messaging service type - `"iMessage"` - `"SMS"` - `"RCS"` - `is_me: optional boolean` Whether this handle belongs to the sender (your phone number) - `left_at: optional string` When they left (if applicable) - `status: optional "active" or "left" or "removed"` Participant status - `"active"` - `"left"` - `"removed"` - `parts: optional array of TextPartResponse or MediaPartResponse or LinkPartResponse` Message parts in order (text, media, and link) - `TextPartResponse object { reactions, type, value, text_decorations }` A text message part - `reactions: array of Reaction` Reactions on this message part - `handle: ChatHandle` - `is_me: boolean` Whether this reaction is from the current user - `type: ReactionType` Type of reaction. Standard iMessage tapbacks are love, like, dislike, laugh, emphasize, question. Custom emoji reactions have type "custom" with the actual emoji in the custom_emoji field. Sticker reactions have type "sticker" with sticker attachment details in the sticker field. - `"love"` - `"like"` - `"dislike"` - `"laugh"` - `"emphasize"` - `"question"` - `"custom"` - `"sticker"` - `custom_emoji: optional string` Custom emoji if type is "custom", null otherwise - `sticker: optional object { file_name, height, mime_type, 2 more }` Sticker attachment details when reaction_type is "sticker". Null for non-sticker reactions. - `file_name: optional string` Filename of the sticker - `height: optional number` Sticker image height in pixels - `mime_type: optional string` MIME type of the sticker image - `url: optional string` Presigned URL for downloading the sticker image (expires in 1 hour). - `width: optional number` Sticker image width in pixels - `type: "text"` Indicates this is a text message part - `"text"` - `value: string` The text content - `text_decorations: optional array of TextDecoration` Text decorations applied to character ranges in the value - `range: array of number` Character range `[start, end)` in the `value` string where the decoration applies. `start` is inclusive, `end` is exclusive. *Characters are measured as UTF-16 code units. Most characters count as 1; some emoji count as 2.* - `animation: optional "big" or "small" or "shake" or 5 more` Animated text effect to apply. Mutually exclusive with `style`. - `"big"` - `"small"` - `"shake"` - `"nod"` - `"explode"` - `"ripple"` - `"bloom"` - `"jitter"` - `style: optional "bold" or "italic" or "strikethrough" or "underline"` Text style to apply. Mutually exclusive with `animation`. - `"bold"` - `"italic"` - `"strikethrough"` - `"underline"` - `MediaPartResponse object { id, filename, mime_type, 4 more }` A media attachment part - `id: string` Unique attachment identifier - `filename: string` Original filename - `mime_type: string` MIME type of the file - `reactions: array of Reaction` Reactions on this message part - `handle: ChatHandle` - `is_me: boolean` Whether this reaction is from the current user - `type: ReactionType` Type of reaction. Standard iMessage tapbacks are love, like, dislike, laugh, emphasize, question. Custom emoji reactions have type "custom" with the actual emoji in the custom_emoji field. Sticker reactions have type "sticker" with sticker attachment details in the sticker field. - `custom_emoji: optional string` Custom emoji if type is "custom", null otherwise - `sticker: optional object { file_name, height, mime_type, 2 more }` Sticker attachment details when reaction_type is "sticker". Null for non-sticker reactions. - `size_bytes: number` File size in bytes - `type: "media"` Indicates this is a media attachment part - `"media"` - `url: string` Presigned URL for downloading the attachment (expires in 1 hour). - `LinkPartResponse object { reactions, type, value }` A rich link preview part - `reactions: array of Reaction` Reactions on this message part - `handle: ChatHandle` - `is_me: boolean` Whether this reaction is from the current user - `type: ReactionType` Type of reaction. Standard iMessage tapbacks are love, like, dislike, laugh, emphasize, question. Custom emoji reactions have type "custom" with the actual emoji in the custom_emoji field. Sticker reactions have type "sticker" with sticker attachment details in the sticker field. - `custom_emoji: optional string` Custom emoji if type is "custom", null otherwise - `sticker: optional object { file_name, height, mime_type, 2 more }` Sticker attachment details when reaction_type is "sticker". Null for non-sticker reactions. - `type: "link"` Indicates this is a rich link preview part - `"link"` - `value: string` The URL - `preferred_service: optional ServiceType` Messaging service type - `read_at: optional string` When the message was read - `reply_to: optional ReplyTo` Indicates this message is a threaded reply to another message - `message_id: string` The ID of the message to reply to - `part_index: optional number` The specific message part to reply to (0-based index). Defaults to 0 (first part) if not provided. Use this when replying to a specific part of a multipart message. - `sent_at: optional string` When the message was sent - `service: optional ServiceType` Messaging service type ### Example ```http curl https://api.linqapp.com/api/partner/v3/messages/$MESSAGE_ID \ -H "Authorization: Bearer $LINQ_API_V3_API_KEY" ``` #### Response ```json { "id": "69a37c7d-af4f-4b5e-af42-e28e98ce873a", "chat_id": "94c6bf33-31d9-40e3-a0e9-f94250ecedb9", "created_at": "2024-01-15T10:30:00Z", "is_delivered": true, "is_from_me": true, "is_read": false, "updated_at": "2024-01-15T10:30:00Z", "delivered_at": "2024-01-15T10:30:10Z", "effect": { "name": "confetti", "type": "screen" }, "from": "+12052535597", "from_handle": { "id": "550e8400-e29b-41d4-a716-446655440000", "handle": "+15551234567", "joined_at": "2025-05-21T15:30:00.000-05:00", "service": "iMessage", "is_me": false, "left_at": "2019-12-27T18:11:19.117Z", "status": "active" }, "parts": [ { "reactions": [ { "handle": { "id": "69a37c7d-af4f-4b5e-af42-e28e98ce873a", "handle": "+15551234567", "joined_at": "2025-05-21T15:30:00.000-05:00", "service": "iMessage", "is_me": false, "left_at": "2019-12-27T18:11:19.117Z", "status": "active" }, "is_me": false, "type": "love", "custom_emoji": null, "sticker": { "file_name": "sticker.png", "height": 420, "mime_type": "image/png", "url": "https://cdn.linqapp.com/attachments/a1b2c3d4/sticker.png?signature=...", "width": 420 } } ], "type": "text", "value": "Hello!", "text_decorations": [ { "range": [ 0, 5 ], "animation": "shake", "style": "bold" } ] } ], "preferred_service": "iMessage", "read_at": "2024-01-15T10:35:00Z", "reply_to": { "message_id": "550e8400-e29b-41d4-a716-446655440000", "part_index": 0 }, "sent_at": "2024-01-15T10:30:05Z", "service": "iMessage" } ``` ## Delete a message from system **delete** `/v3/messages/{messageId}` Deletes a message from the Linq API only. This does NOT unsend or remove the message from the actual chat — recipients will still see the message. ### Path Parameters - `messageId: string` ### Example ```http curl https://api.linqapp.com/api/partner/v3/messages/$MESSAGE_ID \ -X DELETE \ -H "Authorization: Bearer $LINQ_API_V3_API_KEY" ``` #### Response ```json { "error": { "status": 400, "code": 1002, "message": "Phone number must be in E.164 format", "doc_url": "https://docs.linqapp.com/error/codes/1xxx/1002/" }, "success": false } ``` ## Add or remove a reaction to a message **post** `/v3/messages/{messageId}/reactions` Add or remove emoji reactions to messages. Reactions let users express their response to a message without sending a new message. **Supported Reactions:** - love ❤️ - like 👍 - dislike 👎 - laugh 😂 - emphasize ‼️ - question ❓ - custom - any emoji (use `custom_emoji` field to specify) ### Path Parameters - `messageId: string` ### Body Parameters - `operation: "add" or "remove"` Whether to add or remove the reaction - `"add"` - `"remove"` - `type: ReactionType` Type of reaction. Standard iMessage tapbacks are love, like, dislike, laugh, emphasize, question. Custom emoji reactions have type "custom" with the actual emoji in the custom_emoji field. Sticker reactions have type "sticker" with sticker attachment details in the sticker field. - `"love"` - `"like"` - `"dislike"` - `"laugh"` - `"emphasize"` - `"question"` - `"custom"` - `"sticker"` - `custom_emoji: optional string` Custom emoji string. Required when type is "custom". - `part_index: optional number` Optional index of the message part to react to. If not provided, reacts to the entire message (part 0). ### Returns - `message: optional string` - `status: optional string` - `trace_id: optional string` ### Example ```http curl https://api.linqapp.com/api/partner/v3/messages/$MESSAGE_ID/reactions \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $LINQ_API_V3_API_KEY" \ -d '{ "operation": "add", "type": "love", "part_index": 1 }' ``` #### Response ```json { "message": "Reaction processed", "status": "accepted", "trace_id": "trace_id" } ``` ## Edit the content of a message part **patch** `/v3/messages/{messageId}` Edit the text content of a specific part of a previously sent message. **Note:** A message can be edited up to 5 times, and only within 15 minutes of when it was originally sent. ### Path Parameters - `messageId: string` ### Body Parameters - `text: string` New text content for the message part - `part_index: optional number` Index of the message part to edit. Defaults to 0. ### Returns - `Message object { id, chat_id, created_at, 14 more }` - `id: string` Unique identifier for the message - `chat_id: string` ID of the chat this message belongs to - `created_at: string` When the message was created - `is_delivered: boolean` Whether the message has been delivered - `is_from_me: boolean` Whether this message was sent by the authenticated user - `is_read: boolean` Whether the message has been read - `updated_at: string` When the message was last updated - `delivered_at: optional string` When the message was delivered - `effect: optional MessageEffect` iMessage effect applied to a message (screen or bubble effect) - `name: optional string` Name of the effect. Common values: - Screen effects: confetti, fireworks, lasers, sparkles, celebration, hearts, love, balloons, happy_birthday, echo, spotlight - Bubble effects: slam, loud, gentle, invisible - `type: optional "screen" or "bubble"` Type of effect - `"screen"` - `"bubble"` - `from: optional string` DEPRECATED: Use from_handle instead. Phone number of the message sender. - `from_handle: optional ChatHandle` The sender of this message as a full handle object - `id: string` Unique identifier for this handle - `handle: string` Phone number (E.164) or email address of the participant - `joined_at: string` When this participant joined the chat - `service: ServiceType` Messaging service type - `"iMessage"` - `"SMS"` - `"RCS"` - `is_me: optional boolean` Whether this handle belongs to the sender (your phone number) - `left_at: optional string` When they left (if applicable) - `status: optional "active" or "left" or "removed"` Participant status - `"active"` - `"left"` - `"removed"` - `parts: optional array of TextPartResponse or MediaPartResponse or LinkPartResponse` Message parts in order (text, media, and link) - `TextPartResponse object { reactions, type, value, text_decorations }` A text message part - `reactions: array of Reaction` Reactions on this message part - `handle: ChatHandle` - `is_me: boolean` Whether this reaction is from the current user - `type: ReactionType` Type of reaction. Standard iMessage tapbacks are love, like, dislike, laugh, emphasize, question. Custom emoji reactions have type "custom" with the actual emoji in the custom_emoji field. Sticker reactions have type "sticker" with sticker attachment details in the sticker field. - `"love"` - `"like"` - `"dislike"` - `"laugh"` - `"emphasize"` - `"question"` - `"custom"` - `"sticker"` - `custom_emoji: optional string` Custom emoji if type is "custom", null otherwise - `sticker: optional object { file_name, height, mime_type, 2 more }` Sticker attachment details when reaction_type is "sticker". Null for non-sticker reactions. - `file_name: optional string` Filename of the sticker - `height: optional number` Sticker image height in pixels - `mime_type: optional string` MIME type of the sticker image - `url: optional string` Presigned URL for downloading the sticker image (expires in 1 hour). - `width: optional number` Sticker image width in pixels - `type: "text"` Indicates this is a text message part - `"text"` - `value: string` The text content - `text_decorations: optional array of TextDecoration` Text decorations applied to character ranges in the value - `range: array of number` Character range `[start, end)` in the `value` string where the decoration applies. `start` is inclusive, `end` is exclusive. *Characters are measured as UTF-16 code units. Most characters count as 1; some emoji count as 2.* - `animation: optional "big" or "small" or "shake" or 5 more` Animated text effect to apply. Mutually exclusive with `style`. - `"big"` - `"small"` - `"shake"` - `"nod"` - `"explode"` - `"ripple"` - `"bloom"` - `"jitter"` - `style: optional "bold" or "italic" or "strikethrough" or "underline"` Text style to apply. Mutually exclusive with `animation`. - `"bold"` - `"italic"` - `"strikethrough"` - `"underline"` - `MediaPartResponse object { id, filename, mime_type, 4 more }` A media attachment part - `id: string` Unique attachment identifier - `filename: string` Original filename - `mime_type: string` MIME type of the file - `reactions: array of Reaction` Reactions on this message part - `handle: ChatHandle` - `is_me: boolean` Whether this reaction is from the current user - `type: ReactionType` Type of reaction. Standard iMessage tapbacks are love, like, dislike, laugh, emphasize, question. Custom emoji reactions have type "custom" with the actual emoji in the custom_emoji field. Sticker reactions have type "sticker" with sticker attachment details in the sticker field. - `custom_emoji: optional string` Custom emoji if type is "custom", null otherwise - `sticker: optional object { file_name, height, mime_type, 2 more }` Sticker attachment details when reaction_type is "sticker". Null for non-sticker reactions. - `size_bytes: number` File size in bytes - `type: "media"` Indicates this is a media attachment part - `"media"` - `url: string` Presigned URL for downloading the attachment (expires in 1 hour). - `LinkPartResponse object { reactions, type, value }` A rich link preview part - `reactions: array of Reaction` Reactions on this message part - `handle: ChatHandle` - `is_me: boolean` Whether this reaction is from the current user - `type: ReactionType` Type of reaction. Standard iMessage tapbacks are love, like, dislike, laugh, emphasize, question. Custom emoji reactions have type "custom" with the actual emoji in the custom_emoji field. Sticker reactions have type "sticker" with sticker attachment details in the sticker field. - `custom_emoji: optional string` Custom emoji if type is "custom", null otherwise - `sticker: optional object { file_name, height, mime_type, 2 more }` Sticker attachment details when reaction_type is "sticker". Null for non-sticker reactions. - `type: "link"` Indicates this is a rich link preview part - `"link"` - `value: string` The URL - `preferred_service: optional ServiceType` Messaging service type - `read_at: optional string` When the message was read - `reply_to: optional ReplyTo` Indicates this message is a threaded reply to another message - `message_id: string` The ID of the message to reply to - `part_index: optional number` The specific message part to reply to (0-based index). Defaults to 0 (first part) if not provided. Use this when replying to a specific part of a multipart message. - `sent_at: optional string` When the message was sent - `service: optional ServiceType` Messaging service type ### Example ```http curl https://api.linqapp.com/api/partner/v3/messages/$MESSAGE_ID \ -X PATCH \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $LINQ_API_V3_API_KEY" \ -d '{ "text": "This is the edited message content" }' ``` #### Response ```json { "id": "69a37c7d-af4f-4b5e-af42-e28e98ce873a", "chat_id": "94c6bf33-31d9-40e3-a0e9-f94250ecedb9", "created_at": "2024-01-15T10:30:00Z", "is_delivered": true, "is_from_me": true, "is_read": false, "updated_at": "2024-01-15T10:30:00Z", "delivered_at": "2024-01-15T10:30:10Z", "effect": { "name": "confetti", "type": "screen" }, "from": "+12052535597", "from_handle": { "id": "550e8400-e29b-41d4-a716-446655440000", "handle": "+15551234567", "joined_at": "2025-05-21T15:30:00.000-05:00", "service": "iMessage", "is_me": false, "left_at": "2019-12-27T18:11:19.117Z", "status": "active" }, "parts": [ { "reactions": [ { "handle": { "id": "69a37c7d-af4f-4b5e-af42-e28e98ce873a", "handle": "+15551234567", "joined_at": "2025-05-21T15:30:00.000-05:00", "service": "iMessage", "is_me": false, "left_at": "2019-12-27T18:11:19.117Z", "status": "active" }, "is_me": false, "type": "love", "custom_emoji": null, "sticker": { "file_name": "sticker.png", "height": 420, "mime_type": "image/png", "url": "https://cdn.linqapp.com/attachments/a1b2c3d4/sticker.png?signature=...", "width": 420 } } ], "type": "text", "value": "Hello!", "text_decorations": [ { "range": [ 0, 5 ], "animation": "shake", "style": "bold" } ] } ], "preferred_service": "iMessage", "read_at": "2024-01-15T10:35:00Z", "reply_to": { "message_id": "550e8400-e29b-41d4-a716-446655440000", "part_index": 0 }, "sent_at": "2024-01-15T10:30:05Z", "service": "iMessage" } ``` ## Domain Types ### Message - `Message object { id, chat_id, created_at, 14 more }` - `id: string` Unique identifier for the message - `chat_id: string` ID of the chat this message belongs to - `created_at: string` When the message was created - `is_delivered: boolean` Whether the message has been delivered - `is_from_me: boolean` Whether this message was sent by the authenticated user - `is_read: boolean` Whether the message has been read - `updated_at: string` When the message was last updated - `delivered_at: optional string` When the message was delivered - `effect: optional MessageEffect` iMessage effect applied to a message (screen or bubble effect) - `name: optional string` Name of the effect. Common values: - Screen effects: confetti, fireworks, lasers, sparkles, celebration, hearts, love, balloons, happy_birthday, echo, spotlight - Bubble effects: slam, loud, gentle, invisible - `type: optional "screen" or "bubble"` Type of effect - `"screen"` - `"bubble"` - `from: optional string` DEPRECATED: Use from_handle instead. Phone number of the message sender. - `from_handle: optional ChatHandle` The sender of this message as a full handle object - `id: string` Unique identifier for this handle - `handle: string` Phone number (E.164) or email address of the participant - `joined_at: string` When this participant joined the chat - `service: ServiceType` Messaging service type - `"iMessage"` - `"SMS"` - `"RCS"` - `is_me: optional boolean` Whether this handle belongs to the sender (your phone number) - `left_at: optional string` When they left (if applicable) - `status: optional "active" or "left" or "removed"` Participant status - `"active"` - `"left"` - `"removed"` - `parts: optional array of TextPartResponse or MediaPartResponse or LinkPartResponse` Message parts in order (text, media, and link) - `TextPartResponse object { reactions, type, value, text_decorations }` A text message part - `reactions: array of Reaction` Reactions on this message part - `handle: ChatHandle` - `is_me: boolean` Whether this reaction is from the current user - `type: ReactionType` Type of reaction. Standard iMessage tapbacks are love, like, dislike, laugh, emphasize, question. Custom emoji reactions have type "custom" with the actual emoji in the custom_emoji field. Sticker reactions have type "sticker" with sticker attachment details in the sticker field. - `"love"` - `"like"` - `"dislike"` - `"laugh"` - `"emphasize"` - `"question"` - `"custom"` - `"sticker"` - `custom_emoji: optional string` Custom emoji if type is "custom", null otherwise - `sticker: optional object { file_name, height, mime_type, 2 more }` Sticker attachment details when reaction_type is "sticker". Null for non-sticker reactions. - `file_name: optional string` Filename of the sticker - `height: optional number` Sticker image height in pixels - `mime_type: optional string` MIME type of the sticker image - `url: optional string` Presigned URL for downloading the sticker image (expires in 1 hour). - `width: optional number` Sticker image width in pixels - `type: "text"` Indicates this is a text message part - `"text"` - `value: string` The text content - `text_decorations: optional array of TextDecoration` Text decorations applied to character ranges in the value - `range: array of number` Character range `[start, end)` in the `value` string where the decoration applies. `start` is inclusive, `end` is exclusive. *Characters are measured as UTF-16 code units. Most characters count as 1; some emoji count as 2.* - `animation: optional "big" or "small" or "shake" or 5 more` Animated text effect to apply. Mutually exclusive with `style`. - `"big"` - `"small"` - `"shake"` - `"nod"` - `"explode"` - `"ripple"` - `"bloom"` - `"jitter"` - `style: optional "bold" or "italic" or "strikethrough" or "underline"` Text style to apply. Mutually exclusive with `animation`. - `"bold"` - `"italic"` - `"strikethrough"` - `"underline"` - `MediaPartResponse object { id, filename, mime_type, 4 more }` A media attachment part - `id: string` Unique attachment identifier - `filename: string` Original filename - `mime_type: string` MIME type of the file - `reactions: array of Reaction` Reactions on this message part - `handle: ChatHandle` - `is_me: boolean` Whether this reaction is from the current user - `type: ReactionType` Type of reaction. Standard iMessage tapbacks are love, like, dislike, laugh, emphasize, question. Custom emoji reactions have type "custom" with the actual emoji in the custom_emoji field. Sticker reactions have type "sticker" with sticker attachment details in the sticker field. - `custom_emoji: optional string` Custom emoji if type is "custom", null otherwise - `sticker: optional object { file_name, height, mime_type, 2 more }` Sticker attachment details when reaction_type is "sticker". Null for non-sticker reactions. - `size_bytes: number` File size in bytes - `type: "media"` Indicates this is a media attachment part - `"media"` - `url: string` Presigned URL for downloading the attachment (expires in 1 hour). - `LinkPartResponse object { reactions, type, value }` A rich link preview part - `reactions: array of Reaction` Reactions on this message part - `handle: ChatHandle` - `is_me: boolean` Whether this reaction is from the current user - `type: ReactionType` Type of reaction. Standard iMessage tapbacks are love, like, dislike, laugh, emphasize, question. Custom emoji reactions have type "custom" with the actual emoji in the custom_emoji field. Sticker reactions have type "sticker" with sticker attachment details in the sticker field. - `custom_emoji: optional string` Custom emoji if type is "custom", null otherwise - `sticker: optional object { file_name, height, mime_type, 2 more }` Sticker attachment details when reaction_type is "sticker". Null for non-sticker reactions. - `type: "link"` Indicates this is a rich link preview part - `"link"` - `value: string` The URL - `preferred_service: optional ServiceType` Messaging service type - `read_at: optional string` When the message was read - `reply_to: optional ReplyTo` Indicates this message is a threaded reply to another message - `message_id: string` The ID of the message to reply to - `part_index: optional number` The specific message part to reply to (0-based index). Defaults to 0 (first part) if not provided. Use this when replying to a specific part of a multipart message. - `sent_at: optional string` When the message was sent - `service: optional ServiceType` Messaging service type ### Message Effect - `MessageEffect object { name, type }` iMessage effect applied to a message (screen or bubble effect) - `name: optional string` Name of the effect. Common values: - Screen effects: confetti, fireworks, lasers, sparkles, celebration, hearts, love, balloons, happy_birthday, echo, spotlight - Bubble effects: slam, loud, gentle, invisible - `type: optional "screen" or "bubble"` Type of effect - `"screen"` - `"bubble"` ### Reply To - `ReplyTo object { message_id, part_index }` Indicates this message is a threaded reply to another message - `message_id: string` The ID of the message to reply to - `part_index: optional number` The specific message part to reply to (0-based index). Defaults to 0 (first part) if not provided. Use this when replying to a specific part of a multipart message. ### Message Add Reaction Response - `MessageAddReactionResponse object { message, status, trace_id }` - `message: optional string` - `status: optional string` - `trace_id: optional string`