跳到主要内容

回调通知说明

一. 回调说明

  • 回调地址: 在企业应用管理中的第三方应用中配置(配置方式可以参考下方回调 FAQ中的回调地址是否支持更改或删除问题), 合同相关的回调也可以在用PDF文件创建签署流程用模板创建签署流程的时候指定

  • 请求方式: 电子签平台的回调都是POST 请求, 如果得到的是GET请求,请确认回调地址是否存在http到https的转发

  • 回调成功条件: 一旦贵方给电子签平台返回httpcode 200, 电子签平台认为回调成功, 将不会再重发回调消息

  • 数据格式: JSON格式("Content-Type":"application/json")

  • 回调地址验证: 如果配置了回调 Url地址,但是没有收到回调通知,贵方可在外网环境用下方curl命令简单, 需要能够正常返回 httpcode 200表示可用 , 如下

curl  https://tsign.tencent.com/callback -H "Content-type: application/json" -X POST -d "{}"

# 需将https://tsign.tencent.com/callback 换成贵方配置的回调地址

如果没有回调通知, 建议日志记录一下接收到的请求, 方便排查问题。

项目说明
回调地址在企业应用管理中的第三方应用中配置(配置方式可以参考下方回调 FAQ中的回调地址是否支持更改或删除问题), 合同相关的回调也可以在用PDF文件创建签署流程用模板创建签署流程的时候指定
请求方式电子签平台的回调都是POST 请求, 如果得到的是GET请求,请确认回调地址是否存在http到https的转发
数据格式JSON格式请求("Content-Type":"application/json"),数据样式:{"encrypt":"base64后的密文"}
回调成功条件一旦贵方给电子签平台返回httpcode 200, 电子签平台认为回调成功, 将不会再重发回调消息

回调地址是否可用的验证方式

如果配置了回调 Url地址,但是没有收到回调通知,贵方可在外网环境用下方curl命令简单, 需要能够正常返回 httpcode 200表示可用 , 如下

curl  https://tsign.tencent.com/callback -H 'Content-type: application/json' -X POST -d '{"encrypt":"62KE4r5Wz0yHzEpMOwVRbM1KV0"}'

# 需将https://tsign.tencent.com/callback 换成贵方配置的回调地址

二. 回调场景

通知类型以 MsgType 做区分,按照回调通知类型主要分为:

三. 回调加密与校验

1. 回调消息加解密

回调加密 key

新建应用号时,如果配置了回调加密 key(可选参数),电子签的回调请求体会进行加密处理,需要客户使用配置的回调加密 key进行解密得到真正的回调消息。

注意:配置了回调加密 key即会开启消息加密,去掉即为关闭发送明文回调消息。建议开启加密确保数据安全。

解密步骤

  1. 对收到的数据{"encrypt":"base64后的密文"}中的base64后的密文进行 Base64 解码得到原始的密文
  2. 原始的密文进行对称解密,算法为 AES-256-CBC,密钥为腾讯电子签提供的 CallbackUrlKey,IV 取 CallbackUrlKey 值的前 16 位,数据采用 PKCS#7 填充。
  3. 解密得到的数据为输入参数的 Json 格式。

    解密代码可以参考 解密代码 demo

2. 回调消息校验

签名验证 token

新建第三方应用时,如果配置了 签名验证 token(可选参数),电子签的回调请求会在header中附带签名参数[Content-Signature],客户方用来验证请求来源确实电子签,保证安全性。

原理可参考:https://docs.github.com/en/developers/webhooks-and-events/webhooks/securing-your-webhooks

校验步骤

当贵方回调服务接收到回调时:

  1. 取出 header [Content-Signature]

  2. 验证签名, 验证代码如下, 如果验证通过,继续处理。如果不通过,忽略该请求

// payload_body 为接收到的消息体内容
// verify_token 为在第三方应用中配置的 "签名验证 token"
// content_signature 为从请求头部中取得的Content-Signature的值

def verify_signature(payload_body,content_signature,verify_token):

signature = 'sha256=' + OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha256'), verify_token, payload_body)

return halt 500, "Signatures didn't match!" unless Rack::Utils.secure_compare(signature, content_signature)

注意:payload_body为整个原始消息体(即:{"encrypt":"密文"}),请不要做任何更改。

四. 通用结构体

1. 明文回调消息结构体

如果未设置回调加密 key, 回调服务接收到的请求直接是这个结构体的json序列化

参数名称参数类型参数描述
MsgIdSting消息唯一ID, 为32为字符串, 用于唯一确定本消息
MsgTypeSting消息类型, 标识本消息是那个场景发送的, 如FlowStatusChange标识合同状态变更, 可以参考各个场景的回调
MsgVersionString消息版本,固定为 ThirdPartyApp
MsgData结构体消息数据, 各个消息类型的结构体不同, 可以参考各个场景的回调中MsgData结构体定义

