카카오톡채널 목록 조회

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

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

문서 생성일 : 2021-01-29

Last updated