跳到主要内容

模板相关回调

一. 模板新增通知

1. 回调触发时机

① 子客在子客控制台手动新增

② 子客领用模板库的模板

③ 自动领用的模板

2. 回调消息类型

TemplateAdd

3. 其他说明

4. 回调结构体

MsgData结构体定义

参数名称参数类型参数描述
ApplicationIdString第三方应用的应用编号
ProxyOrganizationOpenIdString第三方平台子客企业的唯一标识,定义Agent中的ProxyOrganizationOpenId一样, 可以参考Agent结构体
ProxyOperatorOpenIdString如果第三方子企业员工签署, 此字段为第三方子企业员工的唯一标识
TemplateIdString触发回调的模板ID,为32位字符串
TemplateNameString触发回调的模板名称
CreateTimeInteger此模板的创建时间,格式为Unix标准时间戳(秒)
ChannelTemplateIdString若为领用模板,此字段为对应第三方平台模板id
ChannelTemplateNameString若为领用模板,此字段为对应第三方平台模板名称
SaveTypeInteger模板是否自动设置为子客模板,0-需要子客手动领取的模板,1-自动设置子客模板
TemplateVersionInteger模板版本号。默认为空时,初始版本为yyyyMMdd000。全数字字符
UserDataString用户自定义参数,在嵌入式页面下创建/编辑模板时可以指定此参数,回调原样返回。参考ChannelCreateEmbedWebUrl接口说明

5. 示例

{
"MsgId": "yDCVGUUckpwl6zn2UuGjzgvvGIxNNARh",
"MsgType": "TemplateAdd",
"MsgVersion": "ThirdPartyApp",
"MsgData": {
"ApplicationId": "yDCVGUAckpwll4vuUxRbCLx81uTHHOT6",
"ProxyOrganizationOpenId": "essbasic-org-openid",
"ProxyOperatorOpenId": "operator-openid",
"TemplateId": "yDCVGBBckpwll4vuUxRbCLx81uTHAOH5",
"TemplateName": "采购协议",
"CreateTime": 1709629136,
"ChannelTemplateId": "yDw8XUUckpkfomsgU7sFQE70AJBqn3Ch",
"ChannelTemplateName": "采购协议",
"SaveType": 0,
"TemplateVersion": "20231009001",
"UserData": "eyJDb21lRnJvbSI6Inh4eCJ9"
}
}

二. 模板修改通知

1. 回调触发时机

企业在控制台修改模板

2. 回调消息类型

TemplateUpdate

3. 其他说明

4. 回调结构体

MsgData结构体定义

参数名称参数类型参数描述
ApplicationIdString第三方应用的应用编号
ProxyOrganizationOpenIdString第三方平台子客企业的唯一标识,定义Agent中的ProxyOrganizationOpenId一样, 可以参考Agent结构体
ProxyOperatorOpenIdString如果第三方子企业员工签署, 此字段为第三方子企业员工的唯一标识
TemplateIdString触发回调的模板ID,为32位字符串
TemplateNameString触发回调的模板名称
UpdateTimeInteger此模板的修改时间,格式为Unix标准时间戳(秒)
ChannelTemplateIdString若为领用模板,此字段为对应第三方平台模板id
ChannelTemplateNameString若为领用模板,此字段为对应第三方平台模板名称
SaveTypeInteger模板是否自动设置为子客模板,0-需要子客手动领取的模板,1-自动设置子客模板
TemplateVersionInteger模板版本号。默认为空时,初始版本为yyyyMMdd000。全数字字符
UserDataString用户自定义参数,在嵌入式页面下创建/编辑模板时可以指定此参数,回调原样返回。参考ChannelCreateEmbedWebUrl接口说明

5. 示例

