Custom Streams Projects

post
Create Custom Streams Project

https://api-v2.acrcloud.com/api/bm-cs-projects
Request
Response
Request
Headers
Authentication
required
string
Bearer token
Body Parameters
external_ids
optional
string
spotify,deezer,isrc,upc,musicbrainz
metadata_template
optional
string
The streams metadata template
region
required
string
eu-west-1,us-west-2,ap-southeast-1
name
required
string
Project name
buckets
required
string
Bucket ids array
type
required
string
BM-ACRC or BM-LOCAL BM-ACRC: Ingesting the streams audio data on our server. BM-LOCAL: ingesting the streams audio data on your local server. Please refer to Local monitoring Tool
Response
201: Created
{
"data":{
"uid":1,
"access_key":"************",
"type":"BM-ACRC",
"state":1,
"name":"bm-test",
"region":"ap-southeast-1",
"bucket_group":"8881",
"external_id":"",
"updated_at":"2021-01-04 10:42:24",
"created_at":"2021-01-04 10:42:24",
"id":13528,
"buckets":[
{
"id":8881,
"uid":1,
"name":"bucket-music",
"type":"File",
"node":"127.0.0.1-871",
"state":1,
"region":"ap-southeast-1",
"metadata_template":"{"artist":{"default":"abc"}, "album":{
"type":"select", "default":"334", "options":["123", "334"]}}",
"labels":[
"Music",
"Video"
],
"net_type":1,
"created_at":"2019-03-01 15:31:25",
"updated_at":"2020-12-24 08:26:35",
"num":1,
"size":"300000",
"access_permission":"private"
}
],
"status_check":2,
"external_ids":[
"spotify","deezer","isrc"
],
"metadata_template":"StreamId,City,FM",
"monitoring_num":0
}
}
Curl
Curl
curl --location --request POST 'https://api-v2.acrcloud.com/api/bm-cs-projects' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer token' \
--header 'Content-Type: application/json' \
--data-raw '{"name":"test", "region":"eu-west-1", "buckets":[8881,8883],"type":"BM-ACRC", "external_ids":["spotify", "isrc", "deezer"]}'

get
List the projects

https://api-v2.acrcloud.com/api/bm-cs-projects
Request
Response
Request
Headers
Authentication
required
string
Query Parameters
page
optional
string
region
optional
string
types
optional
string
per_page
optional
string
Response
200: OK
{
"data":[
{
"id":12345,
"name":"test",
"uid":1,
"type":"BM-ACRC",
"region":"ap-southeast-1",
"state":1,
"access_key":"************",
"bucket_group":"8891,8880",
"external_id":"",
"noise":1,
"created_at":"2020-07-20 15:56:21",
"updated_at":"2020-07-21 03:43:01",
"buckets":[
{
"id":8891,
"uid":1,
"name":"vue-bucket",
"type":"File",
"node":"127.0.0.1-871",
"state":1,
"region":"ap-southeast-1",
"metadata_template":"album",
"labels":[
"Music",
"Video"
],
"net_type":1,
"created_at":"2019-07-30 09:02:43",
"updated_at":"2019-08-16 07:17:32",
"num":2,
"size":"600",
"access_permission":"private",
"access_users":[
]
},
{
"id":8880,
"uid":0,
"name":"ACRCloud Music",
"type":"ACRCloudFile",
"node":"127.0.0.1-890",
"state":1,
"region":"ap-southeast-1",
"metadata_template":"",
"labels":[
"Music"
],
"net_type":1,
"created_at":"2019-03-01 15:31:25",
"updated_at":"-0001-11-30 00:00:00",
"num":10000,
"size":10000,
"access_permission":"private"
}
],
"status_check":2,
"external_ids":[
],
"metadata_template":"city,country",
"monitoring_num":0
}
],
"links":{
"first":"https://api-v2.acrcloud.com/api/bm-cs-projects?page=1",
"last":"https://api-v2.acrcloud.com/api/bm-cs-projects?page=1",
"prev":null,
"next":null
},
"meta":{
"current_page":1,
"from":1,
"last_page":1,
"path":"https://api-v2.acrcloud.com/api/bm-cs-projects",
"per_page":"20",
"to":1,
"total":1
}
}
Curl
Curl
curl --location --request GET 'https://api-v2.acrcloud.com/api/bm-cs-projects' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer token'

put
Update a project

