跳到主要内容

自定义事件上报

最后更新:2024/05/28

自定义事件请求

调用方式

  • 请求方式: POST
  • 请求地址: https://www.allapp.link/v2/event/srv-custom

请求头参数(Header)

参数必须说明
Content-Typeapplication/json声明json格式
AuthorizationBearer AppKeyAppKey 获取方式:访问密钥

请求内容参数(Body)

请求示例:

{
"project": "项目ID",
"request_id": "uuid",
"timestamp": 1696867200000,
"msg_signature": "请求签名",
"event": "自定义事件名称",
"user_data": {
"blackbox": "blackbox",
"user_id": "user_id"
},
"custom_data": [
{
"key": "自定义事件参数键1","value": "自定义事件参数值1"
},
{
"key": "自定义事件参数键2","value": "自定义事件参数值2"
}
]
}

参数说明

参数必须类型说明
projectstring智链Dashboard后台项目管理页中获取到的项目ID
request_idstring请求唯一id
timestampint64当前时间戳(毫秒)
msg_signaturestringsha1(project+"_"+request_id+"_"+timestamp+"_"+AppSecret)
AppSecret获取方法:AppSecret
eventstring智链Dashboard后台[事件管理页]中定义的EVENT
user_dataobject用户数据
user_data.blackboxstringblackbox, TurboLink定义的终端编码
user_data.user_idstring用户id
custom_data[]object自定义事件数据参数键值对
custom_data.keystring自定义事件参数键
custom_data.valuestring自定义事件参数值

返回示例

{
"code": 200,
"msg": "请求成功",
"data": {
"link_hash_id": "MtwUCV4LxYd7L7V5EUkVom",
"blackbox": "cob6i06rdj7vtortk6o0743701"
}
}

返回参数说明

参数类型说明
codeint32返回状态码 200为成功返回
msgstring返回状态码信息
dataobject返回内容
data.link_hash_idstring归因中的所属链接hash
data.blackboxstringblackbox, TurboLink定义的终端编码

返回编码(code)说明

返回编码说明
200成功
20000通过系统检索错误
20001请求过多
10104参数错误
10105AppKey验证错误,请检查AppKey在HTTPS请求里的Headers设置 AppKey使用
10106AppSecret验证错误,请参考 msg_signature 字段说明
10107API重复请求,上报事件时每次的RequestID都需要不一样
10201上报的事件不存在,需要到Dashboard添加自定义事件
10501blackbox不存在
10502设备不存在
10601没有找到与用户关联的设备信息