GET https://api.solapi.com/messages/v4/groups
메시지 그룹 목록을 조회합니다.
계정 권한 | 회원 권한 | 계정 상태 | 회원 상태 | 계정 인증 |
|
|
|
| |
Name | Type | Required | Allowed Operator [?] | Description |
criteria |
| | 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 |
| | eq | 검색 조건에 사용되는 연산자 criteria 와 같이 'cond1,cond2' 와 같이 ,(콤마)로 구분되며, criteria,value 와 함께 사용됩니다. - eq - 같음 (=) - ne - 같지 않음 (!=) - gt - 보다 큼 (>) - gte - 보다 크거나 같음 (>=) - lt - 보다 작음 (<) - lte - 보다 작거나 같음 (<=) |
value |
| | eq | 검색 값 criteria , cond 값에 대응하는 value 입니다. criteria='messageId,statusCode' cond='eq,eq' 일 경우 groupId 에 대응하는 value 값을 찾고 status 에 대응하는 값을 찾는 조건 입니다. e.g - value='메시지아이디,2000' |
startKey |
| | eq | 현재 목록을 불러올 기준이 되는 키 |
limit |
| | eq | 한 페이지에 불러옥 목록 개수 |
dateType |
| | eq | 설명 없음 |
startDate |
| | eq | 검색 시작 날짜 |
endDate |
| | eq | 검색 끝 날짜 |
{"startKey": "string","limit": "number","nextKey": "string","groupList": {"groupId": {"count": {"total": "number","sentTotal": "number","sentFailed": "number","sentSuccess": "number","sentPending": "number","sentReplacement": "number","refund": "number","registeredFailed": "number","registeredSuccess": "number"},"balance": {"requested": "number","replacement": "number","refund": "number","sum": "number"},"point": {"requested": "number","replacement": "number","refund": "number","sum": "number"},"app": {"profit": {"sms": "number","lms": "number","mms": "number","ata": "number","cta": "number","cti": "number"},"appId": "string","version": "string"},"sdkVersion": "string","osPlatform": "string","log": [{"message": "object","createAt": "date"}],"status": "any","scheduledDate": "date","dateSent": "date","dateCompleted": "date","isRefunded": "boolean","flagUpdated": "boolean","groupId": "string","accountId": "string","apiVersion": "string","countForCharge": {"sms": {"country": "number"},"lms": {"country": "number"},"mms": {"country": "number"},"ata": {"country": "number"},"cta": {"country": "number"},"cti": {"country": "number"}},"price": {},"dateCreated": "date","dateUpdated": "date"}}}
Name | Type | Should Return | Description |
startKey |
| | 현재 목록을 불러올 기준이 되는 키 |
limit |
| | 한 페이지에 불러옥 목록 개수 |
nextKey |
| | 다음 목록을 불러올 수 있는 키 |
| | 그룹 목록 |
Name | Type | Should Return | Description |
groupId |
| | 그룹 아이디 |
Name | Type | Should Return | Description |
count |
| | 카운트 |
balance |
| | 잔액 |
point |
| | 포인트 |
app |
| | 앱 정보 |
sdkVersion |
| | SDK 버전 |
osPlatform |
| | OS / Platform |
log |
| | 로그 |
status |
| | 그룹 상태 PENDING - 대기중 SENDING - 이미 발송 요청된 그룹 DELETED - 삭제 처리된 그룹 FAILED - 실패 처리된 그룹 COMPLETE - 발송 완료된 그룹 SCHEDULED - 발송 예약된 그룹 |
scheduledDate |
| | 설명 없음 |
dateSent |
| | 발송 일시 |
dateCompleted |
| | 완료 일시 |
isRefunded |
| | 환급 여부 |
flagUpdated |
| | 업데이트 여부 |
groupId |
| | 그룹 아이디 |
accountId |
| | 계정 고유 번호 |
apiVersion |
| | API 버전 |
| | 차감 카운트 | |
price |
| | 단가 |
dateCreated |
| | 생성 일시 |
dateUpdated |
| | 업데이트 일시 |
Name | Type | Should Return | Description |
total |
| | 토탈 |
sentTotal |
| | 전체 발송 건수 |
sentFailed |
| | 발송 실패 건수 |
sentSuccess |
| | 발송 성공 건수 |
sentPending |
| | 대기 건수 |
sentReplacement |
| | 대체 발송 건수 |
refund |
| | 환급 건수 |
registeredFailed |
| | 접수 실패 건수 |
registeredSuccess |
| | 접수 성공 건수 |
Name | Type | Should Return | Description |
requested |
| | 차감 금액 |
replacement |
| | 대체 발송 금액 |
refund |
| | 환급 금액 |
sum |
| | 합계 금액 |
Name | Type | Should Return | Description |
requested |
| | 차감 포인트 |
replacement |
| | 대체 발송 포인트 |
refund |
| | 환급 포인트 |
sum |
| | 합계 포인트 |
Name | Type | Should Return | Description |
profit |
| | 앱 사용 요금 |
appId |
| | 앱 아이디 |
version |
| | 앱 버전 |
Name | Type | Should Return | Description |
sms |
| | SMS 사용 요금 |
lms |
| | LMS 사용 요금 |
mms |
| | MMS 사용 요금 |
ata |
| | 알림톡 사용 요금 |
cta |
| | 친구톡 사용 요금 |
cti |
| | 친구톡 이미지 사용 요금 |
Name | Type | Should Return | Description |
message |
| | 로그 메시지 |
createAt |
| | 로그 기록 일시 |
Name | Type | Should Return | Description |
country |
| | 국가별 SMS 차감 금액 |
Name | Type | Should Return | Description |
country |
| | 국가별 LMS 차감 금액 |
Name | Type | Should Return | Description |
country |
| | 국가별 MMS 차감 금액 |
Name | Type | Should Return | Description |
country |
| | 국가별 알림톡 차감 금액 |
Name | Type | Should Return | Description |
country |
| | 국가별 친구톡 차감 금액 |
Name | Type | Should Return | Description |
country |
| | 국가별 친구톡 이미지 차감 금액 |
Name | Type | Should Return | Description |
Sample Request
http://api.solapi.com/messages/v4/groups?limit=10
Sample Response
{"startKey": null,"limit": 10,"groupList": {"G4VZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ": {"_id": "G4VZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ","count": {"total": 0,"sentTotal": 0,"sentFailed": 0,"sentSuccess": 0,"sentPending": 0,"sentReplacement": 0,"refund": 0,"registeredFailed": 0,"registeredSuccess": 0},"balance": {"requested": 0,"replacement": 0,"refund": 0,"sum": 0},"point": {"requested": 0,"replacement": 0,"refund": 0,"sum": 0},"app": {"profit": {"sms": 0,"lms": 0,"mms": 0,"ata": 0,"cta": 0,"cti": 0},"appId": null,"version": null},"serviceMethod": "MT","sdkVersion": null,"osPlatform": null,"log": [{"createAt": "2021-01-23T10:41:06.846Z","message": "메시지 그룹이 생성되었습니다."}],"status": "PENDING","dateSent": null,"scheduledDate": null,"dateCompleted": null,"isRefunded": false,"flagUpdated": false,"prepaid": true,"strict": true,"masterAccountId": null,"groupId": "G4VZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ","accountId": "12925149","apiVersion": "4","countForCharge": {"sms": {"82": 0},"lms": {},"mms": {},"ata": {},"cta": {},"cti": {}},"price": {},"customFields": {},"hint": {},"dateCreated": "2021-01-23T10:41:06.849Z","dateUpdated": "2021-01-23T10:41:06.849Z"},"G4V20210123194107UP2POEHUJV29RD1": {"_id": "G4V20210123194107UP2POEHUJV29RD1","count": {"total": 0,"sentTotal": 0,"sentFailed": 0,"sentSuccess": 0,"sentPending": 0,"sentReplacement": 0,"refund": 0,"registeredFailed": 0,"registeredSuccess": 0},"countForCharge": {"sms": {},"lms": {},"mms": {},"ata": {},"cta": {},"cti": {}},"balance": {"requested": 0,"replacement": 0,"refund": 0,"sum": 0},"point": {"requested": 0,"replacement": 0,"refund": 0,"sum": 0},"app": {"profit": {"sms": 0,"lms": 0,"mms": 0,"ata": 0,"cta": 0,"cti": 0},"appId": null,"version": null},"serviceMethod": "MT","sdkVersion": null,"osPlatform": null,"log": [{"createAt": "2021-01-23T10:41:07.390Z","message": "[::ffff:127.0.0.1] 메시지 그룹이 생성되었습니다."}],"status": "PENDING","dateSent": null,"scheduledDate": null,"dateCompleted": null,"isRefunded": false,"flagUpdated": false,"prepaid": true,"strict": false,"masterAccountId": null,"accountId": "12925149","apiVersion": "4","customFields": {},"hint": null,"groupId": "G4V20210123194107UP2POEHUJV29RD1","price": {},"dateCreated": "2021-01-23T10:41:07.393Z","dateUpdated": "2021-01-23T10:41:07.393Z"},"G4V20210123194107QARFNEEGEI8AV3Q": {"_id": "G4V20210123194107QARFNEEGEI8AV3Q","count": {"total": 0,"sentTotal": 0,"sentFailed": 0,"sentSuccess": 0,"sentPending": 0,"sentReplacement": 0,"refund": 0,"registeredFailed": 0,"registeredSuccess": 0},"countForCharge": {"sms": {},"lms": {},"mms": {},"ata": {},"cta": {},"cti": {}},"balance": {"requested": 0,"replacement": 0,"refund": 0,"sum": 0},"point": {"requested": 0,"replacement": 0,"refund": 0,"sum": 0},"app": {"profit": {"sms": 0,"lms": 0,"mms": 0,"ata": 0,"cta": 0,"cti": 0},"appId": "TESTAPPID","version": null},"serviceMethod": "MT","sdkVersion": "1.0","osPlatform": "win","log": [{"createAt": "2021-01-23T10:41:07.414Z","message": "[::ffff:127.0.0.1] 메시지 그룹이 생성되었습니다."}],"status": "PENDING","dateSent": null,"scheduledDate": null,"dateCompleted": null,"isRefunded": false,"flagUpdated": false,"prepaid": true,"strict": false,"masterAccountId": null,"accountId": "12925149","apiVersion": "4","customFields": {},"hint": null,"groupId": "G4V20210123194107QARFNEEGEI8AV3Q","price": {},"dateCreated": "2021-01-23T10:41:07.417Z","dateUpdated": "2021-01-23T10:41:07.417Z"},"G4V20210123194107N3WRMYFRNZPPOHP": {"_id": "G4V20210123194107N3WRMYFRNZPPOHP","count": {"total": 0,"sentTotal": 0,"sentFailed": 0,"sentSuccess": 0,"sentPending": 0,"sentReplacement": 0,"refund": 0,"registeredFailed": 0,"registeredSuccess": 0},"countForCharge": {"sms": {},"lms": {},"mms": {},"ata": {},"cta": {},"cti": {}},"balance": {"requested": 0,"replacement": 0,"refund": 0,"sum": 0},"point": {"requested": 0,"replacement": 0,"refund": 0,"sum": 0},"app": {"profit": {"sms": 0,"lms": 0,"mms": 0,"ata": 0,"cta": 0,"cti": 0},"appId": null,"version": null},"serviceMethod": "MT","sdkVersion": "1.0","osPlatform": "win","log": [{"createAt": "2021-01-23T10:41:07.436Z","message": "[::ffff:127.0.0.1] 메시지 그룹이 생성되었습니다."}],"status": "PENDING","dateSent": null,"scheduledDate": null,"dateCompleted": null,"isRefunded": false,"flagUpdated": false,"prepaid": true,"strict": false,"masterAccountId": null,"accountId": "12925149","apiVersion": "4","customFields": {},"hint": {"routeType": "large"},"groupId": "G4V20210123194107N3WRMYFRNZPPOHP","price": {},"dateCreated": "2021-01-23T10:41:07.438Z","dateUpdated": "2021-01-23T10:41:07.438Z"},"G4V20210123194107DVHM2KVVTUODBFE": {"_id": "G4V20210123194107DVHM2KVVTUODBFE","count": {"total": 0,"sentTotal": 0,"sentFailed": 0,"sentSuccess": 0,"sentPending": 0,"sentReplacement": 0,"refund": 0,"registeredFailed": 0,"registeredSuccess": 0},"countForCharge": {"sms": {},"lms": {},"mms": {},"ata": {},"cta": {},"cti": {}},"balance": {"requested": 0,"replacement": 0,"refund": 0,"sum": 0},"point": {"requested": 0,"replacement": 0,"refund": 0,"sum": 0},"app": {"profit": {"sms": 0,"lms": 0,"mms": 0,"ata": 0,"cta": 0,"cti": 0},"appId": null,"version": null},"serviceMethod": "MT","sdkVersion": null,"osPlatform": null,"log": [{"message": "유효하지 않은 AppId","createAt": "2021-01-23T10:41:07.371Z"}],"status": "FAILED","dateSent": null,"scheduledDate": null,"dateCompleted": null,"isRefunded": false,"flagUpdated": false,"prepaid": true,"strict": false,"masterAccountId": null,"accountId": "12925149","apiVersion": "4","groupId": "G4V20210123194107DVHM2KVVTUODBFE","price": {},"customFields": {},"hint": {},"dateCreated": "2021-01-23T10:41:07.374Z","dateUpdated": "2021-01-23T10:41:07.374Z"},"G4V20210123194107CGFDYZJ99DTJODB": {"_id": "G4V20210123194107CGFDYZJ99DTJODB","count": {"total": 0,"sentTotal": 0,"sentFailed": 0,"sentSuccess": 0,"sentPending": 0,"sentReplacement": 0,"refund": 0,"registeredFailed": 0,"registeredSuccess": 0},"countForCharge": {"sms": {},"lms": {},"mms": {},"ata": {},"cta": {},"cti": {}},"balance": {"requested": 0,"replacement": 0,"refund": 0,"sum": 0},"point": {"requested": 0,"replacement": 0,"refund": 0,"sum": 0},"app": {"profit": {"sms": 0,"lms": 0,"mms": 0,"ata": 0,"cta": 0,"cti": 0},"appId": null,"version": null},"serviceMethod": "MT","sdkVersion": "1.0","osPlatform": "win","log": [{"createAt": "2021-01-23T10:41:07.426Z","message": "[::ffff:127.0.0.1] 메시지 그룹이 생성되었습니다."}],"status": "PENDING","dateSent": null,"scheduledDate": null,"dateCompleted": null,"isRefunded": false,"flagUpdated": false,"prepaid": true,"strict": false,"masterAccountId": null,"accountId": "12925149","apiVersion": "4","customFields": {},"hint": null,"groupId": "G4V20210123194107CGFDYZJ99DTJODB","price": {},"dateCreated": "2021-01-23T10:41:07.428Z","dateUpdated": "2021-01-23T10:41:07.428Z"},"G4V20190FFFFFFFFFH3PTASXMNJG2JIO": {"_id": "G4V20190FFFFFFFFFH3PTASXMNJG2JIO","count": {"total": 0,"sentTotal": 0,"sentFailed": 0,"sentSuccess": 0,"sentPending": 0,"sentReplacement": 0,"refund": 0,"registeredFailed": 0,"registeredSuccess": 1},"balance": {"requested": 0,"replacement": 0,"refund": 0,"sum": 0},"point": {"requested": 0,"replacement": 0,"refund": 0,"sum": 0},"app": {"profit": {"sms": 0,"lms": 0,"mms": 0,"ata": 0,"cta": 0,"cti": 0},"appId": null,"version": null},"serviceMethod": "MT","sdkVersion": null,"osPlatform": null,"log": [{"message": "메시지 그룹이 생성되었습니다.","createAt": "2021-01-23T10:41:06.871Z"},{"message": "국가코드(82)의 단문문자(SMS) 1 건이 추가되었습니다.","createAt": "2021-01-23T10:41:06.871Z"}],"status": "PENDING","dateSent": null,"scheduledDate": null,"dateCompleted": null,"isRefunded": false,"flagUpdated": false,"prepaid": true,"strict": true,"masterAccountId": null,"groupId": "G4V20190FFFFFFFFFH3PTASXMNJG2JIO","accountId": "12925149","apiVersion": "4","countForCharge": {"sms": {"82": 1},"lms": {},"mms": {},"ata": {},"cta": {},"cti": {}},"price": {},"customFields": {},"hint": {},"dateCreated": "2021-01-23T10:41:06.889Z","dateUpdated": "2021-01-23T10:41:06.889Z"},"G4V20190607105937H3PTASXMNJG2JID": {"_id": "G4V20190607105937H3PTASXMNJG2JID","count": {"total": 0,"sentTotal": 0,"sentFailed": 0,"sentSuccess": 0,"sentPending": 0,"sentReplacement": 0,"refund": 0,"registeredFailed": 0,"registeredSuccess": 0},"balance": {"requested": 0,"replacement": 0,"refund": 0,"sum": 0},"point": {"requested": 0,"replacement": 0,"refund": 0,"sum": 0},"app": {"profit": {"sms": 0,"lms": 0,"mms": 0,"ata": 0,"cta": 0,"cti": 0},"appId": null,"version": null},"serviceMethod": "MT","sdkVersion": null,"osPlatform": null,"log": [{"createAt": "2021-01-23T10:41:06.835Z","message": "메시지 그룹이 생성되었습니다."}],"status": "PENDING","dateSent": null,"scheduledDate": null,"dateCompleted": null,"isRefunded": false,"flagUpdated": false,"prepaid": true,"strict": true,"masterAccountId": null,"groupId": "G4V20190607105937H3PTASXMNJG2JID","accountId": "12925149","apiVersion": "4","countForCharge": {"sms": {"82": 0},"lms": {},"mms": {},"ata": {},"cta": {},"cti": {}},"price": {},"customFields": {},"hint": {},"dateCreated": "2021-01-23T10:41:06.839Z","dateUpdated": "2021-01-23T10:41:06.839Z"},"G4V20190607105937H3PFASXMNJG2JID": {"_id": "G4V20190607105937H3PFASXMNJG2JID","count": {"total": 0,"sentTotal": 0,"sentFailed": 0,"sentSuccess": 0,"sentPending": 0,"sentReplacement": 0,"refund": 0,"registeredFailed": 0,"registeredSuccess": 0},"balance": {"requested": 0,"replacement": 0,"refund": 0,"sum": 0},"point": {"requested": 0,"replacement": 0,"refund": 0,"sum": 0},"app": {"profit": {"sms": 0,"lms": 0,"mms": 0,"ata": 0,"cta": 0,"cti": 0},"appId": null,"version": null},"serviceMethod": "MT","sdkVersion": null,"osPlatform": null,"log": [{"createAt": "2021-01-23T10:41:06.841Z","message": "메시지 그룹이 생성되었습니다."}],"status": "PENDING","dateSent": null,"scheduledDate": null,"dateCompleted": null,"isRefunded": false,"flagUpdated": false,"prepaid": true,"strict": true,"masterAccountId": null,"groupId": "G4V20190607105937H3PFASXMNJG2JID","accountId": "12925149","apiVersion": "4","countForCharge": {"sms": {"82": 0},"lms": {},"mms": {},"ata": {},"cta": {},"cti": {}},"price": {},"customFields": {},"hint": {},"dateCreated": "2021-01-23T10:41:06.844Z","dateUpdated": "2021-01-23T10:41:06.844Z"},"G4V2019030710593FFFNCELSCHEDULE4": {"_id": "G4V2019030710593FFFNCELSCHEDULE4","count": {"total": 0,"sentTotal": 0,"sentFailed": 0,"sentSuccess": 0,"sentPending": 0,"sentReplacement": 0,"refund": 0,"registeredFailed": 0,"registeredSuccess": 1},"balance": {"requested": 0,"replacement": 0,"refund": 0,"sum": 0},"point": {"requested": 0,"replacement": 0,"refund": 0,"sum": 0},"app": {"profit": {"sms": 0,"lms": 0,"mms": 0,"ata": 0,"cta": 0,"cti": 0},"appId": null,"version": null},"serviceMethod": "MT","sdkVersion": null,"osPlatform": null,"log": [{"message": "메시지 그룹이 생성되었습니다.","createAt": "2021-01-23T10:41:06.851Z"},{"message": "국가코드(82)의 단문문자(SMS) 1 건이 추가되었습니다.","createAt": "2021-01-23T10:41:06.851Z"}],"status": "FAILED","dateSent": null,"scheduledDate": null,"dateCompleted": null,"isRefunded": false,"flagUpdated": false,"prepaid": true,"strict": true,"masterAccountId": null,"groupId": "G4V2019030710593FFFNCELSCHEDULE4","accountId": "12925149","apiVersion": "4","countForCharge": {"sms": {"82": 1},"lms": {},"mms": {},"ata": {},"cta": {},"cti": {}},"price": {},"customFields": {},"hint": {},"dateCreated": "2021-01-23T10:41:06.855Z","dateUpdated": "2021-01-23T10:41:06.855Z"}},"nextKey": "G4V20190307105937H3PTASXMNJGCCCC"}
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.solapi.com/messages/v4/groups?limit=10'};request(options, function(error, response, body) {if (error) throw error;console.log('result :', body);});
<?php$url = "http://api.solapi.com/messages/v4/groups?limit=10";$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 requestsurl = "http://api.solapi.com/messages/v4/groups?limit=10"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/bashcurl -X GET \-H 'Authorization: HMAC-SHA256 apiKey=NCSAYU7YDBXYORXC, date=2019-07-01T00:41:48Z, salt=jqsba2jxjnrjor, signature=1779eac71a24cbeeadfa7263cb84b7ea0af1714f5c0270aa30ffd34600e363b4' \http://api.solapi.com/messages/v4/groups?limit=10