All Products
Search
Document Center

ApsaraVideo Live:ModifyLiveMessageUserInfo

Last Updated:Nov 14, 2024

Modifies the information about a user.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
live:ModifyLiveMessageUserInfoupdate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
AppIdstringYes

The ID of the interactive messaging application whose user information you want to modify.

demo
UserIdstringYes

The ID of the user whose information you want to modify.

uid2
UserMetaInfostringNo

The additional information about the user after the modification. The value can be up to 512 bytes in length.

uid2meta2
DataCenterstringNo

The data center. It must be the same as the data center that was specified when you called the CreateLiveMessageApp operation to create the interactive messaging application. Valid values: cn-shanghai and ap-southeast-1 (Singapore).

cn-shanghai

Response parameters

ParameterTypeDescriptionExample
object
FailListarray<object>

The users whose information failed to be modified.

FailGroupsobject
Codeinteger

The error code.

440
GroupIdstring

The ID of the group to which the user belongs. For failed modification, the information of the user is not updated when you query the users in the group. You can try again after you check the failure reason and fix the issue.

grouptest2
Reasonstring

The reason why the information of the user failed to be modified.

group not exists or already deleted
Successboolean

Indicates whether the group to which the user belongs is modified. In this case, the group is not modified.

false
RequestIdstring

The request ID.

3271ACD2-F143-1204-AFDB-9A87C131****
SuccessListarray<object>

The users whose information was modified.

SuccessGroupsobject
GroupIdstring

The ID of the group to which the user belongs. For successful modification, the information of the user is updated when you query the users in the group.

grouptest1
Successboolean

Indicates whether the group to which the user belongs is modified. In this case, the group is modified.

true

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
400InputInvalid%s.Illegal input parameters
403NoAuth%s.No permission
404ResourceNotExist%s.The requested resource does not exist, please check and try again
500ServerError%s.Unknown error, please try again later or submit a ticket for consultation.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-05-10The Error code has changed. The response structure of the API has changedView Change Details