Skip to main content
GET
/
v2
/
sms-threads
/
{sms_thread_id}
/
messages
Get SMS Thread Messages
curl --request GET \
  --url https://api.example.com/v2/sms-threads/{sms_thread_id}/messages \
  --header 'Authorization: Bearer <token>'
[
  {
    "created_at": "2023-11-07T05:31:56Z",
    "modified_at": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "body": "<string>",
    "classifications": [
      {
        "created_at": "2023-11-07T05:31:56Z",
        "modified_at": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "action_recommendation": "<string>",
        "agent_confidence_score": 123,
        "agent_metrics": {
          "confidence_reason": "<string>",
          "confidence_score": 123,
          "error_code": "duplicate",
          "uncertainties": [
            "<string>"
          ]
        },
        "classification": "payment_inquiry",
        "evidence": {},
        "is_action_required": true,
        "is_reply_required": true,
        "language": "<string>",
        "reason": "<string>",
        "object": "<string>"
      }
    ],
    "direction": "inbound",
    "from_number": "<string>",
    "to_number": "<string>",
    "status": "draft",
    "is_automated": true,
    "sent_at": "2023-11-07T05:31:56Z",
    "delivered_at": "2023-11-07T05:31:56Z",
    "object": "<string>"
  }
]

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

sms_thread_id
string
required

Response

Successful Response

created_at
string<date-time>
required
modified_at
string<date-time> | null
required
id
string
required
body
string
required

The message content

classifications
InteractionClassification · object[]
required
direction
enum<string>
required
Available options:
inbound,
outbound
from_number
string<phone>
required

The sending phone number

to_number
string<phone>
required

The receiving phone number

status
enum<string>
required
Available options:
draft,
pending,
sent,
delivered,
failed,
undelivered
is_automated
boolean
required

Whether the SMS was automatically sent by a workflow

sent_at
string<date-time> | null
required
delivered_at
string<date-time> | null
required
object
string
required

String representing the object's type. Objects of the same type share the same value.