SOLAPI
Search…
그룹 목록 조회

Request

GET https://api.solapi.com/messages/v4/groups
메시지 그룹 목록을 조회합니다.

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
검색 끝 날짜

Response

Response Structure

{
"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",
"nsa": "number",
"rcs_sms": "number",
"rcs_lms": "number",
"rcs_mms": "number",
"rcs_tpl": "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"
},
"nsa": {
"country": "number"
},
"rcs_sms": {
"country": "number"
},
"rcs_lms": {
"country": "number"
},
"rcs_mms": {
"country": "number"
},
"rcs_tpl": {
"country": "number"
}
},
"price": {},
"dateCreated": "date",
"dateUpdated": "date"
}
}
}

Response Description

Response /
Name
Type
Should Return
Description
startKey
string
현재 목록을 불러올 기준이 되는 키
limit
number
한 페이지에 불러옥 목록 개수
nextKey
string
다음 목록을 불러올 수 있는 키
groupList
object
그룹 목록
Response / groupList
Name
Type
Should Return
Description
groupId
string
그룹 아이디
Response / groupList / groupId
Name
Type
Should Return
Description
count
object
카운트
balance
number
잔액
point
number
포인트
app
object
앱 정보
sdkVersion
string
SDK 버전
osPlatform
string
OS / Platform
log
Array
로그
status
any
그룹 상태 PENDING - 대기중 SENDING - 이미 발송 요청된 그룹 DELETED - 삭제 처리된 그룹 FAILED - 실패 처리된 그룹 COMPLETE - 발송 완료된 그룹 SCHEDULED - 발송 예약된 그룹
scheduledDate
date
설명 없음
dateSent
date
발송 일시
dateCompleted
date
완료 일시
isRefunded
boolean
환급 여부
flagUpdated
boolean
업데이트 여부
groupId
string
그룹 아이디
accountId
string
계정 고유 번호
apiVersion
string
API 버전
object
차감 카운트
price
any
단가
dateCreated
date
생성 일시
dateUpdated
date
업데이트 일시
Response / groupList / groupId / count
Name
Type
Should Return
Description
total
number
토탈
sentTotal
number
전체 발송 건수
sentFailed
number
발송 실패 건수
sentSuccess
number
발송 성공 건수
sentPending
number
대기 건수
sentReplacement
number
대체 발송 건수
refund
number
환급 건수
registeredFailed
number
접수 실패 건수
registeredSuccess
number
접수 성공 건수
Response / groupList / groupId / balance
Name
Type
Should Return
Description
requested
number
차감 금액
replacement
number
대체 발송 금액
refund
number
환급 금액
sum
number
합계 금액
Response / groupList / groupId / point
Name
Type
Should Return
Description
requested
number
차감 포인트
replacement
number
대체 발송 포인트
refund
number
환급 포인트
sum
number
합계 포인트
Response / groupList / groupId / app
Name
Type
Should Return
Description
profit
object
앱 사용 요금
appId
string
앱 아이디
version
string
앱 버전
Response / groupList / groupId / app / profit
Name
Type
Should Return
Description
sms
number
SMS 사용 요금
lms
number
LMS 사용 요금
mms
number
MMS 사용 요금
ata
number
알림톡 사용 요금
cta
number
친구톡 사용 요금
cti
number
친구톡 이미지 사용 요금
nsa
number
네이버 스마트 알림 사용 요금
rcs_sms
number
RCS SMS 사용 요금
rcs_lms
number
RCS LMS 사용 요금
rcs_mms
number
RCS MMS 사용 요금
rcs_tpl
number
RCS 템플릿 사용 요금
Response / groupList / groupId / log
Name
Type
Should Return
Description
message
object
로그 메시지
createAt
date
로그 기록 일시
Response / groupList / groupId / countForCharge
Name
Type
Should Return
Description
sms
object
SMS 차감 건수
lms
object
LMS 차감 건수
mms
object
MMS 차감 건수
ata
object
알림톡 차감 건수
cta
object
친구톡 차감 건수
cti
object
친구톡 이미지 차감 건수
nsa
object
네이버 스마트 알림 차감 건수
rcs_sms
object
RCS SMS 차감 건수
rcs_lms
object
RCS LMS 차감 건수
rcs_mms
object
RCS MMS 차감 건수
rcs_tpl
object
RCS 템플릿 차감 건수
Response / groupList / groupId / countForCharge / sms
Name
Type
Should Return
Description
country
number
국가별 SMS 차감 건수
Response / groupList / groupId / countForCharge / lms
Name
Type
Should Return
Description
country
number
국가별 LMS 차감 건수
Response / groupList / groupId / countForCharge / mms
Name
Type
Should Return
Description
country
number
국가별 MMS 차감 건수
Response / groupList / groupId / countForCharge / ata
Name
Type
Should Return
Description
country
number
국가별 알림톡 차감 건수
Response / groupList / groupId / countForCharge / cta
Name
Type
Should Return
Description
country
number
국가별 친구톡 차감 건수
Response / groupList / groupId / countForCharge / cti
Name
Type
Should Return
Description
country
number
국가별 친구톡 이미지 차감 건수
Response / groupList / groupId / countForCharge / nsa
Name
Type
Should Return
Description
country
number
국가별 네이버 스마트 알림 차감 건수
Response / groupList / groupId / countForCharge / rcs_sms
Name
Type
Should Return
Description
country
number
국가별 RCS SMS 차감 건수
Response / groupList / groupId / countForCharge / rcs_lms
Name
Type
Should Return
Description
country
number
국가별 RCS LMS 차감 건수
Response / groupList / groupId / countForCharge / rcs_mms
Name
Type
Should Return
Description
country
number
국가별 RCS MMS 차감 건수
Response / groupList / groupId / countForCharge / rcs_tpl
Name
Type
Should Return
Description
country
number
국가별 RCS 템플릿 차감 건수
Response / groupList / groupId / price

