Sendon SDK for TypeScript

다양한 메시징 채널과의 원활한 통합을 위한 엔터프라이즈급 메시징 SDK

설치 • 빠른 시작 • 기능 • API 레퍼런스 • 지원

📦 설치

npm install @alipeople/sendon-sdk-typescript

또는 Yarn 사용:

yarn add @alipeople/sendon-sdk-typescript

🚀 빠른 시작

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

// SDK 초기화
const sendon = new Sendon({
  id: 'your-api-id',
  apikey: 'your-api-key',
  debug: false // 선택사항: 상세 로깅을 위한 디버그 모드 활성화
});

// SMS 메시지 전송
const result = await sendon.sms.send({
  from: '01012345678',
  to: ['01087654321'],
  message: '안녕하세요!'
});

✨ 기능

📱 SMS 서비스

엔터프라이즈급 신뢰성을 갖춘 완벽한 SMS/LMS/MMS 메시징 기능.

• SMS/LMS 메시징: 단문 및 장문 메시지 전송
• MMS 지원: 이미지를 포함한 리치 미디어 메시징
• 대량 전송: 여러 수신자에게 효율적으로 메시지 전송
• 예약 발송: 최적의 타이밍에 맞춘 메시지 예약
• 배송 리포트: 실시간 상태 추적 및 리포팅
• 이미지 관리: MMS 이미지 업로드 및 관리

💬 카카오 서비스

알림톡과 브랜드메시지를 위한 포괄적인 카카오 비즈니스 메시징 통합.

• 알림톡: 템플릿 기반 정보성 메시징
• 브랜드메시지: 다양한 템플릿을 활용한 리치한 홍보 메시징
  • 텍스트, 이미지, 와이드, 와이드 아이템 리스트, 캐러셀 피드 형식
• 템플릿 관리: 메시지 템플릿 생성, 수정 및 관리
• 발신 프로필 관리: 여러 발신자 프로필 처리
• 검수 시스템: 템플릿 검수 요청 및 상태 추적
• 대량 메시징: 여러 수신자에게 효율적으로 전송

🎯 RCS 서비스

향상된 모바일 메시징을 위한 차세대 리치 커뮤니케이션 서비스.

• 리치 미디어 지원: 인터랙티브 카드, 캐러셀 및 버튼
• 브랜드 메시징: 맞춤형 브랜딩 및 스타일링
• CSV 업로드: CSV를 통한 대량 수신자 관리
• 고급 분석: 상세한 메시지 성과 추적
• 폴백 옵션: SMS/MMS로 자동 폴백

🚫 연락처 서비스

메시징 제어를 위한 차단 목록 관리.

• 차단 목록 관리: 차단 목록에 번호 추가 및 제거
• 멀티 채널 지원: SMS 및 카카오 채널 전체에서 번호 차단
• 차단 유형 필터링: 다양한 차단 카테고리
• 날짜 범위 조회: 날짜 범위별 차단 목록 검색
• 페이지네이션 지원: 대량 차단 목록의 효율적인 처리

📤 발신자 서비스

발신번호 관리 및 검증.

• 번호 목록 조회: 등록된 모든 발신번호 확인
• 페이지네이션 지원: 여러 발신번호 탐색
• 번호 검증: 검증된 발신번호 관리

💳 결제 서비스

결제 이력 및 거래 추적.

• 결제 이력: 상세한 결제 거래 로그 확인
• 날짜 범위 필터링: 날짜 범위별 결제 검색
• 거래 상세 정보: 특정 결제 정보 접근
• 페이지네이션 지원: 결제 기록 탐색

💰 포인트 서비스

메시지 비용 계산 및 포인트 추적.

• 비용 계산: 메시지 전송 비용 확인
• 포인트 목록: 사용 가능한 포인트 및 잔액 확인
• 사용량 추적: 포인트 소비 모니터링

📖 API 레퍼런스

초기화

const sendon = new Sendon({
  id: string,        // API ID
  apikey: string,    // API Key
  debug?: boolean    // 디버그 로깅 활성화 (선택사항)
});

SMS 서비스

// SMS/LMS/MMS 전송
await sendon.sms.send({
  from: string,
  to: string[],
  message: string,
  subject?: string,  // LMS/MMS용
  images?: File[]    // MMS용
});

// 예약 메시지 취소
await sendon.sms.cancel(groupId);

// 메시지 상태 확인
await sendon.sms.find(groupId);

카카오 서비스

// 알림톡 전송
await sendon.kakao.sendAlimTalk({
  sendProfileId: string,
  templateCode: string,
  messages: MessageData[]
});

// 브랜드메시지 전송
await sendon.kakao.sendBrandMessage({
  sendProfileId: string,
  templateCode: string,
  messages: MessageData[]
});

// 템플릿 관리
await sendon.kakao.createTemplate(sendProfileId, templateData);
await sendon.kakao.getTemplates(sendProfileId, query);
await sendon.kakao.updateTemplate(sendProfileId, templateId, templateData);

RCS 서비스

// RCS 메시지 전송
await sendon.rcs.send({
  messageType: 'SMS' | 'LMS' | 'MMS' | 'RCS',
  from: string,
  messages: RcsMessageData[]
});

// CSV 업로드 URL 가져오기
await sendon.rcs.createCsvUploadUrl();

연락처 서비스 (차단 목록)

// 차단 목록 항목 생성
await sendon.contacts.createBlocklist({
  phoneNumbers: ['01012345678'],
  blockType: 'SMS',
  senderNumber: '0212345678'
});

// 차단 목록 조회
await sendon.contacts.getBlocklist({
  blockType: ['SMS', 'KAKAO'],
  limit: 100
});

// 차단 목록에서 삭제
await sendon.contacts.deleteBlocklist(blocklistId);

결제 서비스

// 결제 이력 조회
await sendon.payment.getPaymentHistories({
  startDate: new Date('2024-01-01'),
  endDate: new Date('2024-12-31'),
  page: 1,
  limit: 20
});

// 결제 상세 정보 조회
await sendon.payment.getPaymentHistoryDetail(historyId);

포인트 서비스

// 메시지 비용 확인
await sendon.point.getCost();

// 사용 가능한 포인트 목록 조회
await sendon.point.listPoints();

발신자 서비스

// 등록된 발신번호 목록 조회
await sendon.sender.listUserNumbers(page, limit);

🔒 보안

• 안전한 인증: API 키 기반 인증
• 데이터 암호화: 모든 데이터는 HTTPS를 통해 전송
• 속도 제한: 내장된 속도 제한 처리
• 오류 처리: 포괄적인 오류 관리

📊 성능

• 최적화된 배칭: 효율적인 대량 작업
• 연결 풀링: 재사용 가능한 HTTP 연결
• Async/Await 지원: 현대적인 비동기 패턴
• TypeScript 네이티브: 완벽한 타입 안전성과 IntelliSense

🛠️ 개발

이 SDK는 다음과 같이 구축되었습니다:

• TypeScript 5.1+ 타입 안전성을 위해
• Axios HTTP 클라이언트
• OpenAPI Generator API 일관성을 위해
• Vitest 테스팅을 위해

📄 라이선스

이 프로젝트는 MIT 라이선스 하에 있습니다.

🤝 지원

기술 지원 및 문의 사항은 지원팀에 문의하거나 문서 포털을 방문해 주세요.

Built with ❤️ by Alipeople