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

Unterstützte Produkte

Erfordert eines der folgenden Produkte oder höher.
Marketing HubMarketing Hub -Kostenlos
Sales HubSales Hub -Professional
Service HubService Hub -Professional
Content HubContent Hub -Kostenlos
Diese API erfordert einen der folgenden Bereiche:
conversations.custom_channels.read

Authorizations

Authorization
string
header
required

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

Path Parameters

channelId
integer
required

Der Kanal, über den die Nachricht gesendet wurde

messageId
string
required

Die ID der Nachricht

Response

successful operation

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
  • FILE
  • LOCATION
  • CONTACT
  • UNSUPPORTED_CONTENT
  • MESSAGE_HEADER
  • QUICK_REPLIES
  • WHATSAPP_TEMPLATE_METADATA
  • SOCIAL_MEDIA_METADATA
conversationsThreadId
string
required
type
enum<string>
default:MESSAGE
required
Verfügbare Optionen:
MESSAGE
createdAt
string<date-time>
required
archived
boolean
required
createdBy
string
required
recipients
object[]
required
truncationStatus
enum<string>
required
Verfügbare Optionen:
NOT_TRUNCATED,
TRUNCATED_TO_MOST_RECENT_REPLY,
TRUNCATED
client
object
required
id
string
required
text
string
required
channelAccountId
string
required
senders
object[]
required
channelId
string
required
direction
enum<string>
required
Verfügbare Optionen:
INCOMING,
OUTGOING
subject
string
richText
string
inReplyToId
string
updatedAt
string<date-time>
status
object