GetFlowPreviewUrl を使用した WhatsApp フローのプレビュー URL の取得 - Chat App

操作説明

WhatsApp フローを作成した後、この操作を呼び出してフローのプレビュー URL を取得できます。
この操作を呼び出す前に、WhatsApp フローが正常に作成されていることを確認してください。
WhatsApp フローがない場合は、CreateFlow 操作を呼び出して作成できます。

QPS 制限

この操作は、ユーザーごとに 1 秒あたり 5 クエリ (QPS) に制限されています。この制限を超えると、API 呼び出しはスロットルされます。これはビジネスに影響を与える可能性があります。それに応じて呼び出しを計画してください。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

cams:GetFlowPreviewUrl

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
FlowId	string	必須	フロー ID。これは、WhatsApp フローを作成するときに CreateFlow 操作によって返される FlowId です。	333993838***
CustSpaceId	string	任意	独立系ソフトウェアベンダー (ISV) のサブカスタマーのスペース ID、またはダイレクトカスタマーのインスタンス ID です。[チャネル管理] ページでスペース ID を表示します。	cams-kei****

レスポンスフィールド

フィールド	型	説明	例
	object	返されたデータ。
AccessDeniedDetail	string	アクセス拒否に関する詳細。	None
RequestId	string	リクエスト ID。	90E63D28-E31D-1EB2-8939-A94866411B2O
Message	string	エラーメッセージ。	None
Data	object	返されたデータオブジェクト。
FlowId	string	フロー ID。	92675332812643****
PreviewUrl	string	一時的なプレビュー URL。	https://business.facebook.com/****
PreviewUrlExpires	integer	プレビュー URL の有効期限。	1700617436633
Code	string	エラーコード。詳細については、「エラーコード」をご参照ください。	OK

例

成功レスポンス

JSONJSON

{
  "AccessDeniedDetail": "None",
  "RequestId": "90E63D28-E31D-1EB2-8939-A94866411B2O",
  "Message": "None",
  "Data": {
    "FlowId": "92675332812643****",
    "PreviewUrl": "https://business.facebook.com/****",
    "PreviewUrlExpires": 1700617436633
  },
  "Code": "OK"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	Product.Unsubscript	You have not subscribed to the specified product.
400	Ram.PermissionDeny	You are not authorized to perform the operation.
400	System.LimitControl	The system is under flow control.
400	Unknown.ResourceOwnerId	The resource does not belong to the current user.

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

変更履歴

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