注意:以下文档只适用于TOP接口,请谨慎使用!

taobao.openim.relations.get (获取openim账号的聊天关系)

获取openim账号的聊天关系

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
beg_date String 必须 20150501 查询起始日期。格式yyyyMMdd。不得早于一个月
end_date String 必须 20150503 查询结束日期。格式yyyyMMdd。不得早于一个月
user OpenImUser 必须 用户信息
  • └ uid
  • String
  • 必须
  • abc
  • 用户id
  • └ taobao_account
  • Boolean
  • 可选
  • false
  • 默认值:false
  • 是否为淘宝账号
  • └ app_key
  • String
  • 可选
  • 234234
  • 账户appkey

响应参数

名称 类型 示例值 描述
users OpenImUser [] 用户信息列表
  • └ uid
  • String
  • abc
  • 用户id
  • └ taobao_account
  • Boolean
  • false
  • 是否为淘宝账号
  • └ app_key
  • String
  • demo
  • 账户appkey

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
OpenimRelationsGetRequest req = new OpenimRelationsGetRequest();
req.setBegDate("20150501");
req.setEndDate("20150503");
OpenImUser obj1 = new OpenImUser();
obj1.setUid("abc");
obj1.setTaobaoAccount(false);
obj1.setAppKey("demo");
req.setUser(obj1);
OpenimRelationsGetResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<openim_relations_get_response>
    <users>
        <open_im_user>
            <uid>abc</uid>
            <taobao_account>false</taobao_account>
            <app_key>demo</app_key>
        </open_im_user>
    </users>
</openim_relations_get_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

返回
顶部