https://api-v2.acrcloud.com/api/bm-cs-projects/:id
Request
Response
Request
Path Parameters
id
required
number
The project id
Headers
Authentication
required
string
Bearer token
Body Parameters
name
optional
string
buckets
optional
string
external_ids
optional
string
metadata_template
optional
string
Response
200: OK
{
"data":{
"uid":1,
"access_key":"**************",
"type":"BM-ACRC",
"state":1,
"name":"bm-test",
"region":"ap-southeast-1",
"bucket_group":"8881",
"external_id":"",
"updated_at":"2021-01-04 10:42:24",
"created_at":"2021-01-04 10:42:24",
"id":13528,
"buckets":[
{
"id":8881,
"uid":1,
"name":"bucket-music",
"type":"File",
"node":"127.0.0.1-871",
"state":1,
"region":"ap-southeast-1",
"metadata_template":"{"artist":{"default":"abc"}, "album":{
"type":"select", "default":"334", "options":["123", "334"]}}",
"labels":[
"Music",
"Video"
],
"net_type":1,
"created_at":"2019-03-01 15:31:25",
"updated_at":"2020-12-24 08:26:35",
"num":1,
"size":"300000",
"access_permission":"private"
}
],
"status_check":2,
"external_ids":[
"spotify","deezer","isrc"
],
"metadata_template":"StreamId,City,FM",
"monitoring_num":0
}
}

delete
Delete a project

https://api-v2.acrcloud.com/api/bm-cs-projects/:id
Request
Response
Request
Path Parameters
id
required
number
The project id
Headers
Authentication
required
string
Bearer token
Response
204: No Content

post
Set result callback url

https://api-v2.acrcloud.com/api/bm-cs-projects/:id/result-callback
Request
Response
Request
Path Parameters
id
required
number
The project id
Headers
Authentication
required
string
Bearer token
Body Parameters
result_callback_url
optional
string
Response
200: OK
{
"data":{
"id":13528,
"name":"bm-test",
"uid":1,
"type":"BM-ACRC",
"region":"ap-southeast-1",
"state":1,
"access_key":"***********",
"bucket_group":"8881",
"external_id":"",
"noise":1,
"created_at":"2021-01-04 10:42:24",
"updated_at":"2021-01-04 10:42:24",
"buckets":[
{
"id":8881,
"uid":1,
"name":"bucket-music",
"type":"File",
"node":"127.0.0.1-871",
"state":1,
"region":"ap-southeast-1",
"metadata_template":"{"artist":{"default":"abc"}, "album":{
"type":"select", "default":"334", "options":["123", "334"]}}",
"labels":[
"Music",
"Video"
],
"net_type":1,
"created_at":"2019-03-01 15:31:25",
"updated_at":"2020-12-24 08:26:35",
"num":1,
"size":"300000",
"access_permission":"private"
}
],
"status_check":2,
"external_ids":[
],
"metadata_template":"StreamId,City,FM",
"result_callback_url":"https://callback.acrcloud.com",
"result_callback_send_type":"JSON",
"result_callback_send_noresult":"NO",
"result_callback_retry":0,
"monitoring_num":0
}
}

post
Set state notification callback

https://api-v2.acrcloud.com/api/bm-cs-projects/:id/state-notification
Request
Response
Request
Path Parameters
id
required
string
The project id
Headers
Authentication
required
string
Bearer token
Body Parameters
state_notification_email
optional
string
state_notification_email: if the streams' states change, we will send a notification to the email you set.
state_notification_email_frequency
optional
string
state_notification_email_frequency: 0:High 1:Low 2:None
state_notification_url
optional
string
state_notification_url: if the streams' states change, we will post a request to this url you set.
Response
200: OK
{
"data":{
"id":13528,
"name":"bm-test",
"uid":1,
"type":"BM-ACRC",
"region":"ap-southeast-1",
"state":1,
"access_key":"***************",
"bucket_group":"8881",
"external_id":"",
"noise":1,
"created_at":"2021-01-04 10:42:24",
"updated_at":"2021-01-04 10:42:24",
"buckets":[
{
"id":8881,
"uid":1,
"name":"bucket-music",
"type":"File",
"node":"127.0.0.1-871",
"state":1,
"region":"ap-southeast-1",
"metadata_template":"{"artist":{"default":"abc"}, "album":{
"type":"select", "default":"334", "options":["123", "334"]}}",
"labels":[
"Music",
"Video"
],
"net_type":1,
"created_at":"2019-03-01 15:31:25",
"updated_at":"2020-12-24 08:26:35",
"num":1,
"size":"300000",
"access_permission":"private"
}
],
"status_check":2,
"external_ids":[
],
"metadata_template":"StreamId,City,FM",
"result_callback_url":"https://callback.acrcloud.com",
"result_callback_send_type":"JSON",
"result_callback_send_noresult":"NO",
"result_callback_retry":0,
"state_notification_url":"http://test.notification.com",
"state_notification_email":"[email protected]",
"state_notification_email_frequency":"LOW",
"monitoring_num":2
}
}