Channel Events

Once the Agora Notification Center Service (NCS) is enabled, the Agora NCS server sends notification callbacks as HTTPS POST requests to your server when your subscribed events occur. The data format of the requests is JSON, the character encoding is UTF-8, and the signature algorithm is HMAC/SHA1 or HMAC/SHA256.

Request Header

The header of notification callbacks contains the following fields:

Request Body

The request body of the notification callbacks contains the following fields:

Example of the request body of notification callbacks:

{ "noticeId": "2000001428:4330:107", "productId": 1, "eventType": 101, "notifyMs": 1611566412672, "payload": {...} } 

Types of channel events

The Agora NCS server notifies your server of the following types of channel events when you use the RTC service:

101 channel create

eventType 101 indicates that a channel is initialized (when the first user joins the channel). The payload contains the following fields:

Example of the payload``:

{ "channelName": "test_webhook", "ts": 1560396834 }

102 channel destroy

eventType 102 indicates that the last user in the channel leaves the channel and the channel is destroyed. The payload contains the following fields:

Example of the payload:

{ "channelName": "test_webhook", "ts": 1560399999 }

103 broadcaster join channel

eventType 103 indicates that a host joins the channel in the live streaming profile. The payload contains the following fields:

Example of the payload:

{ "channelName": "test_webhook", "uid": 12121212, "platform": 1, "clientSeq": 1625051030746, "ts": 1560396843 }

104 broadcaster leave channel

eventType 104 indicates that a host leaves the channel in the live streaming profile. The payload contains the following fields:

Example of the payload:

{ "channelName": "test_webhook", "uid": 12121212, "platform": 1, "clientSeq": 1625051030789, "reason": 1, "ts": 1560396943, "duration": 600 }

105 audience join channel

eventType 105 indicates that an audience member joins the channel in the live streaming profile. The payload includes the following fields:

Example of the payload:

{ "channelName": "test_webhook", "uid": 12121212, "platform": 1, "clientSeq": 1625051035346, "ts": 1560396843 }

106 audience leave channel

eventType 106 indicates that an audience member leaves the channel In the live streaming profile. The payload includes the following fields:

Example of the payload:

{ "channelName": "test_webhook", "uid": 12121212, "platform": 1, "clientSeq": 1625051035390, "reason": 1, "ts": 1560396943, "duration": 600 }

107 user join channel with communication mode

eventType 107 indicates that a user joins the channel in the communication profile. The payload includes the following fields:

Example of the payload:

{ "channelName": "test_webhook", "uid": 12121212, "platform": 1, "clientSeq": 1625051035369, "ts": 1560396834 }

108 user leave channel with communication mode

eventType 108 indicates that a user leaves the channel in the communication profile. The payload includes the following fields:

Example of the payload:

{ "channelName": "test_webhook", "uid": 12121212, "platform": 1, "clientSeq": 1625051037369, "reason": 1, "ts": 1560496834, "duration": 600 }

111 client role change to broadcaster

eventType 111 indicates that an audience member calls setClientRole to switch their user role to host in the live streaming profile. The payload includes the following fields:

Example of the payload:

{ "channelName": "test_webhook", "uid": 12121212, "clientSeq": 1625051035469, "ts": 1560396834 }

112 client role change to audience

eventType 112 indicates that a host call setClientRole to switch their user role to audience member in the live streaming profile. The payload contains the following fields:

Example of the payload:

{   "channelName": "test_webhook",    "uid": 12121212,    "clientSeq": 16250510358369,    "ts": 1560496834 }