Block chat users temporarily

Article summary

Did you find this summary helpful?

Thank you for your feedback

Available in Classic and VPC

It is an API to block chat users for a certain period of time. For the use flow of B2B PRISM Live Studio, see Chat user management process.

Requests

The request format is as follows:

PUT /prism/v1/service/live/{liveId}/timedBan/{userId}

The description of the header is as follows:

Name	Type	Description	Required
x-prism-access-token	String	Access Token issued through OAuth2.0 authorization	Y

The description of the parameters is as follows:

Name	Type	Description	Required
liveId	String	Live ID	Y
userId	String	User ID	Y

The description of the body is as follows:

Name	Type	Description	Required
banTime	Number	Specifies the time to block in units of seconds Enter a value more than 0	Y

Introduces examples of syntax.

An example of the syntax is as follows:

curl -X PUT /prism/v1/service/live/{liveId}/timedBan/{userId}
    -H "x-prism-access-token: {access-token}"

Was this article helpful?

Table of contents