SMS API
SMS API は、SMSメッセージを送信・キャンセル・状態取得などをするためのAPIです。このAPIを使用することで、アプリケーションから直接SMSメッセージを操作することができます。
REST APIとは
SMS API はREST API で構築されています。
APIは「Application Programming Interface」の略で、プログラム経由でアプリケーションにアクセスや資源を操作するIFのことを言います。
RESTは「Representational State Transfer」と呼ばれ、統一的に定義されたステートレスなインターフェースを利用し、HTTP通信によってアプリケーションにアクセスしてその中のデータを利用します。
一般的には、POST、GET、PUT、GET のメソッドを採用しています。『Karaden』 も原則同様のものを採用しています。（SMS API は POST と GET のみ）
エンドポイント
APIにアクセスするためのURI（エンドポイント）は下記のとおりです。
認証
API への HTTP リクエストは、 HTTP 基本認証 で保護されます。
Karaden IDとトークンを作成し、API実行時に トークンを 付与して認証を行います。
SMSでAPIでメッセージを送信する。
『Karaden』の SMS API は、メッセージをプログラムで送信および管理するのに役立ちます。
- API を使用してSMSメッセージを送信するには、SMS 送信APIにPOSTリクエストを送ります。
- また、SMS APIを使用して、 メッセージを取得し 、アカウントに関連付けられている メッセージを確認することもできます。
この API を使用すると、次のことができます。
- 新しいメッセージを送信する：SMS送信
- 送信結果の一覧を取得する：SMS送信結果取得(一括)
- 送信結果をレコード単位で取得する：SMS送信結果取得(レコード単位)
- SMS送信をキャンセルする：SMS送信キャンセル
- サービス設定で指定されているエンドポイントへSMS送達結果を通知する：SMS送信結果返信（コールバック）
プログラミングにてAPIを実行する場合は上記の各仕様のほかに、SMS API共通仕様を参考に実装をお願いします。
インストール無しでのクイックスタート
インストールやプログラミングを利用せずお試しで送信したい場合は下記を参照ください。
ヘルパー ライブラリを活用してメッセージを送受信する
SMS API を使用すれば、Web アプリケーションから直接メッセージを送信できます。
プログラミング不要でお試しの送信を行いたい場合はこちらの記事を参照してください。
サポートされているヘルパー ライブラリ のいずれかを使用してこれを行う方法の詳細な手順については、次の SMS クイックスタートをご覧ください。