SOLAPI
Search…
메시지 조회

Request

1
GET https://api.solapi.com/messages/v4/list
Copied!
메시지의 목록을 조회합니다.

Authorization 인증 필요 [?]

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

Query Params

Name
Type
Required
Allowed Operator [?]
Description
criteria
string
eq
검색 조건에 사용되는 필드명 criteria 의 값은 'key1,key2,key3' 과 같이 ,(콤마) 로 구분되며 cond, value 와 함께 사용됩니다. - messageId - 메시지 아이디 입니다. - groupId - 그룹 아이디 입니다. - to - 수신 번호 입니다. - from - 발신 번호 입니다. - type - 문자 메시지의 타입 입니다. (SMS, LMS, MMS, ATA, CTA, CTI) - dateCreated - 그룹 생성일 입니다. - dateUpdated - 그룹 정보를 변경한 마지막 시각 입니다. - replacement - 대체 발송 여부 입니다. (true, false) - statusCode - 문자 메시지의 상태 코드 입니다.
cond
string
eq
검색 조건에 사용되는 연산자 criteria 와 같이 'cond1,cond2' 와 같이 ,(콤마)로 구분되며, criteria,value 와 함께 사용됩니다. - eq - 같음 (=) - ne - 같지 않음 (!=) - gt - 보다 큼 (>) - gte - 보다 크거나 같음 (>=) - lt - 보다 작음 (<) - lte - 보다 작거나 같음 (<=)
value
string
eq
검색 값 criteria , cond 값에 대응하는 value 입니다. criteria='messageId,statusCode' cond='eq,eq' 일 경우 groupId 에 대응하는 value 값을 찾고 status 에 대응하는 값을 찾는 조건 입니다. e.g - value='메시지아이디,2000'
startKey
string
eq
현재 목록을 불러올 기준이 되는 키
limit
number
eq
한 페이지에 불러옥 목록 개수
dateType
string
eq
설명 없음
startDate
date
eq
검색 시작 날짜
endDate
date
eq
검색 끝 날짜
messageId
string
eq
메시지 아이디
messageIds
array
eq, in
메시지 아이디 목록
groupId
string
eq
메시지 그룹 아이디
to
string
eq
수신번호
from
string
eq
발신번호 사전 등록된 전화번호만 사용 가능
type
string
eq, in
메시지 타입
statusCode
string
eq, in
상태 코드 참고
dateCreated
date
eq
최초 생성 날짜
dateUpdated
date
eq
최근 수정 날짜

Samples

/messages/v4/list (메시지 조회)

