SEsendon
Contacts

통합 수신거부 목록 조회

Changed on

등록된 통합 수신거부 목록을 조회합니다. 각 항목에는 전화번호, 등록 경로, 등록 당시의 메시지 유형과 발신정보가 포함되며, 페이지네이션을 지원합니다.

get/v2/contacts/blocklist/unified

Request

  • Base URL
    https://api.sendon.io
  • URL
    https://api.sendon.io/v2/contacts/blocklist/unified
  • Auth
    HTTP basic

Query parameters

messageType'DIRECT' | 'SMS' | 'KAKAO' | 'RCS'

등록 당시의 메시지 유형으로 필터링합니다. DIRECT, SMS, KAKAO, RCS 중에서 선택할 수 있습니다.

blockTypestring[]

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

keywordstring

전화번호 검색어입니다. 입력한 문자열이 포함된 전화번호만 조회합니다.

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": 12345,
    "blocklist": [
      {
        "userId": 12345,
        "phoneNumber": "01012345678",
        "blockId": 12345,
        "blockType": "API",
        "messageType": "DIRECT",
        "senderNumber": "01087654321",
        "kakaoChannelId": "센드온"
      }
    ],
    "totalCount": 3
  }
}

Changes