메시지 목록 조회
GET
/messages/v4/list
Query Params
| 이름 | 타입 | 필수 여부 | 허용 연산자[?] | 설명 |
|---|---|---|---|---|
messageId | String | - | eq | 메시지 아이디로 조회합니다. |
groupId | String | - | eq | 메시지의 그룹 아이디로 조회합니다. |
to | String | - | eq | 메시지를 수신한 전화번호 입니다. |
from | String | - | eq | 메시지를 발신한 전화번호 입니다. |
type | String | - | eqin | 메시지의 타입 입니다. - SMS: 일반 단문 문자 - LMS: 장문 문자 - MMS: 이미지 문자 - RCS_SMS: RCS 단문 문자 - RCS_LMS: RCS 장문 문자 - RCS_MMS: RCS 이미지 문자 - RCS_TPL: RCS 텍스트 템플릿 - RCS_LTPL: RCS LMS 템플릿 - RCS_ITPL: RCS 이미지 템플릿 - ATA: 알림톡 - CTA: 친구톡 - CTI: 친구톡(이미지) - FAX: 팩스 - VOICE: 보이스 메시지 |
dateCreated | String | - | eq | 메시지 생성일시를 기준으로 조회합니다 |
dateUpdated | String | - | eq | 메시지 생성일시를 기준으로 조회합니다 |
dateType | String | - | eq | (범위 조회) 조회할 날짜의 타입 입니다. 기본값: CREATED - CREATED: 생성시간을 기준으로 조회 - UPDATED: 갱신시간을 기준으로 조회 |
startDate | String | - | eq | (범위 조회) 조회할 시작 날짜 입니다. |
endDate | String | - | eq | (범위 조회) 조회할 끝 날짜 입니다. |
startKey | String | - | eq | 현재 목록을 불러올 기준이 되는 키 값 입니다. |
limit | Number | - | eq | 한번에 조회할 데이터의 개수 입니다. 기본값: 20 |
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' |