Skip to main content
POST
/
sms
curl --request POST \
  --url https://client-api.tryvox.co/v3/sms \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "from_number": "07011112222",
  "to_number": "01012345678",
  "message": "예약 확인 안내드립니다.",
  "metadata": {
    "external_id": "sms_20260526_001"
  }
}
'
{
  "id": "<string>",
  "from_number": "<string>",
  "to_number": "<string>",
  "message": "<string>",
  "byte_count": 1,
  "status": "<string>",
  "created_at": 123,
  "title": "<string>",
  "image_urls": [
    "<string>"
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.tryvox.co/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Headers

​
Idempotency-Key
string | null

동일한 POST 요청을 24시간 동안 안전하게 재시도하기 위한 선택적 멱등 키입니다. 제공할 경우 비어 있지 않아야 하며 최대 255자까지 허용됩니다.

Body

application/json

SMS 발송 페이로드입니다. 텍스트 전용 SMS/LMS는 image_file_keys를 생략하고, MMS는 최대 3개의 file key를 포함합니다.

POST /v3/sms 요청 페이로드입니다.

​
from_number
string
required

발신 전화번호입니다. 인증된 조직 소유이며 SMS 발송이 활성화되어 있어야 합니다.

Example:

"07011112222"

​
to_number
string
required

국내 숫자 전용 형식의 수신자 전화번호입니다.

Example:

"01012345678"

​
message
string
required

메시지 본문입니다. 90 UTF-8 byte 이하 메시지는 SMS로 발송되며, 제목이나 이미지 첨부가 있으면 LMS/MMS로 발송됩니다.

Example:

"예약 확인 안내드립니다."

​
title
string | null

선택적 제목입니다. 제목을 제공하면 LMS 또는 MMS로 발송됩니다.

Example:

"예약 안내"

​
image_file_keys
string[] | null

파일 업로드 API가 반환한 선택적 이미지 첨부 file key입니다. 최대 3개까지 제공하며, 텍스트 전용 SMS/LMS는 생략하거나 null로 둡니다.

Maximum array length: 3
Example:
["file_abc123", "file_def456"]
​
metadata
Metadata · object

요청 추적을 위한 선택적 클라이언트 metadata입니다.

Example:
{ "external_id": "sms_20260526_001" }

Response

성공 응답

POST /v3/sms 응답 페이로드입니다.

​
id
string
required

SMS 메시지 식별자입니다.

Pattern: ^[0-9a-f]{12}$
Example:

"a1b2c3d4e5f6"

​
from_number
string
required

발신 전화번호입니다.

​
to_number
string
required

수신자 전화번호입니다.

​
message
string
required

수신자에게 발송된 메시지 본문입니다.

​
message_type
enum<string>
required

결정된 메시지 타입입니다.

Available options:
sms,
lms,
mms
​
byte_count
integer
required

메시지 본문의 UTF-8 byte 수입니다.

Required range: x >= 0
Example:

33

​
status
string
required

발송 파이프라인 상태입니다.

​
created_at
integer
required

리소스 생성 시각이며, 밀리초 단위 unix timestamp입니다.

​
title
string | null

메시지 제목이며, 없으면 null입니다.

​
image_urls
string[] | null

MMS 첨부의 제공자 이미지 URL이며, 텍스트 전용 발송이면 null입니다.