새로운 문서를 작성 중입니다.새 문서로 이동
ClawOps Docs
API Reference

수신거부 목록 조회

GET
/v1/accounts/{accountId}/blocked-recipients

계정의 수신거부(DNC) 명단을 조회합니다. 기본은 현재 차단 중인 항목만 반환하며, 해제된 이력까지 보려면 status 를 released 또는 all 로 지정합니다.

같은 번호라도 채널(call/message)마다 별개 항목이므로, 전화와 문자를 모두 거부한 번호는 2건으로 나타납니다.

Authorization

BearerAuth
AuthorizationBearer <token>

API Key를 Bearer 토큰으로 전달

In: header

Path Parameters

accountId*string

계정 ID

Query Parameters

channel?string

채널 필터. 미지정 시 전체.

Value in"call" | "message"
number?string

번호 필터. 하이픈·+82 형태로 보내도 정규화 후 대조합니다.

status?string

active=차단 중(기본), released=해제된 이력, all=전체

Default"active"
Value in"active" | "released" | "all"
page?integer

페이지 번호(0-based)

Default0
pageSize?integer

페이지 크기(최대 100)

Default20
Rangevalue <= 100
page_size?integerDeprecated

pageSize 의 별칭(하위호환). 신규 연동은 pageSize 를 사용하세요.

Rangevalue <= 100
limit?integerDeprecated

pageSize 의 별칭(하위호환). 신규 연동은 pageSize 를 사용하세요.

Rangevalue <= 100

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/accounts/AC1a2b3c4d/blocked-recipients?channel=call&number=010-1234-5678&status=active&page=0&pageSize=20&page_size=50&limit=100"
{
  "data": [
    {
      "id": "clx9blk00001",
      "number": "01012345678",
      "channel": "call",
      "active": true,
      "source": "api",
      "sourceRef": "CA1a2b3c4d5e",
      "note": "상담 중 재연락 거부 의사 밝힘",
      "createdBy": null,
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "unblockedAt": "2019-08-24T14:15:22Z",
      "unblockedSource": "api",
      "unblockedBy": "string",
      "unblockedNote": "string"
    }
  ],
  "meta": {
    "page": 0,
    "pageSize": 0,
    "total": 0
  }
}
{
  "error": "string",
  "code": "recipient_blocked"
}
{
  "error": "string",
  "code": "recipient_blocked"
}
{
  "error": "string",
  "code": "recipient_blocked"
}