# 配置请求地址

# 功能简介

请求地址用于接收开放平台向应用推送的事件消息。当应用订阅的事件发生时,开放平台会向该请求地址发送相应的 HTTP POST 请求。

注意:

  • 每个应用只能配置一个请求地址,该应用订阅的所有事件都会发送到该请求地址。
  • 请求地址必须是公网 IP 地址。

# 操作方式

# Step 1:配置验证请求的响应方式

在开发者后台,配置请求地址后,开放平台会向请求地址推送一个 application/json 格式的 POST 请求,该 POST 请求用于验证所配置的请求地址的合法性。该 POST 请求中会携带一个 challenge 字段,应用需要在 1 秒内,将接收到的 challenge 值原样返回给Bosshi开放平台。

业务方回传响应示例:

{       
    "challenge": "ajls384kdjx98XX"  
}
1
2
3

请注意: 开放平台会根据 Encrypt Key 的配置情况,决定推送给业务方的 POST 请求格式,与之对应业务方的处理方式也不同。

# 未配置 Encrypt Key(密钥信息)

如果没有设置 Encrypt Key,Bosshi开放平台会推送明文的 POST 请求:

{       
    "challenge": "ajls384kdjx98XX", // 应用需要在响应中原样返回的值       
    "token": "xxxxxx",              // 即 Verification Token      
    "type": "url_verification"      // 表示这是一个验证请求   
}
1
2
3
4
5

当请求地址收到开放平台推送的 POST 验证请求时,需要解析出 challenge 值,并在 1 秒内原样返回该该值作为响应。

{       
    "challenge": "ajls384kdjx98XX"  
} 
1
2
3

# 已配置 Encrypt Key(密钥信息)

如果配置了 Encrypt Key,Bosshi开放平台会推送加密后的 POST 请求。

{      
    "encrypt": "ds3da3sj32421lkkld4s5ao" // 加密字符串  
}
1
2
3

应用需要先解密,然后从解密后的内容中提取出 challenge 值,并在 1 秒内原样返回该值作为响应。有关解密方法的详细介绍,请参考接收并处理事件

解密后的 POST 请求示例:

{       
    "challenge": "ajls384kdjx98XX", // 应用需要在响应中原样返回的值       
    "token": "xxxxxx",              // 即 Verification Token      
    "type": "url_verification"      // 表示这是一个验证请求   
}
1
2
3
4
5

响应示例:

{       
    "challenge": "ajls384kdjx98XX"  
}
1
2
3

# Step 2:配置请求地址

  1. 登录开发者后台 (opens new window)

  2. 在应用列表中点击具体应用,进入应用管理详情页面。

  3. 进入 事件订阅 页面。定位到 请求地址配置 区域,点击 编辑 按钮。

  4. 输入请求地址后,点击 保存

    点击保存后,Bosshi开放平台便会向请求地址发送一个 POST 请求,验证请求地址的合法性。

最后更新于 : 6/8/2023, 1:27:57 PM