SetGroupMembersNickname
https://zim-api.zego.im/
By calling this API, you can batch modify the nicknames of members in a group. By default, you can modify the nicknames of up to 20 users at a time. If you need to adjust this, please contact ZEGOCLOUD Technical Support.
After the nickname is successfully set, group members will receive relevant notifications through the following ZIM SDK callback interfaces:
| iOS | Android | macOS | Windows |
|---|---|---|---|
| groupMemberInfoUpdated | onGroupMemberInfoUpdated | groupMemberInfoUpdated | onGroupMemberInfoUpdated |
| Web | Mini Program | Flutter | React Native |
|---|---|---|---|
| groupMemberInfoUpdated | groupMemberInfoUpdated | onGroupMemberInfoUpdated | groupMemberInfoUpdated |
| Unity3D | uni-app | uni-app x | HarmonyOS |
|---|---|---|
| OnGroupMemberInfoUpdated | groupMemberInfoUpdated | groupMemberInfoUpdated |
FromUserId and UserId have logged in to the ZIM service by calling the login method on the client, or have completed registration by calling the server-side API.The parameters FromUserId, GroupId, UserIds, and Nickname only support numbers, English characters, and '!','#','$','%','&','(',')','+','\'',':',';','<','=','.','>','?' ,'@','[',']','^','_','{','}','|','~'.
Request
Query Parameters
Possible values: [SetGroupMembersNickname]
API prototype parameter
https://zim-api.zego.im/?Action=SetGroupMembersNickname
💡Public parameter. Application ID, assigned by ZEGOCLOUD. Get it from the ZEGOCLOUD Admin Console.
💡Public parameter. A 16-character hexadecimal random string (hex encoding of 8-byte random number). Refer to Signature example for how to generate.
💡Public parameter. Current Unix timestamp, in seconds. Refer to Signature example for how to generate, with a maximum error of 10 minutes.
Possible values: [2.0]
Default value: 2.0
💡Public parameter. Signature version number.
💡Public parameter. Signature, used to verify the legitimacy of the request. Refer to Signing the requests for how to generate an API request signature.
- application/json
Responses
- 200
- application/json