문자 전송내역 목록 조회(Search) API를 호출하는 경우 반환되는 응답항목에 대해 안내드리겠습니다. 요청 URI Query String 항목과 응답전문 항목에 대한 설명을 참조하여 연동개발을 진행하시기 바랍니다.
목록 조회(Search) API 요청정보
요청정보를 구성하는 URI Query String은 다음과 같이 구성됩니다.
| 항목명 | 변수명 | 타입 | 필수 | 비고 |
|---|---|---|---|---|
| 시작일자 | SDate | String |
○ |
작성형태 yyyyMMdd |
| 종료일자 | EDate | String |
○ |
작성형태 yyyyMMdd |
| 전송상태값 배열 | State | Array | – |
[배열] 1-대기, 2-성공, 3-실패, 4-취소 |
| 검색대상 배열 | Item | Array | – | [배열] SMS, LMS, MMS |
| 예약여부 | ReserveYN | Boolean | – | true-예약전송건 조회 |
| 개인조회 여부 | SenderYN | Boolean | – | true-개인조회 |
| 페이지 번호 | Page | Number | – | 조회 페이지 번호 |
| 페이지당 검색개수 | PerPage | Number | – | 기본값 500, 최대값 1000 |
| 정렬방향 | Order | String | – | ‘A’ : 오름차순, ‘D’ : 내림차순(기본값) |
목록 조회(Search) API 응답항목
응답전문은 요청결과정보와 (세금)계산서 상태정보 배열로 구성됩니다.
| 항목 | 변수명 | 타입 | 설명 |
|---|---|---|---|
| 상태코드 | code | Number | 요청에 대한 응답 상태코드 |
| 메시지 | message | String | 요청에 대한 응답 메시지 |
| 총 검색결과 건수 | total | Number | |
| 페이지당 검색개수 | perPage | Number | 기본값 500, 최대값 1000 |
| 페이지 번호 | pageNum | Number | |
| 페이지 개수 | pageCount | Number | |
| 전송내역 정보 배열 | list | Array | 전송내역 배열, 최대 1000건 |
| 전송상태 코드 | ㄴstate | String | [참고] 문자전송 결과코드 안내 |
| 전송결과 코드 | ㄴresult | String | [참고] 문자전송 결과코드 안내 |
| 메시지 제목 | ㄴsubject | String | |
| 메시지 내용 | ㄴcontent | String | |
| 발신번호 | ㄴsendNum | String | |
| 수신번호 | ㄴreceiveNum | String | |
| 수신자명 | ㄴreceiveName | String | |
| 접수일시 | ㄴreceiptDT | String | 표시형식, yyyyMMddHHmmss |
| 예약일시 | ㄴreserveDT | String | 표시형식, yyyyMMddHHmmss |
| 전송결과 수신일시 | ㄴresultDT | String | 표시형식, yyyyMMddHHmmss |
| 문자유형 | ㄴtype | String | |
| 전송처리 이동통신사명 | ㄴtranNet | String |
지금까지 문자 API의 전송내역 조회(Search) API에 대해 안내해 드렸습니다. 문자 API에 대한 자세한 사항은 [ 링크허브 자료실 > 문자 API 연동매뉴얼 ] 참조하시기 바랍니다.
고객님들의 편의를 위하여 이메일, 전화 등 다양한 채널을 열어놓고 있으니 언제든지 연락주시기 바랍니다.
링크허브 개발팀 정요한 과장 / T.1600-9854 / D. 070-4304-2991/ E. code@linkhub.co.kr