쿨에스엠에스
  • Documents for COOLSMS Developers
  • AUTHENTICATION
    • Overview
    • API Key 인증 방식
    • OAuth2 인증 방식
      • 적용하기
      • 권한(Scope) 목록
    • 멤버 권한 목록
  • DEVELOPMENT-KITS
    • C#
    • DB연동 Agent
    • Go
    • Java
    • Node JS
    • Others
    • PHP
    • Python
    • Ruby
    • Visual Basic .NET
    • Visual Basic 6
  • APP-STORE
    • 쿨에스엠에스 OAuth2 연동 Node & Express를 이용하여 앱 만들기
    • 쿨에스엠에스 앱 스토어에 내가 만든 앱 등록하기
  • API REFERENCE
    • Overview
    • 메시지
      • 여러건 발송
      • 단일 메시지
      • 그룹 메시지
        • 그룹 생성
        • 그룹 메시지 추가
        • 그룹 메시지 목록 조회
        • 그룹 메시지 삭제
        • 발송 요청
        • 그룹 목록 조회
        • 그룹 정보 조회
        • 그룹 삭제
      • 메시지 조회
      • 통계 조회
      • 통계 엑셀 파일 다운로드
    • 카카오톡
      • 템플릿을 삭제
      • 카테고리 정보 조회
      • 카카오톡채널 조회
      • 카카오톡채널 목록 조회
      • 템플릿 정보 조회
      • 템플릿 목록 조회
      • 템플릿 숨김 설정
      • 카카오톡채널 추가
      • 템플릿 추가
      • 템플릿 댓글 추가
      • 카카오톡채널 연동 토큰 신청
      • 템플릿 정보 수정
      • 템플릿 검수 요청
    • 잔액
      • 잔액이전
      • 사용자 충전
      • 은행 계좌 등록
      • 결제수단 등록
      • 출금 신청
      • 등록된 계좌 정보 삭제
      • 결제 수단 제거
      • 잔액조회
      • 잔액 변동내역 조회
      • 계좌 정보 조회
      • 견적서 발급
      • 알림 설정 조회
      • 결제수단 목록 조회
      • 거래명세서 발급
      • 출금 요청 상태 조회
      • 등록된 결제수단의 우선순위를 변경
      • 잔액 소진 알림 설정
      • 잔액 소진 알림 on/off 설정
      • 자동 충전 on/off
    • 가격
      • 하나의 국가의 메시지 단가 가져오기
      • 국가별 메시지 가격 리스트 가져오기
    • 스토리지
      • 파일 삭제
      • 파일 조회
      • 파일 목록 조회
      • 파일 업로드
    • 메시지 상태 코드
    • Terminology
  • OLD-VERSIONS
    • SMS API Version 1
    • SMS API Version 2
  • OLD-VERSIONS-SDK
    • C
    • Delphi
      • API Reference
      • Examples
    • java
    • JAVA
    • java
    • PHP
      • PHP SDK v2
        • Example
    • python
    • Python
    • python
    • 에러코드 참고
Powered by GitBook
On this page
  • Request
  • Authorization 인증 필요 [?]
  • Query Params
  • Samples
  • getBalanceHistory.spec.js
Export as PDF
  1. API REFERENCE
  2. 잔액

잔액 변동내역 조회

Previous잔액조회Next계좌 정보 조회

Last updated 5 years ago

Request

GET https://api.coolsms.co.kr/cash/v1/balance/history

메시지 발송, 출금등으로 변동 된 잔액 내역을 조회합니다.

Authorization 인증 필요

계정 권한

회원 권한

계정 상태

회원 상태

계정 인증

cash:read

role-cash:read

Query Params

Name

Type

Required

Description

offset

number

eq

검색 시작 지점

limit

number

eq

한 페이지에 불러옥 목록 개수

startDate

string

eq

검색 날짜 시작 범위

endDate

string

eq

검색 날짜 끝 범위

type

string

eq

충전 및 차감 타입

groupId

string

eq

메시지 그룹 ID

rechargeMethod

string

eq

결제 수단 (STRIPE

ACCOUNT-TRANSFER)

serviceMethod

string

eq

사용 서비스 (MT)

balanceAmount

number

eq

사용 금액

