Skip to main content
GET
/
{instance}
/
message-threads
{
  "data": [
    {
      "id": "9df34184-99e5-43a5-9e6d-371de0344bb9",
      "phone_id": "9defcf1e-552c-4bef-a843-872edec576ef",
      "last_message_id": "9e05ec65-bd9e-42b8-aa18-ddd497b4667e",
      "from_phone_number": "4100",
      "to_phone_number": "+2014398429234",
      "is_archived": false,
      "last_message_content": "مبروك ليك 20 وحدة هدية\r\nرد ب 1 الاّن!\r\nو اشتراك اول يوم علينا\r\nو فرصتك تلعب و تكسب 50,000جنيه\r\nاشترك في GamezZe بـ5جنيه لليوم \r\nرد ب 1 الاّن",
      "last_message_at": "2025-01-21 17:38:41",
      "created_at": "2025-01-12 11:23:38",
      "updated_at": "2025-01-21 18:06:21"
    }
  ],
  "links": {
    "first": "https://beta.hypersender.com/api/sms/v1/9defcf1e-552c-4bef-a843-872edec576ef/message-threads?per_page=1&page=1",
    "last": "https://beta.hypersender.com/api/sms/v1/9defcf1e-552c-4bef-a843-872edec576ef/message-threads?per_page=1&page=6",
    "prev": null,
    "next": "https://beta.hypersender.com/api/sms/v1/9defcf1e-552c-4bef-a843-872edec576ef/message-threads?per_page=1&page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 6,
    "links": [
      {
        "url": null,
        "label": "« Previous",
        "active": false
      },
      {
        "url": "https://beta.hypersender.com/api/sms/v1/9defcf1e-552c-4bef-a843-872edec576ef/message-threads?per_page=1&page=1",
        "label": "1",
        "active": true
      },
      {
        "url": "https://beta.hypersender.com/api/sms/v1/9defcf1e-552c-4bef-a843-872edec576ef/message-threads?per_page=1&page=2",
        "label": "2",
        "active": false
      },
      {
        "url": "https://beta.hypersender.com/api/sms/v1/9defcf1e-552c-4bef-a843-872edec576ef/message-threads?per_page=1&page=3",
        "label": "3",
        "active": false
      },
      {
        "url": "https://beta.hypersender.com/api/sms/v1/9defcf1e-552c-4bef-a843-872edec576ef/message-threads?per_page=1&page=4",
        "label": "4",
        "active": false
      },
      {
        "url": "https://beta.hypersender.com/api/sms/v1/9defcf1e-552c-4bef-a843-872edec576ef/message-threads?per_page=1&page=5",
        "label": "5",
        "active": false
      },
      {
        "url": "https://beta.hypersender.com/api/sms/v1/9defcf1e-552c-4bef-a843-872edec576ef/message-threads?per_page=1&page=6",
        "label": "6",
        "active": false
      },
      {
        "url": "https://beta.hypersender.com/api/sms/v1/9defcf1e-552c-4bef-a843-872edec576ef/message-threads?per_page=1&page=2",
        "label": "Next »",
        "active": false
      }
    ],
    "path": "https://beta.hypersender.com/api/sms/v1/9defcf1e-552c-4bef-a843-872edec576ef/message-threads",
    "per_page": 1,
    "to": 1,
    "total": 6
  }
}
This endpoint will index all of the contacts which a phone number has communicated with (threads). with paging limited to 50 messages per response. It will be sorted by updated_at in descending order.

Authorizations

​
Authorization
string
header
required

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

Headers

​
Accept
string

Path Parameters

​
instance
string
required

Instance UUID copied from hypersender dashboard

Example:

"{{ instance_id }}"

Query Parameters

​
per_page
string

number of messages per page, max: 50

​
sort
string

default: -updated_at, you can sort by any date: 'created_at', 'last_message_at', 'updated_at'

​
filter[last_message_content]
string

filter by last message content.

​
filter[is_archived]
boolean

filter by SMS messages based on their archived status.

​
filter[last_message_id]
string

get the thread where the thread is the specified message id

​
filter[from_or_to_number]
string

get the thread where the "from" or "to" of phone number

​
include
string

include the phone or messageThread object with the message, possible values: phone, messageThread

Response

Successful response

​
data
object[]
​
links
object
​
meta
object