CPaaS NOW

このセクションではCPaaS NOWのAPIを利用するための共通仕様について説明します。

リクエスト

すべてのAPIアクセスはHTTPS経由で行われ、すべてのデータはJSON形式で受信されます。

Authorization : Bearer YOUR_API_TOKEN
Content-Type  : application/json

レスポンス

すべてのデータはJSON形式で送信されます。

稼働時間は、平日9:00から24:00で稼働しております。
予期せぬ事態で一時的に利用できない場合がございます。
利用できない際にはお手数ですが、お問い合わせください。
お問い合わせ受付時間は平日9:00から17:00となっております。

※ 開発環境から実際にSMSやEメールの配信はできません。
※ 稼働時間外のアクセスは、503エラーが表示される可能性があります。
※ 短時間での大量入力テストは行わないようお願いいたします。
※ 本番環境と同等のセキュリティは担保されておりません。
※ ハードウェア、ソフトウェア、設定等が本番と異なる部分がございます。

テスト用宛先に配信いただくことで、予め用意された結果を返却します。
開発環境では実際にSMSやEメールを配信することはできませんので 動作確認にはテスト用宛先一覧をご利用ください。

※この番号は本番環境では、利用できません。

SMS

※ その他の携帯番号について配信結果は保証されません

Eメール

※ その他のメールアドレスについて配信結果は保証されません

テスト用認証コードを利用することで、予め用意された結果を返却します。
開発環境では実際に認証コードを配信することはできませんので 認証確認APIの動作確認にはテスト用認証コードをご利用ください。

※ その他の認証コードについて認証結果は保証されません
※ 電話番号は結果に関わりません

各APIに記載しておりますcurlのサンプルは、Windowsではそのまま利用できない場合があります。

例えば、コマンドプロンプトで実施する場合は以下のように修正して実行してください

1. コマンドを複数行に分割して書く場合、行末は\の代わりに^を使用します。
   
2. リクエストボディを送信する場合、ボディ全体を''の代わりに""で囲みます。
   
3. リクエストボディに"が含まれる場合、ダブルクオーテーションを\でエスケープします。
   
4. リクエストボディに日本語が含まれる場合は、2,3の代わりにリクエストボディだけをテキストファイルにUTF-8で保存し、-d @リクエストファイル名を指定します。

フォールバック配信登録APIの場合、以下のようになります。

curl "https://sandbox.cpaasnow.com/api/v1/fallback_deliveries" ^
  -X POST ^
  -d "{\"deliveries\": [{\"channel\": \"sms\",\"to\": \"09001111101\",\"text\": \"My new message\"},{\"channel\": \"email\",\"to\": {\"name\": \"To Name\",\"address\": \"success@example.com\"},\"from\": {\"name\": \"From Name\",\"address\": \"from_address@example.com\"},\"reply_to\": {\"name\": \"Reply_to Name\",\"address\": \"reply_to_address@example.com\"},\"subject\": \"Email subject\",\"text\": \"Email text\"}],\"user_reference\": \"sample\",\"bill_split_code\": \"bill_split_code-1\"}" ^
  -H "Authorization:Bearer YOUR_API_TOKEN" ^
  -H "Content-Type: application/json"

リクエストボディに日本語が含まれる場合、以下のようになります。

curl "https://sandbox.cpaasnow.com/api/v1/fallback_deliveries" ^
  -X POST ^
  -d @request.json ^
  -H "Authorization:Bearer YOUR_API_TOKEN" ^
  -H "Content-Type: application/json"

その際のrequest.jsonの内容は以下のようになります。

{"deliveries": [{"channel": "sms","to": "09001111101","text": "My new message"},{"channel": "email","to": {"name": "To Name","address": "success@example.com"},"from": {"name": "From Name","address": "from_address@example.com"},"reply_to": {"name": "Reply_to Name","address": "reply_to_address@example.com"},"subject": "【●●ショップ】会員登録ありがとうございます","text": "※このメールはシステムからの自動返信です\r\n●●様\r\n..."}],"user_reference": "sample","bill_split_code": "bill_split_code-1"}

携帯電話番号を指定して、SMSメッセージを配信します。

メールアドレスを指定して、Eメールを配信します。

1つの送信リクエストで、最大2つの宛先への送信を試みる機能です。
2つのチャネル、宛先情報を入力することで、1番目の宛先が失敗した場合、
CPaaS NOW 側で自動に2番目の宛先への送信処理を行います。

携帯電話番号を指定して、認証コードを配信します。

CPaaS NOW APIのイベントを貴社で用意されたURLに送信します。
デフォルトで全てのイベントを送信する設定になっています。
受け取りを希望しない場合はログイン後の設定画面より設定してください。
レスポンスはHTTPステータス200を返してください。
レスポンスのHTTPステータスが200系以外の場合、 5回まで同内容のイベントを再送します。
再送間隔は10分となります。