2. 密文回调消息结构体

如果设置了回调加密 key , 回调服务接收到的请求是此密文回调消息结构体的json序列化, 解密后才是明文回调消息结构体json序列化

参数名称参数类型参数描述
encryptString加密后的消息体(需通过回调加密 key解密得到明文回调消息结构体json序列化)

五. 回调 FAQ

回调地址是否支持同时配置多个?

支持,回调地址一个每个第三方应用下只能有一个,根据您的需求不同的地址可以配置相同或者不同的 回调加密 key签名验证 token

回调地址是否支持更改或删除?

支持,您可以在控制台在企业应用管理中的第三方应用中配置中进行回调地址的配置。

第三方应用配置中心

回调配置后多长时间生效呢?

配置完成后立即生效, 如果修改了回调加密 key签名验证 token , 确保回调已经支持新这两个key。

为什么客户收到 ALL(合同签署完成)的回调通知后,又收到了PART(合同签署中)或者INIT(合同创建)的通知?

以单方签署的合同为例,FlowCallbackStatus 状态变化一般是由合同签署中或者合同创建变为合同签署完成。 少量回调可能因状态变化间隔比较短、重发、或者网络传输等原因,小几率出现到达顺序不一致,建议开发者从代码层面进行适当控制,例如状态更新为合同签署完成后不能再更新为合同签署中合同创建

电子签发送回调时超时时间是多久?

超时时间为 5 秒。

电子签发送回调失败后,回调最大重试次数是多少?重试机制是怎么样的呢?

回调的最大重试次数是 36 次;回调重试间隔随次数增加,具体如下:

1 秒、2 秒、3 秒、4 秒、5 秒、10 秒、15 秒、20 秒、25 秒、30 秒、35 秒、40 秒、45 秒、50 秒、55 秒、1 分、2 分、3 分、4 分、5 分、6 分、7 分、8 分、9 分、10 分、15 分、25 分、35 分、45 分、55 分、1 时、2 时、3 时、4 时、5 时、6 时

如果36次都失败, 电子签平台认为此消息无法回调会丢弃此消息

回调延时多长?

回调会在发生对应事件后立刻执行,涉及处理和网络请求等,一般会在几百毫秒的延时的样子。

具体延时时间取决于网络状况、服务器负载和其他因素。

如果您长时间未收到回调通知,请检查贵方的回调服务是否正常,如果正常的话可以联系客服人员进行处理。

六. 回调样例

1. 密文回调消息

POST /callback HTTP/1.1
Host: www.esstest.com
User-Agent: Go-http-client/1.1
Content-Length: xxx
Content-Type: application/json
Accept-Encoding: gzip

{"encrypt":"uXm2LDbslypT/mTXnKJynaj7riwJt356nGXvs/MszFshjs591sgduXpQpYXGNfox6U3Mk65Q+vCOo8CAHoMgVJVHEJl1ZmHvR1ocYNvquuVcwOK+/QN4zuH1NbkEtACLsVFgmG/B9L9pV3+i6u/uCTcFFF6LyxcgB4V7OHBwRoOUSLi/LqBTshNstW5W/mDzBPZUwed9e3Kk1Cmt7VUn+z22kyF0AoHuGuvUtVId7n+TAda7eTSty6nkFtxXk/DhvZPMeFXyN61aOa8nKSdL9bAosjjkrMYevlWhDsGeINDtSjLNmkzlEs9ZpOEMCHy8bG9vHMRuyFdW1hjBBTM/Tw=="}

此处使用 回调加密 key: TencentEssEncryptTestKey12345678 ,参考解密代码Demo解密后可获取以下明文:

!该 回调加密 key 仅用于此处测试样例。

{
"MsgId": "yDwf4UUckpsjeox1URAyCMBHv7W1zDbP",
"MsgType": "OrgAuth",
"MsgVersion": "ThirdPartyApp",
"MsgData": {
"ApplicationId": "yDwftUUckpsrmwz5UEfbpqAAAAAAAAAA",
"ProxyOrganizationOpenId": "MockOpenId",
"ProxyOperatorOpenId": "MockUserOpenId",
"AuthSuccess": true
}
}

2. 明文回调消息

POST /callback HTTP/1.1
Host: www.esstest.com
User-Agent: Go-http-client/1.1
Content-Length: xxx
Content-Type: application/json
Accept-Encoding: gzip

{"MsgId":"yDwf4UUckpsjeox1URAyCMBHv7W1zDbP","MsgType":"OrgAuth","MsgVersion":"ThirdPartyApp","MsgData":{"ApplicationId":"yDwftUUckpsrmwz5UEfbpqAAAAAAAAAA","ProxyOrganizationOpenId":"MockOpenId","ProxyOperatorOpenId":"MockUserOpenId","AuthSuccess":true}}
购买咨询
微信客服
4006-808-062
4006-808-062