目录
接口简介调用前提调用方式 示例代码 参数 success 回调入参 fail / complete 回调入参错误码兼容性相关接口旧版 jweixin 兼容 示例代码接口简介
viewTodo —— 在「待办」能力下,根据待办 id 拉起企业微信原生的待办详情页,让用户在 H5 页面内查看本应用此前创建的某条待办的完整内容、参与人、截止时间等信息。
适用场景:业务网页内点击"查看待办"按钮跳转详情、待办创建后回显详情、从消息卡片承接待办查看动作。
本接口只能查看本应用此前通过 创建待办 创建的待办;查看其他应用创建的待办会报 viewTodo:fail no permission。
调用前提
- 必须先使用
ww.register 进行应用身份注册(详见 JS-SDK 签名算法) - 应用必须是全员可见的自建应用,否则报
viewTodo:fail no permission - 当前成员必须在应用的可见范围内
- 待办必须由本应用自己创建(即
todoId 来自本应用的 createTodo 回调) - 第三方应用、代开发应用 暂不支持
调用方式
示例代码
ww.viewTodo({
todoId: 'TODO_ID',
success(result) {
},
fail(result) {
},
complete(result) {
}
})
参数
| 参数 | 类型 | 必填 | 说明 |
|---|
| todoId | string | 是 | 待办 id,由 createTodo 创建成功后回调返回 |
| success | (result: { errMsg: string }) => void | 否 | 调用成功的回调函数 |
| fail | (result: { errMsg: string }) => void | 否 | 调用失败的回调函数 |
| complete | (result: { errMsg: string }) => void | 否 | 调用结束的回调函数(成功 / 失败都会执行) |
success 回调入参
| 字段 | 类型 | 说明 |
|---|
| errMsg | string | 执行结果,固定为 viewTodo:ok。本接口仅拉起详情页,不返回待办的业务字段 |
fail / complete 回调入参
| 字段 | 类型 | 说明 |
|---|
| errMsg | string | 错误信息,详见下方「错误码」。complete 在成功时同样会收到 viewTodo:ok |
错误码
errMsg | 含义 | 处理建议 |
|---|
viewTodo:cancel | 用户主动关闭详情页 | 静默处理 |
viewTodo:fail no permission | 应用签名校验失败 成员不在可见范围 应用未设置为全员可见 / 试图查看非本应用创建的待办 | 检查应用是否「全员可见」、当前成员是否在可见范围、todoId 是否本应用通过 createTodo 创建 |
viewTodo:fail no session or expired | 没有调用过登录接口或登录态已过期 | 重新完成应用身份注册 |
通用错误码参见 全局错误码。
兼容性
相关接口
旧版 jweixin 兼容
仅供使用 jweixin-1.2.0.js 旧 SDK 的存量项目参考。新项目请使用上方调用方式。
示例代码
wx.invoke('viewTodo', {
"todoId": "TODO_ID"
}, function(res) {
if (res.err_msg === 'viewTodo:ok') {
} else if (res.err_msg === 'viewTodo:cancel') {
} else {
}
})