MENU
      Block chat users temporarily
        • PDF

        Block chat users temporarily

        • PDF

        Article summary

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

        Request headers

        The description of the header is as follows:

        NameTypeDescriptionRequired
        x-prism-access-tokenStringAccess Token issued through OAuth2.0 authorizationY

        Request path parameters

        The description of the parameters is as follows:

        NameTypeDescriptionRequired
        liveIdStringLive IDY
        userIdStringUser IDY

        Request body

        The description of the body is as follows:

        NameTypeDescriptionRequired
        banTimeNumber
      • 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}"
        Bash

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.