그룹 목록 조회
GET
/messages/v4/groups
메시지 그룹 목록을 조회합니다.
Query Params
| 이름 | 타입 | 필수 여부 | 허용 연산자[?] | 설명 |
|---|---|---|---|---|
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
| 이름 | 타입 | 반드시 반환 | 설명 |
|---|---|---|---|
startKey | String | - | 현재 목록을 불러올 기준이 되는 키 |
limit | Number | - | 페이지당 항목 수 |
nextKey | String | - | 설명 없음 |
groupList | Object | - | 그룹 목록 |