ModifyLiveMessageUserInfo - Modify user info | ApsaraVideo Live API - ApsaraVideo Live

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

live:ModifyLiveMessageUserInfo

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The ID of the interactive messaging application.	demo
UserId	string	Yes	The ID of the user to modify.	uid2
UserMetaInfo	string	No	Additional user metadata after the modification. Maximum length: 512 bytes.	uid2meta2
DataCenter	string	No	The data center. Must match the value specified when calling CreateLiveMessageApp. Valid values: cn-shanghai and ap-southeast-1 (Singapore).	cn-shanghai

Response elements

Element	Type	Description	Example
	object
FailList	array<object>	Users whose information failed to be modified.
	object
Code	integer	The error code.	440
GroupId	string	The group ID. For failed modification, the information of the user is not updated when you query the users in the group. Check the failure reason and retry.	grouptest2
Reason	string	The failure reason.	group not exists or already deleted
Success	boolean	Indicates whether the group to which the user belongs is modified. In this case, the group is not modified.	false
RequestId	string	The request ID.	3271ACD2-F143-1204-AFDB-9A87C131****
SuccessList	array<object>	Users whose information was modified.
	object
GroupId	string	The group ID. For successful modification, the information of the user is updated when you query the users in the group.	grouptest1
Success	boolean	Indicates whether the group to which the user belongs is modified. In this case, the group is modified.	true

Examples

Success response

JSON format

{
  "FailList": [
    {
      "Code": 440,
      "GroupId": "grouptest2",
      "Reason": "group not exists or already deleted",
      "Success": false
    }
  ],
  "RequestId": "3271ACD2-F143-1204-AFDB-9A87C131****",
  "SuccessList": [
    {
      "GroupId": "grouptest1",
      "Success": true
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InputInvalid	%s.	Invalid input parameters.
500	ServerError	%s.	Unknown error. Try again later or submit a ticket.
403	NoAuth	%s.	Insufficient permissions.
404	ResourceNotExist	%s.	The specified resource does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.