alibaba.mos.tmc.send.ding.robot.message (发送钉钉机器人消息通用模板)

发送钉钉机器人消息通用模板

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
relation_id String 必须 uuid UUID
agent_id String 必须 xxx 需要发送的钉钉app
action_card_dto ActionCardDTO 可选 卡片消息
  • └ title
  • String
  • 可选
  • 标题
  • 标题
  • └ text
  • String
  • 可选
  • 文本内容
  • 文本内容
  • └ btn_orientation
  • String
  • 可选
  • 0
  • 按钮布局 0竖排1横排
  • btns
  • ActionCardBtnDTO []
  • 可选
  • null
  • 按钮列表,目前最多支持三个按钮
  • └ title
  • String
  • 可选
  • 内容不错
  • 按钮文本
  • └ action_url
  • String
  • 可选
  • https://www.miaostreet.com/
  • 按钮跳转url
sample_link_dto SampleLinkDTO 可选 图片链接消息
  • └ text
  • String
  • 可选
  • 消息内容
  • 消息内容
  • └ title
  • String
  • 可选
  • 标题
  • 标题
  • └ pic_url
  • String
  • 可选
  • http://dingtalk.com
  • 图片链接
  • └ message_url
  • String
  • 可选
  • http://dingtalk.com
  • 跳转链接
sample_text_dto SampleTextDTO 可选 文本消息
  • └ content
  • String
  • 可选
  • 消息内容
  • 消息内容
sample_markdown_dto SampleMarkdownDTO 可选 markdown消息
  • └ text
  • String
  • 可选
  • 消息
  • 消息内容
  • └ title
  • String
  • 可选
  • 标题
  • 消息标题
reciever_id_list Number 必须 null 接收人id(默认淘宝id)
user_type Number 可选 3 接收人id类型(2:MIS_ID,3:淘宝id)

响应参数

名称 类型 示例值 描述
data Boolean true 返回结果
result_success Boolean true 服务是否成功
result_err_code String 200 错误码
err_message String 错误信息 错误信息
attributes Json null 拓展字段
is_async Boolean false 是否异步
async_result String null 异步结果
trace_id String 1111fd234f5234234 调用链id

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaMosTmcSendDingRobotMessageRequest req = new AlibabaMosTmcSendDingRobotMessageRequest();
req.setRelationId("uuid");
req.setAgentId("xxx");
AlibabaMosTmcSendDingRobotMessageRequest.ActionCardDTO obj1 = new AlibabaMosTmcSendDingRobotMessageRequest.ActionCardDTO();
obj1.setTitle("标题");
obj1.setText("文本内容");
obj1.setBtnOrientation("0");
List<AlibabaMosTmcSendDingRobotMessageRequest.ActionCardBtnDTO> list3 = new ArrayList<AlibabaMosTmcSendDingRobotMessageRequest.ActionCardBtnDTO>();
AlibabaMosTmcSendDingRobotMessageRequest.ActionCardBtnDTO obj4 = new AlibabaMosTmcSendDingRobotMessageRequest.ActionCardBtnDTO();
list3.add(obj4);
obj4.setTitle("内容不错");
obj4.setActionUrl("https://www.miaostreet.com/");
obj1.setBtns(list3);
req.setActionCardDto(obj1);
AlibabaMosTmcSendDingRobotMessageRequest.SampleLinkDTO obj5 = new AlibabaMosTmcSendDingRobotMessageRequest.SampleLinkDTO();
obj5.setText("消息内容");
obj5.setTitle("标题");
obj5.setPicUrl("http://dingtalk.com");
obj5.setMessageUrl("http://dingtalk.com");
req.setSampleLinkDto(obj5);
AlibabaMosTmcSendDingRobotMessageRequest.SampleTextDTO obj6 = new AlibabaMosTmcSendDingRobotMessageRequest.SampleTextDTO();
obj6.setContent("消息内容");
req.setSampleTextDto(obj6);
AlibabaMosTmcSendDingRobotMessageRequest.SampleMarkdownDTO obj7 = new AlibabaMosTmcSendDingRobotMessageRequest.SampleMarkdownDTO();
obj7.setText("消息");
obj7.setTitle("标题");
req.setSampleMarkdownDto(obj7);
req.setRecieverIdList(nullL);
req.setUserType(3L);
AlibabaMosTmcSendDingRobotMessageResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<alibaba_mos_tmc_send_ding_robot_message_response>
    <data>true</data>
    <result_success>true</result_success>
    <result_err_code>200</result_err_code>
    <err_message>错误信息</err_message>
    <attributes>null</attributes>
    <is_async>false</is_async>
    <async_result>null</async_result>
    <trace_id>1111fd234f5234234</trace_id>
</alibaba_mos_tmc_send_ding_robot_message_response>

异常示例

  • XML示例
  • JSON示例
<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

错误码解释

错误码 错误描述 解决方案

API工具

如何获得此API

FAQ

返回
顶部