ACRCloud 文档中心

Appearance

音频文件 ​

API 主地址：https://cn-api-v2.acrcloud.cn/api

请求时在 hearder 中必须携带 Authorization Bearer Token。

如果你不知道 Authorization Bearer Token 是什么, 请查看 AccessToken 部分。

提示

请注意 Authorization 的值必须以「Bearer 」开头且与获取到的 access token 中有一个空格

下面是一个例子：

python

headers = {'Authorization': Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.qzoqZ8EOWghqmiaYp_Bf4olGiclMMFL9UQJrx57zJNz8pAP1xsPQhVYdBYsJoP37o9ojT0MquvC1bm98xtTgZK_lkNwI9ukVTaSOyG191ifVrqxN4JJgKdaiPePIJJkoz1xwcQjPwmwdO2OHtVoAp3VZVQgNW9XK1ZCO_BFOM_y2wYnJE2SBGX8FxucSo5ttmzV4WVC86UkN4TA8SE_PNxI8shsi3ySV0KsVYWsCN16zkLXbOIUExmNot4HQKgMucgjrNkeZ5afNMCi9r51CRa9rvoWhQs8G4ZAYT7IwhRgGAuDxQyZKjRlCrpz3MHh6sTNi16ibTfA1pLW6lqkalsLhaULPqShrkreQCO6OSurhVXKLOvjKLOzySjUdFNVJBy9JgqDggvgYrIxLluK5zaiLM9wXuF07Dp25-T1hKXjBY0xBJu6ZwDl5NbFmLqB5owwDpG8MwYFeNqFXcspdwDlAR5qyG3DgvmaUerry1-f8QQLzNOYFgODSNxZRGy6QpwMx4NkGk2ypzm7rgXcuDKcYZ_1fc8nnia97uD9D-k1p5RJJC4Zs-NWlDU3L9Q0jTSJhyfVr9GIMsUSXk00rIoPtwz5i7pARMdD-hwIt3dkAOZSW-b3e_U_Fpw}

资源库 API 列表

URL方法说明
/buckets/:bucket_id/filesPOST上传音频/指纹内容到资源库
/buckets/:bucket_id/filesGET获取资源库中的文件列表
/buckets/:bucket_id/files/:idPUT更新文件信息
/buckets/:bucket_id/files/:idsDELETE删除资源库中的文件
/buckets/:bucket_id/files/:ids/movePUT移动文件到资源库
/buckets/:bucket_id/files/:idsGET获取文件信息

上传文件到资源库 ​

上传音频/指纹内容到资源库

API 地址：https://cn-api-v2.acrcloud.cn/api/buckets/:bucket_id/files

请求方法： POST

路径：

  • 「:bucket_id」替换成你的资源库的id

参数：

参数名类型描述
data_typestring文件类型，单选，audio;fingerprint;audio_url
fileobject文件内容， 需要 data_type 为 audio 或者 fingerprint
titlestring文件标题
user_definedstring用户自定义的内容 json 格式
urlstring文件下载地址，需要 data_type 为 audio_url

返回值：

Response
json
{
    "data": {
        "uid": 1,
        "acr_id": "6d3e17559677cd79ecb0b7cd2c79bea0",
        "bucket_id": 8891,
        "state": 0,
        "title": "adsfad",
        "audio_id": "",
        "duration": "78.524082",
        "user_defined": {},
        "updated_at": "2020-12-24T08:49:17.000000Z",
        "created_at": "2020-12-24T08:49:17.000000Z",
        "id": 20
    }
}

代码示例：

sh
curl --location --request POST 'https://api-v2.acrcloud.com/api/buckets/8891/files' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer token' \
--form 'file=@"/Users/olym/Downloads/test.mp3"' \
--form 'title="adsfad"' \
--form 'data_type="audio"'

curl --location --request POST 'https://api-v2.acrcloud.com/api/buckets/8891/files' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer token' \
--header 'Content-Type: application/json' \
--data-raw '{"data_type":"audio_url", "title":"file-title", "user_defined":{"artists":"artist"}, "url":"https://your_host.com/AEA040700015_T1.mp3"}'
sh
import requests
import json