Sample Request
1
http://api.solapi.com/messages/v4/list?criteria=messageId&value=M4V20180307110044DTYYJBBYLPQZIB1&cond=eq
Copied!
Sample Response
1
{
2
"startKey": null,
3
"limit": 20,
4
"messageList": {
5
"M4V20180307110044DTYYJBBYLPQZIB1": {
6
"_id": "M4V20180307110044DTYYJBBYLPQZIB1",
7
"kakaoOptions": {
8
"senderKey": null,
9
"templateCode": null,
10
"buttonName": null,
11
"buttonUrl": null,
12
"pfId": null,
13
"templateId": null,
14
"imageId": null,
15
"disableSms": false,
16
"title": null,
17
"adFlag": false,
18
"buttons": []
19
},
20
"naverOptions": {
21
"talkId": null,
22
"templateId": null,
23
"disableSms": false,
24
"buttons": []
25
},
26
"rcsOptions": {
27
"brandId": null,
28
"templateId": null,
29
"copyAllowed": true,
30
"commercialType": false,
31
"mmsType": null,
32
"disableSms": false,
33
"additionalBody": [],
34
"buttons": []
35
},
36
"type": null,
37
"country": "82",
38
"subject": null,
39
"imageId": null,
40
"currentQueue": null,
41
"dateProcessed": null,
42
"dateReported": null,
43
"dateReceived": null,
44
"statusCode": "TEST1000",
45
"networkCode": null,
46
"log": [],
47
"replacement": false,
48
"autoTypeDetect": true,
49
"resendCount": 0,
50
"status": "PENDING",
51
"messageId": "M4V20180307110044DTYYJBBYLPQZIB1",
52
"groupId": "G4V20180307105937H3PTASXMNJG2JIO",
53
"accountId": "12925149",
54
"text": "text",
55
"from": "01000000000",
56
"to": "01000000000",
57
"customFields": {},
58
"queues": [],
59
"dateCreated": "2021-11-16T05:09:39.837Z",
60
"dateUpdated": "2021-11-16T05:09:39.837Z",
61
"reason": null,
62
"networkName": "ETC"
63
}
64
}
65
}
Copied!
Sample Code
NODE
PHP
PYTHON
CURL
RUBY
GO
JAVA
1
var request = require('request');
2
3
var options = {
4
headers: {
5
Authorization:
6
'HMAC-SHA256 apiKey=NCSAYU7YDBXYORXC, date=2019-07-01T00:41:48Z, salt=jqsba2jxjnrjor, signature=1779eac71a24cbeeadfa7263cb84b7ea0af1714f5c0270aa30ffd34600e363b4'
7
},
8
method: 'GET',
9
json: true,
10
url:
11
'http://api.solapi.com/messages/v4/list?criteria=messageId&value=M4V20180307110044DTYYJBBYLPQZIB1&cond=eq'
12
};
13
14
request(options, function(error, response, body) {
15
if (error) throw error;
16
console.log('result :', body);
17
});
Copied!
1
<?php
2
$url = "http://api.solapi.com/messages/v4/list?criteria=messageId&value=M4V20180307110044DTYYJBBYLPQZIB1&cond=eq";
3
4
$options = array(
5
'http' => array(
6
'header' => "Authorization: HMAC-SHA256 apiKey=NCSAYU7YDBXYORXC, date=2019-07-01T00:41:48Z, salt=jqsba2jxjnrjor, signature=1779eac71a24cbeeadfa7263cb84b7ea0af1714f5c0270aa30ffd34600e363b4\r\n",
7
'method' => 'GET'
8
)
9
);
10
11
$context = stream_context_create($options);
12
$result = file_get_contents($url, false, $context);
13
14
var_dump($result);
Copied!
1
import requests
2
3
url = "http://api.solapi.com/messages/v4/list?criteria=messageId&value=M4V20180307110044DTYYJBBYLPQZIB1&cond=eq"
4
headers = {
5
"Authorization": "HMAC-SHA256 apiKey=NCSAYU7YDBXYORXC, date=2019-07-01T00:41:48Z, salt=jqsba2jxjnrjor, signature=1779eac71a24cbeeadfa7263cb84b7ea0af1714f5c0270aa30ffd34600e363b4"
6
}
7
8
response = requests.get(url, headers=headers)
9
print(response.status_code)
10
print(response.text)
Copied!
1
#!/bin/bash
2
curl -X GET \
3
-H 'Authorization: HMAC-SHA256 apiKey=NCSAYU7YDBXYORXC, date=2019-07-01T00:41:48Z, salt=jqsba2jxjnrjor, signature=1779eac71a24cbeeadfa7263cb84b7ea0af1714f5c0270aa30ffd34600e363b4' \
4
http://api.solapi.com/messages/v4/list?criteria=messageId&value=M4V20180307110044DTYYJBBYLPQZIB1&cond=eq
Copied!
1
require 'net/http'
2
require 'uri'
3
require 'json'
4
5
uri = URI.parse("http://api.solapi.com/messages/v4/list?criteria=messageId&value=M4V20180307110044DTYYJBBYLPQZIB1&cond=eq")
6
7
headers = {
8
"Authorization": "HMAC-SHA256 apiKey=NCSAYU7YDBXYORXC, date=2019-07-01T00:41:48Z, salt=jqsba2jxjnrjor, signature=1779eac71a24cbeeadfa7263cb84b7ea0af1714f5c0270aa30ffd34600e363b4"
9
}
10
http = Net::HTTP.new(uri.host, uri.port)
11
request = Net::HTTP::Get.new(uri.request_uri, headers)
12
13
response = http.request(request)
14
puts response.code
15
puts response.body
Copied!
1
package main
2
3
import (
4
"fmt"
5
"io/ioutil"
6
"net/http"
7
"strings"
8
)
9
10
func main() {
11
uri := "http://api.solapi.com/messages/v4/list?criteria=messageId&value=M4V20180307110044DTYYJBBYLPQZIB1&cond=eq"
12
13
req, err := http.NewRequest("GET", uri, nil)
14
if err != nil { panic(err) }
15
16
req.Header.Set("Authorization", "HMAC-SHA256 apiKey=NCSAYU7YDBXYORXC, date=2019-07-01T00:41:48Z, salt=jqsba2jxjnrjor, signature=1779eac71a24cbeeadfa7263cb84b7ea0af1714f5c0270aa30ffd34600e363b4")
17
18
client := &http.Client{}
19
resp, err := client.Do(req)
20
if err != nil { panic(err) }
21
defer resp.Body.Close()
22
23
bytes, _ := ioutil.ReadAll(resp.Body)
24
str := string(bytes)
25
fmt.Println(str)
26
}
Copied!
1
package solapi;
2
3
import java.io.BufferedReader;
4
import java.io.DataOutputStream;
5
import java.io.InputStreamReader;
6
import java.net.HttpURLConnection;
7
import java.net.URL;
8
9
public class Request {
10
public static void main(String[] args) throws Exception {
11
String targetUrl = "http://api.solapi.com/messages/v4/list?criteria=messageId&value=M4V20180307110044DTYYJBBYLPQZIB1&cond=eq";
12
13
URL url = new URL(targetUrl);
14
HttpURLConnection con = (HttpURLConnection) url.openConnection();
15
16
con.setRequestMethod("GET");
17
18
con.setRequestProperty("Authorization", "HMAC-SHA256 apiKey=NCSAYU7YDBXYORXC, date=2019-07-01T00:41:48Z, salt=jqsba2jxjnrjor, signature=1779eac71a24cbeeadfa7263cb84b7ea0af1714f5c0270aa30ffd34600e363b4");
19
20
con.setDoOutput(true);
21
DataOutputStream wr = new DataOutputStream(con.getOutputStream());
22
wr.writeBytes(parameters);
23
wr.flush();
24
wr.close();
25
26
int responseCode = con.getResponseCode();
27
BufferedReader in = new BufferedReader(new InputStreamReader(con.getInputStream()));
28
String line;
29
StringBuffer response = new StringBuffer();
30
while ((line = in.readLine()) != null) {
31
response.append(line);
32
}
33
in.close();
34
35
System.out.println("HTTP response code : " + responseCode);
36
System.out.println("HTTP body : " + response.toString());
37
}
38
}
Copied!
문서 생성일 : 2021-11-16