통계 조회

Request

GET https://api.coolsms.co.kr/messages/v4/statistics

통계를 조회합니다.

Authorization 인증 필요 [?]

계정 권한

회원 권한

계정 상태

회원 상태

계정 인증

message:read

role-message:read

ACTIVE

Query Params

Name

Type

Required

Allowed Operator [?]

Description

startDate

date

검색 시작 날짜

endDate

date

검색 끝 날짜

masterAccountId

string

설명 없음

Samples

getStatistics.spec.js

Sample Request

http://api.coolsms.co.kr/messages/v4/statistics

Sample Response

{
    "balance": 1,
    "point": 1,
    "monthlyBalanceAvg": 1,
    "monthlyPointAvg": 1,
    "monthPeriod": [
        {
            "date": "2021/07",
            "balance": 1,
            "balanceAvg": 1,
            "point": 1,
            "pointAvg": 1,
            "dayPeriod": [
                {
                    "_id": "2021-07-14T07:12:48.791Z",
                    "month": "2021/07",
                    "date": "2021/07/14",
                    "balance": 1,
                    "point": 1,
                    "statusCode": {
                        "4000": {
                            "sms": 1,
                            "lms": 1,
                            "mms": 1,
                            "ata": 1,
                            "cta": 1,
                            "rcs_sms": 1,
                            "rcs_lms": 1,
                            "rcs_mms": 1,
                            "rcs_tpl": 1
                        }
                    },
                    "refund": {
                        "balance": 100,
                        "point": 10
                    },
                    "total": {
                        "total": 9,
                        "sms": 1,
                        "lms": 1,
                        "mms": 1,
                        "ata": 1,
                        "cta": 1,
                        "cti": 0,
                        "nsa": 0,
                        "rcs_sms": 1,
                        "rcs_lms": 1,
                        "rcs_mms": 1,
                        "rcs_tpl": 1
                    },
                    "successed": {
                        "total": 9,
                        "sms": 1,
                        "lms": 1,
                        "mms": 1,
                        "ata": 1,
                        "cta": 1,
                        "cti": 0,
                        "nsa": 0,
                        "rcs_sms": 1,
                        "rcs_lms": 1,
                        "rcs_mms": 1,
                        "rcs_tpl": 1
                    },
                    "failed": {
                        "total": 0,
                        "sms": 0,
                        "lms": 0,
                        "mms": 0,
                        "ata": 0,
                        "cta": 0,
                        "cti": 0,
                        "nsa": 0,
                        "rcs_sms": 0,
                        "rcs_lms": 0,
                        "rcs_mms": 0,
                        "rcs_tpl": 0
                    }
                }
            ],
            "refund": {
                "balance": 100,
                "balanceAvg": 100,
                "point": 10,
                "pointAvg": 10
            },
            "total": {
                "total": 9,
                "sms": 1,
                "lms": 1,
                "mms": 1,
                "ata": 1,
                "cta": 1,
                "cti": 0,
                "nsa": 0,
                "rcs_sms": 1,
                "rcs_lms": 1,
                "rcs_mms": 1,
                "rcs_tpl": 1
            },
            "successed": {
                "total": 9,
                "sms": 1,
                "lms": 1,
                "mms": 1,
                "ata": 1,
                "cta": 1,
                "cti": 0,
                "nsa": 0,
                "rcs_sms": 1,
                "rcs_lms": 1,
                "rcs_mms": 1,
                "rcs_tpl": 1
            },
            "failed": {
                "total": 0,
                "sms": 0,
                "lms": 0,
                "mms": 0,
                "ata": 0,
                "cta": 0,
                "cti": 0,
                "nsa": 0,
                "rcs_sms": 0,
                "rcs_lms": 0,
                "rcs_mms": 0,
                "rcs_tpl": 0
            }
        }
    ],
    "refund": {
        "balance": 100,
        "balanceAvg": 100,
        "point": 10,
        "pointAvg": 10
    },
    "dayPeriod": [
        {
            "_id": "2021-07-14T07:12:48.791Z",
            "month": "2021/07",
            "date": "2021/07/14",
            "balance": 1,
            "point": 1,
            "statusCode": {
                "4000": {
                    "sms": 1,
                    "lms": 1,
                    "mms": 1,
                    "ata": 1,
                    "cta": 1,
                    "rcs_sms": 1,
                    "rcs_lms": 1,
                    "rcs_mms": 1,
                    "rcs_tpl": 1
                }
            },
            "refund": {
                "balance": 100,
                "point": 10
            },
            "total": {
                "total": 9,
                "sms": 1,
                "lms": 1,
                "mms": 1,
                "ata": 1,
                "cta": 1,
                "cti": 0,
                "nsa": 0,
                "rcs_sms": 1,
                "rcs_lms": 1,
                "rcs_mms": 1,
                "rcs_tpl": 1
            },
            "successed": {
                "total": 9,
                "sms": 1,
                "lms": 1,
                "mms": 1,
                "ata": 1,
                "cta": 1,
                "cti": 0,
                "nsa": 0,
                "rcs_sms": 1,
                "rcs_lms": 1,
                "rcs_mms": 1,
                "rcs_tpl": 1
            },
            "failed": {
                "total": 0,
                "sms": 0,
                "lms": 0,
                "mms": 0,
                "ata": 0,
                "cta": 0,
                "cti": 0,
                "nsa": 0,
                "rcs_sms": 0,
                "rcs_lms": 0,
                "rcs_mms": 0,
                "rcs_tpl": 0
            }
        }
    ],
    "total": {
        "total": 9,
        "sms": 1,
        "lms": 1,
        "mms": 1,
        "ata": 1,
        "cta": 1,
        "cti": 0,
        "nsa": 0,
        "rcs_sms": 1,
        "rcs_lms": 1,
        "rcs_mms": 1,
        "rcs_tpl": 1
    },
    "successed": {
        "total": 9,
        "sms": 1,
        "lms": 1,
        "mms": 1,
        "ata": 1,
        "cta": 1,
        "cti": 0,
        "nsa": 0,
        "rcs_sms": 1,
        "rcs_lms": 1,
        "rcs_mms": 1,
        "rcs_tpl": 1
    },
    "failed": {
        "total": 0,
        "sms": 0,
        "lms": 0,
        "mms": 0,
        "ata": 0,
        "cta": 0,
        "cti": 0,
        "nsa": 0,
        "rcs_sms": 0,
        "rcs_lms": 0,
        "rcs_mms": 0,
        "rcs_tpl": 0
    },
    "dailyBalanceAvg": 1,
    "dailyPointAvg": 1,
    "dailyTotalCountAvg": 9,
    "dailyFailedCountAvg": 0,
    "dailySuccessedCountAvg": 9
}

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/messages/v4/statistics'
};

request(options, function(error, response, body) {
  if (error) throw error;
  console.log('result :', body);
});

<?php
$url = "http://api.coolsms.co.kr/messages/v4/statistics";

$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/messages/v4/statistics"
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/messages/v4/statistics

require 'net/http'
require 'uri'
require 'json'

uri = URI.parse("http://api.coolsms.co.kr/messages/v4/statistics")

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/messages/v4/statistics"

  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 solapi;

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/messages/v4/statistics";

    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());
  }
}

문서 생성일 : 2021-07-14

Previous메시지 조회 Next통계 엑셀 파일 다운로드

Last updated 2 years ago