Block chat users temporarily

Prev Next

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}

Request headers

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

Request path parameters

The description of the parameters is as follows:

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

Request body

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

    Examples

    Introduces examples of syntax.

    Request examples

    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}"