balanceRecharge

boolean

eq

잔액 충전 여부

balanceDeduct

boolean

eq

잔액 차감 여부

pointRecharge

boolean

eq

포인트 충전 여부

pointDeduct

boolean

eq

포인트 차감 여부

Samples

getBalanceHistory.spec.js

Sample Request

http://api.coolsms.co.kr/cash/v1/balance/history

Sample Response

[
    {
        "balanceAmount": 0,
        "pointAmount": 100,
        "groupId": null,
        "memo": null,
        "rechargeMethod": null,
        "serviceMethod": null,
        "chargedMethod": null,
        "paymentMethod": null,
        "accountId": "19041920726336",
        "oldBalance": 0,
        "newBalance": 0,
        "oldPoint": 0,
        "newPoint": 100,
        "type": "MANUAL",
        "dateCreated": "2018-04-01T10:00:00.000Z",
        "historyId": "5db728d9aa83954519463abf"
    },
    {
        "balanceAmount": 0,
        "pointAmount": 100,
        "groupId": null,
        "memo": null,
        "rechargeMethod": null,
        "serviceMethod": null,
        "chargedMethod": null,
        "paymentMethod": null,
        "accountId": "19041920726336",
        "oldBalance": 0,
        "newBalance": 0,
        "oldPoint": 0,
        "newPoint": 100,
        "type": "MANUAL",
        "dateCreated": "2018-04-01T10:00:00.000Z",
        "historyId": "5db728d9aa83954519463ac7"
    },
    {
        "balanceAmount": 0,
        "pointAmount": 100,
        "groupId": null,
        "memo": null,
        "rechargeMethod": null,
        "serviceMethod": null,
        "chargedMethod": null,
        "paymentMethod": null,
        "accountId": "19041920726336",
        "oldBalance": 0,
        "newBalance": 0,
        "oldPoint": 0,
        "newPoint": 100,
        "type": "MANUAL",
        "dateCreated": "2018-04-01T10:00:00.000Z",
        "historyId": "5db728d9aa83954519463ac5"
    },
    {
        "balanceAmount": 0,
        "pointAmount": 100,
        "groupId": null,
        "memo": null,
        "rechargeMethod": null,
        "serviceMethod": null,
        "chargedMethod": null,
        "paymentMethod": null,
        "accountId": "19041920726336",
        "oldBalance": 0,
        "newBalance": 0,
        "oldPoint": 0,
        "newPoint": 100,
        "type": "MANUAL",
        "dateCreated": "2018-04-01T10:00:00.000Z",
        "historyId": "5db728d9aa83954519463ac3"
    },
    {
        "balanceAmount": 0,
        "pointAmount": 100,
        "groupId": null,
        "memo": null,
        "rechargeMethod": null,
        "serviceMethod": null,
        "chargedMethod": null,
        "paymentMethod": null,
        "accountId": "19041920726336",
        "oldBalance": 0,
        "newBalance": 0,
        "oldPoint": 0,
        "newPoint": 100,
        "type": "MANUAL",
        "dateCreated": "2018-04-01T10:00:00.000Z",
        "historyId": "5db728d9aa83954519463ac1"
    },
    {
        "balanceAmount": 100,
        "pointAmount": -100,
        "groupId": null,
        "memo": null,
        "rechargeMethod": null,
        "serviceMethod": null,
        "chargedMethod": null,
        "paymentMethod": null,
        "accountId": "19041920726336",
        "oldBalance": 0,
        "newBalance": 100,
        "oldPoint": 300,
        "newPoint": 200,
        "type": "MANUAL",
        "dateCreated": "2018-04-01T09:00:00.000Z",
        "historyId": "5db728d9aa83954519463aec"
    },
    {
        "balanceAmount": 100,
        "pointAmount": -100,
        "groupId": null,
        "memo": null,
        "rechargeMethod": null,
        "serviceMethod": null,
        "chargedMethod": null,
        "paymentMethod": null,
        "accountId": "19041920726336",
        "oldBalance": 0,
        "newBalance": 100,
        "oldPoint": 300,
        "newPoint": 200,
        "type": "MANUAL",
        "dateCreated": "2018-04-01T09:00:00.000Z",
        "historyId": "5db728d9aa83954519463ae1"
    },
    {
        "balanceAmount": 100,
        "pointAmount": -100,
        "groupId": null,
        "memo": null,
        "rechargeMethod": null,
        "serviceMethod": null,
        "chargedMethod": null,
        "paymentMethod": null,
        "accountId": "19041920726336",
        "oldBalance": 0,
        "newBalance": 100,
        "oldPoint": 300,
        "newPoint": 200,
        "type": "MANUAL",
        "dateCreated": "2018-04-01T09:00:00.000Z",
        "historyId": "5db728d9aa83954519463ae8"
    },
    {
        "balanceAmount": 100,
        "pointAmount": -100,
        "groupId": null,
        "memo": null,
        "rechargeMethod": null,
        "serviceMethod": null,
        "chargedMethod": null,
        "paymentMethod": null,
        "accountId": "19041920726336",
        "oldBalance": 0,
        "newBalance": 100,
        "oldPoint": 300,
        "newPoint": 200,
        "type": "MANUAL",
        "dateCreated": "2018-04-01T09:00:00.000Z",
        "historyId": "5db728d9aa83954519463ade"
    },
    {
        "balanceAmount": 100,
        "pointAmount": -100,
        "groupId": null,
        "memo": null,
        "rechargeMethod": null,
        "serviceMethod": null,
        "chargedMethod": null,
        "paymentMethod": null,
        "accountId": "19041920726336",
        "oldBalance": 0,
        "newBalance": 100,
        "oldPoint": 300,
        "newPoint": 200,
        "type": "MANUAL",
        "dateCreated": "2018-04-01T09:00:00.000Z",
        "historyId": "5db728d9aa83954519463ae4"
    },
    {
        "balanceAmount": 0,
        "pointAmount": -100,
        "groupId": null,
        "memo": null,
        "rechargeMethod": null,
        "serviceMethod": null,
        "chargedMethod": null,
        "paymentMethod": null,
        "accountId": "19041920726336",
        "oldBalance": 0,
        "newBalance": 0,
        "oldPoint": 300,
        "newPoint": 200,
        "type": "MANUAL",
        "dateCreated": "2018-04-01T08:30:00.000Z",
        "historyId": "5db728d9aa83954519463ad7"
    },
    {
        "balanceAmount": 0,
        "pointAmount": -100,
        "groupId": null,
        "memo": null,
        "rechargeMethod": null,
        "serviceMethod": null,
        "chargedMethod": null,
        "paymentMethod": null,
        "accountId": "19041920726336",
        "oldBalance": 0,
        "newBalance": 0,
        "oldPoint": 300,
        "newPoint": 200,
        "type": "MANUAL",
        "dateCreated": "2018-04-01T08:30:00.000Z",
        "historyId": "5db728d9aa83954519463ae3"
    },
    {
        "balanceAmount": 0,
        "pointAmount": -100,
        "groupId": null,
        "memo": null,
        "rechargeMethod": null,
        "serviceMethod": null,
        "chargedMethod": null,
        "paymentMethod": null,
        "accountId": "19041920726336",
        "oldBalance": 0,
        "newBalance": 0,
        "oldPoint": 300,
        "newPoint": 200,
        "type": "MANUAL",
        "dateCreated": "2018-04-01T08:30:00.000Z",
        "historyId": "5db728d9aa83954519463ad5"
    },
    {
        "balanceAmount": 0,
        "pointAmount": -100,
        "groupId": null,
        "memo": null,
        "rechargeMethod": null,
        "serviceMethod": null,
        "chargedMethod": null,
        "paymentMethod": null,
        "accountId": "19041920726336",
        "oldBalance": 0,
        "newBalance": 0,
        "oldPoint": 300,
        "newPoint": 200,
        "type": "MANUAL",
        "dateCreated": "2018-04-01T08:30:00.000Z",
        "historyId": "5db728d9aa83954519463ae7"
    },
    {
        "balanceAmount": 0,
        "pointAmount": -100,
        "groupId": null,
        "memo": null,
        "rechargeMethod": null,
        "serviceMethod": null,
        "chargedMethod": null,
        "paymentMethod": null,
        "accountId": "19041920726336",
        "oldBalance": 0,
        "newBalance": 0,
        "oldPoint": 300,
        "newPoint": 200,
        "type": "MANUAL",
        "dateCreated": "2018-04-01T08:30:00.000Z",
        "historyId": "5db728d9aa83954519463ad9"
    },
    {
        "balanceAmount": 0,
        "pointAmount": -100,
        "groupId": null,
        "memo": null,
        "rechargeMethod": null,
        "serviceMethod": null,
        "chargedMethod": null,
        "paymentMethod": null,
        "accountId": "19041920726336",
        "oldBalance": 0,
        "newBalance": 0,
        "oldPoint": 300,
        "newPoint": 200,
        "type": "MANUAL",
        "dateCreated": "2018-04-01T08:30:00.000Z",
        "historyId": "5db728d9aa83954519463adb"
    },
    {
        "balanceAmount": 0,
        "pointAmount": -100,
        "groupId": null,
        "memo": null,
        "rechargeMethod": null,
        "serviceMethod": null,
        "chargedMethod": null,
        "paymentMethod": null,
        "accountId": "19041920726336",
        "oldBalance": 0,
        "newBalance": 0,
        "oldPoint": 300,
        "newPoint": 200,
        "type": "MANUAL",
        "dateCreated": "2018-04-01T08:30:00.000Z",
        "historyId": "5db728d9aa83954519463add"
    },
    {
        "balanceAmount": 0,
        "pointAmount": -100,
        "groupId": null,
        "memo": null,
        "rechargeMethod": null,
        "serviceMethod": null,
        "chargedMethod": null,
        "paymentMethod": null,
        "accountId": "19041920726336",
        "oldBalance": 0,
        "newBalance": 0,
        "oldPoint": 300,
        "newPoint": 200,
        "type": "MANUAL",
        "dateCreated": "2018-04-01T08:30:00.000Z",
        "historyId": "5db728d9aa83954519463ad3"
    },
    {
        "balanceAmount": 0,
        "pointAmount": -100,
        "groupId": null,
        "memo": null,
        "rechargeMethod": null,
        "serviceMethod": null,
        "chargedMethod": null,
        "paymentMethod": null,
        "accountId": "19041920726336",
        "oldBalance": 0,
        "newBalance": 0,
        "oldPoint": 300,
        "newPoint": 200,
        "type": "MANUAL",
        "dateCreated": "2018-04-01T08:30:00.000Z",
        "historyId": "5db728d9aa83954519463ae0"
    },
    {
        "balanceAmount": 0,
        "pointAmount": -100,
        "groupId": null,
        "memo": null,
        "rechargeMethod": null,
        "serviceMethod": null,
        "chargedMethod": null,
        "paymentMethod": null,
        "accountId": "19041920726336",
        "oldBalance": 0,
        "newBalance": 0,
        "oldPoint": 300,
        "newPoint": 200,
        "type": "MANUAL",
        "dateCreated": "2018-04-01T08:30:00.000Z",
        "historyId": "5db728d9aa83954519463aeb"
    }
]

