淘宝开放平台

登录
文档中心 > API类目 > 菜鸟无线API

菜鸟无线API

cainiao.guoguo.im.send (发送在线消息)

菜鸟裹裹消息发送api

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
client_unique_key String 必须 123123 客户端唯一标识
content String 必须 hello 内容
ext String 可选 aaa 额外数据
receiver_id Number 可选 123213 接收者id
receiver_mobile String 可选 13612332132 接收者手机号
retry Boolean 可选 false
  • 默认值：false
    		•  是否重试
    send_strategy Number 可选 1
  • 默认值：0
    		•  发送策略
    sender_id Number 必须 321321 发送者id
    sess_id Number 可选 1112
  • 默认值：0
    		•  会话id
    session_code String 必须 avcd sessionCode
    type String 必须 1 类型
    user_id Number 必须 123321 当前用户id

    响应参数

    名称 类型 示例值 描述
    data MessageRespone aa data
    • └ client_unique_key
    • String
    • aa
    • clientUniqueKey
    • └ msg_id
    • Number
    • 123321
    • msgId
    • └ session_id
    • Number
    • 321321
    • sessionId
    • └ un_read_cnt
    • Number
    • 123
    • unReadCnt
    status_code String FAIL statusCode
    status_message String UN_INVALID statusMessage
    is_success Boolean false success

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    CainiaoGuoguoImSendRequest req = new CainiaoGuoguoImSendRequest();
    req.setClientUniqueKey("123123");
    req.setContent("hello");
    req.setExt("aaa");
    req.setReceiverId(123213L);
    req.setReceiverMobile("13612332132");
    req.setRetry(false);
    req.setSendStrategy(1L);
    req.setSenderId(321321L);
    req.setSessId(1112L);
    req.setSessionCode("avcd");
    req.setType("1");
    req.setUserId(123321L);
    CainiaoGuoguoImSendResponse rsp = client.execute(req);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    <cainiao_guoguo_im_send_response>
        <data>
            <client_unique_key>aa</client_unique_key>
            <msg_id>123321</msg_id>
            <session_id>321321</session_id>
            <un_read_cnt>123</un_read_cnt>
        </data>
        <status_code>FAIL</status_code>
        <status_message>UN_INVALID</status_message>
        <is_success>false</is_success>
    </cainiao_guoguo_im_send_response>

    异常示例

    • XML示例
    • JSON示例
    1
    2
    3
    4
    5
    6
    <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测试工具 错误码查询工具 SDK下载

    如何获得此API

    FAQ

    我要提问
    返回
    顶部