Send OTP API

ユーザーへ認証コード（OTP）を送信します。実装前に API共通仕様を確認してください。

標準設定では、ユーザーの電話番号のみを指定すれば、Unimatrixが安全な数値の認証コードを自動生成し、その時点で利用可能な配信経路を選択して認証メッセージを送信します。

定義

Action: otp.send
HTTP Method: POST
Content-Type: application/json

リクエストパラメータ

Name	Type	Required	Description	Example
to	string	Yes	認証先の電話番号。E.164形式	+12068800123
digits	integer	No	生成する認証コードの桁数。4〜8。既定値: `6`	6
intent	string	No	認証コードの利用目的。異なる認証シナリオの識別に利用します。最大36文字	login
channel	string	No	使用する認証チャネル。`sms`、`call`、`whatsapp`、`auto` のいずれか。既定値: `auto`	auto
code	string	No	自動生成の代わりに使用するカスタム認証コード。4〜8桁の数字文字列。 * 推奨しません。カスタム認証コードの利用はセキュリティ低下の要因になり得ます。	123456
ttl	integer	No	カスタム認証コードの有効期限（秒）。最大 `1800`。既定値: `300`	300

リクエスト例

以下の例では、認証コードを自動生成し、ユーザーの電話番号へ送信します。

curl -X POST 'https://api.unimtx.com/?action=otp.send&accessKeyId=YOUR_ACCESS_KEY_ID' \
-H 'Content-Type: application/json' \
-d '{
  "to": "+120688001xx"
}'

認証コードの送信後は Verify OTP API を利用して、ユーザーが入力した認証コードの妥当性を確認してください。

レスポンスパラメータ

Name	Type	Description	Example
code	string	戻り値コード	0
message	string	戻り値メッセージ	Success
data	JSON	結果

Results `data`

Name	Type	Description	Example
id	string	メッセージID	e7f51d2e5550131c3acc7fbc84e9901b
to	string	認証対象の電話番号（E.164）	+12068800123
iso	string	国コード（ISO2）	US
cc	string	国番号	1
parts	integer	分割通数	1
price	string	利用額	0.018900

レスポンス例

成功レスポンス例

Status Code: 200, Response Body:

{
  "code": "0",
  "message": "Success",
  "data": {
    "id": "e7f51d2e5550131c3acc7fbc84e9901b",
    "to": "+12068800123",
    "iso": "US",
    "cc": "1",
    "parts": 1,
    "price": "0.018900"
  }
}

失敗レスポンス例

Status Code: 400, Response Body:

{
  "code": "107111",
  "message": "InvalidPhoneNumbers"
}