GET
/
conversations
/
v3
/
conversations
/
threads
/
{threadId}
/
messages
/
{messageId}
Get a single message
curl --request GET \
  --url https://api.hubapi.com/conversations/v3/conversations/threads/{threadId}/messages/{messageId} \
  --header 'Authorization: Bearer <token>'
{
  "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": "<string>",
        "value": "<string>"
      }
    }
  ],
  "recipients": [
    {
      "actorId": "<string>",
      "name": "<string>",
      "deliveryIdentifier": {
        "type": "<string>",
        "value": "<string>"
      },
      "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>"
}
サポートされる製品
次のいずれかの製品またはそれ以上が必要です。
Marketing HubMarketing Hub無料ツール
Sales HubSales Hub無料ツール
Service HubService Hub無料ツール
Content HubContent Hub無料ツール

必須スコープ

この API には、次のいずれかのスコープが必要です。
  • conversations.read

Authorizations

Authorization
string
header
required

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

Response

successful operation

type
enum<string>
default:MESSAGE
required
Available options:
MESSAGE
id
string
required
conversationsThreadId
string
required
createdAt
string<date-time>
required
createdBy
string
required
client
object
required
senders
object[]
required
recipients
object[]
required
archived
boolean
required
text
string
required
attachments
(FILE · object | LOCATION · object | CONTACT · object | UNSUPPORTED_CONTENT · object | MESSAGE_HEADER · object | QUICK_REPLIES · object | WHATSAPP_TEMPLATE_METADATA · object | SOCIAL_MEDIA_METADATA · object)[]
required
truncationStatus
enum<string>
required
Available options:
NOT_TRUNCATED,
TRUNCATED_TO_MOST_RECENT_REPLY,
TRUNCATED
direction
enum<string>
required
Available options:
INCOMING,
OUTGOING
channelId
string
required
channelAccountId
string
required
updatedAt
string<date-time>
richText
string
subject
string
inReplyToId
string
status
object