Skip to navigation

수신거부 항목 조회

View as Markdown

수신거부 항목 하나의 상세를 조회합니다. 해제된 항목도 이력으로 남아 있어 조회되며, 이때 active 는 false 입니다.

Authentication

AuthorizationBearer

API Key를 Bearer 토큰으로 전달

Path parameters

accountIdstringRequired

계정 ID

blockIdstringRequired

수신거부 항목 id

Response

수신거부 항목 상세

idstringOptional

수신거부 항목 id

recipientstringOptional

수신거부한 상대. 채널과 무관하게 항상 이 칸에 들어갑니다 — call·message 면 전화번호(하이픈·+82 로 보내도 국내 표기로 정규화), email 이면 이메일 주소(소문자로 정규화).

채널이 늘어도 이 칸 하나만 읽으면 됩니다. 저장 컬럼명(number)을 그대로 노출하지 않는 이유는, 전화번호라는 이름에 이메일 주소를 담으면 그 칸을 전화번호로 가정한 코드(포맷터 등)가 조용히 깨지기 때문입니다.

channelenumOptional

차단 채널. call=전화, message=문자(SMS/LMS/MMS 공통), email=이메일. 같은 상대라도 채널마다 별개 항목입니다.

Allowed values:
activebooleanOptional

지금 차단 중인지 여부. 해제된 항목도 이력으로 남아 조회되므로 이 값으로 구분합니다.

sourcestringOptional

접수 경로. 공개 API 로 등록하면 api·console·import 중 하나입니다. ARS(수신거부 9번)·문자 회신 등 내부 접수 경로로 등록된 항목은 ars·sms·agent 로 나타납니다.

sourceRefstring or nullOptional

증빙 링크. 어느 통화에서 수신거부를 눌렀는지 / 어느 문자에 회신했는지. 가리키는 대상은 source 가 결정합니다.

notestring or nullOptional

자유 메모

createdBystring or nullOptional

등록 주체(콘솔 사용자 등). 자동 접수는 null 입니다.

createdAtdatetimeOptional

수신거부 접수 시각

updatedAtdatetimeOptional
unblockedAtdatetime or nullOptional

해제 시각. null 이면 차단 중입니다. 해제해도 항목은 삭제되지 않고 이력으로 남습니다.

unblockedSourcestring or nullOptional

해제 경로

unblockedBystring or nullOptional

해제 주체. 자동 해제는 null 입니다.

unblockedNotestring or nullOptional

해제 사유 메모

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error