EnableWhatsappROIMetric - 开启Whatsapp ROI指标统计

开启Whatsapp相关指标统计。

接口说明

  • 在通过 API 方式获取 WhatsApp 类型通道的号码发送量指标,或 Marketing 类型模板的相关指标之前,您需要先调用此接口开启 Whatsapp ROI 指标统计。

  • 开启 Whatsapp ROI 指标统计后,至少需一天才会有指标统计数据,开启前的消息发送量指标和 Marketing 类型模板的相关指标将不进行统计。

  • 开启 Whatsapp ROI 指标统计后,您可调用 GetChatappPhoneNumberMetric 接口查询号码的发送量指标、调用 GetChatappTemplateMetric 接口查询 Marketing 类型模板的相关指标。

QPS 限制

本接口的单用户 QPS 限制为 5 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

cams:EnableWhatsappROIMetric

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

IsvCode

string

ISV 校验码,用于校验子账号是否由 ISV 授权。

skdi3kksloslikd****

CustSpaceId

string

ISV 子客户的 SpaceId/实例 ID。即通道 ID,在通道管理界面查看。

cams-************

返回参数

名称

类型

描述

示例值

object

返回数据。

AccessDeniedDetail

string

访问被拒绝详细信息。

None

RequestId

string

请求 ID。

608F9CCA-B5EB-3D72-8047-B25D6D75BDEC

Message

string

错误提示信息。

None

Code

string

请求状态码。取值:

  • OK:代表请求成功。

  • 其他错误码,请参见 API 错误码

OK

示例

正常返回示例

JSON格式

{
  "AccessDeniedDetail": "None",
  "RequestId": "608F9CCA-B5EB-3D72-8047-B25D6D75BDEC\n",
  "Message": "None",
  "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. 资源不属于当前用户。

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情