GET
/
api
/
v3
/
video-streaming
/
{streamId}
/
viewer-bans
get list of banned viewers
curl --request GET \
  --url https://apix.us.amity.co/api/v3/video-streaming/{streamId}/viewer-bans \
  --header 'Authorization: Bearer <token>'
{
  "videoStreamingBannedUsers": [
    {
      "userId": "<string>",
      "banBy": "<string>",
      "userPublicId": "<string>",
      "banByPublicId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "videoStreamings": {
    "streamId": "<string>",
    "userId": "<string>",
    "userInternalId": "64be1f6cb9b4106b5a6bbf3f",
    "userPublicId": "User123",
    "thumbnailFileId": "<string>",
    "title": "<string>",
    "status": "idle",
    "isLive": true,
    "isDeleted": true,
    "description": "<string>",
    "platform": {
      "name": "<string>",
      "version": "<string>"
    },
    "moderationId": "<string>",
    "startedAt": "2023-11-07T05:31:56Z",
    "endedAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "metadata": {},
    "resolution": "SD",
    "streamerUrl": {
      "url": "<string>",
      "components": {
        "origin": "<string>",
        "appName": "<string>",
        "streamName": "<string>",
        "query": "<string>"
      }
    },
    "recordings": [
      {
        "flv": {
          "url": "<string>",
          "duration": 123,
          "startTime": 123,
          "stopTime": 123
        },
        "mp4": {
          "url": "<string>",
          "duration": 123,
          "startTime": 123,
          "stopTime": 123
        },
        "m3u8": {
          "url": "<string>",
          "duration": 123,
          "startTime": 123,
          "stopTime": 123
        }
      }
    ],
    "watcherUrl": {
      "flv": {
        "url": "<string>",
        "components": {
          "origin": "<string>",
          "appName": "<string>",
          "streamName": "<string>",
          "query": "<string>"
        }
      },
      "hls": {
        "url": "<string>",
        "components": {
          "origin": "<string>",
          "appName": "<string>",
          "streamName": "<string>",
          "query": "<string>"
        }
      },
      "rtmp": {
        "url": "<string>",
        "components": {
          "origin": "<string>",
          "appName": "<string>",
          "streamName": "<string>",
          "query": "<string>"
        }
      }
    },
    "postId": "<string>",
    "channelId": "<string>",
    "channelEnabled": true
  },
  "videoStreamingModerations": {
    "moderationId": "<string>",
    "streamId": "<string>",
    "flagLabels": [
      {
        "category": "pornography",
        "threshold": 123,
        "detectedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "terminateLabels": [
      {
        "category": "pornography",
        "threshold": 123,
        "detectedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "users": {
    "_id": "<string>",
    "path": "<string>",
    "userId": "<string>",
    "roles": [
      "<string>"
    ],
    "displayName": "<string>",
    "flagCount": 123,
    "hashFlag": {
      "bits": 123,
      "hashes": 123,
      "hash": [
        "<string>"
      ]
    },
    "metadata": {},
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "isDeleted": true
  },
  "communities": {
    "_id": "<string>",
    "path": "<string>",
    "communityId": "<string>",
    "channelId": "<string>",
    "userId": "<string>",
    "userPublicId": "<string>",
    "userInternalId": "<string>",
    "displayName": "<string>",
    "avatarFileId": "<string>",
    "description": "<string>",
    "isOfficial": true,
    "isPublic": true,
    "onlyAdminCanPost": true,
    "tags": [
      "<string>"
    ],
    "metadata": {},
    "postsCount": 123,
    "membersCount": 123,
    "isJoined": true,
    "categoryIds": [
      "<string>"
    ],
    "isDeleted": false,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "hasFlaggedComment": false,
    "hasFlaggedPost": false,
    "needApprovalOnPostCreation": false,
    "moderatorMemberCount": 123,
    "allowCommentInStory": true,
    "isDiscoverable": false,
    "requiresJoinApproval": false,
    "notificationMode": "default"
  },
  "posts": {
    "_id": "<string>",
    "path": "<string>",
    "postId": "<string>",
    "parentPostId": "<string>",
    "postedUserId": "<string>",
    "postedUserPublicId": "<string>",
    "postedUserInternalId": "<string>",
    "publisherId": "<string>",
    "publisherPublicId": "<string>",
    "sharedUserId": "<string>",
    "sharedCount": 123,
    "targetId": "<string>",
    "targetPublicId": "<string>",
    "targetInternalId": "<string>",
    "targetType": "user",
    "dataType": "text",
    "data": {
      "title": "<string>",
      "text": "<string>",
      "fileId": "<string>",
      "thumbnailFileId": "<string>",
      "videoFileId": {
        "original": "<string>",
        "low": "<string>",
        "medium": "<string>",
        "high": "<string>"
      },
      "streamId": "<string>"
    },
    "metadata": {},
    "flagCount": 123,
    "hashFlag": {
      "bits": 123,
      "hashes": 123,
      "hash": [
        "<string>"
      ]
    },
    "editedAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "reactions": {
      "like": 1
    },
    "reactionsCount": 1,
    "myReactions": [
      "like"
    ],
    "commentsCount": 1,
    "comments": [
      "<string>"
    ],
    "children": [
      "<string>"
    ],
    "childrenNumber": 123,
    "isDeleted": false,
    "hasFlaggedComment": false,
    "hasFlaggedChildren": false,
    "feedId": "<string>",
    "tags": [
      "<string>"
    ],
    "mentionees": [
      {
        "type": "user",
        "userIds": [
          "<string>"
        ],
        "userPublicIds": [
          "<string>"
        ],
        "userInternalIds": [
          "<string>"
        ]
      }
    ],
    "impression": 123,
    "reach": 123
  },
  "files": {
    "fileId": "<string>",
    "fileUrl": "<string>",
    "type": "image",
    "accessType": "public",
    "altText": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "attributes": {
      "name": "<string>",
      "extension": "<string>",
      "size": 123,
      "mimeType": "<string>",
      "metadata": {
        "exif": {},
        "gps": {},
        "height": 123,
        "width": 123,
        "isFull": true
      }
    }
  },
  "paging": {
    "next": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

streamId
string
required

Stream id to update

Maximum length: 50

Response

200
application/json

List of banned users

The response is of type object.