淘宝开放平台

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

菜鸟无线API

cainiao.yima.communication.records.querylist (短信云呼通知记录列表)

短信云呼通知记录列表

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
personal_user_id Number 可选 4398618530740 小件员个人账号
page_cursor String 可选 "" 游标
record_type Number 可选 100
  • 默认值：100
    		•  统计类型:总数、失败、成功、无法来取
    search_key String 可选 23213321 根据运单号or手机号查询
    personal_session String 可选 fadfsadaf session
    time_type Number 可选 1 时间类别：1 当天 2 半年

    响应参数

    名称 类型 示例值 描述
    data CommunicationRecordsListResponse data 出参
    • └ page_cursor
    • String
    • “”
    • 游标
    • datas
    • RecordDto []
    • 结果集
    • └ create_time
    • Number
    • 创建时间
    • └ id
    • Number
    • 1112
    • 记录id
    • └ mail_no
    • String
    • 42323423
    • 运单号
    • └ num
    • String
    • 2
    • 编号
    • └ phone
    • String
    • 122112
    • 手机号
    • └ send_content
    • String
    • 打的费
    • 发送内容
    • └ send_type
    • Number
    • 1
    • 通知类型：短信or云呼
    • └ status
    • Number
    • 1
    • 状态
    • └ task_id
    • Number
    • 21414
    • 任务id
    • └ sms_count
    • Number
    • 1
    • 短信计费条数
    • └ source
    • String
    • COLLECT
    • 调用来源
    • └ total_counts
    • Number
    • 100
    • 总数
    status_code String 121 错误编码
    status_message String ERROR 错误信息
    is_success Boolean true 处理成功与否
    trace_id String fdfa 鹰眼id

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    CainiaoYimaCommunicationRecordsQuerylistRequest req = new CainiaoYimaCommunicationRecordsQuerylistRequest();
    req.setPersonalUserId(4398618530740L);
    req.setPageCursor("\"\"");
    req.setRecordType(100L);
    req.setSearchKey("23213321");
    req.setPersonalSession("fadfsadaf");
    req.setTimeType(1L);
    CainiaoYimaCommunicationRecordsQuerylistResponse rsp = client.execute(req);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    <cainiao_yima_communication_records_querylist_response>
        <data>
            <page_cursor>“”</page_cursor>
            <datas>
                <record_dto>
                    <create_time></create_time>
                    <id>1112</id>
                    <mail_no>42323423</mail_no>
                    <num>2</num>
                    <phone>122112</phone>
                    <send_content>打的费</send_content>
                    <send_type>1</send_type>
                    <status>1</status>
                    <task_id>21414</task_id>
                    <sms_count>1</sms_count>
                    <source>COLLECT</source>
                </record_dto>
            </datas>
            <total_counts>100</total_counts>
        </data>
        <status_code>121</status_code>
        <status_message>ERROR</status_message>
        <is_success>true</is_success>
        <trace_id>fdfa</trace_id>
    </cainiao_yima_communication_records_querylist_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

    我要提问
    返回
    顶部