수신거부번호 관리

센드온 SDK는 수신거부번호 목록 관리 기능을 제공하여 발송 시 차단된 전화번호를 자동으로 제외할 수 있습니다.
개발자는 API를 이용해 수신거부번호 목록에 전화번호를 추가하거나 삭제할 수 있으며, 등록된 리스트를 조회할 수도 있습니다.

수신거부번호 목록 조회

현재 등록된 수신거부번호 목록을 조회할 수 있습니다.

Node.js 예제

import { Sendon } from '@alipeople/sendon-sdk-typescript'
import { GetBlocklistResponseDto } from '@alipeople/sendon-sdk-typescript';

const sendon = new Sendon({ id: "YOUR_ID", apikey: "YOUR_APIKEY" })

const result: GetBlocklistResponseDto = await sendon.contacts.getBlocklist({
  cursor: 0, // 시작 위치 (옵션)
  limit: 3, // 조회할 항목 수 (옵션)
});

응답 예제

{
  "code": 200,
  "message": "OK",
  "data": {
    "blocklist": [
      {
        "userId": 0,
        "channelId": 0,
        "phoneNumber": "BLOCKED_PHONE_NUMBER",
        "blockId": 1,
        "blockType": "WEB",
        "blockDomain": "https://block-domain.com",
        "createdAt": "2024-11-21T08:42:07.000Z",
        "updatedAt": "2024-11-21T08:42:07.000Z"
      },
      {
        "userId": 0,
        "channelId": 0,
        "phoneNumber": "BLOCKED_PHONE_NUMBER",
        "blockId": 2,
        "blockType": "API",
        "blockDomain": "https://block-domain.com",
        "createdAt": "2024-11-21T08:43:06.000Z",
        "updatedAt": "2024-11-21T08:43:06.000Z"
      },
      {
        "userId": 0,
        "channelId": 0,
        "phoneNumber": "BLOCKED_PHONE_NUMBER",
        "blockId": 3,
        "blockType": "ARS",
        "blockDomain": "ARS",
        "createdAt": "2024-11-21T10:26:53.000Z",
        "updatedAt": "2024-11-21T10:26:53.000Z"
      }
    ],
    "cursor": null,
    "totalCount": 3
  }
}

수신거부번호 목록 조회 응답 필드 설명

파라미터	타입	설명	필수 여부
userId	number	사용자 ID	필수
blockId	number	수신거부번호 ID	필수
channelId	number	채널 ID	필수
phoneNumber	string	수신거부된 전화번호	필수
blockType	string	수신거부 유형	필수
blockDomain	string	수신거부 요청 도메인	필수
createdAt	string	수신거부번호 생성일	필수
updatedAt	string	수신거부번호 수정일	필수

자세한 코드 예제는 아래 문서를 참고하세요.

🔗 SDK 수신거부번호 조회 가이드

수신거부번호 추가

특정 전화번호를 수신거부번호 목록에 추가할 수 있습니다.

Node.js 예제

import { Sendon } from '@alipeople/sendon-sdk-typescript'
import { CreateBlocklistResponseDto } from '@alipeople/sendon-sdk-typescript';

const sendon = new Sendon({ id: "YOUR_ID", apikey: "YOUR_APIKEY" })

const addResult: CreateBlocklistResponseDto = await sendon.contacts.createBlocklist({
  phoneNumber: 'PHONE_NUMBER',
});

응답 예제

{
  "code": 200,
  "message": "OK",
  "data": {
    "id": 1
  }
}

수신거부번호 추가 응답 필드 설명

파라미터	타입	설명	필수 여부
id	number	추가된 수신거부번호 ID	필수

수신거부번호 삭제

특정 전화번호를 수신거부번호 목록에서 삭제할 수 있습니다.

Node.js 예제

import { Sendon } from '@alipeople/sendon-sdk-typescript'
import { DeleteBlocklistResponseDto } from '@alipeople/sendon-sdk-typescript';

const sendon = new Sendon({ id: "YOUR_ID", apikey: "YOUR_APIKEY" })

const removeResult: DeleteBlocklistResponseDto = await sendon.contacts.deleteBlocklist(blocklistId);

응답 예제

{
  "code": 200,
  "message": "OK",
  "data": {
    "isSuccess": true
  }
}

수신거부번호 삭제 응답 필드 설명

파라미터	타입	설명	필수 여부
isSuccess	boolean	수신거부 삭제 성공 유무	필수

자세한 코드 예제는 아래 문서를 참고하세요.

🔗 SDK 수신거부번호 추가/삭제 가이드

사용 시 주의사항

자동 필터링 기능: 발송 시 수신거부번호 목록에 등록된 번호는 자동으로 필터링되므로 추가적인 처리 없이 안정적인 메시징이 가능합니다.
응답 데이터 확인: 추가, 삭제, 조회 요청 후 반환되는 데이터를 확인하여 요청이 성공적으로 처리되었는지 점검하세요.
권한 관리: 수신 차단 리스트 관리 기능은 민감한 작업이므로 적절한 인증과 권한 설정이 필요합니다.