Custom snapshot and moderation

Custom snapshot and moderation enables you to use third-party cloud storage services, while standard snapshot and moderation does not.

Sets the custom snapshot configuration for all live streams under an entry point, including the interval of snapshot capturing and whether to enable content moderation.

_1

PATCH https://api.agora.io/v1/projects/{appid}/fls/entry_points/{entry_point}/settings/snapshot/custom/regions/{region}

Parameter	Type	Description
appid	String	Required. The App ID corresponding to the entry point.
entry_point	String	Required. The entry point name.
region	String	Required. The configured region when adding the domain.

The request body is in the JSON Object type, and contains the following fields:

Field	Type	Description
enabled	Bool	Required. Whether to enable the snapshot capturing function: true: Enable snapshot capturing. false: Disable snapshot capturing.
snapshotInterval	Integer	Optional. The interval between snapshot capturing, in seconds. The default value is 10, and the value range is [5,300].
storageConfig	JSON Object	Optional. For the storage configuration of the snapshot files, see StorageConfig.
enableModeration	Bool	Optional. Whether to enable content moderation: true: Enable content moderation. false: (default) Disable content moderation.

If the returned HTTP status code is 200, the request is successful.

If the returned HTTP status code is not 200, the request fails. You can refer to the HTTP status code for possible reasons.

Request line

_1

PATCH https://api.agora.io/v1/projects/{your_appid}/fls/entry_points/live/settings/snapshot/custom/regions/cn HTTP/1.1

Request body

_12

{

_12

"enabled": true,

_12

"enableModeration": true,

_12

"snapshotInterval": 30,

_12

"storageConfig": {

_12

"accessKey": "{your access key}",

_12

"bucket": "{your bucket}",

_12

"region": 3,

_12

"secretKey": "{your secret key}",

_12

"vendor": 2

_12

}

_12

}

Response line

_1

HTTP/1.1 200 OK

Gets the custom snapshot configuration of an entry point.

_1

GET https://api.agora.io/v1/projects/{appid}/fls/entry_points/{entry_point}/settings/snapshot/custom/regions/{region}

Parameter	Type	Description
appid	String	Required. The App ID corresponding to the entry point.
entry_point	String	Required. The entry point name.
region	String	Required. The configured region when adding the domain.

If the returned HTTP status code is 200, the request is successful, and the response body contains the following fields:

Field	Type	Description
enabled	Bool	Whether the snapshot capturing function is enabled: true: Snapshot capturing is enabled. false: Snapshot capturing is disabled.
snapshotInterval	Integer	The interval between snapshot capturing, in seconds. The default value is 10, and the value range is [5,300].
storageConfig	JSON Object	For the storage configuration of the snapshot files, see StorageConfig.
enableModeration	Bool	Whether content moderation is enabled: true: Content moderation is enabled. false: Content moderation is not enabled.

If the returned HTTP status code is not 200, the request fails. You can refer to the HTTP status code for possible reasons.

Request line

_1

GET https://api.agora.io/v1/projects/{your_appid}/fls/entry_points/live/settings/snapshot/custom/regions/cn HTTP/1.1

Response line

_1

HTTP/1.1 200 OK

Request body

_11

{

_11

"enabled": true,

_11

"enableModeration": true,

_11

"snapshotInterval": 30,

_11

"storageConfig": {

_11

"accessKey": "test access key",

_11

"region": 3,

_11

"secretKey": "test secret key",

_11

"vendor": 2

_11

}

_11

}

The storage configuration of the snapshot files contains the following fields:

• vendor: Number. The third-party cloud storage vendor.

  • 0: Qiniu Cloud

  • 1: Amazon S3

  • 2: Alibaba Cloud

  • 3: Tencent Cloud

  • 4: Kingsoft Cloud

  • 5: Microsoft Azure

  • 6: Google Cloud

  • 7: Huawei Cloud

  • 8: Baidu AI Cloud

• region: Number. The region information specified for the third-party cloud storage. The recording service only supports regions in the following lists:

  In order to improve the success rate and real-time performance when uploading recording files, if you set the region of the cloud recording service in the acquire method, make sure that the region of the third-party cloud storage corresponds to the same geographical region. For example, if the region of the cloud recording service is set to NA (North America), the third-party cloud storage needs to be set to a location within North America.

When the third-party cloud storage is Qiniu Cloud (vendor = 0):

• 0: East China
• 1: North China
• 2: South China
• 3: North America
• 4: Southeast Asia

When the third-party cloud storage is Amazon S3 (vendor = 1):

• 0：US_EAST_1
• 1：US_EAST_2
• 2：US_WEST_1
• 3：US_WEST_2
• 4：EU_WEST_1
• 5：EU_WEST_2
• 6：EU_WEST_3
• 7：EU_CENTRAL_1
• 8：AP_SOUTHEAST_1
• 9：AP_SOUTHEAST_2
• 10：AP_NORTHEAST_1
• 11：AP_NORTHEAST_2
• 12：SA_EAST_1
• 13：CA_CENTRAL_1
• 14：AP_SOUTH_1
• 15：CN_NORTH_1
• 16：CN_NORTHWEST_1
• 18：AF_SOUTH_1
• 19：AP_EAST_1
• 20：AP_NORTHEAST_3
• 21：EU_NORTH_1
• 22：ME_SOUTH_1
• 24：AP_SOUTHEAST_3
• 25：EU_SOUTH_1
• 26：AWS_REGION_NUM

When the third-party cloud storage is Alibaba Cloud (vendor = 2):

• 0: CN_Hangzhou
• 1: CN_Shanghai
• 2: CN_Qingdao
• 3: CN_Beijing
• 4: CN_Zhangjiakou
• 5: CN_Huhehaote
• 6: CN_Shenzhen
• 7: CN_Hongkong
• 8: US_West_1
• 9: US_East_1
• 10: AP_Southeast_1
• 11: AP_Southeast_2
• 12: AP_Southeast_3
• 13: AP_Southeast_5
• 14: AP_Northeast_1
• 15: AP_South_1
• 16: EU_Central_1
• 17: EU_West_1
• 18: EU_East_1
• 19：AP_Southeast_6
• 20：CN_Heyuan
• 21：CN_Guangzhou
• 22：CN_Chengdu

For details, see Alibaba Cloud Documentation.

When the third-party cloud storage is Tencent Cloud (vendor = 3):

• 0：AP_Beijing_1
• 1：AP_Beijing
• 2：AP_Shanghai
• 3：AP_Guangzhou
• 4：AP_Chengdu
• 5：AP_Chongqing
• 6：AP_Shenzhen_FSI
• 7：AP_Shanghai_FSI
• 8：AP_Beijing_FSI
• 9：AP_Hongkong
• 10：AP_Singapore
• 11：AP_Mumbai
• 12：AP_Seoul
• 13：AP_Bangkok
• 14：AP_Tokyo
• 15：NA_Siliconvalley
• 16：NA_Ashburn
• 17：NA_Toronto
• 18：EU_Frankfurt
• 19：EU_Moscow

When the third-party cloud storage is Kingsoft Cloud (vendor = 4):

• 0：CN_Hangzhou
• 1：CN_Shanghai
• 2：CN_Qingdao
• 3：CN_Beijing
• 4：CN_Guangzhou
• 5：CN_Hongkong
• 6：JR_Beijing
• 7：JR_Shanghai
• 8：NA_Russia_1
• 9：NA_Singapore_1

When the third-party cloud storage is Microsoft Azure (vendor = 5):

The region parameter has no effect, whether or not it is set.

When the third-party cloud storage is Google Cloud (vendor = 6):

The region parameter has no effect, whether or not it is set.

When the third-party cloud storage is Huawei Cloud (vendor = 7):

• 0：CN_North_1
• 1：CN_North_4
• 2：CN_East_2
• 3：CN_East_3
• 4：CN_South_1
• 5：CN_Southwest_2
• 6：AP_Southeast_1
• 7：AP_Southeast_2
• 8：AP_Southeast_3
• 9：AF_South_1
• 10：SA_Argentina_1
• 11：SA_Peru_1
• 12：NA_Mexico_1
• 13：SA_Brazil_1
• 14：LA_South_2
• 15：SA_Chile_1

When the third-party cloud storage is Baidu AI Cloud (vendor = 8):

• 0：Beijing
• 1：Baoding
• 2：Suzhou
• 3：Guangzhou
• 4：Hongkong
• 5：Singapore
• 6：Wuhan
• 7：Shanghai

• bucket: String. The bucket name of the third-party cloud storage.

• accessKey: String. The access key of the third-party cloud storage. Agora suggests that you use a write-only access key.

• secretKey: String. The secret key of the third-party cloud storage.

Status code	Description
200	The request succeeds.
400	The parameter is invalid, for example the appid or the entry_point is empty, or the region parameter value is invalid.
401	Unauthorized (the customer ID and the customer secret do not match).
404	The server cannot find the resource according to the request, which means the requested entry point does not exist or the requested URI path is invalid.
500	An internal error occurs in the server, so the server is not able to complete the request.
504	An internal error occurs in the server. The gateway or the proxy server did not receive a timely request from the remote server.