GET
/
api
/
v3
/
video-streaming
get list of video streaming
curl --request GET \
  --url https://apix.us.amity.co/api/v3/video-streaming \
  --header 'Authorization: Bearer <token>'
{
  "results": {
    "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,
        "isParent": false,
        "parentStreamId": "<string>",
        "childStreamIds": []
      }
    ],
    "videoStreamingChildren": [
      {
        "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,
        "isParent": false,
        "parentStreamId": "<string>",
        "childStreamIds": []
      }
    ],
    "videoStreamModerations": [
      {
        "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>",
        "userInternalId": "<string>",
        "userPublicId": "<string>",
        "roles": [
          "<string>"
        ],
        "permissions": [
          "MUTE_CHANNEL"
        ],
        "displayName": "<string>",
        "profileHandle": "<string>",
        "description": "<string>",
        "avatarFileId": "<string>",
        "avatarCustomUrl": "<string>",
        "flagCount": 123,
        "hashFlag": {
          "bits": 123,
          "hashes": 123,
          "hash": [
            "<string>"
          ]
        },
        "metadata": {},
        "isGlobalBan": true,
        "isBrand": true,
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "isDeleted": true
      }
    ],
    "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>",
    "prev": "<string>"
  }
}

Authorizations

Authorization
string
header
required

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

Query Parameters

isLive
boolean
default:false
statuses
enum<string>[]

Status of livestreaming

  • idle - streaming is just created
  • live - streamer is streaming now or streamer is reconnecting
  • ended - streamer stop streaming or streamer disconnect and not connect back in time period
  • recorded - live stream recordings available
Maximum length: 10
userPublicIds
string[]
Maximum length: 100
sortBy
enum<string>
Available options:
firstCreated,
lastCreated
isDeleted
boolean

isDeleted:

  • null(default) - Show both video streaming is activated and video streaming is inactivated.
  • true - Show video streaming is inactivated only.
  • false - Show video streaming is activated only.
options
object

Response

list of video streaming

results
object
paging
object