Create a group

Description

To create a group through this interface.

Upon successful creation of the group, the group owner will receive a notification of successful group creation through the following callback interface in the ZIM SDK, while other group members will receive a notification of joining the group:

Operation prototype

• Request method: POST
• Request endpoint: https://zim-api.zego.im/?Action=CreateGroup
• Protocol: HTTPS
• Rate limit: 20 requests/second

Request parameters

Listed below are the parameters specific to this request and part of the public request parameters. For the complete list of public request parameters, see Accessing Server APIs - Public parameters.

Sample request

• Request URL:

  https://zim-api.zego.im/?Action=CreateGroup
  &<Common request parameters>

• Request body:

  {
      "GroupId": "group",
      "GroupName": "group_name",
      "GroupNotice": "group_notice",
      "GroupAvatar": "https://www.baidu.com/",
      "GroupOwner": "owner",
      "UserId": [
          "user1",
          "user2"
      ],
      "Attributes": [
          {
              "Key": "key1",
              "Value": "value1"
          },
          {
              "Key": "key2",
              "Value": "value2"
          }
      ],
      "CreateGroupTime": 0
  }

Sample request

Sample response

{
    "Code": 0,
    "Message": "success",
    "RequestId": "343649807833778782",
    "GroupId": "group",
    "Members": [
        {
            "UserId": "owner",
            "UserName": "owner"
        },
        {
            "UserId": "user1",
            "UserName": "user1"
        }
    ],
    "ErrorUsers": [
        {
            "UserId": "user2",
            "SubCode": 660000015
        }
    ]
}

Return codes

The following table describes only the return codes related to the business logic of the operation. For the complete list of return codes, see Return codes.