SmsConversion による OTP メッセージステータスのレポート - SMS

操作説明

メトリクス：

リクエストされた OTP メッセージ
検証済みの OTP メッセージ

OTP コンバージョン率は、次の数式に基づいて計算されます：OTP コンバージョン率 = 検証済みの OTP メッセージ数 / リクエストされた OTP メッセージ数。

説明

SmsConversion 操作を呼び出して OTP コンバージョン率をクエリすると、ビジネスに影響が及ぶ可能性があります。次の操作を実行することを推奨します：

キューまたはイベントを設定して、SmsConversion 操作を非同期で呼び出します。
手動でサービスをデグレードするか、サーキットブレーカーを使用してサービスを自動的にデグレードします。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dysms:SmsConversion

update

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
MessageId	string	任意	OTP メッセージの ID。	1008030300****
Delivered	boolean	必須	顧客が OTP メッセージに返信したかどうかを指定します。有効な値は true と false です。	true
ConversionTime	integer	任意	OTP メッセージが配信された時刻。値は UNIX タイムスタンプです。単位：ミリ秒。このパラメーターを空のままにした場合、デフォルトで現在のタイムスタンプが指定されます。このパラメーターを指定する場合、タイムスタンプはメッセージ送信時刻より後で、かつ現在のタイムスタンプより前である必要があります。	1349055900000
To	string	任意	受信者の携帯電話番号。携帯電話番号の先頭に国番号を追加する必要があります。詳細については、「国番号」をご参照ください。	8521245567****

レスポンスフィールド

フィールド	型	説明	例
	object
ResponseCode	string	ステータスコード。OK が返された場合、リクエストは成功です。詳細については、「エラーコード」をご参照ください。	OK
ResponseDescription	string	ステータスコードの説明。	OK
RequestId	string	リクエストの ID。	F655A8D5-B967-440B-8683-DAD6FF8D****

例

成功レスポンス

JSONJSON

{
  "ResponseCode": "OK",
  "ResponseDescription": "OK",
  "RequestId": "F655A8D5-B967-440B-8683-DAD6FF8D****"
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。