Skip to main content
GET
/
v2
/
sms-threads
/
{sms_thread_id}
Get a SMS Thread
curl --request GET \
  --url https://api.example.com/v2/sms-threads/{sms_thread_id} \
  --header 'Authorization: Bearer <token>'
{
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "from_number": "<string>",
  "to_number": "<string>",
  "partner": {
    "created_at": "2023-11-07T05:31:56Z",
    "modified_at": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "account_number": "<string>",
    "assignee_id": "<string>",
    "currency": "ADP",
    "email": "<string>",
    "name": "<string>",
    "legal_name": "<string>",
    "phone": "<string>",
    "parent_id": "<string>",
    "remote_id": "<string>",
    "object": "<string>"
  },
  "last_inbound_at": "2023-11-07T05:31:56Z",
  "last_outbound_at": "2023-11-07T05:31:56Z",
  "latest_message_at": "2023-11-07T05:31:56Z",
  "latest_message_body": "<string>",
  "messages": [
    {
      "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>"
    }
  ],
  "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

SMS thread with partner information.

​
created_at
string<date-time>
required
​
modified_at
string<date-time> | null
required
​
id
string
required
​
from_number
string<phone>
required

Phone number of the organization

​
to_number
string<phone>
required

Phone number of the partner

​
partner
object
required
​
last_inbound_at
string<date-time> | null
required

Timestamp of the last inbound SMS in this thread

​
last_outbound_at
string<date-time> | null
required

Timestamp of the last outbound SMS in this thread

​
latest_message_at
string<date-time> | null
required
​
latest_message_body
string | null
required
​
messages
SMS · object[]
required
​
object
string
required

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