Webhook 技术对接说明

Webhook 技术对接说明

Webhook 通道及参数配置

通道参数 描述 定义配置处
请求地址 您开发的 HTTP Server地址 webhook-通道管理-基本信息-请求地址
用户属性 参数名称需要配置,值自动从用户属性中获取 webhook-通道管理-用户属性
模板参数 参数名称需要配置,值从计划配置中获取 webhook-通道管理-模板参数

如下图:
image-1

HTTP Endpoint Server

为与个推用户运营的 Webhook 对接,您需要开发一个 HTTP Server。其应遵循的 API 定义见下文。

Webhook Request

  • 请求地址: webhook-通道管理中填写的请求地址
  • 请求方式: POST

Header参数说明

名称 类型 是否必须 说明
x-app-id String 个推APPID
x-id-type String 发送ID类型,现在只有gtcid一种

body参数说明

  • content-type:application/json;charset=utf-8

  • 参数示例

[
  {
    "id": "gtcid",
    "user_property": {
      "name": "Chen",
      "age": 20
    },
    "model_property": {
      "a": "AAA",
      "b": 2
    },
    "plan_info": {
      "plan_id": "PLAN_2024-03-08_3ea26b568bc844a1be98ad09acbfe26c",
      "node_id": "8d4ede33-52ad-4b28-8f76-f3676421576a",
      "report_date": "2024-03-08"
    }
  }
]
  • 请求参数说明
  • Request Body 是一个 LIST,每个元素是一个单用户触发的 JSON 结构,详情如下:
名称 类型 是否必须 默认值 描述
id String ID的值
user_property Json 用户属性,对应webhook-通道管理-用户属性
model_property Json 模板参数,对应webhook-通道管理-模板参数
plan_info Json 流程画布信息(测试时无此内容)
  • user_property 说明
JSON构成 说明
KEY 用户属性-参数名称
VALUE 用户属性-属性参数对应的值
  • model_property 说明
JSON构成 说明
KEY 模板参数-参数名称
VALUE 模板参数-参数值
  • plan_info 说明
名称 类型 是否必须 默认值 描述
plan_id String 计划ID
node_id String 节点ID
report_date String 日期,格式:yyyy-MM-dd

Webhook Response

满足以下要求,个推用户运营认为发送成功。

  • HTTP Status Code: 大于等于200且小于300
  • ContentType: application/json; charset=utf-8
  • ContentLength: 大于0

文档中心搜索

技术
咨询

微信扫一扫

随时联系技术支持

在线
咨询