url = "https://api-v2.acrcloud.com/api/buckets/8891/files"

payload={'title': 'adsfad','data_type': 'audio',"user_defined":json.dumps({"key1":"value1", "key2":"value2"})}
files=[
  ('file',('test.mp3',open('/Users/olym/Downloads/test.mp3','rb'),'audio/mpeg'))
]
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer token'
}

response = requests.request("POST", url, 
               headers=headers, 
               data=payload, 
               files=files)

print(response.text)
sh

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api-v2.acrcloud.com/api/buckets/8891/files',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => array('file'=> new CURLFILE('/Users/olym/Downloads/test.mp3'),'title' => 'adsfad','data_type' => 'audio'),
  CURLOPT_HTTPHEADER => array(
    'Accept: application/json',
    'Authorization: Bearer token'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
sh

var axios = require('axios');
var FormData = require('form-data');
var fs = require('fs');
var data = new FormData();
data.append('file', fs.createReadStream('/Users/olym/Downloads/test.mp3'));
data.append('title', 'adsfad');
data.append('data_type', 'audio');

var config = {
  method: 'post',
  url: 'https://api-v2.acrcloud.com/api/buckets/8891/files',
  headers: { 
    'Accept': 'application/json', 
    'Authorization': 'Bearer token', 
    ...data.getHeaders()
  },
  data : data
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});
sh
require "uri"
require "net/http"

url = URI("https://api-v2.acrcloud.com/api/buckets/8891/files")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["Accept"] = "application/json"
request["Authorization"] = "Bearer token"
form_data = [['file', File.open('/Users/olym/Downloads/test.mp3')],['title', 'adsfad'],['data_type', 'audio']]
request.set_form form_data, 'multipart/form-data'
response = http.request(request)
puts response.read_body

获取资源库中的文件列表 ​

获取资源库中的文件列表

API 地址：https://cn-api-v2.acrcloud.cn/api/buckets/:bucket_id/files

请求方法： GET

路径：

  • 「:bucket_id」替换成你的资源库的id

参数：

参数名类型描述
searchstring搜索关键词
sortstring排序键，按 id 或状态排序，默认是按 id 排序
orderstring顺序，asc|desc, 默认 asc
pageint翻页的页数
per_pageint每页的个数
stateint0:processing | 1:Ready (audio files have been processed) | -1: Error

返回值：

