1. 消息推送接口
接口地址
https://www.fdccloud.com/api/tenant-open/send-msg?access_token={$access_token}
传参方式：
POST
1.1. 文本消息
{
"touser": "mysoft596713fb26afb120144809",
"touser_value_type": "openid",
"agentid": "3023",
"msgtype": "text",
"text": {
"content": "你有一个待办事项，点击<a href='http://www.baidu.com'> 查看详情</a>，哈哈哈哈哈点击<a href='http://www.baidu.com'> 查看详情</a>"
}
}
参数说明
| 参数 | 描述 |
|---|---|
| touser | 必须有，(openid或者user_code，多个接收者用竖线分隔) |
| touser_value_type | 非必填，默认值为'openid' 1、当'touser_value_type'='openid'时，表示上面的字段'touser'使用openid进行推送 2、当'touser_value_type'='user_code'时，表示上面的字段'touser'使用user_code进行推送（适用于第三方用户体系与云助手一致，user_code相同，无需做用户打通） |
| agentid | 必须有，应用code(注册应用时,系统自动分配的) |
| msgtype | 必须有，消息类型，目前支持text、news、oa |
| content | 必须有，消息内容 |
效果
1.2. 图文消息
{
"touser": "mysoft596713fb26afb120144809",
"touser_value_type": "openid",
"agentid": "3023",
"msgtype": "news",
"news": {
"articles": [
{
"title": "待办提醒",
"description": "亲爱的主人，您今天的待办事项如下：\r\n即将签约的客户有 3 位，\r\n逾期未签约的客户有 2 位，\r\n逾期未交款的客户有 4 位；\r\n请您及时进行催办，加油哦~~",
"url": "http://qy-ci.mysoft.com.cn/sale-micro/my56a9c966df069/remind/contract/zygw?p_TaskWakeId=1&UserGuid=7A916792-56C5-11E5-A33B-00155D0AB842&TaskIdentifier=1&__from=wx",
"picurl": "http://img.taopic.com/uploads/allimg/140326/235113-1403260U22059.jpg"
}
]
}
}
参数说明
| 参数 | 描述 |
|---|---|
| touser | 必须有，(openid或者user_code，多个接收者用竖线分隔) |
| touser_value_type | 非必填，默认值为'openid' 1、当'touser_value_type'='openid'时，表示上面的字段'touser'使用openid进行推送 2、当'touser_value_type'='user_code'时，表示上面的字段'touser'使用user_code进行推送（适用于第三方用户体系与云助手一致，user_code相同，无需做用户打通） |
| agentid | 必须有，应用code(p_apps.appcode) |
| msgtype | 必须有，消息类型，目前支持text、news、oa |
| title | 消息标题 |
| description | 消息描述 |
| url | 消息跳转地址 |
| picurl | 消息图片 |
效果
1.3. oa消息
{
"touser": "mysoft596713fb26afb120144809",
"touser_value_type": "openid",
"agentid": "3023",
"msgtype": "oa",
"biz_id": "abc_900000000001",
"extra": {
"biz_type": 1,
"sound":"myywg_grab_order_task_repair"
},
"oa": {
"message_url": "http://dingtalk.com",
"head": {
"bgcolor": "33b5e5",
"text": "头部标题"
},
"body": {
"title": "正文标题",
"form": [
{
"key": "姓名:",
"value": "张三"
},
{
"key": "年龄:",
"value": "20"
},
{
"key": "身高:",
"value": "1.8米"
},
{
"key": "体重:",
"value": "130斤"
},
{
"key": "学历:",
"value": "本科"
}
],
"rich": {
"num": "15.6",
"unit": "元"
},
"content": "大段文本大段文本大段文本大段文本大段文本大段文本大段文本大段文本大段文本大段文本大段文本大段文本",
"file_count": "3个附件",
"author": "李四",
"relation": "3个流程",
"ywstatus": {
"text": "已归档",
"color": "ff0000"
},
"mark": [
{
"bgcolor": "FFFFFF",
"text": "会议"
}
]
}
}
}
参数说明
| 参数 | 描述 |
|---|---|
| touser | 必须有，(openid或者user_code，多个接收者用竖线分隔) |
| touser_value_type | 非必填，默认值为'openid' 1、当'touser_value_type'='openid'时，表示上面的字段'touser'使用openid进行推送 2、当'touser_value_type'='user_code'时，表示上面的字段'touser'使用user_code进行推送（适用于第三方用户体系与云助手一致，user_code相同，无需做用户打通） |
| agentid | 必须有，应用code(p_apps.appcode) |
| msgtype | 必须有，消息类型，目前支持text、news、oa |
| biz_id | 消息业务id，用来刷新消息状态，待审类型的请务必传biz_id字段，刷新消息状态会用到（如果要将消息推往云助手的‘待办中心’则需要使用此字段） |
| extra.biz_type | 消息业务类型，0：待审，1：待阅,不传默认为待阅（如果要将消息推往云助手的‘待办中心’则需要使用此字段） |
| extra.sound | 消息推送-语音提醒(云助手内置了部分语音文件，按规范指定语音文件名即可) |
| message_url | 消息跳转地址 |
| bgcolor | 消息头部颜色，长度限制为8个英文字符，其中前2为表示透明度，后6位表示颜色值，不要添加0x |
| oa.head.text | 消息头部标题 |
| oa.body.title | 消息体的标题 |
| body.form.key | 消息体的关键字 |
| body.form.value | 消息体的关键字对应的值 |
| body.rich.num | 单行富文本信息的数目 |
| body.rich.unit | 单行富文本信息的单位 |
| oa.body.content | 消息体的内容，最多显示3行 |
| oa.body.image | 消息体中图片地址 |
| oa.body.file_count | 自定义的附件数目 |
| oa.body.relation | 关联流程 |
| ywstatus.text | 业务状态描述 |
| ywstatus.color | 业务状态描述颜色 |
| oa.body.author | 自定义的作者名字 |
效果
接口调用后返回结果如下：
{
"errcode": 0,
"errmsg": "ok"
}
1.4. 更新待办
接口地址
https://www.fdccloud.com/api/tenant-open/update-msg-status-by-usercode?access_token={$access_token}
传参方式：
POST
{
"msg": [
{
"user_code": "zhangs",
"biz_id": "900000000001",
"todo": 1
},
{
"user_code": "lis",
"biz_id": "900000000002",
"todo": 1
}
]
}
参数说明
| 参数 | 描述 |
|---|---|
| user_code | 必须有，用户代码 |
| biz_id | 必须有，业务biz_id |
| todo | 待办状态：1:置为已办 |
接口调用后返回结果如下：
{
"errcode": 0,
"errmsg": "ok"
}
1.5. 更改业务文字状态
接口地址
https://www.fdccloud.com/api/tenant-open/update-ywstatus?access_token={$access_token}
传参方式：
POST
{ "touser": "mysoft596713fb26afb120144809", "touser_value_type": "openid", "agentid": "3023", "biz_id": "abc_900000000001", "ywstatus": { "text":"已完成"， "color":"ff0000" } }
参数说明
| 参数 | 描述 |
|---|---|
| touser | 必须有(openid或者user_code) |
| touser_value_type | 非必须,默认是openid，可选值openid或user_code |
| agentid | 必须有，应用code |
| biz_id | 必须有，业务biz_id |
| ywstatus | 业务状态 |
| text | 业务状态描述 |
| color | 业务状态夜色 |
接口调用后返回结果如下：
{
"errcode": 0,
"errmsg": "ok"
}
效果
1.6. 消息置为已读
接口地址
https://www.fdccloud.com/api/tenant-open/reset-unread-msg-num
传参方式：
POST
{ "tenant_id":"my56a9c966df069", "app_code":"3021", "user_type":"erp", "user_id":"zhangs3" }
参数说明
| 参数 | 描述 |
|---|---|
| tenant_id | 租户id，登录云助手后台获取 |
| app_code | 应用标识：3021:管理简讯、3042:移动计划 |
| user_type | 用户类型：erp、dingtalk、wx、multi_wx1、multi_wx2、multi_wx3 |
| user_id | 用户标识：erp的user_code、钉钉的用户id、微信的用户id |
接口调用后返回结果如下：
{
"errcode": 0,
"errmsg": "ok"
}