Skip to main content
GET
발신 문자 목록 조회

Authorizations

Authorization
string
header
required

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

Query Parameters

call_id
string<uuid> | null

통화 UUID 필터입니다.

chat_id
string<uuid> | null

채팅 UUID 필터입니다. 문자 채팅의 에이전트 답변이나 outbound 메시지로 발신한 문자만 반환합니다.

customer_id
string<uuid> | null

귀속 고객 UUID 필터입니다. 해당 고객에 귀속된 문자만 반환합니다.

batch_id
string<uuid> | null

대량 문자 발신 UUID 필터입니다. 해당 대량 문자 발신에 속한 문자만 반환합니다.

from_number
string | null

발신번호 정확 일치 필터입니다. 하이픈 없는 국내 번호입니다.

to_number
string | null

수신번호 정확 일치 필터입니다. 하이픈 없는 국내 번호입니다.

delivery_status
enum<string>[] | null

발신 상태 필터입니다(반복 가능). 허용값: pending, queued, sent, failed, blocked, canceled, legacy.

발신 상태입니다. pending은 발신 처리 중, queued는 통신사 최종 결과를 기다리는 상태(아직 요금 부과 전), sent는 요금이 부과되는 성공, failed는 발신 실패, blocked는 제한된 내용이 포함되어 발신하지 않은 상태, canceled는 대량 문자 발신 취소로 발신하지 않은 상태, legacy는 발신 상태를 기록하기 전의 과거 기록입니다.

Available options:
pending,
queued,
sent,
failed,
blocked,
canceled,
legacy
created_at_after
integer | null

생성 시각 하한입니다(unix ms, 이 시각 이상). 10~11자리 unix 초 입력도 허용하며 자동으로 ms로 변환됩니다.

created_at_before
integer | null

생성 시각 상한입니다(unix ms, 이 시각 이하). 10~11자리 unix 초 입력도 허용하며 자동으로 ms로 변환됩니다.

sort_order
enum<string>
default: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
SMSSendResponse · object[]
required

페이지 항목입니다.

total_count
integer
required

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

next_cursor
string | null

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