결과조회 API
- 잔여건수 조회발송가능한 단문,장문,그림 문자 건수를 조회하실 수 있습니다.
- 최근전송내역 조회발송한 문자내역을 조회하실 수 있습니다.
- 전송결과 조회메세지ID를 기준으로 문자결과를 조회하실 수 있습니다.
Base URL
| 잔여건수 | https://apis.aligo.in/remain/ |
|---|---|
| 최근발송내역 | https://apis.aligo.in/list/ |
| 문자전송결과 | https://apis.aligo.in/sms_list/ |
Request format
전세계 언어를 지원하기 위해 UTF-8인코딩을 사용합니다.
* [M] Mandatory:필수 [O] Optional:옵션
| Parameter | M/O | TYPE | Description |
|---|---|---|---|
| userid | M | Char | 사용자ID ex) userid=alipeople |
| key | M | Char | API Key ex) key=zt5p0p7c6we0w7cw9zccjuagcxyh8q5x |
| mid | M | Char | 메세지ID(sms_list 해당) |
| page | O | Integer | 페이지 수(list, sms_list 해당) |
| page_size | O | Integer | 페이지당 결과갯수 |
Request Response format
Request 에 대한 Response 를 통해 전송요청에 대한 성공/실패 여부를 확인 할 수 있으며, 단말기 도착여부는 Report를 통해 확인 할 수 있습니다.
* [M] Mandatory:필수 [O] Optional:옵션
| Parameter | M/O | TYPE | Description |
|---|---|---|---|
| result_code | M | Char | 결과코드 |
| message | M | Char | 결과 메세지 |
| SMS_CNT | O | Integer | 발송가능한 단문 잔여건수 (remain 해당) |
| LMS_CNT | O | Integer | 발송가능한 장문 잔여건수 (remain 해당) |
| MMS_CNT | O | Integer | 발송가능한 그림문자 잔여건수 (remain 해당) |
| list | O | Array | 결과 목록 (list, sms_list 해당) |
| next_yn | O | Char | 다음 결과목록 유무 (list, sms_list 해당) - Y : 다음페이지 있음 , N : 다음페이지 없음(마지막) |
Response Return Code
Request 에 대한 Response 를 통해 요청에 대한 성공/실패 여부를 확인 할 수 있습니다.
* [M] Mandatory:필수 [O] Optional:옵션
| Status | code | Description(Message) |
|---|---|---|
| SUCCESS | 1 | 조회성공(success) |
| FAILURE | -100 | 서버에러 |
| INVALID | -101 | 필수입력 부적합 |
| INVALID | -102 | 인증 에러 |
| UNKNOWN | -900 | 알려지지 않은 에러 |
Example
| curl_send.html | 문자발송 예제 |
|---|---|
| curl_remain.html | 발송가능 잔여건수 조회 예제 |
| curl_list.html | 최근발송한 내역 조회 예제 |
| curl_sms_list.html | 문자전송결과 조회 예제 |
PHP용 API 예제를 다운로드 하실 수 있습니다. PHP용 예제 다운로드