Samples

메시지 그룹 목록 get /messages/v4/groups

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,
"nsa": 0,
"rcs_sms": 0,
"rcs_lms": 0,
"rcs_mms": 0,
"rcs_tpl": 0
},
"appId": null,
"version": null
},
"serviceMethod": "MT",
"sdkVersion": null,
"osPlatform": null,
"log": [
{
"createAt": "2021-11-16T05:09:39.782Z",
"message": "메시지 그룹이 생성되었습니다."
}
],
"status": "PENDING",
"dateSent": null,
"scheduledDate": null,
"dateCompleted": null,
"isRefunded": false,
"flagUpdated": false,
"prepaid": true,
"strict": true,
"masterAccountId": null,
"allowDuplicates": false,
"groupId": "G4VZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ",
"accountId": "12925149",
"apiVersion": "4",
"countForCharge": {
"sms": {
"82": 0
},
"lms": {},
"mms": {},
"ata": {},
"cta": {},
"cti": {},
"nsa": {},
"rcs_sms": {},
"rcs_lms": {},
"rcs_mms": {},
"rcs_tpl": {}
},
"price": {},
"customFields": {},
"hint": {},
"dateCreated": "2021-11-16T05:09:39.784Z",
"dateUpdated": "2021-11-16T05:09:39.784Z"
},
"G4V20211116140940ZQUVQBZLFDBAGDG": {
"_id": "G4V20211116140940ZQUVQBZLFDBAGDG",
"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": {},
"nsa": {},
"rcs_sms": {},
"rcs_lms": {},
"rcs_mms": {},
"rcs_tpl": {}
},
"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,
"nsa": 0,
"rcs_sms": 0,
"rcs_lms": 0,
"rcs_mms": 0,
"rcs_tpl": 0
},
"appId": null,
"version": null
},
"serviceMethod": "MT",
"sdkVersion": null,
"osPlatform": null,
"log": [
{
"message": "유효하지 않은 AppId",
"createAt": "2021-11-16T05:09:40.131Z"
}
],
"status": "FAILED",
"dateSent": null,
"scheduledDate": null,
"dateCompleted": null,
"isRefunded": false,
"flagUpdated": false,
"prepaid": true,
"strict": false,
"masterAccountId": null,
"allowDuplicates": false,
"accountId": "12925149",
"apiVersion": "4",
"groupId": "G4V20211116140940ZQUVQBZLFDBAGDG",
"price": {},
"customFields": {},
"hint": {},
"dateCreated": "2021-11-16T05:09:40.135Z",
"dateUpdated": "2021-11-16T05:09:40.135Z"
},
"G4V20211116140940SONAQ84M9DOETDI": {
"_id": "G4V20211116140940SONAQ84M9DOETDI",
"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": {},
"nsa": {},
"rcs_sms": {},
"rcs_lms": {},
"rcs_mms": {},
"rcs_tpl": {}
},
"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,
"nsa": 0,
"rcs_sms": 0,
"rcs_lms": 0,
"rcs_mms": 0,
"rcs_tpl": 0
},
"appId": null,
"version": null
},
"serviceMethod": "MT",
"sdkVersion": "1.0",
"osPlatform": "win",
"log": [
{
"createAt": "2021-11-16T05:09:40.182Z",
"message": "[::ffff:127.0.0.1] 메시지 그룹이 생성되었습니다."
}
],
"status": "PENDING",
"dateSent": null,
"scheduledDate": null,
"dateCompleted": null,
"isRefunded": false,
"flagUpdated": false,
"prepaid": true,
"strict": false,
"masterAccountId": null,
"allowDuplicates": false,
"accountId": "12925149",
"apiVersion": "4",
"customFields": {},
"hint": null,
"groupId": "G4V20211116140940SONAQ84M9DOETDI",
"price": {},
"dateCreated": "2021-11-16T05:09:40.185Z",
"dateUpdated": "2021-11-16T05:09:40.185Z"
},
"G4V20211116140940IXCEQWLEZSBIARK": {
"_id": "G4V20211116140940IXCEQWLEZSBIARK",
"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": {},
"nsa": {},
"rcs_sms": {},
"rcs_lms": {},
"rcs_mms": {},
"rcs_tpl": {}
},
"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,
"nsa": 0,
"rcs_sms": 0,
"rcs_lms": 0,
"rcs_mms": 0,
"rcs_tpl": 0
},
"appId": "TESTAPPID",
"version": null
},
"serviceMethod": "MT",
"sdkVersion": "1.0",
"osPlatform": "win",
"log": [
{
"createAt": "2021-11-16T05:09:40.168Z",
"message": "[::ffff:127.0.0.1] 메시지 그룹이 생성되었습니다."
}
],
"status": "PENDING",
"dateSent": null,
"scheduledDate": null,
"dateCompleted": null,
"isRefunded": false,
"flagUpdated": false,
"prepaid": true,
"strict": false,
"masterAccountId": null,
"allowDuplicates": false,
"accountId": "12925149",
"apiVersion": "4",
"customFields": {},
"hint": null,
"groupId": "G4V20211116140940IXCEQWLEZSBIARK",
"price": {},
"dateCreated": "2021-11-16T05:09:40.171Z",
"dateUpdated": "2021-11-16T05:09:40.171Z"
},
"G4V20211116140940GR2VJW4WCXDPZBH": {
"_id": "G4V20211116140940GR2VJW4WCXDPZBH",
"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": {},
"nsa": {},
"rcs_sms": {},
"rcs_lms": {},
"rcs_mms": {},
"rcs_tpl": {}
},
"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,
"nsa": 0,
"rcs_sms": 0,
"rcs_lms": 0,
"rcs_mms": 0,
"rcs_tpl": 0
},
"appId": null,
"version": null
},
"serviceMethod": "MT",
"sdkVersion": "1.0",
"osPlatform": "win",
"log": [
{
"createAt": "2021-11-16T05:09:40.193Z",
"message": "[::ffff:127.0.0.1] 메시지 그룹이 생성되었습니다."
}
],
"status": "PENDING",
"dateSent": null,
"scheduledDate": null,
"dateCompleted": null,
"isRefunded": false,
"flagUpdated": false,
"prepaid": true,
"strict": false,
"masterAccountId": null,
"allowDuplicates": false,
"accountId": "12925149",
"apiVersion": "4",
"customFields"