tencent cloud

Feedback

Pick User on the Seat

Last updated: 2024-09-14 17:33:22

    Feature Overview

    App administrators can allow members to take the seat through this API.

    API Calling Description

    Sample Request URL

    https://xxxxxx/v4/room_engine_http_mic/pick_user_on_seat?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

    Request Parameters

    The table below only lists the parameters modified when calling this API. For more details, please refer to RESTful API Overview.
    Parameter
    Description
    xxxxxx
    The reserved domain name for the country/region where the SDKAppID is located:
    Singapore :adminapisgp.im.qcloud.com
    v4/room_engine_http_mic/pick_user_on_seat
    Request API
    sdkappid
    The SDKAppID assigned by the Chat console when an app is created
    identifier
    Must be an App administrator account. For more details, please refer to App Administrator.
    usersig
    The Signature generated by the App administrator account. For more details, please refer to Generating UserSig.
    random
    Enter a random 32-bit unsigned integer ranging from 0 to 4294967295
    contenttype
    The request format fixed value is json

    Maximum Calling Frequency

    200 times per second.

    Sample Request Packets

    Basic Form
    {
    "RoomId":"room-test",
    "Member_Account":"user2",
    "Index":1
    }

    Request Packet Field Description

    Field
    Type
    Attribute
    Description
    RoomId
    String
    Mandatory
    Room ID
    Index
    Integer
    Mandatory
    Seat position number
    Member_Account
    String
    Mandatory
    Seat user ID, must be a room member

    Sample Response Packets

    Basic Form
    {
    "ErrorCode": 0,
    "ErrorInfo": "",
    "ActionStatus": "OK",
    "RequestId": "Id-7c1680be52734bdc8d6de398ab9505e7-O-Seq-57717"
    }

    Response Packet Field Description

    Field
    Type
    Description
    ActionStatus
    String
    The result of the request process. OK for success, FAIL for failure.
    ErrorCode
    Integer
    Error code. 0 for success, others for failure.
    ErrorInfo
    String
    Error message
    RequestId
    String
    The unique request ID is returned with each request and required to provide this RequestId when locating issues.

    Error Codes

    Unless a network error occurs (e.g., 502 error), the HTTP status code for this interface will always be 200. The actual error codes and messages are conveyed through ErrorCode and ErrorInfo in the response body. For common error codes (60000 to 79999), see Error Code documentation. The private error codes for this API are as follows:
    Error code
    Description
    100001
    Internal server error, please retry.
    100002
    Invalid parameter, please check the request for correctness based on the error description.
    100004
    Room does not exist, or it once existed but now has been destroyed.
    100005
    The user on the seat is not a room member.
    100200
    The seat position has been locked, you can try switching to another position.
    100202
    Already in queue for the seat.
    100203
    Already on the seat.
    100205
    The seat position is full.
    100210
    There is already a user on the seat position.
    100211
    This room does not support seat connection.

    Possible Callbacks

    
    
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support