Mailisk

Appearance

Search SMS messages​

GET
/api/sms/{phone_number}/messages

This endpoint returns the latest SMS messages for a specific phone number.
When the wait query flag is set to true and no messages are found yet, the endpoint waits briefly and redirects back to the same URL so the client can retry the same request automatically.

Authorizations​

ApiKey
Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

phone_number*
Type
string
Required

Query Parameters

limit*
Type
number
Required
Minimum
1
Maximum
100
Default
20
offset*
Type
number
Required
Minimum
0
Default
0
body
Type
string
from_number
Type
string
from_date
Type
string
to_date
Type
string
wait
Type
boolean
Default
false

Responses​

application/json
JSON
{
  
"total_count": 0,
  
"options": {
  
},
  
"data": [
  
  
{
  
  
  
"id": "string",
  
  
  
"sms_phone_number_id": "string",
  
  
  
"body": "string",
  
  
  
"from_number": "string",
  
  
  
"to_number": "string",
  
  
  
"provider_message_id": "string",
  
  
  
"created_at": "string",
  
  
  
"direction": "string"
  
  
}
  
]
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI