获取Flow预览URL。
接口说明
- 
您在创建 WhatsApp Flow 后,可通过此接口获取流程预览 URL,以预览您的流程。
 - 
在调用此接口前,请确保您已有成功创建的 WhatsApp Flow。
 - 
若您没有已成功创建的 WhatsApp Flow,可调用 CreateFlow 接口创建 WhatsApp Flow。
 
QPS 限制
本接口的单用户 QPS 限制为 5 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
        
            调试
        
    
授权信息
| 
                                 操作  | 
                            
                                 访问级别  | 
                            
                                 资源类型  | 
                            
                                 条件关键字  | 
                            
                                 关联操作  | 
                        
| 
                                 cams:GetFlowPreviewUrl  | 
                            
                                 get  | 
                            
                                     *全部资源 
  | 
                            无 | 无 | 
请求参数
| 
                             名称  | 
                        
                             类型  | 
                        
                             必填  | 
                        
                             描述  | 
                        
                             示例值  | 
                    
| FlowId | 
                             string  | 
                        
                             是  | 
                        
                             流程 ID,即为在创建 WhatsApp Flow 时通过 CreateFlow 接口返回的 FlowId。  | 
                        
                             333993838***  | 
                    
| CustSpaceId | 
                             string  | 
                        
                             否  | 
                        
                             ISV 子客户的 SpaceId/直客客户实例 ID。在 通道管理 界面查看 Space ID。  | 
                        
                             cams-kei****  | 
                    
返回参数
| 
                             名称  | 
                        
                             类型  | 
                        
                             描述  | 
                        
                             示例值  | 
                    
| 
                             object  | 
                        
                             返回数据。  | 
                        ||
| AccessDeniedDetail | 
                             string  | 
                        
                             访问被拒绝详细信息。  | 
                        
                             None  | 
                    
| RequestId | 
                             string  | 
                        
                             请求 ID。  | 
                        
                             90E63D28-E31D-1EB2-8939-A94866411B2O  | 
                    
| Message | 
                             string  | 
                        
                             错误描述信息。  | 
                        
                             None  | 
                    
| Data | 
                             object  | 
                        
                             返回数据对象。  | 
                        |
| FlowId | 
                             string  | 
                        
                             Flow ID。  | 
                        
                             92675332812643****  | 
                    
| PreviewUrl | 
                             string  | 
                        
                             临时预览链接。  | 
                        
                             https://business.facebook.com/****  | 
                    
| PreviewUrlExpires | 
                             integer  | 
                        
                             预览 URL 的过期时间。  | 
                        
                             1700617436633  | 
                    
| Code | 
                             string  | 
                        
                             错误码。更多详情请参见错误码。  | 
                        
                             OK  | 
                    
示例
正常返回示例
JSON格式
{
  "AccessDeniedDetail": "None",
  "RequestId": "90E63D28-E31D-1EB2-8939-A94866411B2O",
  "Message": "None",
  "Data": {
    "FlowId": "92675332812643****",
    "PreviewUrl": "https://business.facebook.com/****",
    "PreviewUrlExpires": 1700617436633
  },
  "Code": "OK"
}
            错误码
| 
                                 HTTP status code  | 
            				
                                 错误码  | 
            				
                                 错误信息  | 
            				
                                 描述  | 
            			
|---|---|---|---|
| 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. | 资源不属于当前用户。 | 
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。