# API List
The vchatCloud API is divided into chatroom management API, user management API, and chat API.
Every request must include a API_KEY and X-AUTH-TOKEN.
- chatroom management: A chat room-related API that allows you to create, modify, and destroy chat rooms and querying chat room lists and details.
- user management: A user-related API that allows you to query chat room users and restrict their use.
- chat: A chat-related API that enables notifications, whispering, and sending reservation messages.
TIP
✔️ To check API_KEY, roomId, clientKey and issue X-AUTH-TOKEN, see the Prepare to use API.
# chatroom management
The following are the main request URLs, methods, and response formats used in the Chatroom Management API:
| Request URL | Method | Response | Description |
|---|---|---|---|
| https://vchatcloud.com/openapi/v1/rooms | GET/POST | JSON | Request chat room list information and chat room creation. |
| https://vchatcloud.com/openapi/v1/rooms/{roomId} | GET/POST/DEL | JSON | Request chat room details, chat room modify and destroy. |
# user management
The following are the main request URLs, methods, and response formats used by the User Management API:
| Request URL | Method | Response | Description |
|---|---|---|---|
| https://vchatcloud.com/openapi/v1/users/{roomId} | GET | JSON | Request a list of chat room users and more information. |
| https://vchatcloud.com/openapi/v1/exiles/{roomId} | GET | JSON | Request a list of exiles users and more information. |
| https://vchatcloud.com/openapi/v1/exiles/{roomId}/{clientKey} | POST/PUT | JSON | Request user exiles and cancel exile |
| https://vchatcloud.com/openapi/v1/mute/{roomId} | GET | JSON | Request a list of write restriction user and more information. |
| https://vchatcloud.com/openapi/v1/mute/{roomId}/{clientKey} | POST/PUT | JSON | Request user writing restrictions and unwrite restrictions. |
# chat
The following are the main request URLs, methods, and response formats used in the Chat API:
| Request URL | Method | Response | Description |
|---|---|---|---|
| https://vchatcloud.com/openapi/v1/notice/{roomId} | POST | JSON | Request to send notice. |
| https://vchatcloud.com/openapi/v1/custom/{roomId} | POST | JSON | Request to send custom messages. |
| https://vchatcloud.com/openapi/v1/custom/{roomId}/{scheduleId} | DEL | JSON | Request cancellation of sending custom messages. |
| https://vchatcloud.com/openapi/v1/whisper/{roomId}/{clientKey} | POST | JSON | Request to send whispering message. |