# 获取成员变更事件推送
# 描述
应用接入后,成员变更事件会以数据推送形式通知应用,信息变更事件参考文档信息变更事件推送 (opens new window)
# 支持事件
事件类型 | 事件 | 事件描述 |
---|---|---|
用户信息事件 | addUser | 新增用户信息事件 |
updateUser | 修改用户信息事件 | |
deleteUser | 删除用户信息事件 |
# 字段申请:
发送需要申请的字段到seasonyuan@tencent.com进行申请(邮件同时也抄送至lydiaxyang@tencent.com , lindayyang@tencent.com , ronniewan@tencent.com),申请时需要注明申请内容、应用APPKEY、应用名称、及应用使用场景
# 请求方法:
POST(application/json)
# 请求地址:
应用在接入时,需要提供接收事件推送地址进行配置
# 组织架构信息事件
# 请求参数:
{
"app_key": "APP_KEY",
"school_code":"1011789061",
"event":"addUser",
"raw_data": "..."
}
参数 | 必填 | 类型 | 实例 | 参数说明 |
---|---|---|---|---|
appkey | 是 | String | APP_KEY | 应用接入时分配的key |
school_code | 是 | String | 1011789061 | 主体的编号 |
event | 是 | String | addOrg | 事件类型 |
raw_data | 是 | String | ... | 加密数据 |
其中raw_data为加密后的数据,解密之后为:(加解密算法见注意事项)(分行业用户字段说明)
{
"card_number": "07302590",
"name": "陈小明",
"identity_type": "1",
"grade": "2016",
"college": "人居环境工程学院",
"profession": " 工程造价",
"class": "1班",
"identity_title": "经理/总监/部长/本科生...",
"gender": 1,
"organization": [
2,
222,
496
],
"role": [
1,
2
],
"campus": "东校区",
"dorm_number": "至善园",
"physical_chip_number": "xaqwecf",
"physical_card_number": "fqweasd",
"nation": "汉族",
"birthday": "20020319",
"origin_place": "深圳市",
"graduated_school": "小碧中学",
"address": "广东省深圳市",
"contact_person": "陈大明",
"contact_phone": "(+86)13800138000",
"email": "605135612@qq.com",
"id_card": "440305200203194013",
"telephone": "(+86)13800138000",
"bind_status": 0,
"frozen_status": 0,
"active_status": 0,
"entrust_status": 0,
"start_at": "2019-10-14 00:00:00",
"expire_at": "2019-10-18 00:00:00",
"updated_at": "2019-10-16 00:00:00",
"head_image":"https://xxxxxxxxxxxxxx/a.png",
"serial_number": "19527123",
"job_title": "经理"
}
参数 | 必填 | 类型 | 实例 | 说明 |
---|---|---|---|---|
card_number | 是 | String(32) | 07302590 | 用户电子卡号/学工号 |
name | 是 | Integer | 陈小明 | 用户姓名 |
identity_type | 是 | Integer | 1 | 成员身份类型,参考文档成员身份类型列表 |
grade | 否 | String | 2016 | 年级(需申请) |
college | 否 | String | 人居环境工程学院 | 学院(需申请) |
profession | 否 | String | 工程造价 | 专业(需申请) |
class | 否 | String | 1班 | 班级(需申请) |
identity_title | 否 | String | 经理/总监/部长/本科生... | 身份职称(需申请) |
gender | 否 | Integer | 1 | 性别,0为未知,1为男,2为女(需申请) |
organization | 否 | Array | [2,222,496] | 用户所属组织架构id列表(需申请) |
role | 否 | Array | [1,2] | 用户所属角色id列表(需申请) |
campus | 否 | String | 东校区 | 校区(需申请) |
dorm_number | 否 | String | 至善园6号 | 宿舍号(需申请) |
physical_chip_number | 否 | String | xaqwecf | 物理芯片号(需申请) |
physical_card_number | 否 | String | fqweasd | 物理卡号(需申请) |
nation | 否 | String | 汉族 | 民族(需申请) |
birthday | 否 | String | 20020319 | 生日(需申请) |
origin_place | 否 | String | 深圳市 | 生源地(需申请) |
graduated_school | 否 | String | 小碧中学 | 毕业学校(需申请) |
address | 否 | String | 广东省深圳市 | 地址(需申请) |
contact_person | 否 | String | 陈大明 | 联系人姓名(需申请) |
contact_phone | 否 | String | (+86)13800138000 | 联系人手机号码(带区号)(需申请) |
否 | String | 605135612@qq.com | 用户邮箱(需申请) | |
id_card | 否 | String | 440305200203194013 | 身份证(需申请) |
telephone | 否 | String | (+86)13800138000 | 手机号码(带区号)(需申请) |
bind_status | 否 | Integer | 0 | 绑定状态(需申请) |
frozen_status | 否 | Integer | 0 | 冻结状态(需申请) |
active_status | 否 | Integer | 0 | 激活状态(需申请) |
start_at | 否 | Datatime | 2019-10-14 00:00:00 | 有效起始时间(需申请) |
entrust_status | 是 | Integer | 0 | 签约状态(需申请)0-未签约,1-已签约 |
expire_at | 否 | Datatime | 2019-10-18 00:00:00 | 有效结束时间(需申请) |
updated_at | 否 | Datatime | 2019-10-16 00:00:00 | 用户信息变更时间(需申请) |
head_image | 否 | String | https://xxxxxxxxxxxxx/a.png | 用户头像(需申请) |
serial_number | 否 | String | 19527123 | 编号(需申请) |
job_title | 否 | String | 经理 | 职务(需申请) |
# 响应说明:
{
"code": 0,
"message": "ok",
}
参数 | 必填 | 类型 | 实例 | 说明 |
---|---|---|---|---|
code | 是 | Integer | 0 | 接收响应状态码,0为成功,非0时则认为接收方接受数据失败,将会进行重试 |
message | 是 | String | ok | 接收状态补充说明 |
# 注意事项
- 签名算法
具体算法参考签名算法 签名验证工具参考签名验证工具 (opens new window)
- 加密算法
采用AES对称加密算法(AES/CBC/ZeroPadding 128位模式),具体算法见加解密
KEY = APP_KEY
IV = APP_SECRET 前16位
- 成员身份类型 每个主体都可以自定义成员身份类型,获取成员身份类型列表,参考文档获取成员身份类型
# 更新日志
日期 | 变更说明 |
2019-10-18 | 获取成员变更事件推送 响应返回新增 start_time 有效起始时间字段,将 expire_time的有效期解释更改为 有效结束时间 |
2020-05-08 | 新增角色字段 |