메시지 조회
목차
Request
[GET] https://api.solapi.com/messages/v4/list
메시지의 목록을 조회합니다.
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 와 함께 사용됩니다. - 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 | string | eq | 검색 날짜 시작 범위 | |
| endDate | string | eq | 검색 날짜 끝 범위 | |
| messageId | string | eq | 메시지 아이디 | |
| messageIds | array | eq, in | 메시지 아이디 목록 | |
| groupId | string | eq | 메시지 그룹 아이디 | |
| to | string | eq | 수신번호 | |
| from | string | eq | 발신번호 | |
| type | string | eq, in | 메시지 타입
| |
| statusCode | string | eq, in, ne | 상태 코드 참고 | |
| dateCreated | date | eq | 최초 생성 날짜 | |
| dateUpdated | date | eq | 최근 수정 날짜 |
문서 생성일 : 2024-05-23