SMS API Version 2
이 문서는 REST기반의 문자메시지(국내,해외문자,알림톡,친구톡) API로 예약 문자를 포함한 문자전송, 전송된 문자의 상태 확인, 잔액정보 및 예약취소 등의 작업을 요청하는 방법을 기술하고 있습니다. PHP, Java, Python, Delphi, C 등 다양한 언어로 구현된 샘플을 SDK 페이지에서 제공하고 있습니다..
인증을 위한 API Key 및 API Secret 코드는 문자메시지 > 환경설정 > API Key 관리 메뉴에서 발급 및 관리가 가능합니다. API Key 관리 문서를 참고하세요.
아래는 각 Resource의 역할을 테이블로 정리하였습니다. 상세한 설명을 보시려면 해당 Resource를 클릭하여 주세요.
Part | Resource | Description |
그룹메시지 | 그룹 생성 | |
그룹 목록 | | |
그룹 삭제 | | |
그룹 정보 리턴 | | |
메시지 추가 | | |
JSON형식으로 메시지 추가 | | |
추가된 메시지 목록 | | |
메시지 삭제 | | |
메시지 발송 | | |
이미지 | 이미지 업로드 | |
이미지 목록 | | |
이미지 정보 | | |
이미지 | | |
기타 | 문자발송 요청 | |
발송된 문자정보 조회 | | |
예약문자 취소 | | |
전액정보 조회 | | |
전송채널 상태 조회 | |
Version | Description |
1.1 | Android 누리고 푸시 지원
1만건 전송을 40초 이하로 단축 후불제 회원 지원 |
1.2 | iOS 누리고 푸시 지원
1만건 전송을 20초 이하로 단축 |
1.3 | 쿨서포터즈 정책 지원 반영 |
1.4 | status 리소스에 시간별, 일별 전송현황을 위한 date, unit 필드 추가 |
1.5 | Agent 정보 전송 |
1.6 | 카카오 알림톡 기능 추가 |
2.0 | 그룹 메시징 추가 |
대용량의 메시지를 안전하고 빠르게 전송하도록 그룹메시지를 위한 API를 제공합니다.
아래의 API 호출 흐름으로 대량의 그룹메시지를 보낼 수 있습니다.
new_group -> add_messages -> send
new_group 호출로 메시지를 담을 그룹을 생성하고 리턴된 그룹아이디를 키로 add_messages 호출로 메시지를 접수하고 send 호출로 접수된 메시지를 서버단에 전송을 수행합니다. 이로 인해 한번 접수된 메시지는 유실 없이 안정적으로 발송이 보장됩니다.
메시지를 담을 그룹을 생성하여 그룹아이디를 리턴합니다.
Mandatory | Field | Description |
Ο | 인증정보 | |
| charset | 한글 인코딩 방식을 지정합니다.
유니코드 UTF-8 일 경우 utf8,
완성형 한글(EUC-KR) 일 경우 euckr 으로 입력,
입력 없으면 utf8가 기본 |
| srk | |
| mode (현재 미지원) | test로 입력할 경우 CARRIER 시뮬레이터로 시뮬레이션됩니다. ** 수신번호를 반드시 01000000000 으로 테스트 **
예약필드 datetime는 무시됩니다. 결과값은 60 잔액에서 실제 차감되며 다음날 새벽에 재충전됩니다. |
| force_sms (현재 미지원) | 누리고푸시를 사용하더라도 강제로 문자 발송. true 혹은 false(기본) |
| only_ | 알림톡이 실패해도 문자메시지로 대체하여 발송하지 않습니다.
true 혹은 false(기본) |
| site_user | API를 호출하는 사이트에서 관리하는 유저 아이디 입력. 미입력시 __private__ 으로 입력됩니다.
해당 아이디 앞으로 등록된 발신번호를 확인합니다.
발신번호 등록 API를 참고하세요.
http://developer.coolsms.co.kr/SenderID_API |
| os_platform | 클라이언트의 OS 및 플랫폼 버전 예) CentOS 6.6 (v1.5에서 추가됨) |
| dev_lang | 개발 프로그래밍 언어 예) PHP 5.3.3 (v1.5에서 추가됨) |
| sdk_version | SDK 버전 예) PHP SDK 1.5 (v1.5에서 추가됨) |
| app_version | 어플리케이션 버전 예) Purplebook 4.1 (v1.5에서 추가됨) |
JSON 포맷으로 리턴 됩니다.
Mandatory | Field | Description |
O | group_id | 그룹 아이디 |
curl -XGET 'https://api.coolsms.co.kr/sms/2/new_group?api_key=NCS52A57F48C3D32&signature=202b4d499fbd71813c170a415f84097a×tamp=1456364125'
{
"group_id":"565ba3d7d216a"
}
생성된 그룹 목록을 리턴합니다.
Mandatory | Field | Description |
Ο | 인증정보 |
JSON 포맷으로 리턴 됩니다.
Mandatory | Field | Description |
O | - | array 형식의 그룹아이디 목록 리턴 |
curl -XGET 'https://api.coolsms.co.kr/sms/2/group_list?api_key=NCS52A57F48C3D32&signature=202b4d499fbd71813c170a415f84097a×tamp=1456364125'
[
"565ba3d7d216a",
"565ba3dea161b"
]
그룹을 삭제합니다. 담겨 있는 메시지도 함께 삭제됩니다.
Mandatory | Field | Description |
Ο | 인증정보 | |
O | group_ids | 삭제할 그룹 아이디 콤마(,)로 구분된 아이디 목록 입력 가능 |
JSON 포맷으로 리턴 됩니다.
Mandatory | Field | Description |
O | success_count | 삭제된 그룹 갯수 |
O | error_count | 오류 처리된 그룹 갯수 |
O | error_list | 오류 내역
["{인덱스}": "{오류코드}", ...] 형식 |
curl -XPOST 'https://api.coolsms.co.kr/sms/2/delete_groups' -d 'api_key=NCS52A57F48C3D32&signature=202b4d499fbd71813c170a415f84097a×tamp=1456364125&group_ids=565ba3d7d216a'
{
"success_count": 3,
"error_count": 2,
"error_list": [
4: "62",
5: "54"
]
}
그룹 정보를 리턴합니다.
Mandatory | Field | Description |
Ο | 인증정보 | |
O | group_id | 그룹 아이디 |
JSON 포맷으로 리턴 됩니다.
Mandatory | Field | Description |
O | group_id | 그룹 아이디 |
O | message_count | 그룹에 담긴 메시지 갯수 |
curl -XGET 'https://api.coolsms.co.kr/sms/2/groups/{group_id}' -d 'api_key=NCS52A57F48C3D32&signature=202b4d499fbd71813c170a415f84097a×tamp=1456364125&group_id=565ba3d7d216a'
{
"group_id":"565ba3d7d216a",
"message_count":970
}
그룹에 발송할 문자메시지를 추가합니다.
Mandatory | Field | Description |
Ο | 인증정보 | |
O | to |