Sample Code

var request = require('request');

var options = {
  headers: {
    Authorization:
      'HMAC-SHA256 apiKey=NCSAYU7YDBXYORXC, date=2019-07-01T00:41:48Z, salt=jqsba2jxjnrjor, signature=1779eac71a24cbeeadfa7263cb84b7ea0af1714f5c0270aa30ffd34600e363b4'
  },
  method: 'GET',
  json: true,
  url: 'http://api.coolsms.co.kr/cash/v1/balance/history'
};

request(options, function(error, response, body) {
  if (error) throw error;
  console.log('result :', body);
});
var options = {
  headers: {
    Authorization:
      'HMAC-SHA256 apiKey=NCSAYU7YDBXYORXC, date=2019-07-01T00:41:48Z, salt=jqsba2jxjnrjor, signature=1779eac71a24cbeeadfa7263cb84b7ea0af1714f5c0270aa30ffd34600e363b4'
  },
  method: 'GET',
  url: 'http://api.coolsms.co.kr/cash/v1/balance/history'
};

$.ajax(options).done(function(response) {
  console.log(response);
});
<?php
$url = "http://api.coolsms.co.kr/cash/v1/balance/history";

$options = array(
    'http' => array(
        'header'  => "Authorization: HMAC-SHA256 apiKey=NCSAYU7YDBXYORXC, date=2019-07-01T00:41:48Z, salt=jqsba2jxjnrjor, signature=1779eac71a24cbeeadfa7263cb84b7ea0af1714f5c0270aa30ffd34600e363b4\r\n",
        'method'  => 'GET'
    )
);

