专属小红点推送新版SDK

更新于 2024-01-29调用本接口，给企业自建或第三方企业应用推送在快捷栏上显示的小红点信息。

调用本接口，实现的效果如下图所示。

说明

仅限购买了开放&集成包的专属钉钉企业进行使用，如需购买，请联系钉钉小二咨询，使用前你可以登录钉钉管理后台 > 钉钉专属版 > 开放&运维 > 能力开放 > 推送小红点进行配置。

权限

要调用此API，需要以下权限之一。

应用类型	是否支持	权限	API Explorer调试
企业内部应用	支持	专属钉钉专属设计读写权限	API Explorer
第三方企业应用	支持	专属钉钉专属设计读写权限	API Explorer

名称	类型	是否必填	描述
x-acs-dingtalk-access-token	String	是	调用该接口的访问凭证：企业内部应用可调用获取企业内部应用的accessToken接口获取。第三方企业应用可调用获取第三方应用授权企业的accessToken接口获取。

名称

类型

是否必填

描述

x-acs-dingtalk-access-token

String

是

调用该接口的访问凭证：

名称	类型	是否必填	描述
badgeItems	Array	否	推送列表，建议不超过100。
userId	String	否	员工userId。
pushValue	String	否	推送的内容。（目前仅限数字）
agentId	String	是	微应用agentId，请参考基础概念-AgentId。
pushType	String	是	推送类型取值： Number：pushValue值为数字

名称	类型	描述
success	Boolean	推送是否成功，true表示成功。

请求示例

HTTP

Java

Python

PHP

Node.js

返回示例

HttpCode	错误码	错误信息	说明
500	param.illegal	参数错误:%s	参数错误，包含agentId、pushType、userIdList、pushValue
500	not.have.permission	当前组织没有红点推送权限	当前组织没有红点推送权限
500	system.error	系统错误	内部服务发生的异常情况
500	agent.not.allow	未授权该微应用红点推送权限	未授权该微应用红点推送权限

这篇文档是否有帮助？

本页内容