使用模板发送工作通知消息
POST
/topapi/message/corpconversation/sendbytemplate最后修改时间:: 2 年前
责任人: 未设置
说明
调用本接口使用消息模板发送工作通知。
服务地址:https://oapi.dingtalk.com
权限
服务端API是以应用维度授权的,在创建应用时,系统已默认添加了消息通知权限。
应用类型 | 是否支持调用 | 权限申请方式 | API Explorer调试 |
---|---|---|---|
企业内部应用 | 否 | — | — |
第三方企业应用 | 是 | 无需申请 | 调试 |
第三方个人应用 | 否 | — | — |
请求参数
Query 参数
access_token
string
必需
调用服务端API授权凭证,可通过获取第三方企业应用的access_token接口获取。
示例值:
Be3xxxx
Body 参数application/json
agent_id
number
必需
应用的agentid,可调用获取企业授权信息接口获取。
template_id
string
必需
消息模板ID。在开发者后台应用的开发管理页面查看。
userid_list
string
可选
接收者的用户userid列表。最大列表长度为5000。
dept_id_list
string
可选
接收者的部门id列表。最大列表长度为500。dept_id_list和userid_list不能同时为空。
data
string
可选
消息模板动态参数赋值数据。key和value均为字符串格式。
示例
{
"agent_id": "948060598",
"template_id": "e27a9eed42b34a14a2xxxx",
"data": "{\"name\":\"淘宝6\",\"name2\":\"http://www.taobao.com\"}",
"dept_id_list": "421897262"
}
示例代码
返回响应
成功(200)
HTTP 状态码: 200
内容格式: JSONapplication/json
数据结构
errmsg
string
返回码描述。
errcode
number
返回码。
task_id
number
可选
创建的异步发送任务ID。
request_id
string
请求ID。
示例
{
"errmsg": "string",
"errcode": 0,
"task_id": 0,
"request_id": "string"
}
最后修改时间: 2 年前