MImirakl
Conversations

getConversationMessages - Get messages for a conversation

Changed on
<div class="extension-title">Description</div>

Returns messages of a conversation, ordered by channel creation date descending.

<div class="api-description-extension"> </div>
get/conversations/{conversationId}

Request

Path parameters

conversationIdstring required

Unique identifier of the conversation

Query parameters

message_afterstring date-time

Return only messages created in Connect after this date (exclusive filter)

Response

Messages for the conversation

Example response

{
  "messages": [
    {
      "attachments": [
        {
          "filename": "billing_statement.pdf",
          "id": "550e8400-e29b-41d4-a716-446655440001",
          "size_in_bytes": 987
        }
      ],
      "body": "Hello, I need help with my billing statement.",
      "channel_created_at": "2024-06-01T10:05:00Z",
      "channel_message_id": "msg-2odjwo",
      "created_at": "2024-06-01T10:05:00Z",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "sender": {
        "id": "00032",
        "name": "Marketplace 1",
        "type": "CHANNEL"
      }
    }
  ]
}

Changes

  • d12b10bceb6aRevision changes
    • warning

      added the new CHANNEL enum value to the /// response property for the response status

    • warning

      added the new CUSTOMER enum value to the /// response property for the response status

    • warning

      added the new STORE enum value to the /// response property for the response status