跳转到主要内容
调用本接口,更新 OA 工作通知消息的状态。

接口调用说明

  • 本接口适用于 OA 工作通知类型,实时更新审批状态的场景。
  • 调用本接口,只能更新7天内发出的工作通知状态栏。

请求

基本信息
HTTP URLhttps://oapi.dingtalk.io/topapi/message/corpconversation/status_bar/update
HTTP MethodPOST
支持的应用类型appType-企业内部应用appType-第三方企业应用
权限要求permission-qyapi_base-调用企业API时需要具备的基本权限

查询参数

名称类型是否必填示例值描述
access_tokenStringbE74xxxx调用该API的应用凭证。 - 企业内部应用,通过获取企业内部应用的access_token接口获取。 - 第三方企业应用,通过获取第三方企业的access_token接口获取。

请求体

名称类型是否必填示例值描述
agent_idNumber123发送消息时使用的微应用的AgentID。 - 企业内部应用,可在开发者后台的应用详情页面查看。image - 第三方企业应用可调用获取企业授权信息接口获取。
task_idNumber11工作通知任务ID,调用发送工作通知接口获取task_id参数值。
status_valueString已同意状态栏值。
status_bgString0xFF78C06E状态栏背景色,推荐0xFF加六位颜色值。

请求示例

curl -X POST "https://oapi.dingtalk.io/topapi/message/corpconversation/status_bar/update" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=e4bbxxxxe7683' \
-d 'agent_id=123' \
-d 'status_bg=0xFFF65E5E' \
-d 'status_value=%E5%B7%B2%E5%AE%8C%E6%88%90' \
-d 'task_id=1111'
Java
DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.io/topapi/message/corpconversation/status_bar/update");
OapiMessageCorpconversationStatusBarUpdateRequest req = new OapiMessageCorpconversationStatusBarUpdateRequest();
req.setAgentId(123L);
req.setTaskId(1111L);
req.setStatusValue("已完成");
req.setStatusBg("0xFFF65E5E");
OapiMessageCorpconversationStatusBarUpdateResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
Python
import dingtalk.api

req=dingtalk.api.OapiMessageCorpconversationStatusBarUpdateRequest("https://oapi.dingtalk.io/topapi/message/corpconversation/status_bar/update")

req.agent_id=123
req.task_id=1111
req.status_value="已完成"
req.status_bg="0xFFF65E5E"
try:
  resp= req.getResponse(access_token)
  print(resp)
except Exception,e:
  print(e)
PHP
include "TopSdk.php";
date_default_timezone_set('Asia/Shanghai');

$c = new DingTalkClient(DingTalkConstant::$CALL_TYPE_OAPI, DingTalkConstant::$METHOD_POST , DingTalkConstant::$FORMAT_JSON);
$req = new OapiMessageCorpconversationStatusBarUpdateRequest;
$req->setAgentId("123");
$req->setTaskId("1111");
$req->setStatusValue("已完成");
$req->setStatusBg("0xFFF65E5E");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.io/topapi/message/corpconversation/status_bar/update");
C#
IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.io/topapi/message/corpconversation/status_bar/update");
OapiMessageCorpconversationStatusBarUpdateRequest req = new OapiMessageCorpconversationStatusBarUpdateRequest();
req.AgentId = 123L;
req.TaskId = 1111L;
req.StatusValue = "已完成";
req.StatusBg = "0xFFF65E5E";
OapiMessageCorpconversationStatusBarUpdateResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);

响应

响应体

名称类型示例值描述
request_idString4jzllmte0wau请求ID。
errmsgStringok返回码描述。
errcodeNumber0返回码。

响应体示例

{
  "request_id":"4jzllmte0wau"
  "errcode":0,
  "errmsg":"ok",
}

错误码

若调用该接口报错,可根据错误信息在全局错误码文档中查找解决方案。
错误码(errorcode)错误信息描述(errmsg)解决方案
40056不合法的agentid确认agentId是否正确
40035不合法的参数确认taskId是否正确
41052本次发送人数过多,不再返回发送结果- 减少发送工作通知人员数量 - 确认工作通知消息的发送进度是否完成,若进度没有完成,则会出现该错误。
500系统异常出现未知的系统异常