Skip to navigation

메시지 단건 조회

View as Markdown

특정 메시지의 상세 정보를 조회합니다.

Authentication

AuthorizationBearer

API Key를 Bearer 토큰으로 전달

Path parameters

accountIdstringRequired

계정 ID

messageIdstringRequired

메시지 ID

Response

메시지 정보

messageIdstringOptional
statusenumOptional
Allowed values:
failureCodestring or nullOptional

문자(SMS·LMS·MMS) 실패 사유 코드입니다. 조회 응답에 있으며, 실패 건이 아니거나 사유가 기록되지 않은 건은 null 입니다.

invalid_number 없는 번호, recipient_opted_out 수신 거부, spam_blocked 통신사 스팸 차단, number_ported 번호이동, handset_off 단말기 전원 꺼짐, out_of_coverage 서비스 지역 밖, handset_storage_full 단말기 저장 공간 부족, timeout 결과 대기 시간 초과, invalid_data 발송 데이터 오류, invalid_message 메시지 형식 오류, message_too_large 크기 초과, rate_limited 전송량 초과, invalid_sender 발신번호 형식 오류, sender_not_registered 미등록 발신번호, sender_blocked 발신번호 차단, service_not_permitted 서비스 권한 문제, carrier_error 통신사 기타 오류, unknown 확인 불가.

failureMessagestring or nullOptional

실패 사유 설명입니다. 문구는 바뀔 수 있으니 분기에는 failureCode 를 쓰세요.

typeenumOptional

ata 는 카카오 알림톡, bms 는 카카오 브랜드 메시지입니다. 본문(body)은 템플릿에 변수를 치환한 결과이며, 버튼·아이템 리스트·강조 문구는 템플릿에 담긴 대로 발송되어 이 값에는 담기지 않습니다.

Allowed values:
subjectstring or nullOptional

메시지 제목 (LMS/MMS)

tostringOptional
fromstringOptional
bodystring or nullOptional
numMediaintegerOptional

첨부 이미지 수

mediaUrllist of stringsOptional

첨부 이미지 URL 목록

directionenumOptional
Allowed values:
accountIdstringOptional
dateCreateddatetimeOptional
dateUpdateddatetime or nullOptional

Errors

401
Unauthorized Error
404
Not Found Error