Overview
쿨에스엠에스의 REST API Reference 내용을 담고 있습니다.
참고 REST는 Representational State Transfer의 약자로 API 연동 규격을 명확하게 정의되고 쉽게 구현 할 수 있습니다. https://ko.wikipedia.org/wiki/REST
쿨에스엠에스 SMS REST API 서버로 Request를 보내기 위해서 인증을 거쳐야 합니다.
API Key 를 이용한 방법과 소셜로그인으로 불리우는 OAuth 2.0 을 지원하고 있습니다.
https://api.coolsms.co.kr/<ServiceName>/<Version>/<ResourcePath>
<ServiceName>
- 서비스 이름(messages, kakao, cash, senderid, ...)
<Version>
- 서비스 버전
<ResourcePath>
- 필요시 특정 리소스 경로를 나타냅니다
API Request 시 파라메터 값과 Response 의 데이터 값은 JSON 형식으로 합니다. 모든 Request 에 Content-type 을 application/json 으로 설정하여 주세요.
Operator(이하 오퍼레이터)는 COOLSMS에서 제공하는 고급 기능으로써 특정 정보를 검색하고자 URL Query Parameter를 사용할 때 자세하고 질 높은 Query를 작성할 수 있도록 도와줍니다. 또한 API를 통해 COOLSMS 서비스를 이용하고자 할 경우 숙지해야 될 기능입니다.
오퍼레이터는
eq
, ne
, like
, gte
, lte
, gt
, lt
총 7가지 종류가 있습니다.이름 | 설명 |
| 어떤 오퍼레이터도 사용하지 않았다면 eq를 사용했을 때와 같은 일을 수행합니다. |
eq | Eqaul |