카카오톡채널 목록 조회

Request

GET https://api.coolsms.co.kr/kakao/v1/plus-friends

카카오톡채널의 목록을 조회합니다.

Authorization 인증 필요 [?]

계정 권한	회원 권한	계정 상태	회원 상태	계정 인증
kakao:read	role-kakao:read

Query Params

Name	Type	Required	Allowed Operator [?]	Description
pfId	string		eq	카카오톡채널 고유 아이디
searchId	string		eq, ne, like	카카오톡채널 검색용 아이디
phoneNumber	string		eq, ne, like	핸드폰 번호
categoryCode	string		eq	카카오톡채널 카테고리 코드
dateCreated	date		eq, gte, lte, gt, lt	최초 생성 날짜
dateUpdated	date		eq, gte, lte, gt, lt	최근 수정 날짜
startKey	string		eq	현재 목록을 불러올 기준이 되는 키
limit	number		eq	한 페이지에 불러옥 목록 개수

Samples

getPlusFriends.spec.js

Sample Request

http://api.coolsms.co.kr/kakao/v1/plus-friends?

Sample Response

{
    "limit": 20,
    "friends": [
        {
            "pfId": "KA01PF190227072057634pRBhbpAweee",
            "searchId": "COMPANY3",
            "accountId": "19301859371111",
            "senderKeys": [
                {
                    "key": "DDDAAAAUUUO33",
                    "service": "daou",
                    "categoryCode": "11111111111"
                }
            ],
            "phoneNumber": "010-3333-3333",
            "dateCreated": "2021-01-29T01:29:14.794Z",
            "dateUpdated": "2021-01-29T01:29:14.794Z"
        },
        {
            "pfId": "KA01PF190227072057634pRBhbpAwddd",
            "searchId": "COMPANY5",
            "accountId": "19301859371111",
            "senderKeys": [
                {
                    "key": "DDDAAAAUUUO55",
                    "service": "daou",
                    "categoryCode": "11111111111"
                }
            ],
            "phoneNumber": "010-5555-5555",
            "dateCreated": "2021-01-29T01:29:14.798Z",
            "dateUpdated": "2021-01-29T01:29:14.798Z"
        },
        {
            "pfId": "KA01PF190227072057634pRBhbpAwccc",
            "searchId": "COMPANY2",
            "accountId": "19301859371111",
            "senderKeys": [
                {
                    "key": "DDDAAAAUUUO22",
                    "service": "daou",
                    "categoryCode": "11111111111"
                }
            ],
            "phoneNumber": "010-2222-2222",
            "dateCreated": "2021-01-29T01:29:14.792Z",
            "dateUpdated": "2021-01-29T01:29:14.792Z"
        },
        {
            "pfId": "KA01PF190227072057634pRBhbpAwbbb",
            "searchId": "COMPANY1",
            "accountId": "19301859371111",
            "senderKeys": [
                {
                    "key": "DDDAAAAUUUO11",
                    "service": "daou",
                    "categoryCode": "11111111111"
                }
            ],
            "phoneNumber": "010-1111-1111",
            "dateCreated": "2021-01-29T01:29:14.790Z",
            "dateUpdated": "2021-01-29T01:29:14.790Z"
        },
        {
            "pfId": "KA01PF190227072057634pRBhbpAwaaa",
            "searchId": "COMPANY4",
            "accountId": "19301859371111",
            "senderKeys": [
                {
                    "key": "DDDAAAAUUUO44",
                    "service": "daou",
                    "categoryCode": "11111111111"
                }
            ],
            "phoneNumber": "010-4444-4444",
            "dateCreated": "2021-01-29T01:29:14.796Z",
            "dateUpdated": "2021-01-29T01:29:14.796Z"
        }
    ],
    "startKey": "KA01PF190227072057634pRBhbpAweee",
    "nextKey": null
}

Sample Code

NODE

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/kakao/v1/plus-friends?'
};

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

PHP

<?php
$url = "http://api.coolsms.co.kr/kakao/v1/plus-friends?";

$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);

PYTHON

import requests

url = "http://api.coolsms.co.kr/kakao/v1/plus-friends?"
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)

CURL

#!/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/kakao/v1/plus-friends?

RUBY

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

uri = URI.parse("http://api.coolsms.co.kr/kakao/v1/plus-friends?")

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

GO

package main

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

func main() {
  uri := "http://api.coolsms.co.kr/kakao/v1/plus-friends?"

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

JAVA

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/kakao/v1/plus-friends?";

    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-01-29