그룹 정보 조회

목차

• Request
  • Authorization 인증 필요
  • Path Parameters
• Response
  • Response Structure
  • Response Description

Request

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

메시지 그룹의 정보를 조회합니다.

---

Authorization 인증 필요

Authorization 인증이란?

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

Path Parameters

Name	Description
:groupId	메시지 그룹 아이디

---

Response

Response Structure

{
    "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
count	object		설명 없음
balance	object		설명 없음
point	object		설명 없음
app	object		설명 없음
sdkVersion	string		SDK 버전
osPlatform	string		OS 플렛폼
log	array		설명 없음
status	string		상태값
scheduledDate	date		메시지 예약 날짜
dateSent	date		설명 없음
dateCompleted	date		설명 없음
isRefunded	boolean		설명 없음
flagUpdated	boolean		설명 없음
groupId	string		메시지 그룹 아이디
accountId	string		계정 고유 아이디
apiVersion	string		설명 없음
countForCharge	object		설명 없음
price	object		설명 없음
dateCreated	date		최초 생성 날짜
dateUpdated	date		최근 수정 날짜

Response / 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 / balance

Name	Type	Should Return	Description
requested	number		설명 없음
replacement	number		설명 없음
refund	number		설명 없음
sum	number		설명 없음

Response / point

Name	Type	Should Return	Description
requested	number		설명 없음
replacement	number		설명 없음
refund	number		설명 없음
sum	number		설명 없음

Response / app

Name	Type	Should Return	Description
profit	object		설명 없음
appId	string		앱 아이디
version	string		설명 없음

Response / 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_lms	number		설명 없음
rcs_mms	number		설명 없음
rcs_tpl	number		설명 없음
fax	number		설명 없음
voice	number		설명 없음

Response / log

Name	Type	Should Return	Description
message	string		메시지에 대한 정보
createAt	date		설명 없음

Response / countForCharge

Name	Type	Should Return	Description
sms	object		설명 없음
lms	object		설명 없음
mms	object		설명 없음
ata	object		설명 없음
cta	object		설명 없음
cti	object		설명 없음
nsa	object		설명 없음
rcs_sms	object		설명 없음
rcs_lms	object		설명 없음
rcs_mms	object		설명 없음
rcs_tpl	object		설명 없음
fax	object		설명 없음
voice	object		설명 없음

Response / countForCharge / sms

Name	Type	Should Return	Description
country	number		국가번호 (기본: 82, 미국(캐나다):1, 중국: 86, 일본: 81)

Response / countForCharge / lms

Name	Type	Should Return	Description
country	number		국가번호 (기본: 82, 미국(캐나다):1, 중국: 86, 일본: 81)

Response / countForCharge / mms

Name	Type	Should Return	Description
country	number		국가번호 (기본: 82, 미국(캐나다):1, 중국: 86, 일본: 81)

Response / countForCharge / ata

Name	Type	Should Return	Description
country	number		국가번호 (기본: 82, 미국(캐나다):1, 중국: 86, 일본: 81)

Response / countForCharge / cta

Name	Type	Should Return	Description
country	number		국가번호 (기본: 82, 미국(캐나다):1, 중국: 86, 일본: 81)

Response / countForCharge / cti

Name	Type	Should Return	Description
country	number		국가번호 (기본: 82, 미국(캐나다):1, 중국: 86, 일본: 81)

Response / countForCharge / nsa

Name	Type	Should Return	Description
country	number		국가번호 (기본: 82, 미국(캐나다):1, 중국: 86, 일본: 81)

Response / countForCharge / rcs_sms

Name	Type	Should Return	Description
country	number		국가번호 (기본: 82, 미국(캐나다):1, 중국: 86, 일본: 81)

Response / countForCharge / rcs_lms

Name	Type	Should Return	Description
country	number		국가번호 (기본: 82, 미국(캐나다):1, 중국: 86, 일본: 81)

Response / countForCharge / rcs_mms

Name	Type	Should Return	Description
country	number		국가번호 (기본: 82, 미국(캐나다):1, 중국: 86, 일본: 81)

Response / countForCharge / rcs_tpl

Name	Type	Should Return	Description
country	number		국가번호 (기본: 82, 미국(캐나다):1, 중국: 86, 일본: 81)

Response / countForCharge / fax

Name	Type	Should Return	Description
country	number		국가번호 (기본: 82, 미국(캐나다):1, 중국: 86, 일본: 81)

Response / countForCharge / voice

Name	Type	Should Return	Description
country	number		국가번호 (기본: 82, 미국(캐나다):1, 중국: 86, 일본: 81)

Response / price

Name	Type	Should Return	Description

---

문서 생성일 : 2024-05-23