그룹 메시지 목록 조회

Request

GET https://api.coolsms.co.kr/messages/v4/groups/:groupId/messages

그룹에 속한 메시지들을 조회합니다.

Authorization 인증 필요 [?]

계정 권한

회원 권한

계정 상태

회원 상태

계정 인증

message:read

role-message:read

ACTIVE

ACTIVE

Path Parameters

Name

Description

:groupId

메시지 그룹 아이디

Query Params

Name

Type

Required

Allowed Operator [?]

Description

startKey

string

eq

현재 목록을 불러올 기준이 되는 키

limit

number

eq

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

Samples

GET /messages/v4/groups/{groupId}/messages

Sample Request

http://api.coolsms.co.kr/messages/v4/groups/G4V20180307105937H3PTASXMNJG2JIO/messages

Sample Response

{
    "startKey": null,
    "limit": 20,
    "messageList": {
        "M4V20180307110044DTYYJBBYLPQZIB1": {
            "_id": "M4V20180307110044DTYYJBBYLPQZIB1",
            "kakaoOptions": {
                "senderKey": null,
                "templateCode": null,
                "buttonName": null,
                "buttonUrl": null,
                "pfId": null,
                "templateId": null,
                "imageId": null,
                "disableSms": false,
                "title": null,
                "adFlag": false,
                "buttons": []
            },
            "naverOptions": {
                "talkId": null,
                "templateId": null,
                "disableSms": false,
                "buttons": []
            },
            "rcsOptions": {
                "brandId": null,
                "templateId": null,
                "copyAllowed": true,
                "commercialType": false,
                "mmsType": null,
                "disableSms": false,
                "additionalBody": [],
                "buttons": []
            },
            "type": null,
            "country": "82",
            "subject": null,
            "imageId": null,
            "currentQueue": null,
            "dateProcessed": null,
            "dateReported": null,
            "dateReceived": null,
            "statusCode": "TEST1000",
            "networkCode": null,
            "log": [],
            "replacement": false,
            "autoTypeDetect": true,
            "resendCount": 0,
            "status": "PENDING",
            "messageId": "M4V20180307110044DTYYJBBYLPQZIB1",
            "groupId": "G4V20180307105937H3PTASXMNJG2JIO",
            "accountId": "12925149",
            "text": "text",
            "from": "01000000000",
            "to": "01000000000",
            "customFields": {},
            "queues": [],
            "dateCreated": "2021-07-14T07:12:41.992Z",
            "dateUpdated": "2021-07-14T07:12:41.992Z",
            "reason": null,
            "networkName": "ETC"
        }
    }
}

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/groups/G4V20180307105937H3PTASXMNJG2JIO/messages'
};

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

문서 생성일 : 2021-07-14

Last updated