수신 거부 번호 조회

Prev Next

Classic/VPC 환경에서 이용 가능합니다.

광고 메시지 수신을 거부한 번호를 조회합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드 URI
GET /sms/v2/services/{serviceId}/unsubscribes

요청 헤더

Simple & Easy Notification Service API에서 공통으로 사용하는 헤더에 대한 정보는 Simple & Easy Notification Service 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
serviceId String Required SMS 서비스 아이디

요청 쿼리 파라미터

요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
clientTelNo String Optional 수신 거부 전화번호
  • 숫자만 입력 가능
pageSize Integer Optional 페이지당 항목 수
  • 1~100
pageIndex Integer Optional 페이지 인덱스
  • 0~N (기본값: 0)
startTime Integer Optional 조회 시작 일시(밀리초)
  • Unix Timestamp 형식
  • 수신 거부 등록 일시 기준
  • 미입력 시 기본값으로 전체 기간 적용
endTime Integer Optional 조회 종료 일시(밀리초)
  • Unix Timestamp 형식
  • 수신 거부 등록 일시 기준
  • 미입력 시 기본값으로 전체 기간 적용

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request GET 'https://sens.apigw.ntruss.com/sms/v2/services/ncp:sms:kr:50*********1:sens/unsubscribes?startTime=1763721600000&endTime=1763808000000' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
clientTelNo String Required 수신 거부 전화번호
registerTime String Required 수신 거부 등록 일시
  • YYYY-MM-DDTHH:mm:ss.sss 형식
registerType String Required 수신 거부 유입 경로
  • C | M
    • C: ARS
    • M: 수동

응답 상태 코드

Simple & Easy Notification Service API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Simple & Easy Notification Service 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.
조회 기간 내 등록된 수신 거부 번호가 없으면, 200 OK와 함께 빈 값으로 호출됩니다.

[
    {
        "clientTelNo": "010********",
        "registerType": "M",
        "registerTime": "2025-11-21T16:10:47.884"
    }
]