メインコンテンツへスキップ
  1. Karaden SMS API サポート
  2. スタートアップガイド
  3. SMS

PHPクイックスタート

  • 更新

はじめに

PHPライブラリは、PHPで書かれたアプリケーションから『Karaden SMS API』へ簡単にアクセスするための手段を提供します。
それにはAPIレスポンスから動的に初期化するAPIリソースの一連のクラス定義が含まれているため、『Karaden SMS API』の幅広いバージョンと互換性があります。
 
 

動作環境

PHP 7.4～
 
 

パッケージマネージャについて

本ライブラリはパッケージマネージャとしてcomposerを利用することを想定しています。
 
 

言語ライブラリのダウンロード

composerがインストールされている環境で、下記のコマンドを実行してください。
composer require karaden-prg/karaden-prg-php
※Windows環境で実行する場合、シンボリックリンクエラーが発生する場合があります。その場合はWSL2の利用をご検討ください。
 
このライブラリはHTTPクライアントを抽象化するライブラリであるHTTPlugを使用しています。
使用する環境に合わせ、いずれかのHTTPlugのクライアント/アダプタをインストールする必要があります。
例えばGuzzleの7.xを使用する場合、下記を実行する必要があります。
 
composer require php-http/guzzle7-adapter
 
 

使い方

このライブラリを使用するには、『Karaden SMS API』でテナントを作成し、プロジェクト毎に発行できるトークンを発行し、サービスを登録する必要があります。
作成したテナントID（テナントIDはテナント選択画面で表示されています）は、`Config::$tenantId`に、発行したトークンは`Config::$apiKey`に、サービスIDは`withServiceId`にそれぞれ設定します。
 
\Karaden\Config::$apiKey = '<トークン>';
\Karaden\Config::$tenantId = '<テナントID>';

$params = \Karaden\Param\Message\MessageCreateParams::newBuilder()
    ->withServiceId(<サービスID>)
    ->withTo('09012345678')
    ->withBody('本文')
    ->build();

try {
    $message = \Karaden\Model\Message::create($params);
} catch ( Exception $e ) {
    $error_obj = $e->error;
    $error_code = $error_obj->getCode() ?? "";
    $error_message = $error_obj->getMessage() ?? "";
    echo "Error Code: " . $error_code . PHP_EOL;
    echo "Error Message: " . $error_message . PHP_EOL;
}

※本コードはSMS送信部分の概念を切り出したものです。実際のコードについては次のサンプルコードを参照下さい。

 

 

サンプルコード

下記を参照ください。
 

関連記事