End room

1 Description

Ends a room.

After a room is ended, users cannot join or rejoin the room.

2 Request method and endpoint

• Request method: POST
• Request endpoint:

  Service environment	Rate limit	Endpoint
  Production	20 times/second	https://roomkit-api.zego.im/room/v2/cancel

• Transmission protocol: HTTPS

3 Request parameters

4 Sample request

{
    "pid": 1255,
    "room_id": "123456",
    "custom_message": "Class cancelled.",
    "secret_id": 2587762184,
    "access_token": "kaVmfcZR5P8hpqqMmAWXCGYkxf2AgpQjo3NPfBg-mVHYfYUkukaXWN-wekbdVRDlYEp4mbvq9tonqDEw2nNsiw=="
}

5 Response parameters

6 Sample response

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