$context  = stream_context_create($options);
$result = file_get_contents($url, false, $context);

var_dump($result);
import requests

url = "http://api.coolsms.co.kr/cash/v1/balance/history"
headers = {
  "Authorization": "HMAC-SHA256 apiKey=NCSAYU7YDBXYORXC, date=2019-07-01T00:41:48Z, salt=jqsba2jxjnrjor, signature=1779eac71a24cbeeadfa7263cb84b7ea0af1714f5c0270aa30ffd34600e363b4"
}

response = requests.get(url, headers=headers)
print(response.status_code)
print(response.text)
#!/bin/bash
curl -X GET \
    -H 'Authorization: HMAC-SHA256 apiKey=NCSAYU7YDBXYORXC, date=2019-07-01T00:41:48Z, salt=jqsba2jxjnrjor, signature=1779eac71a24cbeeadfa7263cb84b7ea0af1714f5c0270aa30ffd34600e363b4' \
    http://api.coolsms.co.kr/cash/v1/balance/history
require 'net/http'
require 'uri'
require 'json'

uri = URI.parse("http://api.coolsms.co.kr/cash/v1/balance/history")

headers = {
  "Authorization": "HMAC-SHA256 apiKey=NCSAYU7YDBXYORXC, date=2019-07-01T00:41:48Z, salt=jqsba2jxjnrjor, signature=1779eac71a24cbeeadfa7263cb84b7ea0af1714f5c0270aa30ffd34600e363b4"
}
http = Net::HTTP.new(uri.host, uri.port)
request = Net::HTTP::Get.new(uri.request_uri, headers)

