WhatsApp API uploadenvent

根据数据集ID上报CAPI广告数据

根据数据集ID上报CAPI广告数据。

• URL：/v1/wa/m/ads/uploadenvent
• Method：POST
• Content-Type：application/json
• 需要鉴权：是

鉴权机制

鉴权规则请参考地址：API接口调用约定

请求参数

header参数：

参数名	类型	必选	示例值	说明
accessKey	String	是	fme2na3kdi3ki	用户身份标识
ts	String	是	1655710885431	当前请求的时间戳（单位是毫秒），牛信服务端允许用户端请求最大时间误差为60秒
bizType	String	是	2	WhatsApp业务类型，取固定值“2”
action	String	是	uploadenvent	WhatsApp业务操作，取固定值“uploadenvent”
sign	String	是	6e9506557d1f289501d333ee2c365826	API入参参数签名，签名算法

body参数：

参数名	类型	必选	示例值	说明
phone	String	是	86158xxx1795	商户的WhatsApp号码列表，需要带国码,如185xxx99
messaging_product	String	是	whatsapp	发送消息的通道，应用于WhatsApp消息的发送时，值必须为“whatsapp”
version	String	是	v18.0	要调用的api版本
datasetId	String	是	228279***1111	数据集ID
data	Array[adsInfo]	是		上传的广告数据列表

请求示例

body（application/json） 参数：

{
    "phone": "18506008399",
    "messaging_product": "whatsapp",
    "version": "v18.0",
    "datasetId": "2282***693501",
    "data": [
        {
            "event_name": "Purchase",
            "event_time": 1705047463,
            "action_source": "business_messaging",
            "messaging_channel": "whatsapp",
            "user_data": {
                "page_id": "10948****38973",
                "ctwa_clid": "ARDwXUV2rAPUHcGzOz2WxqPKs0NciAjV3WZUqoDWIAn*******Vb2vucgvOpcXbmtHeR0LuLjNGru3bhV5"
            },
            "custom_data": {
                "currency": "USD",
                "value": 0
            }
        }
    ]
}

data中的字段含义请参考： https://developers.facebook.com/docs/marketing-api/conversions-api/business-messaging?locale=zh_CN

响应参数

参数名	类型	说明
code	Integer	结果编码
data	resultInfo	请求结果
message	String	请求结果说明

• resultInfo object参数：

参数名	类型	说明
data	resultInfo object	业务数据

• resultInfo object参数：

参数名	类型	说明
data	dataInfo	数据集列表

• dataInfobject参数：

参数名	类型	说明
success	boolean	true

响应示例

成功示例

{
  "code": 0,
  "message": "Success",
  "data": {
    "success": true
  },
  "traceId": "a0385a44d8***8618a41438053e3"
}

失败示例

{
  "code": 0,
  "message": "Success",
  "data": {
    "error": {
      "message": "Invalid parameter",
      "type": "OAuthException",
      "code": 100.0,
      "error_subcode": 2804072.0,
      "is_transient": false,
      "error_user_title": "消息事件的 Page Id 和 Ctwa Clid 参数不匹配",
      "error_user_msg": "对于 CTWA 事件，应使用与“page_id”参数相同的编号来生成“ctwa_clid”参数。请在用户数据中提供匹配的“page_id”和“ctwa_clid”值。",
      "fbtrace_id": "AWFyjZy01okmhmXRNstyG8t"
    }
  },
  "traceId": "689053bf61fe4157a21e4b7e46c1995f"
}

响应码说明

code	message	解决办法
0	请求成功
400	请求失败	请联系技术人员排除问题