目录
接口简介调用前提调用方式 示例代码 参数 success 回调入参 fail / complete 回调入参错误码兼容性相关接口旧版 jweixin 兼容 示例代码接口简介
createTodo —— 在「待办」能力下,调起企业微信原生的待办创建页,让用户在 H5 页面内快速新建一条待办,并可预填内容、参与人和截止时间。
适用场景:业务网页内一键发起待办(如审批补充材料、跟进客户、任务派发)、从工作台 / 侧边栏跳转后承接待办创建动作、消息卡片点击后唤起待办创建。
本接口只调起创建面板,不会自动发起任何业务操作。创建成功后从 res.todoId 取得待办 id,可配合 查看待办详情 跳转查看。
调用前提
- 必须先使用
ww.register 进行应用身份注册(详见 JS-SDK 签名算法) - 应用必须是全员可见的自建应用,否则报
createTodo:fail no permission - 当前成员必须在应用的可见范围内
- 第三方应用、代开发应用 暂不支持
调用方式
示例代码
ww.createTodo({
content: '待办内容',
attendees: ['jack', 'jason'],
endTime: 1667318400,
success(result) {
},
fail(result) {
},
complete(result) {
}
})
参数
| 参数 | 类型 | 必填 | 说明 |
|---|
| content | string | 否 | 待办内容(标题)。建议不超过一行可见长度,过长会被截断显示 |
| attendees | array<string> | 否 | 参与人 userid 列表。需为当前应用可见范围内的企业成员 |
| endTime | number | 否 | 截止时间,unix 时间戳,单位:秒 |
| success | (result: SuccessResult) => void | 否 | 调用成功的回调函数,详见 success 回调入参 |
| fail | (result: { errMsg: string }) => void | 否 | 调用失败的回调函数 |
| complete | (result: { errMsg: string }) => void | 否 | 调用结束的回调函数(成功 / 失败都会执行) |
success 回调入参
| 字段 | 类型 | 说明 |
|---|
| errMsg | string | 执行结果,固定为 createTodo:ok |
| todoId | string | 新建的待办 id。后续可传入 查看待办详情 拉起详情页 |
fail / complete 回调入参
| 字段 | 类型 | 说明 |
|---|
| errMsg | string | 错误信息,详见下方「错误码」。complete 在成功时同样会收到 createTodo:ok |
错误码
errMsg | 含义 | 处理建议 |
|---|
createTodo:cancel | 用户主动取消创建 | 静默处理或友好提示 |
createTodo:fail no permission | 应用签名校验失败 成员不在可见范围 应用未设置为全员可见 | 检查应用是否「全员可见」、当前成员是否在可见范围、ww.register(或 wx.agentConfig)是否成功 |
createTodo:fail no session or expired | 没有调用过登录接口或登录态已过期 | 重新完成应用身份注册 |
通用错误码参见 全局错误码。
兼容性
相关接口
旧版 jweixin 兼容
仅供使用 jweixin-1.2.0.js 旧 SDK 的存量项目参考。新项目请使用上方调用方式。
示例代码
wx.invoke('createTodo', {
"content": "待办内容",
"attendees": ["jack", "jason"],
"end_time": 1667318400
}, function(res) {
if (res.err_msg === 'createTodo:ok') {
var todoId = res.todoId
} else if (res.err_msg === 'createTodo:cancel') {
} else {
}
})