認証コード

認証コード生成配信

認証コード生成配信を登録します。<br> 宛先電話番号を指定して、認証コードを配信します。

post/api/v1/verification_codes/deliveries

Request

  • Base URL: https://sandbox.cpaasnow.com
  • URL: https://sandbox.cpaasnow.com/api/v1/verification_codes/deliveries
  • Auth: HTTP bearer

Request body

tostring required

宛先電話番号<br> 配信する電話番号を指定します。<br> <b>channelの設定によらない共通の仕様</b>

  • 先頭に「+81」を指定した場合「0」に変換されます。
  • ハイフンを含めることはできません。
  • 海外キャリアには配信できません。<br>
  • 0120と0570から始まる10桁の番号はフリーダイヤルであるため、音声もSMSも配信できません。

<b>channel を sms に設定した場合</b>

  • 060、070、080、090から始まる11桁の番号、または020から始まる11桁か14桁の番号に配信できます。<br>
  • 0800から始まる11桁の番号には配信できません。<br>

<b>channel を voice に設定した場合</b>

  • 060、070、080、090から始まる11桁の番号、または050から始まる11桁の番号、または0から始まる10桁の番号に配信できます。
channel'sms' | 'voice' required

配信方法<br> smsでSMSによる配信、voiceで音声による配信が行われます<br>

messagestring required

配信メッセージ<br> {{verification_code}}と{{expiration_minutes}}が必須です。<br> {{verification_code}}は認証コードに置換されます。<br> {{expiration_minutes}}は認証コードの有効期間(分)に置換されます。<br> {{verification_code}}と{{expiration_minutes}}以外の{{}}で囲まれた文字列は入力できません。<br> その他の文字列はそのまま配信されます。<br> {{verification_code}}と{{expiration_minutes}}の置換後の情報を含めて70文字以下にしてください。<br> 本文の文字数は、UTF-16のコードユニット数で判定します。UTF-8のバイト数や文字数ではありません。<br> 改行コードは全てCRLFに変換され、2文字でカウントされます。<br> <br> <b>channel を voice に設定した場合の注意点</b><br>

  • メッセージは1度の通話で最大2回再生します<br>
  • 音声による読み上げを行う場合、漢字やアルファベットなど読み方によって通話時間が変化いたします。<br>
  • 実際の音声サンプル<br>
<table> <thead> <tr> <th>項目</th> <th>内容</th> </tr> </thead> <tbody> <tr> <td>本文</td> <td><code>お客様の認証コードは8466です。この番号を入力してください。このコードは他人に教えないでください。60分間有効です。</code></td> </tr> <tr> <td>文字数</td> <td>59文字</td> </tr> <tr> <td>音声サンプル</td> <td> <audio controls preload="metadata" style="width: 300px; margin: 8px 0;"> <source src="./audios/voice_verification_sample.mp3" type="audio/mpeg"> <a href="./audios/voice_verification_sample.mp3">サンプル音声をダウンロード</a> </audio> </td> </tr> </tbody> </table><br>
code_type'alphanumeric' | 'numeric' required

認証コード文字種<br> 認証コードの文字種を指定します。<br> alphanumericで半角英数字、numericで半角数字の認証コードが生成されます。

code_sizeinteger required

認証コード文字数<br> 認証コードの文字数を指定します。

expiration_minutesinteger required

有効期限<br> 認証コードの有効期限(分)を指定します。<br> <br> ※「配信の受付日時 + 5分」または「配信の完了日時」のどちらか小さいほうを有効期限のスタート時刻とします。

user_referencestring nullable

ユーザー識別子<br> リクエスト時に指定可能な識別子です。<br> フォールバック配信結果取得APIのレスポンス、Webhookでのフォールバック配信結果通知にて同じ値が返却されます。<br> 使用可能文字は半角英数字 、 -(半角ハイフン)、 _(半角アンダースコア)です。

bill_split_codestring nullable

請求明細分割コード<br> 請求明細を分割コード毎に作成します。<br> 使用可能文字は半角英数字 、 -(半角ハイフン)、 _(半角アンダースコア)です。

Response

Accepted

delivery_order_idinteger required

配信オーダーID

accepted_atstring date-time required

配信オーダーの受付日時

Changes

No recorded changes to this operation across all 1 revision of this API.