본문으로 건너뛰기

그룹 목록 조회

GET
/messages/v4/groups


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

Query Params

NameTypeRequiredAllowed 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

NameTypeShould ReturnDescription
startKey
string
-
현재 목록을 불러올 기준이 되는 키
limit
number
-
페이지당 항목 수
nextKey
string
-
설명 없음
groupList
Object
-
그룹 목록

Structures

{4 properties
"startKey": "string",
"limit": "number",
"nextKey": "string",
"groupList":
{1 properties...}
"groupId":
{20 properties...}
"count":
{9 properties...}
"total": "number",
"sentTotal": "number",
"sentFailed": "number",
"sentSuccess": "number",
"sentPending": "number",
"sentReplacement": "number",
"refund": "number",
"registeredFailed": "number",
"registeredSuccess": "number"
}
,
"balance":
{4 properties...}
"requested": "number",
"replacement": "number",
"refund": "number",
"sum": "number"
}
,
"point":
{4 properties...}
"requested": "number",
"replacement": "number",
"refund": "number",
"sum": "number"
}
,
"app":
{3 properties...}
"profit":
{23 properties...}
"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",
"rcs_itpl": "number",
"rcs_ltpl": "number",
"fax": "number",
"voice": "number",
"bms_text": "number",
"bms_image": "number",
"bms_wide": "number",
"bms_wide_item_list": "number",
"bms_carousel_feed": "number",
"bms_premium_video": "number",
"bms_commerce": "number",
"bms_carousel_commerce": "number"
}
,
"appId": "string",
"version": "string"
}
,
"sdkVersion": "string",
"osPlatform": "string",
"log":
[1 items...]
{2 properties...}
"message": "string",
"createAt": "date"
}
]
,
"status": "string",
"scheduledDate": "date",
"dateSent": "date",
"dateCompleted": "date",
"isRefunded": "boolean",
"flagUpdated": "boolean",
"groupId": "string",
"accountId": "string",
"apiVersion": "string",
"countForCharge":
{23 properties...}
"sms":
{1 properties...}
"country": "number"
}
,
"lms":
{1 properties...}
"country": "number"
}
,
"mms":
{1 properties...}
"country": "number"
}
,
"ata":
{1 properties...}
"country": "number"
}
,
"cta":
{1 properties...}
"country": "number"
}
,
"cti":
{1 properties...}
"country": "number"
}
,
"nsa":
{1 properties...}
"country": "number"
}
,
"rcs_sms":
{1 properties...}
"country": "number"
}
,
"rcs_lms":
{1 properties...}
"country": "number"
}
,
"rcs_mms":
{1 properties...}
"country": "number"
}
,
"rcs_tpl":
{1 properties...}
"country": "number"
}
,
"rcs_itpl":
{1 properties...}
"country": "number"
}
,
"rcs_ltpl":
{1 properties...}
"country": "number"
}
,
"fax":
{1 properties...}
"country": "number"
}
,
"voice":
{1 properties...}
"country": "number"
}
,
"bms_text":
{1 properties...}
"country": "number"
}
,
"bms_image":
{1 properties...}
"country": "number"
}
,
"bms_wide":
{1 properties...}
"country": "number"
}
,
"bms_wide_item_list":
{1 properties...}
"country": "number"
}
,
"bms_carousel_feed":
{1 properties...}
"country": "number"
}
,
"bms_premium_video":
{1 properties...}
"country": "number"
}
,
"bms_commerce":
{1 properties...}
"country": "number"
}
,
"bms_carousel_commerce":
{1 properties...}
"country": "number"
}
}
,
"price":
{
}
,
"dateCreated": "date",
"dateUpdated": "date"
}
}
}