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