GET
/v1/comms/textsRead the text message log
Every SMS and iMessage this workspace sent or received, newest first, across every thread. Narrow with direction, or with definitionId + rowId for one record's texts. Start here for "what have we texted them".
Access class: workspace.
Send request
Use the documented inputs to call this endpoint directly.
API serverbase URL
Bearer tokensessionoptional
Stored only in this browser for the session security scheme and reused on every API page in this group.
Parameters
Values are applied to the request and the example on the right.
bodyquery · nulloptional
paramsquery · objectoptional
queryquery · objectoptional
definitionIdstringoptional
directionstringoptional
limitintegeroptional
offsetintegeroptional
rowIdstringoptional
Responses
200application/json
the action's answer
{
"texts": [
{
"contact_identifier": "string",
"contact_name": "string",
"content": "string",
"conversation_id": 1.5,
"delivery": {
"attempts": 1.5,
"claimed_by": "string",
"error": "string",
"next_attempt_at": "string",
"state": "string"
},
"direction": "string",
"id": 1.5,
"is_deleted": true,
"medium": "string",
"occurred_at": "string",
"recorded_at": "string",
"sender_id": 1.5,
"sender_name": "string",
"sender_type": "string",
"status": "string",
"text": {
"error_code": "string",
"error_message": "string",
"media_count": 1.5,
"provider": "string",
"segment_count": 1.5
}
}
],
"total": 1.5
}textsarray<>required
totalnumberrequired
defaultapplication/json
a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.
{
"error": "string"
}errorstringrequired