PIN/OTP (ワンタイムパスワード) を要求
詳細
PIN/OTP(ワンタイムパスワード)を要求するためには、Confirm API エンドポイントに対してPOSTメソッドでリクエストする必要があります。
エンドポイント URL: https://api.cpaas.symphony.rakuten.net/twofa/v1/request
メソッド: POST
HTTP ヘッダー
パラメーター | 要否 | 値 |
---|---|---|
Authentication | 必須 | Type: Bearer Token: JWT Token |
Accept | 必須 | application/json |
Content-Type | 必須 | application/json; charset=UTF-8 |
リクエストボディスキーマ: application/json
パラメーター | 要否 | 詳細/値 |
---|---|---|
to | 必須 | 送信先電話番号は下記の形式になります。国コード + 電話番号(MSISDN)
|
language | 必須 | 対応言語のセクションを参照してください。 例 英語: en_GB or en_gb 英語 : ja_JP or ja_jp |
outcome_url | 必須 | 後ほど利用するコールバックURLになります。ダミーの値を入力してください。 |
from | 条件付き必須 | T要件と設定に応じて、送信元IDまたは数字になりま す。デフォルトの送信元IDが登録されていない場合は、この値を指定する必要があります。 送信元 IDは各通信事業者に事前に登録または弊社担当者に確認 されている必要があります。送信元 ID の登録については担当者にお問い合わせください。送信元 ID が正しく登録されていない場合、SMS は端末へ配信されません。登録されている送信元 ID は全てダッシュボー ド上にて確認することができます。 |
api_key | 任意 | 認証時に使用されるAPIキーを参照用に入力することができます。 |
charge_profile | Optional | 下記請求プロファイルをご利用できます: br/>PAY_PER_REQUEST : リクエストの結果に関係なく、リクエストに対して定額料金を請求します。すべてのメッセージ費用が含まれています。 PAY_PER_CONVERSION : リクエストがPINで正常に確認された場合のみ、リクエストに対して定額料金を請求します。すべてのメッセージ費用が含まれています。 PAY_FOR_MESSAGES_PLUS_SERVICE_FEE : リクエストによって行われたすべての通話とメッセージに対する料金に加え、リクエストの結果に関係なくサービス料金を請求します。 PAY_FOR_MESSAGES_PLUS_CONVERSION_FEE :リクエストによって行われた通話と配信されたメッセージに対する料金に加え、リクエストがPINで正常に確認された場合、リクエストに対してサービス料金を請求します。 Default Charge Profile: PAY_FOR_MESSAGES_PLUS_CONVERSION_FEE |
customization | 任意 | 下記のパラメーターは、PIN要求をカスタマイズするために利用できます。 |
┗pin_length | デフォルト: 6 最低: 3 最大: 8 | |
┗message_text | ユーザーに送信されるカスタマイズされたメッセージ 例: あなたの認証コードは ${pin} | |
┗workflow | SMSワークフローのみ対応 デフォルト: sms | |
metadata | 任意 | 追跡するための追加のメタデータ |
┗client_reference | リクエストを追跡するためにクライアント参照値を送信することができます。 | |
例: client-ref-1 | ||
┗company_name | 参照用の企業名 |
サンプルリクエスト
{
"to": "81XXXXXXXXXX",
"outcome_url": "http://www.example.com",
"language": "en_GB",
"from": "81YYYYYYYYYY",
//These are optional parameters
"customization": {
"pin_length": "8",
"message_text": "Your pin code is: ${pin}",
"workflow": "sms"
},
//These are optional parameters
"metadata": {
"client_reference": "client-ref-1",
"company_name": "...Company ABC..."
}
}
レスポンス:
成功した場合は、APIの呼び出しに対するレスポンスがJson形式で 200 OKとなります。失敗時のレスポンスの詳細は“エラーコード”を参照してください
パラメーター | 詳細 |
---|---|
result_code | 結果コードを参照する |
result_message | 結果コードを参照する |
client_reference | クライアント証明書はリクエストで指定されたときのみ返されます。“client reference” は “Additional/Advanced Options” の下で確認することができます。 |
message_id | 自動的に生成されるID |
サンプルレスポンス
{
"success": true,
"result_code" : 0,
"result_message" : "Request successfully submitted",
"request_id" : "...auto-generated id...",
"client_reference": "...if provided during original request..."
}