Response
json
{
    "data": [
        {
            "id": 20,
            "uid": 1,
            "bucket_id": 8891,
            "acr_id": "6d3e17559677cd79ecb0b7cd2c79bea0",
            "state": 0,
            "title": "adsfad",
            "user_defined": {},
            "duration": 79,
            "audio_id": "",
            "created_at": "2020-12-24T08:49:17.000000Z",
            "updated_at": "2020-12-24T08:49:17.000000Z"
        },
        {
            "id": 13,
            "uid": 1,
            "bucket_id": 8891,
            "acr_id": "224b26f7e3a3c44858be896c0fd9f45f",
            "state": 0,
            "title": "adsfad2",
            "user_defined": {},
            "duration": 79,
            "audio_id": "",
            "created_at": "2020-12-20T21:43:34.000000Z",
            "updated_at": "2020-12-20T21:43:49.000000Z"
        },
        {
            "id": 12,
            "uid": 1,
            "bucket_id": 8891,
            "acr_id": "0e5e7e376f7e177bbcb4da898f740a15",
            "state": 0,
            "title": "bucket",
            "user_defined": {
                "artist": "abc",
                "album": "334",
                "from": "ucf",
                "played_duration": 8,
                "ucf_id": "338229"
            },
            "duration": 206,
            "audio_id": "",
            "created_at": "2020-12-20T21:43:34.000000Z",
            "updated_at": "2020-12-20T21:43:49.000000Z"
        },
        {
            "id": 11,
            "uid": 1,
            "bucket_id": 8891,
            "acr_id": "6c875f014b9ca0ae89f44e1f93151b05",
            "state": 0,
            "title": "adsfad",
            "user_defined": {},
            "duration": 10,
            "audio_id": "",
            "created_at": "2020-12-20T21:43:34.000000Z",
            "updated_at": "2020-12-20T21:43:49.000000Z"
        },
        {
            "id": 10,
            "uid": 1,
            "bucket_id": 8891,
            "acr_id": "3ccdac434e9d08df333e8a5b4b8169fc",
            "state": 0,
            "title": "02c1d27e39",
            "user_defined": {
                "artist": "abc",
                "album": "334",
                "name": "asdf"
            },
            "duration": 14,
            "audio_id": "",
            "created_at": "2020-12-20T21:43:34.000000Z",
            "updated_at": "2020-12-20T21:43:49.000000Z"
        },
        {
            "id": 7,
            "uid": 1,
            "bucket_id": 8891,
            "acr_id": "625b970b5b837326fc927bd14cbfceb5",

            "state": 1,
            "title": "ddddaa",
            "user_defined": {},
            "duration": 300,
            "audio_id": "",
            "created_at": "2020-12-20T21:43:34.000000Z",
            "updated_at": "2020-12-20T21:43:49.000000Z"
        },
        {
            "id": 6,
            "uid": 1,
            "bucket_id": 8891,
            "acr_id": "87cd4888e660049f21199b812cc30346",
            "fp_id": null,
            "state": 1,
            "title": "test",
            "user_defined": {},
            "duration": 300,
            "audio_id": "",
            "created_at": "2020-12-20T21:43:34.000000Z",
            "updated_at": "2020-12-20T21:43:49.000000Z"
        }
    ],
    "links": {
        "first": "http://127.0.0.1:8080/api/buckets/8891/files?page=1",
        "last": "http://127.0.0.1:8080/api/buckets/8891/files?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "http://127.0.0.1:8080/api/buckets/8891/files",
        "per_page": "20",
        "to": 7,
        "total": 7
    }
}

更新文件信息 ​

更新文件信息

API 地址：https://cn-api-v2.acrcloud.cn/api/buckets/:bucket_id/files/:id

请求方法： PUT

路径：

  • 「:bucket_id」替换成你的资源库的 id
  • 「:id」 替换成文件的 id

参数：

参数名类型描述
sortstring排序键，按 id 或状态排序，默认是按 id 排序
orderstring顺序，asc|desc, 默认 asc
pageint翻页的页数
per_pageint每页的个数

返回值：

Response
json
{
    "data": {
        "id": 20,
        "uid": 1,
        "bucket_id": 8891,
        "acr_id": "6d3e17559677cd79ecb0b7cd2c79bea0",
        "state": 0,
        "title": "update-title",
        "user_defined": {
            "artists": "update-artist"
        },
        "duration": 79,
        "audio_id": "",
        "created_at": "2020-12-24T08:49:17.000000Z",
        "updated_at": "2020-12-25T04:34:27.000000Z"
    }
}

删除资源库中的文件 ​

更新文件信息

API 地址：https://cn-api-v2.acrcloud.cn/api/buckets/:bucket_id/files/:ids

请求方法： DELETE

路径：

  • 「:bucket_id」替换成你的资源库的id
  • 「:ids」为文件 id 或者 acrid，可以为多个，以英文逗号隔开','

移动文件到资源库 ​

移动文件某些到资源库

API 地址：https://cn-api-v2.acrcloud.cn/api/buckets/:bucket_id/files/:ids/move

请求方法： PUT

路径：

  • 「:bucket_id」替换成你的想移动的目标资源库的id
  • 「:ids」为文件 id 或者 acrid，可以为多个，以英文逗号隔开 「,」

获取文件信息 ​

获取文件信息

API 地址：https://api-v2.acrcloud.com/api/buckets/:bucket_id/files/:ids

请求方法： GET

路径：

  • 「:bucket_id」替换成你的想移动的目标资源库的id
  • 「:ids」为文件 id 或者 acrid，可以为多个，以英文逗号隔开 「,」

