RHP_API

<back to all web services

GetUserChatroomAuthorisation

Get Chat Room user authorisation

Requires Authentication
The following routes are available for this service:
GET/User/ChatRoom
GetUserChatroomAuthorisation Parameters:
NameParameterData TypeRequiredDescription
RoomIdentifierquerystringNo
UserChatRoomAuthorisation Parameters:
NameParameterData TypeRequiredDescription
CanAccessChatformboolNo
ReasonformUserChatAuthorisationReasonNo
RemainingTimeformint?No
IsModeratorformboolNo
VideoCanViewformintNo
VideoCanBroadcastformboolNo
CanAccessFeaturedChatformboolNo
FeaturedRoomReasonformUserChatAuthorisationReasonNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /User/ChatRoom HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"CanAccessChat":false,"Reason":"Authorised","RemainingTime":0,"IsModerator":false,"VideoCanView":0,"VideoCanBroadcast":false,"CanAccessFeaturedChat":false,"FeaturedRoomReason":"Authorised"}