taobao.openim.tribe.create (创建群)

创建一个openim的群

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
user OpenImUser 必须 用户信息
  • └ uid
  • String
  • 可选
  • abc
  • 用户id
  • └ taobao_account
  • Boolean
  • 可选
  • false
  • 是否为淘宝账号
  • └ app_key
  • String
  • 可选
  • demo
  • 账户appkey
tribe_name String 必须 tribenamedemp 群名称
notice String 必须 tribetypedemp 群公告
tribe_type Number 必须 0 群类型有两种tribe_type = 0 普通群 普通群有管理员角色,对成员加入有权限控制tribe_type = 1 讨论组 讨论组没有管理员,不能解散
members OpenImUser [] 特殊可选
  • 最大列表长度:1000
  • 创建群时候拉入群的成员tribe_type = 1(即为讨论组类型)时 该参数为必选tribe_type = 0 (即为普通群类型)时,改参数无效,可不填
    • └ uid
    • String
    • 可选
    • abc
    • 用户id
    • └ taobao_account
    • Boolean
    • 可选
    • false
    • 是否为淘宝账号
    • └ app_key
    • String
    • 可选
    • demo
    • 账户appkey

    响应参数

    名称 类型 示例值 描述
    tribe_info TribeInfo 创建群的信息
    • └ tribe_id
    • Number
    • 123
    • 群ID
    • └ icon
    • String
    • demo
    • 群头像URL地址
    • └ check_mode
    • Number
    • 123
    • 群验证模式
    • └ tribe_type
    • Number
    • 123
    • 群类型
    • └ name
    • String
    • demo
    • 群名称
    • └ recv_flag
    • Number
    • 123
    • 群接收标记
    • └ notice
    • String
    • demo
    • 群公告

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    OpenimTribeCreateRequest req = new OpenimTribeCreateRequest();
    OpenImUser obj1 = new OpenImUser();
    obj1.setUid("abc");
    obj1.setTaobaoAccount(false);
    obj1.setAppKey("demo");
    req.setUser(obj1);
    req.setTribeName("tribenamedemp");
    req.setNotice("tribetypedemp");
    req.setTribeType(0L);
    List<OpenImUser> list3 = new ArrayList<OpenImUser>();
    OpenImUser obj4 = new OpenImUser();
    list3.add(obj4);
    obj4.setUid("abc");
    obj4.setTaobaoAccount(false);
    obj4.setAppKey("demo");
    req.setMembers(list3);
    OpenimTribeCreateResponse rsp = client.execute(req);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <openim_tribe_create_response>
        <tribe_info>
            <tribe_id>123</tribe_id>
            <icon>demo</icon>
            <check_mode>123</check_mode>
            <tribe_type>123</tribe_type>
            <name>demo</name>
            <recv_flag>123</recv_flag>
            <notice>demo</notice>
        </tribe_info>
    </openim_tribe_create_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>

    错误码解释

    错误码 错误描述 解决方案
    isv.param-error 创建群的参数无效 检查创建的群的参数 1 appKey是否有效 2 tryie_type = 1时 是否有传入members参数
    isp.service-error OPENIM群服务内部错误 请向OPENIM技术支持反馈

    API工具

    如何获得此API

    FAQ

    返回
    顶部