API Reference

coolsms.php

coolsms.php 의 rest 클래스를 생성합니다. 아래와 같은 형태로 객체를 생성할 수 있습니다.

<?php
include "coolsms.php"
$rest = new rest($api_key, $api_secret);
$response = $rest->send($options);
$result = $response->getResult()

 

send (stdClass $options)

$options(stdClass object) 설정에 따른 문자를 발송합니다.

 

Parameters:

Mandatory Field Description
Ο 인증정보 인증데이터는 필수입니다. Authentication 참고
  to

수신번호 입력 콤마(,)로 구분된 수신번호 입력가능

예) 01012345678,01023456789,01034567890

  from 발신번호 예) 0212345678
  text 문자내용
  type

SMS(80바이트), LMS(장문 2,000바이트), MMS(장문+이미지) 입력 없으면 SMS가

기본 국가코드가 KR이 아니면 SMS로 강제

  image 지원형식 : 300KB 이하의 JPEG, PNG, GIF 형식의 파일 2048x2048 픽셀이하
  image_encoding 이미지 인코딩 방식 binary(Default), base64
  refname 참조내용(이름)
  country

한국: 82, 일본: 81, 중국: 86, 미국: 1, 기타 등등 (기본 한국)

http://countrycode.org 참고

  datetime

예약시간을 YYYYMMDDHHMISS 포맷으로 입력

(입력 없거나 지난날짜를 입력하면 바로 전송)

예) 20131216090510 (2013년 12월 16일 9시 5분 10초에 발송되도록 예약)

  subject LMS, MMS 일때 제목 (40바이트)
  charset

한글 인코딩 방식 지정 유니코드 UTF-8 일 경우 utf8 완성형 한글(EUC-KR) 일 경우

euckr 으로 입력 입력 없으면 utf8가 기본

  srk

솔루션 제공 수수료를 정산받을 솔루션 등록키

 Solution Registration Key(수익 배분프로그램 참고)

  mode

test로 입력할 경우 CARRIER 시뮬레이터로 시뮬레이션됨 수신번호를 반드시

01000000000 으로 테스트하세요. 예약필드 datetime는 무시됨 결과값은

60 잔액에서 실제 차감되며 다음날 새벽에 재충전됨

  extension JSON 포맷의 개별 메시지를 담을 수 있음
  delay 0~20 사이의 값으로 전송지연 시간을 줄 수 있음, 1은 약 1초 (기본값은 0)
  force_sms

누리고푸시를 사용하더라도 SMS로 발송되도록 강제

true 혹은 false(기본)

  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에서 추가됨)

 

Returns:

{
  "recipient_number": "01012345678",
  "group_id": "20120217103829612403761364",
  "result_code": "00",
  "result_message": "Success"
}

 

sent (stdClass $options)

발송 되었던 문자에 대한 정보를 가져옵니다.

 

Parameters:

Mandatory Field Description
O 인증정보 인증데이터는 필수입니다. Authentication 참고
  count 문자수 (기본값 20개)
  page

페이지 값

  s_rcpt

발송된 전화번호로 검색

  s_start 보낸 날짜 범위검색할때 시작 일시 설정
  s_end 보낸 날짜 범위검색할때 끝나는 일시 설정
  s_status 메시지상태로 검색
  s_resultcode 전송결과값으로 검색
  mid Message ID 로 검색
  gid Group ID 로 검색

 

Returns:

{
  "total_count":"169",
  "list_count":4,
  "page":1,
  "data":[
    {
      "type":"SMS",
      "accepted_time":"2014-01-07 18:14:54",
      "recipient_number":"01000000000",
      "group_id":"G52CBC596955F0",
      "message_id":"M52CBC59695B31",
      "status":"2",
      "result_code":"58",
      "result_message":"\uc804\uc1a1\uacbd\ub85c \uc5c6\uc74c",
      "sent_time":"201401071814",
      "text":"Test Message"
    }
   ]
}

   

balance (  )

자신의 계정의 남은 잔액과 포인트를 가져옵니다.

 

Parameters: None

 

Returns:

{
   "cash" : "10000",
   "point" : "4145"
}

   

cancel (stdClass $options)

예약문자를 취소한다.

 

Parameters:

Mandatory Field Description
O mid

Message ID 나 Group ID 둘중에 하나를 넣어야합니다.

  gid

 

    

Returns: None

 

발신번호 관련 리소스

register (stdClass $options)

* 보안상 문제로 현재는 제공하지 않습니다. 쿨에스엠에스 사이트에서 발신번호를 등록해 주세요

새로운 발신번호를 등록

 

Parameters:

Mandatory Field Description
O phone

발신번호

예) 021234567

  site_user

사이트 유저 아이디 입력, 미입력시 __private__ 으로 설정됩니다.

예) admin

 

Returns:

{
    "handle_key":"SID55DAD88A7E4EC",
    "ars_number":"01021382269"
}

 

verify (stdClass $options)

* 보안상 문제로 현재는 제공하지 않습니다. 쿨에스엠에스 사이트에서 발신번호를 등록해 주세요

발신번호가 제대로 인증되었는지 확인한다.

 

Parameters:

Mandatory Field Description
O handle_key register 호출 후 리턴받은 핸들값

 

Returns: None

 

delete (stdClass $options)

발신번호가 제대로 인증되었는지 확인한다.

 

Parameters:

Mandatory Field Description
O handle_key 발신번호 핸들값

 

Returns:None

 

get_senderid_list (stdClass $options)

발신번호가 제대로 인증되었는지 확인한다.

 

Parameters:

Mandatory Field Description
  site_user

사이트 유저 아이디 입력, 미입력시 __private__ 으로 입력됩니다.

예) admin

 

Returns:

[
    {"idno":"SID555C89C49627D","phone_number":"0809302266","flag_default":"Y","updatetime":"2015-06-12 10:21:06","regdate":"2015-05-20 22:19:00"},
    {"idno":"SID5568347CC1518","phone_number":"01012345678","flag_default":"N","updatetime":"2015-05-29 18:42:58","regdate":"2015-05-29 18:42:20"}
]

 

set_default (stdClass $options)

기본 발신번호를 지정한다.

 

Parameters:

Mandatory Field Description
O handle_key 발신번호 핸들값을 입력
  site_user

사이트 유저 아이디 입력, 미입력시 __private__ 으로 입력됩니다.

예) admin

 

Returns:

 

get_default (stdClass $options)

기본 발신번호로 설정된 번호를 가져온다.

 

Parameters:

Mandatory Field Description
  site_user

사이트 유저 아이디 입력, 미입력시 __private__ 으로 입력됩니다.

예) admin

 

 

Returns:

{
    "handle_key":"SID555C89C49627D",
    "phone_number":"0809302266"
}