调用CreateGroup创建群会话,若会话已存在,返回会话创建成功。

最大支持500个群成员。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
AppId String apitest

App ID。IMPaaS租户的ID。

RequestParams Object

创建群聊请求体。

Uuid String 12345678998765

用于去重,24小时内相同会去重,最大128个字符。

CreatorAppUid String 9100088885****

创建者用户ID。

Title String 我的饭团群

群标题。

IconMediaId String abc123

群头像ID。必须是通过多媒体上传接口上传图像后返回的mediaId。

Extensions Map

群信息扩展字段。最多20个key,每个value最大512个字节。

String {"k1":"v1"}

扩展信息。

InitMembers Array

初始化群成员列表。可选,创建者可在群成员列表里。

AppUid String 8866

用户ID。

Role Integer 3

成员角色。取值:

  • 1:群主。
  • 2:管理员。
  • 3:普通。
  • 100~127:自定义。
Nick String Alice

群成员昵称。

JoinTime Long 1608739200000

时间戳,单位:毫秒。

一般不填,一般用在异构IM迁移时使用,默认为调用该API的时间。

Extensions Map

群信息扩展字段。最多20个key,每个value最大512个字节。

String {"k1":"v1"}

扩展信息。

返回数据

名称 类型 示例值 描述
RequestId String C02635EE-C867-4CC0-9DE0-E4497378F720

请求ID。

Code String Group.xxx

错误码。

Message String Error Message

错误信息。

Result object

返回结果。

AppCid String $2$111000

创建成功后的群会话ID。

示例

请求示例

http(s)://live-interaction.aliyuncs.com/?AppId=apitest
&RequestParams={"Uuid":"12345678998765","CreatorAppUid":"9100088885****","Title":"我的饭团群","IconMediaId":"abc123","Extensions":{"key":"{\"k1\":\"v1\"}"},"InitMembers":[{"AppUid":"8866","Role":3,"Nick":"Alice","JoinTime":1608739200000,"Extensions":{"key":"{\"k1\":\"v1\"}"}}]}
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<RequestId>C02635EE-C867-4CC0-9DE0-E4497378F720</RequestId>
<Code>Group.xxx</Code>
<Message>Error Message</Message>
<Result>
    <AppCid>$2$111000</AppCid>
</Result>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "C02635EE-C867-4CC0-9DE0-E4497378F720",
  "Code" : "Group.xxx",
  "Message" : "Error Message",
  "Result" : {
    "AppCid" : "$2$111000"
  }
}

错误码

访问错误中心查看更多错误码。