{
"MsgId": "yDCVGUUckpwl5m65UuGjzgvRpTHFlaVJ",
"MsgType": "TemplateUpdate",
"MsgVersion": "ThirdPartyApp",
"MsgData": {
"ApplicationId": "yDCVGUAckpwll4vuUxRbCLx81uTHHOT6",
"ProxyOrganizationOpenId": "essbasic-org-openid",
"ProxyOperatorOpenId": "operator-openid",
"TemplateId": "yDCVGBBckpwll4vuUxRbCLx81uTHAOH5",
"TemplateName": "采购协议",
"UpdateTime": 1709629868,
"ChannelTemplateId": "yDw8XUUckpkfomsgU7sFQE70AJBqn3Ch",
"ChannelTemplateName": "采购协议",
"SaveType": 0,
"TemplateVersion": "20240305001",
"UserData": "eyJDb21lRnJvbSI6Inh4eCJ9"
}
}

三. 模板删除通知

1. 回调触发时机

企业在控制台删除模板

2. 回调消息类型

TemplateDelete

3. 其他说明

4. 回调结构体

MsgData结构体定义

参数名称参数类型参数描述
ApplicationIdString第三方应用的应用编号
ProxyOrganizationOpenIdString第三方平台子客企业的唯一标识,定义Agent中的ProxyOrganizationOpenId一样, 可以参考Agent结构体
ProxyOperatorOpenIdString如果第三方子企业员工签署, 此字段为第三方子企业员工的唯一标识
TemplateIdString触发回调的模板ID,为32位字符串
TemplateNameString触发回调的模板名称
DeleteTimeInteger此模板的删除时间,格式为Unix标准时间戳(秒)
UserDataString用户自定义参数,在嵌入式页面下创建/编辑模板时可以指定此参数,回调原样返回。参考ChannelCreateEmbedWebUrl接口说明

5. 示例

{
"MsgId":"yDwFdUUckpswdrniUuzcbXw8N43W6Kcz",
"MsgType":"TemplateDelete",
"MsgVersion": "ThirdPartyApp",
"MsgData":{
"ApplicationId":"c17bdf9c2a7bdcb32611f4d0200fef3d",
"ProxyOrganizationOpenId":"00498cc8500be9cxxxxxxx3aff766cac",
"ProxyOperatorOpenId":"d7c13a8b81340cce9e3968c0ee248f04",
"TemplateId":"yDRS4UUgygqdcj51UuO4zjEyWTmzsIAR",
"TemplateName":"xx公司劳务合同模板",
"DeleteTime":1626083520,
"UserData": "eyJDb21lRnJvbSI6Inh4eCJ9"
}
}

四. 启用或停用模板通知

1. 回调触发时机

启用或者停用模板

2. 回调消息类型

TemplateAvailable

3. 其他说明

4. 回调结构体

MsgData结构体定义

参数名称参数类型参数描述
ApplicationIdString第三方应用的应用编号
ProxyOrganizationOpenIdString第三方平台子客企业的唯一标识,定义Agent中的ProxyOrganizationOpenId一样, 可以参考Agent结构体
ProxyOperatorOpenIdString第三方子企业员工的唯一标识(操作人)
TemplateIdString触发回调的模板ID,为32位字符串
TemplateNameString触发回调的模板名称
TemplateStatusString触发回调的模板状态 DISABLE:模板停用 ENABLE:模板启用
OperateOnInteger操作时间,格式为Unix标准时间戳(秒)

5. 示例

{
"MsgId":"yDSLfUUckptgrpzoUuePjukw5hxLrwfd",
"MsgType":"TemplateAvailable",
"MsgVersion":"ThirdPartyApp",
"MsgData":{
"ApplicationId": "yDwFUckpstzjhfUugNAWf1KibXqS96",
"ProxyOrganizationOpenId": "org_dianziqian",
"ProxyOperatorOpenId":"org_dianziqian_n9527",
"OperateOn":1701074438,
"TemplateId":"yDSLmUUckpou7y0sUlewriSVCDBIbdvX",
"TemplateName":"对账单模板",
"TemplateStatus":"DISABLE"
}
}
购买咨询
微信客服
4006-808-062
4006-808-062