Skip to main content
GET
대량 문자 발신 조회

Authorizations

Authorization
string
header
required

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

Path Parameters

batch_id
string
required

대량 문자 발신의 UUID입니다.

Response

성공 응답

대량 문자 발신 한 건입니다. 문자별 결과는 GET /v3/sms?batch_id= 로 조회합니다.

id
string
required

대량 문자 발신의 고유 식별자입니다(UUID).

name
string | null
required

대량 문자 발신 이름입니다. 이름 없이 만든 이전 대량 문자 발신은 null입니다.

status
enum<string>
required

대량 문자 발신 상태입니다. canceled는 취소됨, paused는 일시정지 중, draft는 예약 시각 전의 대기 상태입니다. 그 외에는 pending(발신 전), ongoing(발신 중이거나 발신이 끝난 뒤 통신사 결과를 기다리는 중), success(모든 결과가 정해졌거나 마지막 발신 후 10분이 지나 끝남, 실패·차단 항목이 있을 수 있음), fail(접수된 항목 없이 끝남)입니다.

Available options:
draft,
pending,
ongoing,
paused,
success,
fail,
canceled
from_number
string
required

대량 문자 발신 전체가 공유하는 발신번호입니다.

total_count
integer
required

이 대량 문자 발신에 담은 전체 문자 수입니다.

Required range: x >= 0
success_count
integer
required

요금이 부과되는 성공(sent) 항목 수입니다.

Required range: x >= 0
failure_count
integer
required

발신에 실패한(failed) 항목 수입니다.

Required range: x >= 0
pending_count
integer
required

아직 결과가 정해지지 않은 문자 수입니다. 발신하지 않은 pending 문자와 통신사의 최종 결과를 기다리는 queued 문자를 합한 값이며, success_count + failure_count + pending_count + blocked_count + canceled_count가 total_count와 같습니다. 문자별 결과는 GET /v3/sms?batch_id= 로 조회합니다.

Required range: x >= 0
blocked_count
integer
required

제한된 내용이 포함되어 발신하지 않은(blocked) 항목 수입니다.

Required range: x >= 0
canceled_count
integer
required

대량 문자 발신 취소로 발신하지 않은(canceled) 항목 수입니다.

Required range: x >= 0
send_time_window
SMSBatchSendTimeWindow · object | null
required

발신 허용 시간대입니다. 시간대를 정하지 않고 만든 이전 대량 문자 발신은 null입니다.

scheduled_at
integer | null
required

예약 실행 시각입니다. unix milliseconds 형식입니다.

paused_at
integer | null
required

일시정지한 시각입니다(unix ms). 일시정지 중이 아니면 null입니다.

canceled_at
integer | null
required

취소한 시각입니다(unix ms). 취소하지 않았으면 null입니다.

created_at
integer
required

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

finished_at
integer | null
required

대량 문자 발신이 끝난 시각입니다(unix ms). 끝나지 않았으면 null입니다.

sheet_id
string | null
required

대량 문자 발신 생성에 사용한 시트 식별자입니다. 시트를 거치지 않았으면 null입니다.