英語仕様書(オフィシャル)

https://docs.cmtelecom.com/en/one-time-passwords-otp/v1.0


この翻訳はSMS認証専用APIの翻訳になります。

一般的な送信については

Business messaging パートをご覧ください

【翻訳済】SMS配信API仕様書


日本語翻訳は英語版を抜粋して翻訳したものですので、英語版の補助的な資料としてご覧ください。多少の表記の違いやバージョンの違いがござますので、その場合には英語バージョンを参照ください


また、本APIには記載のない、SMS到達不到達のステータスレポート取得希望の場合にはStatus report webhookをご利用いただけます

こちらをご覧ください



Introduction

With the OTP API you can generate one time passwords and verify the response.

Protect your organisation and users against fraudulent login attempts and potential catastrophic effects on your business. CM.com offers a unique Hybrid Two-factor, One Time Password solution that can be delivered via our high quality SMS routes or to your app via Push.

How to start:
1. Register for an account at https://www.cm.com/register/
2. Retrieve your API product token via the ‘Messaging Gateway’ app at https://www.cm.com/app/gateway/

Version 1.0
The Base URL is https://api.cmtelecom.com

HTTP Headers:
X-CM-ProductToken – your product token (string)

前書き

OTP APIでは、ワンタイムパスワードの生成とレスポンスの認証ができます。

CM.comはSMSまたはアプリのプッシュ通知へ配信できる独自のハイブリッド二段階認証/ワンタイムパスワードを提供しています。二段階認証は、あなたの組織を脅かす不正ログインやその他の脅威からビジネスを守ることができます。


始め方

1. CM.comへ登録し、アカウントを作成する https://www.cm.com/register/
※上記サイトは英語での登録となりますので、日本法人では担当営業が代理でアカウント作成をおこなっています。ご希望の際は担当営業へご連絡ください。
2. Messagin Gateway アプリからAPIのプロダクトトークンを取得してください。 https://www.cm.com/app/gateway/

バージョン1.0
ベースURLは https://api.cmtelecom.comです

OTP API end points

Generate code

POST /v1.0/otp/generate

Content-Type: application/json

OTP APIエンドポイント

コードを生成する

POST /v1.0/otp/generate

コンテンツタイプ:application / json

 

Parameters:

required

·       recipient (string) – phone number in international format. e.g. 0031601234567

·       sender (string) – name of the sender (min 3, max 11)

Please note that alphanumeric sender is not supported in all countries.

optional

·       length – length of the code (min 4, max 10, integer) (default = 5)

·       expiry – expiry in seconds (min 10, max 3600, integer) (default = 60 seconds)

·       allowPush (boolean) – Allow code to be send via push notification (default = false)

·       appKey – The app key GUID

·       message – Set a custom message. You can use the placeholder {code} which will be replaced by the actual code. e.g. Your code is: {code}

When allowPush is set to true, a valid app key is required

Example:

{

“recipient”: “0031601234567”,

“sender”: “My company”

}

Response:

  “id”: “1e12cb10-d14a-4cd6-8d86-e5263cf122ee”,

  “createdAt”: “2015-01-01T13:00:00+0000”,

  “expireAt”: “2015-01-01T13:01:00+0000”

}

 

パラメーター:

必須

•recipient(string)-受信者。国際形式の電話番号。 例えば 0031601234567

•sender(string)-送信者の名前(英数字にて最小3文字、最大11文字にて設定できます。頭は必ずアルファベットにしてください

一部の国では英数字の送信者がサポートされていないことに注意してください。詳しくは担当者にご確認ください。

オプション

•length-コードの長さ(最小4、最大10、整数)(デフォルト= 5)

•expiry-秒単位の有効期限(最小10、最大3600、整数)(デフォルト= 60秒)

•allowPush(boolean)-プッシュ通知を介したコードの送信を許可します(デフォルト= false)

•appKey-アプリキーGUID

•message-カスタムメッセージを設定します。 実際のコードで置き換えられるプレースホルダー{code}を使用できます。 例えば あなたのコードは:{code}

allowPushがtrueに設定されている場合、有効なアプリキーが必要です

Example:

{

“recipient”: “0031601234567”,

“sender”: “My company”

}

Response:

  “id”: “1e12cb10-d14a-4cd6-8d86-e5263cf122ee”,

  “createdAt”: “2015-01-01T13:00:00+0000”,

  “expireAt”: “2015-01-01T13:01:00+0000”

}

 

 

 

Verify code

POST /v1.0/otp/verify

Content-Type: application/json

コード認証

POST /v1.0/otp/verify

コンテンツタイプ:application / json

Parameters:
required

·       id – code identifier (string)

·       code – the code (string)

 

パラメーター:

必須

•id-コード識別子(string)

•code-コード(string)

Example:

{

“id”: “1e12cb10-d14a-4cd6-8d86-e5263cf122ee”,

“code”: “12345”

}

Response:

{

  “valid”: true

}

Please note: once a code has been successfully validated, it cannot be validated again.

 

HTTP status codes

200 = OK

400 = Validation Error (Invalid request, see message in the response)

422 = Unprocessable Entity (Could not send OTP, see message in the response)

500 = Internal Server Error (Unknown error occurred)

HTTPステータスコード

200 = OK

400 =検証エラー(無効な要求。応答のメッセージを参照)

422 =処理できないエンティティ(OTPを送信できませんでした。応答のメッセージを参照)

500 =内部サーバーエラー(不明なエラーが発生しました)  

Sample codes

Generate code

In this way you can generate a code.

サンプルコード

コードを生成する

この方法で、コードを生成できます。

※英語版のsamplecodeをご覧くださいhttps://docs.cmtelecom.com/one-time-passwords-(otp)/v1.0

 

 

Verify code

In this way you can verify a code.

※英語版のsamplecodeをご覧くださいhttps://docs.cmtelecom.com/en/one-time-passwords-otp/v1.0 

コード確認

この方法で、コードを検証できます。

※英語版のsamplecodeをご覧ください

https://docs.cmtelecom.com/en/one-time-passwords-otp/v1.0