Skip to main content
GET
발신 문자 조회

Authorizations

Authorization
string
header
required

워크스페이스 API 키를 Authorization: Bearer <token> 형식으로 보냅니다.

Path Parameters

sms_id
string
required

문자의 고유 식별자입니다(12자리 소문자 16진수).

Response

성공 응답

v3 발신 문자 리소스 페이로드입니다.

id
string
required

문자의 고유 식별자입니다.

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

"a1b2c3d4e5f6"

from_number
string
required

발신번호입니다.

Example:

"07011112222"

to_number
string | null
required

수신번호입니다. 보존 기간이 지나 지운 번호는 null입니다.

Example:

"01012345678"

message
string
required

수신자에게 발신한 문자 본문입니다.

Example:

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

message_type
enum<string>
required

확정된 문자 유형입니다('sms', 'lms', 'mms').

Available options:
sms,
lms,
mms
byte_count
integer
required

문자를 만들 때 계산해 저장한 바이트 수입니다. 신규 발신은 EUC-KR 기준이며 이전 기록은 당시 저장된 값을 반환합니다.

Required range: x >= 0
Example:

23

status
enum<string>
required

발신 상태입니다. pending은 발신 처리 중, queued는 통신사 최종 결과를 기다리는 상태로 아직 요금이 부과되지 않으며, 결과는 보통 몇 초 안에 정해지지만 수신 휴대폰이 꺼져 있으면 최대 24시간이 걸립니다. sent는 요금이 부과되는 성공이며 단말 수신이나 열람을 보장하지 않습니다. failed는 발신 실패, blocked는 제한된 내용이 포함되어 발신하지 않은 상태, canceled는 대량 문자 발신이 취소되어 발신하지 않은 상태입니다. legacy는 발신 상태를 기록하기 전의 과거 기록입니다.

Available options:
pending,
queued,
sent,
failed,
blocked,
canceled,
legacy
created_at
integer
required

리소스 생성 시각입니다. unix milliseconds 형식입니다.

Example:

1793051400000

title
string | null

문자 제목입니다. 없으면 null입니다.

image_urls
string[] | null

MMS에 첨부한 이미지 URL입니다. 텍스트만 보낸 발신이면 null입니다.

call_id
string | null

귀속된 통화 UUID입니다. 통화 중 에이전트의 send_sms 툴로 발신했거나 발신 요청이 call_id를 지정한 경우 채워지며, 통화에 귀속되지 않으면 null입니다.

chat_id
string | null

귀속된 채팅 UUID입니다. 문자 채팅의 에이전트 답변이나 outbound 메시지로 발신한 경우 채워지며, 채팅에 귀속되지 않으면 null입니다.

customer_id
string<uuid> | null

서버가 상대방 전화번호로 귀속한 고객 UUID입니다. 아직 고객 귀속이 완료되지 않았으면 null입니다.

metadata
Metadata · object | null

발신 요청에 담아 보낸 메타데이터입니다. 없으면 null입니다.

Example:
batch_id
string<uuid> | null

이 문자가 속한 대량 문자 발신의 UUID입니다. 대량 문자 발신으로 보내지 않은 문자는 null입니다.

error
SMSMessageError · object | null

failed, blocked, canceled 상태일 때의 사유입니다. 그 외 상태에서는 null입니다.

delivered_at
integer | null

문자가 수신 휴대폰에 전달된 시각입니다(unix ms). sent 상태일 때만 채워지며, 전달되지 않았거나 전달 시각을 알 수 없으면 null입니다.