Archive for the 'sms' Category

CakePHP - Clickatell api for sending sms

Friday, February 9th, 2007

I use the clickatell api for sending sms with cakephp. All I did was to grab a php class for the clickatell api which is shown below:

PLAIN TEXT
PHP:
  1. class sendsmsComponent extends Object
  2. {
  3.  
  4. var $api_id = "your_clickatell_api_id";
  5. var $user = "your_clickatell_username";
  6. var $password = "you_clickatell_password";
  7. var $use_ssl = false;
  8.  
  9. /**
  10. * Define SMS balance limit below class will not work
  11. * @var integer
  12. */
  13. var $balace_limit = 0;
  14.  
  15. /**
  16. * Gateway command sending method (curl,fopen)
  17. * @var mixed
  18. */
  19. var $sending_method = "fopen";
  20. var $unicode = false;
  21.  
  22. /**
  23. * Optional CURL Proxy
  24. * @var bool
  25. */
  26. var $curl_use_proxy = false;
  27. var $curl_proxy = "http://127.0.0.1:8080";
  28. var $curl_proxyuserpwd = "login:secretpass";
  29.  
  30. /**
  31. * Callback
  32. * 0 - Off
  33. * 1 - Returns only intermediate statuses
  34. * 2 - Returns only final statuses
  35. * 3 - Returns both intermediate and final statuses
  36. * @var integer
  37. */
  38. var $callback = 0;
  39. var $session;
  40. var $batch;
  41.  
  42. /**
  43. * Class constructor
  44. * Create SMS object and authenticate SMS gateway
  45. * @return object New SMS object.
  46. * @access public
  47. */
  48.  
  49. function startup(&$controller)
  50. {
  51. // This method takes a reference to the controller which is loading it.
  52. // Perform controller initialization here.
  53.  
  54. if ($this->use_ssl) {
  55. $this->base            = "http://api.clickatell.com/http";
  56. $this->base_s        = "https://api.clickatell.com/http";
  57. $this->base_batch    = "http://api.clickatell.com/http_batch";
  58. $this->base_s_batch    = "https://api.clickatell.com/http_batch";
  59.  
  60. } else {
  61. $this->base            = "http://api.clickatell.com/http";
  62. $this->base_s        = $this->base;
  63. $this->base_batch   = "http://api.clickatell.com/http_batch";
  64. $this->base_s_batch = $this->base_batch;
  65.  
  66. }
  67. $this->_auth();
  68. }
  69.  
  70. /*
  71. function sms () {
  72. if ($this->use_ssl) {
  73. $this->base   = "http://api.clickatell.com/http";
  74. $this->base_s = "https://api.clickatell.com/http";
  75. } else {
  76. $this->base   = "http://api.clickatell.com/http";
  77. $this->base_s = $this->base;
  78. }
  80. $this->_auth();
  81. }
  83. */
  84.  
  85. /**
  86. * Authenticate SMS gateway
  87. * @return mixed  "OK" or script die
  88. * @access private
  89. */
  90. function _auth() {
  91. $comm = sprintf ("%s/auth?api_id=%s&user=%s&password=%s", $this->base_s, $this->api_id, $this->user, $this->password);
  92. $this->session = $this->_parse_auth ($this->_execgw($comm));
  93. }
  94.  
  95. /**
  96. * Query SMS credis balance
  97. * @return integer  number of SMS credits
  98. * @access public
  99. */
  100. function getbalance() {
  101. $comm = sprintf ("%s/getbalance?session_id=%s", $this->base, $this->session);
  102. return $this->_parse_getbalance ($this->_execgw($comm));
  103. }
  104.  
  105. /**
  106. * Send SMS message
  107. * @param to mixed  The destination address.
  108. * @param from mixed  The source/sender address
  109. * @param text mixed  The text content of the message
  110. * @return mixed  "OK" or script die
  111. * @access public
  112. */
  113. function send($to=null, $from=null, $text=null) {
  114.  
  115. /* Check SMS credits balance */
  116. if ($this->getbalance() <$this->balace_limit) {
  117. die ("You have reach the SMS credit limit!");
  118. };
  119.  
  120. /* Check SMS $text length */
  121. if ($this->unicode == true) {
  122. $this->_chk_mbstring();
  123. if (mb_strlen ($text)> 210) {
  124. die ("Your unicode message is to long! (Current lenght=".mb_strlen ($text).")");
  125. }
  126. /* Does message need to be concatenate */
  127. if (mb_strlen ($text)> 70) {
  128. $concat = "&concat=3";
  129. } else {
  130. $concat = "";
  131. }
  132. } else {
  133. if (strlen ($text)> 465) {
  134. die ("Your message is to long! (Current lenght=".strlen ($text).")");
  135. }
  136. /* Does message need to be concatenate */
  137. if (strlen ($text)> 160) {
  138. $concat = "&concat=3";
  139. } else {
  140. $concat = "";
  141. }
  142. }
  143.  
  144. /* Check $to and $from is not empty */
  145. if (empty ($to)) {
  146. die ("You not specify destination address (TO)!");
  147. }
  148. if (empty ($from)) {
  149. die ("You not specify source address (FROM)!");
  150. }
  151. $from = $this->_custom_encode($from);
  152.  
  153. /* Reformat $to number */
  154. $cleanup_chr = array ("+", " ", "(", ")", "\r", "\n", "\r\n");
  155. $to = str_replace($cleanup_chr, "", $to);
  156.  
  157. /* Send SMS now */
  158. $comm = sprintf ("%s/sendmsg?session_id=%s&to=%s&from=%s&text=%s&callback=%s&unicode=%s%s",
  159. $this->base,
  160. $this->session,
  162. $from,
  163. $this->encode_message($text),
  164. $this->callback,
  165. $this->unicode,
  166. $concat
  167. );
  168. $myvar = $this->_parse_send ($this->_execgw($comm));
  169. return $myvar;
  170. }
  171.  
  172. function sendbatch($to=null, $from=null, $text=null){
  173. /* Check SMS credits balance */
  174. if ($this->getbalance() <$this->balace_limit) {
  175. die ("You have reach the SMS credit limit!");
  176. };
  177.  
  178. /* Check SMS $text length */
  179. if ($this->unicode == true) {
  180. $this->_chk_mbstring();
  181. if (mb_strlen ($text)> 210) {
  182. die ("Your unicode message is to long! (Current lenght=".mb_strlen ($text).")");
  183. }
  184. /* Does message need to be concatenate */
  185. if (mb_strlen ($text)> 70) {
  186. $concat = "&concat=3";
  187. } else {
  188. $concat = "";
  189. }
  190. } else {
  191. if (strlen ($text)> 465) {
  192. die ("Your message is to long! (Current lenght=".strlen ($text).")");
  193. }
  194. /* Does message need to be concatenate */
  195. if (strlen ($text)> 160) {
  196. $concat = "&concat=3";
  197. } else {
  198. $concat = "";
  199. }
  200. }
  201.  
  202. /* Check $to and $from is not empty */
  203. if (empty ($to)) {
  204. die ("You not specify destination address (TO)!");
  205. }
  206. if (empty ($from)) {
  207. die ("You not specify source address (FROM)!");
  208. }
  209. $from = $this->_custom_encode($from);
  210.  
  211. /* get batchID now */
  212. $comm = sprintf ("%s/startbatch?session_id=%s&template=%s&callback=%s&unicode=%s%s",
  213. $this->base_batch,
  214. $this->session,
  215. $this->encode_message($text),
  216. $this->callback,
  217. $this->unicode,
  218. $concat
  219. );
  220. $this->batch = $this->_batchID ($this->_execgw($comm));
  221.  
  222. $comm = sprintf ("%s/quicksend?session_id=%s&batch_id=%s&to=$to&from=$from",
  223. $this->base_batch,
  224. $this->session,
  225. $this->batch
  226. );
  227. $myvar = $this->_parse_sendbatch ($this->_execgw($comm));
  228. return $myvar;
  229. }
  230.  
  231. /**
  232. * Encode message text according to required standard
  233. * @param text mixed  Input text of message.
  234. * @return mixed  Return encoded text of message.
  235. * @access public
  236. */
  237. function encode_message ($text) {
  238. if ($this->unicode != true) {
  239. //standard encoding
  240. //return rawurlencode($text);
  241. return $this->_custom_encode($text);
  242. } else {
  243. //unicode encoding
  244. $uni_text_len = mb_strlen ($text, "UTF-8");
  245. $out_text = "";
  246.  
  247. //encode each character in text
  248. for ($i=0; $i<$uni_text_len; $i++) {
  249. $out_text .= $this->uniord(mb_substr ($text, $i, 1, "UTF-8"));
  250. }
  251.  
  252. return $out_text;
  253. }
  254. }
  255.  
  256. /**
  257. * Unicode function replacement for ord()
  258. * @param c mixed  Unicode character.
  259. * @return mixed  Return HEX value (with leading zero) of unicode character.
  260. * @access public
  261. */
  262. function uniord($c) {
  263. $ud = 0;
  264. if (ord($c{0})>=0 && ord($c{0})<=127)
  265. $ud = ord($c{0});
  266. if (ord($c{0})>=192 && ord($c{0})<=223)
  267. $ud = (ord($c{0})-192)*64 + (ord($c{1})-128);
  268. if (ord($c{0})>=224 && ord($c{0})<=239)
  269. $ud = (ord($c{0})-224)*4096 + (ord($c{1})-128)*64 + (ord($c{2})-128);
  270. if (ord($c{0})>=240 && ord($c{0})<=247)
  271. $ud = (ord($c{0})-240)*262144 + (ord($c{1})-128)*4096 + (ord($c{2})-128)*64 + (ord($c{3})-128);
  272. if (ord($c{0})>=248 && ord($c{0})<=251)
  273. $ud = (ord($c{0})-248)*16777216 + (ord($c{1})-128)*262144 + (ord($c{2})-128)*4096 + (ord($c{3})-128)*64 + (ord($c{4})-128);
  274. if (ord($c{0})>=252 && ord($c{0})<=253)
  275. $ud = (ord($c{0})-252)*1073741824 + (ord($c{1})-128)*16777216 + (ord($c{2})-128)*262144 + (ord($c{3})-128)*4096 + (ord($c{4})-128)*64 + (ord($c{5})-128);
  276. if (ord($c{0})>=254 && ord($c{0})<=255) //error
  277. $ud = false;
  278. return sprintf("%04x", $ud);
  279. }
  280.  
  281. /**
  282. * Spend voucher with sms credits
  283. * @param token mixed  The 16 character voucher number.
  284. * @return mixed  Status code
  285. * @access public
  286. */
  287. function token_pay ($token) {
  288. $comm = sprintf ("%s/http/token_pay?session_id=%s&token=%s",
  289. $this->base,
  290. $this->session,
  291. $token);
  292.  
  293. return $this->_execgw($comm);
  294. }
  295.  
  296. /**
  297. * Execute gateway commands
  298. * @access private
  299. */
  300. function _execgw($command) {
  301. if ($this->sending_method == "curl")
  302. return $this->_curl($command);
  303. if ($this->sending_method == "fopen")
  304. return $this->_fopen($command);
  305. die ("Unsupported sending method!");
  306. }
  307.  
  308. /**
  309. * CURL sending method
  310. * @access private
  311. */
  312. function _curl($command) {
  313. $this->_chk_curl();
  314. $ch = curl_init ($command);
  315. curl_setopt ($ch, CURLOPT_HEADER, 0);
  316. curl_setopt ($ch, CURLOPT_RETURNTRANSFER,1);
  317. curl_setopt ($ch, CURLOPT_SSL_VERIFYPEER,0);
  318. if ($this->curl_use_proxy) {
  319. curl_setopt ($ch, CURLOPT_PROXY, $this->curl_proxy);
  320. curl_setopt ($ch, CURLOPT_PROXYUSERPWD, $this->curl_proxyuserpwd);
  321. }
  322. $result=curl_exec ($ch);
  323. curl_close ($ch);
  324. return $result;
  325. }
  326.  
  327. /**
  328. * fopen sending method
  329. * @access private
  330. */
  331. function _fopen($command) {
  332. $result =