Developer OpenAPI
首页Apifox官网钉钉openAPI
企业微信openAPI
  • openAPI文档
  • 官方文档
首页Apifox官网钉钉openAPI
企业微信openAPI
  • openAPI文档
  • 官方文档
生态伙伴API
  • 历史文档（不推荐）
  • 开发钉钉应用
  • 服务端API
  • 新版服务端API（DingTalk OpenAPI）
  • 生态伙伴API
e签宝金智CRM阿里商旅小蜜客服智能客服员工服务台
e签宝金智CRM阿里商旅小蜜客服智能客服员工服务台
  1. 员工服务台
  • 使用服务助手推送消息
    POST
  1. 员工服务台

使用服务助手推送消息

POST
http://127.0.0.1/topapi/smartbot/msg/push
生态伙伴API/员工服务台
最后修改时间：2022-08-30 09:19:22
责任人：未设置

说明#

调用本接口通过服务助手机器人给企业员工发送消息。
服务地址：https://oapi.dingtalk.com

权限#

应用类型是否支持调用权限申请方式API Explorer调试企业内部应用是无需申请调试第三方企业应用否——第三方个人应用否——
应用类型是否支持调用权限申请方式API Explorer调试
企业内部应用是无需申请调试
第三方企业应用否——
第三方个人应用否——

请求参数

Query 参数
access_token
string 
必需
调用服务端API授权凭证，可通过获取企业内部应用的access_token接口获取。
示例值:
6d1bxxxx
Body 参数application/json
msg
object 
必需
消息内容，最长不超过2048个字节。消息类型和样例参考消息类型与数据格式。
msgtype
string 
必需
消息类型，支持如下消息类型。text：文本消息。markdown：Markdown消息。action_card：卡片消息。
text
object 
文本消息。
可选
markdown
object 
可选
markdown消息。
action_card
object 
卡片消息。
可选
user_id_list
string 
可选
接收者的userid列表，最大用户列表长度100。
chat_id_list
string 
可选
接收者的会话chatid列表，最大会话列表长度10。
to_all_user
boolean 
可选
是否发送给企业全部用户。当设置为false时必须指定userid_list或chat_id_list其中一个参数的值。
示例
{
  "msg": {
    "msgtype": "text",
    "text": {
      "content": "请提交日报。"
    }
  },
  "user_id_list": "user456"
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://127.0.0.1/topapi/smartbot/msg/push?access_token=6d1bxxxx' \
--header 'Content-Type: application/json' \
--data-raw '{
    "msg": {
        "msgtype": "text",
        "text": {
            "content": "请提交日报。"
        }
    },
    "user_id_list": "user456"
}'

返回响应

🟢200成功
application/json
Body
task_id
string 
可选
创建的异步发送任务id
errcode
number 
返回码。
可选
errmsg
string 
返回码描述。
可选
request_id
string 
请求ID。
可选
示例
{
  "task_id": "string",
  "errcode": 0,
  "errmsg": "string",
  "request_id": "string"
}
Built with