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

alibaba.ailabs.aligenie.skill.message.push (天猫精灵消息推送标准接口)

用于AliGenie技能开发者在技能内主动向音响推送消息的标准服务接口,只有订阅过该消息的用户才能收到消息;

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
auth_account_type String 可选 1000
  • 默认值:1000
  • 鉴权用户类型
    content String 必须 我是消息内容 要推送的消息内容
    skill_id Number 必须 1234 智能应用平台创建的技能id
    account_type String 可选 1001
  • 默认值:1001
  • 接收方的用户Id,从技能WebHook中取得的userOpenId
    push_type String 必须 TO_USER 消息推送的方式,和技能中申请的权限相关,可选值为TO_USER,TO_APP_BOX,BROADCAST
    test Boolean 可选 false
  • 默认值:false
  • 是否是测试消息
    user_id String 可选 userOpenId TO_USER时必填,接收方的用户Id,从技能WebHook中取得的userOpenId
    uuid String 可选 deviceOpenId 接收方的用户设备id,从技能WebHook中取得的deviceOpenId,填写设备id,则用户id必填,否则无法推送

    响应参数

    名称 类型 示例值 描述
    push_error_code String 消息推送错误码
    push_error_msg String 消息推送错误信息
    model Boolean true 消息推送是否成功
    push_result Boolean true 接口调用是否成功

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    AlibabaAilabsAligenieSkillMessagePushRequest req = new AlibabaAilabsAligenieSkillMessagePushRequest();
    req.setAuthAccountType("1000");
    req.setContent("我是消息内容");
    req.setSkillId(1234L);
    req.setAccountType("1001");
    req.setPushType("TO_USER");
    req.setTest(false);
    req.setUserId("userOpenId");
    req.setUuid("deviceOpenId");
    AlibabaAilabsAligenieSkillMessagePushResponse rsp = client.execute(req);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <alibaba_ailabs_aligenie_skill_message_push_response>
        <push_error_code></push_error_code>
        <push_error_msg></push_error_msg>
        <model>true</model>
        <push_result>true</push_result>
    </alibaba_ailabs_aligenie_skill_message_push_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

    返回
    顶部