返回值：

Response
json
{
    "data": [
        {
            "id": 12945472,
            "uid": 19,
            "bucket_id": 966,
            "acr_id": "75806fee10cf4405de502435129d6c06",
            "state": 1,
            "title": "api-test",
            "user_defined": {},
            "duration": 174,
            "created_at": "2020-10-14T11:02:15.000000Z",
            "updated_at": "2020-10-14T11:02:15.000000Z",
            "audio_id": "123"
        },
        {
            "id": 12403501,
            "uid": 19,
            "bucket_id": 966,
            "acr_id": "39a2d627dad781f5fbdb65e0e7d4d7c9",
            "state": 1,
            "title": "bucket-report-test",
            "user_defined": {
                "ucf_id": "718876"
            },
            "duration": 13,
            "created_at": "2020-09-01T03:50:23.000000Z",
            "updated_at": "2020-09-01T03:50:23.000000Z",
            "audio_id": ""
        },
        {
            "id": 12398516,
            "uid": 19,
            "bucket_id": 966,
            "acr_id": "904475b22cc6ffe6692b07dcd65b8ef8",
            "state": 1,
            "title": "music",
            "user_defined": {
                "ucf_id": "725868"
            },
            "duration": 8,
            "created_at": "2020-08-31T15:09:07.000000Z",
            "updated_at": "2020-08-31T15:09:07.000000Z",
            "audio_id": ""
        },
        {
            "id": 12398474,
            "uid": 19,
            "bucket_id": 966,
            "acr_id": "3b6fc496391a6a1758b6cd48da4f792b",
            "state": 1,
            "title": "happy",
            "user_defined": {
                "ucf_id": "718878"
            },
            "duration": 10,
            "created_at": "2020-08-31T15:05:40.000000Z",
            "updated_at": "2020-08-31T15:05:40.000000Z",
            "audio_id": ""
        },
        {
            "id": 12395185,
            "uid": 19,
            "bucket_id": 966,
            "acr_id": "fe34ec4ffbcec033ec2ed050f4b0daa7",
            "state": 1,
            "title": "test",
            "user_defined": {
                "ucf_id": "690303"
            },
            "duration": 10,
            "created_at": "2020-08-31T10:20:33.000000Z",
            "updated_at": "2020-08-31T10:20:33.000000Z",
            "audio_id": ""
        },
        {
            "id": 12158027,
            "uid": 19,
            "bucket_id": 966,
            "acr_id": "d66a31c5e62cf3e86874476da60db641",
            "state": 1,
            "title": "test",
            "user_defined": {
                "type": "advert",
                "from": "ucf",
                "played_duration": 16,
                "ucf_id": "725869"
            },
            "duration": 30,
            "created_at": "2020-08-11T04:03:31.000000Z",
            "updated_at": "2020-08-11T04:03:31.000000Z",
            "audio_id": ""
        },
        {
            "id": 11163949,
            "uid": 19,
            "bucket_id": 966,
            "acr_id": "601a566c3d4d77dfdb220e750384f842",
            "state": 1,
            "title": "Kesayanganku",
            "user_defined": {
                "artist": "Al Ghazali",
                "from": "ucf",
                "played_duration": 0,
                "ucf_id": "579162"
            },
            "duration": 240,
            "created_at": "2020-06-14T13:30:49.000000Z",
            "updated_at": "2020-06-14T13:30:49.000000Z",
            "audio_id": ""
        },
        {
            "id": 1849311,
            "uid": 19,
            "bucket_id": 966,
            "acr_id": "db397154fb9858f17373b5bf66be875a",
            "state": 1,
            "title": "Hiding my heart - Adele",
            "user_defined": {
                "title": "Hiding my heart",
                "artist": "Adele"
            },
            "duration": 208,
            "created_at": "2016-10-09T14:09:43.000000Z",
            "updated_at": "2016-10-09T14:09:49.000000Z",
            "audio_id": "12345"
        }
    ]
}