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

cainiao.yima.communication.home.query (短信云呼首页查询)

短信云呼首页查询

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
personal_user_id Number 可选 3423423432 小件员个人账号
personal_session String 可选 sdfasfjalkdfsj= session

响应参数

名称 类型 示例值 描述
data CommunicationHomeResponse data data
  • └ available_counts
  • Number
  • 40
  • 短信云呼剩余次数
  • icon_item_list
  • Iconitemlist []
  • 图标信息列表
  • └ icon_url
  • String
  • https://
  • 图标地址
  • └ item_id
  • Number
  • 10
  • item_id
  • └ redirect_key
  • String
  • https://
  • 跳转key
  • └ title
  • String
  • 发送通知
  • 名称
  • send_record_list
  • Sendrecordlist []
  • 当天短信云呼记录
  • └ counts
  • Number
  • 10
  • 数量
  • └ record_type
  • Number
  • 100
  • 统计类型:总数、失败、成功、无法来取
  • └ title
  • String
  • 今日发送
  • 名称
  • activity_tag_list
  • ActivityTagItemDto []
  • 活动标签
  • └ code
  • String
  • fist_buy
  • 活动标签编码
  • └ name
  • String
  • 首充有礼
  • 活动标签名称
  • └ recharge_text
  • String
  • 低至2.7分/条 去充值
  • 充值参数
status_code String 222 业务错误码
status_message String 错误信息 错误信息
is_success Boolean true 成功与否
trace_id String fafafad 鹰眼id

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoYimaCommunicationHomeQueryRequest req = new CainiaoYimaCommunicationHomeQueryRequest();
req.setPersonalUserId(3423423432L);
req.setPersonalSession("sdfasfjalkdfsj=");
CainiaoYimaCommunicationHomeQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<cainiao_yima_communication_home_query_response>
    <data>
        <available_counts>40</available_counts>
        <icon_item_list>
            <iconitemlist>
                <icon_url>https://</icon_url>
                <item_id>10</item_id>
                <redirect_key>https://</redirect_key>
                <title>发送通知</title>
            </iconitemlist>
        </icon_item_list>
        <send_record_list>
            <sendrecordlist>
                <counts>10</counts>
                <record_type>100</record_type>
                <title>今日发送</title>
            </sendrecordlist>
        </send_record_list>
        <activity_tag_list>
            <activity_tag_item_dto>
                <code>fist_buy</code>
                <name>首充有礼</name>
            </activity_tag_item_dto>
        </activity_tag_list>
        <recharge_text>低至2.7分/条 去充值</recharge_text>
    </data>
    <status_code>222</status_code>
    <status_message>错误信息</status_message>
    <is_success>true</is_success>
    <trace_id>fafafad</trace_id>
</cainiao_yima_communication_home_query_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

返回
顶部