본문으로 건너뛰기

각종 데이터 조회 예제

해당 페이지에서는 COOLSMS Node.js SDK를 이용하여 각종 COOLSMS 내 저장 된 데이터를 조회하는 방법에 대해 가이드하고 있습니다.

정보
  • 해당 페이지에서 작성된 모든 코드는 JavaScript로 작성되었습니다.
  • 각 발송 예시에 대한 결과 값 표시 기능은 현재 준비중에 있습니다.
  • 해당 예제는 Node.js SDK 5.1.4 버전을 기준으로 작성되었습니다.

환경설정​

터미널에서 연동할 프로젝트의 폴더로 이동하신 다음 아래와 같은 명령어를 입력하여 SDK를 설치해보세요!
설치가 완료되면 아래의 예제들을 참고하셔서 데이터 조회를 진행해보세요!

npm install --save coolsm-node-sdks

잔액 조회​

Node.js
const { CoolsmsMessageService } = require("coolsms-node-sdk");
const messageService = new CoolsmsMessageService("API 키 입력", "API 시크릿 키 입력");

// 잔액 조회
messageService.getBalance().then(res => console.log(res));

메시지 조회 예제(문자, 알림톡 등)​

Node.js
const { CoolsmsMessageService } = require("coolsms-node-sdk");
const messageService = new CoolsmsMessageService("API 키 입력", "API 시크릿 키 입력");

messageService.getMessages({
  // 불러올 메시지 갯수 제한
  // limit: 5, // 5를 입력하면 5건이 조회됩니다, 미 입력시 20개로 지정

  // 메시지 ID로 검색
  // messageId: '메시지 ID 입력', // 메시지 ID는 대개 M4V로 시작합니다

  // 여러 메시지 ID로 검색
  /*messageIds: [
    '메시지 ID 입력' // 메시지 ID는 대개 M4V로 시작합니다
  ],*/

  // 그룹 ID로 검색
  // groupId: '그룹 ID 입력', // 그룹 ID는 대개 G4V로 시작합니다

  // 발신번호로 검색
  // from: '01012345678',

  // 수신번호로 검색
  // to: '01012345678',

  /**
   * 메시지 타입으로 검색
   * SMS: 단문 문자, LMS: 장문 문자, MMS: 사진 문자, ATA: 알림톡, CTA: 친구톡, CTI: 이미지(1장) 친구톡
   */
  // type: "SMS",

  // 날짜로 검색하는 경우
  /*duration: {
    dateType: 'CREATED', 메시지 생성 일 기준, UPDATED로 변경하면 메시지 상태 갱신일자 기준으로 조회 함
    startDate: '2022-05-01 00:00:00', // Date 객체로도 요청 가능
    endDate: '2022-05-31 23:59:59' // Date 객체로도 요청 가능
  }*/
}).then(res => console.log(res));

/**
 * 페이징 예제
 * */
messageService.getMessages().then(res => {
  // for등의 반복문을 이용하여 페이징 된 데이터를 지속적으로 조회할 수 있습니다!
  messageService.getMessages({
    // startKey 부분에 nextKey를 입력할 경우 초기 20건 다음의 데이터를 표시하게 됩니다.
    startKey: res.nextKey
  }).then(res2 => {
    console.log(res2);
  });
});

통계 조회(발송 현황 등)​

const { CoolsmsMessageService } = require("coolsms-node-sdk");
const messageService = new CoolsmsMessageService("API 키 입력", "API 시크릿 키 입력");

messageService.getStatistics({
  // 날짜로 검색하는 경우
  /*duration: {
    startDate: '2022-03-01 00:00:00', // Date 객체로도 요청 가능
    endDate: '2022-03-31 23:59:59' // Date 객체로도 요청 가능
  }*/
}).then(res => console.log(res));