Sign in

v1

latestOpenAPI 3.0.2서비스 이용약관2026-07-265758331.1 KB
Contacts

수신거부 목록 조회

등록된 수신거부 목록을 조회합니다. 각 수신거부 항목에는 전화번호, 발신번호, 등록 일시 등이 포함되며, 페이지네이션을 지원하여 대량의 데이터도 효율적으로 조회할 수 있습니다.

get/v2/contacts/blocklist

Query parameters

senderNumberstring

특정 발신번호의 수신거부 목록만 조회하고 싶을 때 입력합니다. 비워두면 모든 발신번호의 수신거부를 조회합니다.

kakaoChannelIdsstring[]

특정 카카오 채널의 수신거부 목록만 조회하고 싶을 때 입력합니다.

blockTypestring[]

수신거부가 등록된 경로로 필터링합니다. WEB(웹사이트), API(API 호출), ARS(전화 수신거부) 중에서 선택할 수 있습니다.

startDatestring

조회할 기간의 시작 날짜와 시간입니다. YYYY-MM-DD HH:mm:ss 형식으로 입력해주세요.

endDatestring

조회할 기간의 종료 날짜와 시간입니다. YYYY-MM-DD HH:mm:ss 형식으로 입력해주세요.

limitnumber

한 번에 가져올 수신거부 목록의 최대 개수입니다. 너무 큰 값을 설정하면 응답 속도가 느려질 수 있습니다.

cursornumber

페이징을 위한 커서 값입니다. 다음 페이지를 가져올 때 이전 응답에서 받은 cursor 값을 사용하세요.

Response

수신거부 목록 조회가 성공적으로 완료되었습니다. 등록된 수신거부 항목들과 페이지네이션 정보가 반환됩니다.

codenumber required

HTTP 상태 코드입니다. 200이면 성공, 400대는 클라이언트 오류, 500대는 서버 오류를 나타냅니다.

messagestring required

API 호출 결과에 대한 사람이 읽을 수 있는 메시지입니다. 성공 시 "OK", 실패 시 구체적인 오류 사유가 포함됩니다.

Example response

{
  "code": 200,
  "message": "OK",
  "data": {
    "cursor": 20,
    "blocklist": [
      {
        "userId": 12345,
        "channelId": 1,
        "phoneNumber": "01012345678",
        "senderNumber": "01087654321",
        "blockId": 67890,
        "blockType": "API",
        "blockDomain": "https://sendon.io",
        "messageType": "SMS",
        "kakaoChannelId": "카카오 채널 ID",
        "rcsBrandId": "RCS 브랜드 ID",
        "rcsChatbotId": "RCS 챗봇 ID",
        "createdAt": "2024-12-25T10:00:00Z",
        "updatedAt": "2024-12-25T15:30:00Z"
      }
    ],
    "totalCount": 150
  }
}