API

수신거부 그룹 조회

작성일 2026.03.23 | 수정일 2026.03.23

GET/block/groups/
Query
blockGroupId— 수신거부 그룹 핸들키
status— 그룹 상태 (INACTIVE: 비활성, ACTIVE: 활성)
startKey— 페이지네이션 시작 키
limit— 조회 개수 (기본값: 20)
useAll— 전체 발신번호 적용 여부 (true: 모든 발신번호에 적용)
senderNumber— 해당 발신번호가 포함된 그룹만 조회
name— 그룹 이름 (부분 일치 검색 지원)

등록된 수신거부 그룹 목록을 조회합니다. 상태, 발신번호 등 다양한 조건으로 필터링할 수 있습니다.

Response

NameTypeRequiredDescription
startKeyString*현재 페이지 시작 키
nextKeyString*다음 페이지 시작 키
limitNumber*조회 개수
blockGroupsArray*수신거부 그룹 목록
blockGroupIdString*수신거부 그룹 핸들키
accountIdString*계정 고유 ID
statusString*그룹 상태 (INACTIVE: 비활성, ACTIVE: 활성)
nameString*그룹 이름 (최대 50자)
useAllBoolean*전체 발신번호 적용 여부
senderNumbersArray*적용 발신번호 목록 (useAll이 false일 때 사용)
dateCreatedDate*등록 일시
dateUpdatedDate*수정 일시

Structure

Response
{ "startKey": null, "nextKey": null, "limit": 20, "blockGroups": [ { "blockGroupId": "IM01BG2403201400000000abcdefgh", "accountId": "12345678901234", "status": "ACTIVE", "name": "마케팅 수신거부 그룹", "useAll": false, "senderNumbers": [ "029302266", "01012345678" ], "dateCreated": "2024-03-20T14:00:00.000Z", "dateUpdated": "2024-03-20T14:00:00.000Z" } ] }