Skip to main content
GET
/
sms
/
received
수신 SMS 목록 조회
curl --request GET \
  --url https://client-api.tryvox.co/v3/sms/received \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://client-api.tryvox.co/v3/sms/received"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://client-api.tryvox.co/v3/sms/received', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://client-api.tryvox.co/v3/sms/received",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://client-api.tryvox.co/v3/sms/received"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://client-api.tryvox.co/v3/sms/received")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://client-api.tryvox.co/v3/sms/received")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "items": [
    {
      "id": "<string>",
      "received_at": 123,
      "from_number": "<string>",
      "to_number": "<string>",
      "message": "<string>",
      "title": "<string>",
      "call_id": "<string>",
      "attachments": [
        {
          "file_key": "<string>",
          "mime_type": "<string>"
        }
      ]
    }
  ],
  "total_count": 123,
  "next_cursor": "<string>"
}
{
"error": {
"code": "VALIDATION_ERROR",
"message": "Request validation failed.",
"details": {
"field": "name",
"reason": "must not be blank"
}
}
}
{
"error": {
"code": "UNAUTHORIZED",
"message": "Authentication is required.",
"details": {}
}
}
{
"error": {
"code": "FORBIDDEN",
"message": "Permission denied.",
"details": {}
}
}
{
"error": {
"code": "RESOURCE_NOT_FOUND",
"message": "Resource not found.",
"details": {
"resource": "agent"
}
}
}
{
"error": {
"code": "CONFLICT",
"message": "The requested operation conflicts with current state.",
"details": {
"current_status": "draft"
}
}
}
{
"error": {
"code": "RATE_LIMIT_EXCEEDED",
"message": "Too many requests.",
"details": {
"limit": 5,
"window_seconds": 1
}
}
}
{
"error": {
"code": "INTERNAL_ERROR",
"message": "Internal server error.",
"details": {}
}
}
{
"error": {
"code": "SERVICE_UNAVAILABLE",
"message": "Service temporarily unavailable.",
"details": {}
}
}

Authorizations

Authorization
string
header
required

조직 API 키를 Authorization: Bearer <token> 형식으로 보냅니다.

Query Parameters

call_id
string<uuid> | null

통화 UUID 필터.

from_number
string | null

발신 번호 정확 일치 필터.

to_number
string | null

수신 번호 정확 일치 필터.

received_at_after
integer | null

수신 시각 하한 (unix ms, 이 시각 이상). 10~11자리 unix 초 입력도 허용 — 자동으로 ms로 변환된다. 수신 시각 하한 (unix ms, inclusive).

received_at_before
integer | null

수신 시각 상한 (unix ms, 이 시각 이하). 10~11자리 unix 초 입력도 허용 — 자동으로 ms로 변환된다. 수신 시각 상한 (unix ms, inclusive).

sort_order
enum<string>
default:desc

정렬 순서 'asc' 또는 'desc'. 정렬 기준은 수신 시각. 정렬 방향입니다. 허용값은 asc, desc입니다.

Available options:
asc,
desc
cursor
string | null

이전 응답의 next_cursor 값입니다. 다음 페이지를 조회할 때 그대로 전달합니다.

limit
integer
default:50

반환할 최대 항목 수입니다. v3 목록 endpoint는 1~100을 허용합니다.

Required range: 1 <= x <= 100

Response

성공 응답

items
SMSReceivedResponse · object[]
required

페이지 항목입니다.

total_count
integer
required

조건에 맞는 전체 항목 수입니다.

next_cursor
string | null

다음 페이지 커서입니다. 조회할 항목이 더 없으면 null입니다.