그룹 목록 조회

목차

• Request
  • Authorization 인증 필요
  • Query Params
• Response
  • Response Structure
  • Response Description

Request

[GET] https://api.solapi.com/messages/v4/groups

메시지 그룹 목록을 조회합니다.

---

Authorization 인증 필요

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 와 함께 사용됩니다. - groupId - 그룹 아이디 입니다. - dateCreated - 그룹 생성일 입니다. - scheduledDate - 예약 발송일 입니다. - count.total - 그룹에 속한 메시지 총 건수입니다. - count.sentTotal -그룹에 속한 메시지 발송 건수입니다.
cond	string		eq	검색 조건에 사용되는 연산자 criteria 와 같이 'cond1,cond2' 와 같이 ,(콤마)로 구분되며, criteria,value 와 함께 사용됩니다. - eq - 같음 (=) - ne - 같지 않음 (!=) - gt - 보다 큼 (>) - gte - 보다 크거나 같음 (>=) - lt - 보다 작음 (<) - lte - 보다 작거나 같음 (<=)
value	string		eq	검색 값 criteria , cond 값에 대응하는 value 입니다. criteria='groupId,dateCreated' cond='eq,eq' 일 경우 groupId 에 대응하는 value 값을 찾고 status 에 대응하는 값을 찾는 조건 입니다. e.g - value='그룹아이디,생성일'
startKey	string		eq	현재 목록을 불러올 기준이 되는 키
limit	number		eq	한 페이지에 불러옥 목록 개수
dateType	string		eq	설명 없음
startDate	string		eq	검색 날짜 시작 범위
endDate	string		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",
                    "fax": "number",
                    "voice": "number"
                },
                "appId": "string",
                "version": "string"
            },
            "sdkVersion": "string",
            "osPlatform": "string",
            "log": [
                {
                    "message": "string",
                    "createAt": "date"
                }
            ],
            "status": "string",
            "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"
                },
                "fax": {
                    "country": "number"
                },
                "voice": {
                    "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	object		그룹 아이디

Response / groupList / groupId

Name	Type	Should Return	Description
count	object		카운트
balance	object		잔액
point	object		포인트
app	object		앱 정보
sdkVersion	string		SDK 버전
osPlatform	string		OS / Platform
log	Array		로그
status	string		그룹 상태 PENDING - 대기중 SENDING - 이미 발송 요청된 그룹 DELETED - 삭제 처리된 그룹 FAILED - 실패 처리된 그룹 COMPLETE - 발송 완료된 그룹 SCHEDULED - 발송 예약된 그룹
scheduledDate	date		메시지 예약 날짜
dateSent	date		발송 일시
dateCompleted	date		완료 일시
isRefunded	boolean		환급 여부
flagUpdated	boolean		업데이트 여부
groupId	string		그룹 아이디
accountId	string		계정 고유 번호
apiVersion	string		API 버전
countForCharge	object		차감 카운트
price	object		단가
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		단문 문자 사용 요금
lms	number		장문 문자 사용 요금
mms	number		사진 문자 사용 요금
ata	number		알림톡 사용 요금
cta	number		친구톡 사용 요금
cti	number		친구톡 + 이미지 사용 요금
nsa	number		네이버 스마트 알림 사용 요금
rcs_sms	number		RCS 단문 문자 사용 요금
rcs_lms	number		RCS 장문 문자 사용 요금
rcs_mms	number		RCS 사진 문자 사용 요금
rcs_tpl	number		RCS 템플릿 문자 사용 요금
fax	number		팩스 사용 요금
voice	number		보이스콜 사용 요금

Response / groupList / groupId / log

Name	Type	Should Return	Description
message	string		로그 메시지
createAt	date		로그 기록 일시

Response / groupList / groupId / countForCharge

Name	Type	Should Return	Description
sms	object		단문 문자 차감 건수
lms	object		장문 문자 차감 건수
mms	object		사진 문자 차감 건수
ata	object		알림톡 차감 건수
cta	object		친구톡 차감 건수
cti	object		친구톡 + 이미지 차감 건수
nsa	object		네이버 스마트 알림 차감 건수
rcs_sms	object		RCS 단문 문자 차감 건수
rcs_lms	object		RCS 장문 문자 차감 건수
rcs_mms	object		RCS 사진 문자 차감 건수
rcs_tpl	object		RCS 템플릿 문자 차감 건수
fax	object		팩스 차감 건수
voice	object		보이스콜 차감 건수

Response / groupList / groupId / countForCharge / sms

Name	Type	Should Return	Description
country	number		특정국가의 단문 문자 차감 건수

Response / groupList / groupId / countForCharge / lms

Name	Type	Should Return	Description
country	number		특정국가의 장문 문자 차감 건수

Response / groupList / groupId / countForCharge / mms

Name	Type	Should Return	Description
country	number		특정국가의 사진 문자 차감 건수

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 단문 문자 차감 건수

Response / groupList / groupId / countForCharge / rcs_lms

Name	Type	Should Return	Description
country	number		특정국가의 RCS 장문 문자 차감 건수

Response / groupList / groupId / countForCharge / rcs_mms

Name	Type	Should Return	Description
country	number		특정국가의 RCS 사진 문자 차감 건수

Response / groupList / groupId / countForCharge / rcs_tpl

Name	Type	Should Return	Description
country	number		특정국가의 RCS 템플릿 문자 차감 건수

Response / groupList / groupId / countForCharge / fax

Name	Type	Should Return	Description
country	number		특정국가의 팩스 차감 건수

Response / groupList / groupId / countForCharge / voice

Name	Type	Should Return	Description
country	number		특정국가의 보이스콜 차감 건수

Response / groupList / groupId / price

Name	Type	Should Return	Description

---

문서 생성일 : 2024-05-23