Zum Hauptinhalt springen
GET
/
conversations
/
v3
/
conversations
/
threads
/
{threadId}
/
messages
Get message history for a thread
curl --request GET \
  --url https://api.hubapi.com/conversations/v3/conversations/threads/{threadId}/messages \
  --header 'Authorization: Bearer <token>'
{
  "paging": {
    "next": {
      "link": "",
      "after": ""
    }
  },
  "results": [
    {
      "type": "MESSAGE",
      "id": "<string>",
      "conversationsThreadId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "client": {
        "clientType": "HUBSPOT",
        "integrationAppId": 123
      },
      "senders": [
        {
          "actorId": "<string>",
          "name": "<string>",
          "senderField": "<string>",
          "deliveryIdentifier": {
            "type": "<any>",
            "value": "<any>"
          }
        }
      ],
      "recipients": [
        {
          "actorId": "<string>",
          "name": "<string>",
          "deliveryIdentifier": {
            "type": "<any>",
            "value": "<any>"
          },
          "recipientField": "<string>"
        }
      ],
      "archived": true,
      "text": "<string>",
      "richText": "<string>",
      "attachments": [
        {
          "fileUsageType": "<string>",
          "name": "<string>",
          "type": "FILE",
          "url": "<string>",
          "fileId": "<string>"
        }
      ],
      "subject": "<string>",
      "truncationStatus": "NOT_TRUNCATED",
      "inReplyToId": "<string>",
      "status": {
        "statusType": "SENT",
        "failureDetails": {
          "errorMessageTokens": {},
          "errorMessage": "<string>"
        }
      },
      "direction": "INCOMING",
      "channelId": "<string>",
      "channelAccountId": "<string>"
    }
  ]
}

Produits pris en charge

Exige l'un des produits suivants ou un produit supérieur.
Marketing HubMarketing Hub -Gratuit
Sales HubSales Hub -Gratuit
Service HubService Hub -Gratuit
Content HubContent Hub -Gratuit
Cette API requiert l'une des portées suivantes :
conversations.read

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

threadId
integer
required

The unique ID of the thread.

Query Parameters

after
string

The paging cursor token of the last successfully read resource will be returned as the paging.next.after JSON property of a paged response containing more results.

limit
integer

The maximum number of results to display per page.

sort
string[]

Sort direction. Valid options are createdAt (ascending), and -createdAt (descending, default)

archived
boolean

Whether to return only results that have been archived.

property
string

A specific property to include in the message response.

Response

successful operation

results
object[]
required
  • Option 1
  • Option 2
  • Option 3
  • Option 4
  • Option 5
  • Option 6
  • Option 7
  • Option 8
  • Option 9
  • Option 10
  • Option 11
  • Option 12
  • Option 13
  • Option 14
  • Option 15
  • Option 16
  • Option 17
  • Option 18
  • Option 19
  • Option 20
  • Option 21
  • Option 22
  • Option 23
  • Option 24
  • Option 25
  • Option 26
  • Option 27
  • Option 28
  • Option 29
  • Option 30
  • Option 31
  • Option 32
  • Option 33
  • Option 34
  • Option 35
  • Option 36
paging
object