选择应用类型
第三方企业应用开发

发送普通消息

更新于 2024-01-11调用本接口发送普通消息。

重要

为提升接口的使用体验,发送普通消息接口计划升级,后续完善更多功能,重新开放时间请关注文档更新日志。

  • 发送普通消息接口相关文档,已于2022年09月23日迁移至历史文档(不推荐)目录。

  • 不再支持新应用接入,已接入的应用可以正常调用。

发送普通消息是指员工个人在使用应用时,可以通过界面操作的方式向群或其他人的会话中推送消息,例如发送日志的场景。

发送普通消息,需要在前端页面调用JSAPI唤起联系人会话选择页面,选中后会返回会话cid,然后再调用服务端接口向会话里发送一条消息,如下图所示:

重要

发送普通消息需要注意以下事项:

  • 不在当前接口调用所使用的企业的接收者(单聊接收者或者群聊会话里的接收者)不能收到消息。

  • 获取到的会话cid只能使用一次,且有效期为24小时。

  • 消息类型和样例,企业内部应用可参考消息类型与数据格式,钉钉三方企业应用可参考消息类型与数据格式

权限

该接口权限默认已添加,无需申请。

应用类型

是否支持调用

权限申请方式

API Explorer调试

企业内部应用

默认开通,无需申请

第三方企业应用

默认开通,无需申请

第三方个人应用

基本信息

请求方式:POST

请求地址https://oapi.dingtalk.com/message/send_to_conversation

Query参数

名称

类型

是否必填

示例值

描述

access_token

String

6d1bxxxx

调用服务端API的应用凭证。

Body参数

名称

类型

是否必填

示例值

描述

sender

String

user123

消息发送者的userid。

cid

String

123

群会话或者个人会话的id,通过JSAPI接口唤起联系人界面选择会话获取会话cid。

msg

JSON Object

{"msgtype":"text","text":{"content":"请提交日报。"}

消息内容,最长不超过2048个字节。

返回参数

名称

类型

示例值

描述

receiver

String

UserID1|UserID2

有效接收消息的员工的userid。

  • 接收者可以是单聊接收者或者群聊会话里的接收者,如果接收者是当前接口调用所使用的企业的员工,则是有效接收者。

  • 接口返回所有有效接收者的userid。

  • 非有效接收者是收不到消息的。

errmsg

String

ok

返回码描述。

errcode

Number

0

返回码。

示例

请求示例(HTTP)

Loading...

请求正文

Loading...

请求示例(JAVA SDK)

Loading...

返回示例

Loading...
这篇文档是否有帮助?
点击纠错