文档中心 > API类目 > 天猫精灵开放API

taobao.ailab.aicloud.top.message.push.unicast (天猫精灵消息中心单播推送消息接口)

天猫精灵运营平台消息能力开放广播接口,主要开放给b端用户,用户可调用接口进行广播推送,将消息推送到天猫精灵设备或者天猫精灵APP中。

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
message_unicast_request MessageUnicastRequest 可选 消息推送单播请求体
  • └ push_context
  • String
  • 可选
  • {"app":"xxx","version":"xxx"}
  • 推送上下文信息
  • send_target
  • MessageSendTarget
  • 可选
  • 消息发送目标
  • └ target_type
  • String
  • 可选
  • UUID
  • 消息发送用户标识类型
  • └ target_identity
  • String
  • 可选
  • xxx
  • 消息发送用户标识id
  • └ message_template_id
  • String
  • 可选
  • xxx
  • 消息模板id
  • └ message_entity_id
  • String
  • 可选
  • xxx
  • 消息号id
  • └ place_holder
  • String
  • 可选
  • {"title":"xxx","name":"xxx"}
  • 模板占位符

响应参数

名称 类型 示例值 描述
trace_id String xxxxx 本次调用trace
ret_code Number 0 调用结果code 0:成功 非0:失败
ret_msg String 模板不存在 调用结果描述

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AilabAicloudTopMessagePushUnicastRequest req = new AilabAicloudTopMessagePushUnicastRequest();
AilabAicloudTopMessagePushUnicastRequest.MessageUnicastRequest obj1 = new AilabAicloudTopMessagePushUnicastRequest.MessageUnicastRequest();
obj1.setPushContext("{\"app\":\"xxx\",\"version\":\"xxx\"}");
AilabAicloudTopMessagePushUnicastRequest.MessageSendTarget obj2 = new AilabAicloudTopMessagePushUnicastRequest.MessageSendTarget();
obj2.setTargetType("UUID");
obj2.setTargetIdentity("xxx");
obj1.setSendTarget(obj2);
obj1.setMessageTemplateId("xxx");
obj1.setMessageEntityId("xxx");
obj1.setPlaceHolder("{\"title\":\"xxx\",\"name\":\"xxx\"}");
req.setMessageUnicastRequest(obj1);
AilabAicloudTopMessagePushUnicastResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<ailab_aicloud_top_message_push_unicast_response>
    <trace_id>xxxxx</trace_id>
    <ret_code>0</ret_code>
    <ret_msg>模板不存在</ret_msg>
</ailab_aicloud_top_message_push_unicast_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

返回
顶部