GoChat
  • Overview
  • Demo App
  • SDK Integration
  • Client-Side Implementation
  • GoChat Cloud Service
  • Server APIs
  • Error codes
  • Documentation
  • GoChat
  • Server APIs
  • Invite to Stage

Invite to Stage

Last updated:2022-03-22 13:07

1 Description

The room host invites a listener to the speaker stage to join the chat.

Rate limit: 10 requests / second.

2 Request Method and Endpoint

  • Request method: POST
  • Request endpoint: /chat_room/invite_onstage
  • Content-Type: application/json

3 Request Parameters

Parameter Type Required Example Description
uid Int32 Yes 171171717 User ID.
room_id String Yes "11717" Room ID.
target_uid Int32 Yes 171171718 User ID of the listener being invited.

4 Request Example

{
  "uid":171171717,
  "room_id":"11717",
  "target_uid":171171718
}

5 Response Parameters

None.

6 Response Example

{
    "ret": {
        "code": 0,
        "message": "succeed"
    }
}

7 Return Codes

Return Code Description
80001 Incorrect parameter.
80012 The user is offline.
80002 The room does not exist.
80011 The user is not in the room.
Page Directory