response = http.request(request)
puts response.code
puts response.body
package main

import (
  "fmt"
  "io/ioutil"
  "net/http"
  "strings"
)

func main() {
  uri := "http://api.coolsms.co.kr/cash/v1/balance/history"

  req, err := http.NewRequest("GET", uri, nil)
  if err != nil { panic(err) }

  req.Header.Set("Authorization", "HMAC-SHA256 apiKey=NCSAYU7YDBXYORXC, date=2019-07-01T00:41:48Z, salt=jqsba2jxjnrjor, signature=1779eac71a24cbeeadfa7263cb84b7ea0af1714f5c0270aa30ffd34600e363b4")

  client := &http.Client{}
  resp, err := client.Do(req)
  if err != nil { panic(err) }
  defer resp.Body.Close()

  bytes, _ := ioutil.ReadAll(resp.Body)
  str := string(bytes)
  fmt.Println(str)
}
package coolsms;

import java.io.BufferedReader;
import java.io.DataOutputStream;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.URL;

public class Request {
  public static void main(String[] args) throws Exception {
    String targetUrl = "http://api.coolsms.co.kr/cash/v1/balance/history";

    URL url = new URL(targetUrl);
    HttpURLConnection con = (HttpURLConnection) url.openConnection();

    con.setRequestMethod("GET");

    con.setRequestProperty("Authorization", "HMAC-SHA256 apiKey=NCSAYU7YDBXYORXC, date=2019-07-01T00:41:48Z, salt=jqsba2jxjnrjor, signature=1779eac71a24cbeeadfa7263cb84b7ea0af1714f5c0270aa30ffd34600e363b4");

    con.setDoOutput(true);
    DataOutputStream wr = new DataOutputStream(con.getOutputStream());
    wr.writeBytes(parameters);
    wr.flush();
    wr.close();

    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(new InputStreamReader(con.getInputStream()));
    String line;
    StringBuffer response = new StringBuffer();
    while ((line = in.readLine()) != null) {
      response.append(line);
    }
    in.close();

    System.out.println("HTTP response code : " + responseCode);
    System.out.println("HTTP body : " + response.toString());
  }
}

문서 생성일 : 2019-10-28

Allowed Operator

[?]
[?]