Callback on room created
Overview
With this callback, you can receive the callback on the room created by the user in real time, and view the information of the room created by the user.
Callback description
- Request method: POST.
Note
The callback data format is JSON, and you need to perform UrlDecode decoding on it.
- Request URL: The corresponding callback endpoint set in the ZEGOCLOUD Admin Console
- Protocol: HTTPS/HTTP. HTTPS is recommended.
Callback parameters
Parameter | Type | Description |
---|---|---|
appid | String | The unique identifier of the App. |
event | String | The callback event. The return value of this callback is group_create . |
timestamp | Int | The server time in Unix timestamp when the group is created. |
nonce | String | A random number, used to calculate the signature. |
signature | String | The verification string. For details, see Authenticating server-to-server callbacks |
Parameters | Type | Description |
---|---|---|
room_id | String | Room ID. |
operator_account | String | The user ID of the room creator. |
room_name | String | Room name. |
attributes | Array of Object | The attributes set when the room is created. |
└ key | String | The attribute Key. |
└ value | String | The attribute Value. |
└ auto_delete | Int | Whether the attribute will be automatically deleted when operator_account exits the room.
|
We recommend that you convert some parameters to Int for logical processing. The relevant fields include appid
and nonce
.
Sample code
{
"appid" : "1",
"event" : "room_create",
"room_id" : "1",
"nonce": "350176",
"signature": "signature",
"operator_account" : "userA",
"room_name" : "room_name",
"attributes" : [
{
"key" : "UserSet1",
"value" : "UserGet1",
"auto_delete" : 0
}
{
"key" : "UserSet2",
"value" : "UserGet2",
"auto_delete" : 0
}
]
"timestamp" : 1499676978
}
Return codes
A status code of 2XX (such as 200) indicates success, and other responses indicate failure.
Callback retry policy
If the ZEGOCLOUD server does not receive a response, or the HTTP status code received by the ZEGOCLOUD server is not 2xx (such as 200), it will retry with intervals of 2s, 4s, 8s, 16s, and 32s respectively. If the retry still fails after an interval of 32s, it will no longer retry.