v1

latestOpenAPI 3.0.12026-07-22120163333.7 KB

Communication V2

Get a text message by ID

Returns the text message identified by the given communication ID. The communication must be a text record, and the caller must have manage permission on the owning lead; otherwise 400 PERMISSION_DENIED is returned (no existence leak).

Webhook follow-up: when a Text webhook is delivered, pass each createdText[].timelineId from the payload as the communicationId path parameter to fetch the full record. The legacy createdText[].textId field is kept for backward compatibility but is not interchangeable across communicationType — prefer timelineId.

get/v2.0/communication/text/{communicationId}

Path parameters

communicationIdinteger required

Communication ID of the text message.

Headers

Authorizationstring required

Bearer [access_token]

Response

Text message retrieved successfully.

idinteger

The ID of the text

leadIdinteger

The lead(Id) associated with the text

directionstring

Outbound or Inbound text

agentIdinteger

The related Agent ID

textOutcomestring

Text delivery status

textTimestring

The sending time of the text

textTypestring

Manual or Auto text

textContentstring

The content of the text

Example response

{
  "direction": "Outbound",
  "textOutcome": "Delivered",
  "textType": "Auto",
  "textContent": "Content"
}