NAV
bash

简介

工程师爸爸是国内专注于家庭教育,为家长提供精选教育资源的互联网信息平台。作为国内首个关注可触控终端(安卓/苹果/智能TV/智能玩具)儿童教育软件需求、研发、推广生态链发展的平台,工程师爸爸已经与国内外众多儿童App开发企业和儿童出版企业形成良好合作,为数千万华人家庭提供精选的教育资源分发服务。

工程师爸爸儿童教育资源开放平台是工程师爸爸为第三方开发者量身定制的儿童教育资源再分发渠道。通过开放平台,第三方开发者可以很方便地利用工程师爸爸丰富的儿童教育资源提供个性化服务,提升产品质量与服务范围。

开放平台目前以儿童在线教育音频服务为主,今后将逐步开放童书、视频、社交等不同领域的资源。

版本说明

版本号:v3.2

此版本在接口和组织结构方面有较大调整,因此不再兼容旧版本。

返回v2.0版本

账号体系

开放平台采用申请注册制,第三方开发者可以在开放平台上填写注册申请:免费试用,工程师爸爸审核通过后,帮您开通账户,您才可使用开放平台各项服务搭建自己的应用。

开放平台账号由邮件、密码、业务联系人等信息组成,您在申请注册时填入,工程师爸爸审核确认其信息的合法性。

开放服务

由工程师爸爸开发搭建的对外提供的服务业务,第三方可以选取一个或多个开放服务。每个服务视业务不同由工程师爸爸分别提供免费、有限、有偿或定制等服务。视业务领域、服务等级、服务质量需求不同,工程师爸爸有权对所提供的部分服务收取服务费用,具体可和业务人员洽谈。

接入规范

一、 一个设备对应一个 ID 原则

必须使用唯一的设备 ID,获取 Token。平台会识别多设备共用ID,以及进行ID行为审查来识别违规行为。设备ID是平台与内容商结算的重要依据。


二、 必须使用带 Token 的 CDN 地址调用音频

设备在播放音频时,需要先通过 API 获取 CDN 地址和Token ,然后将 CDN 地址和 Token 拼接在一起才能获取音频,所以在得到 CDN 地址后,去获取音频时必须带上 Token,平台会校验token。


三、 单一设备的API和CDN请求小于等于10次/秒

同一个设备 API 访问频率小于等于10次/秒,同一个设备 CDN 访问频率小于等于10次/秒。


四、 进行压力测试必须向平台报备

在压力测试进行前,需要提前告知,约定测试时间、测试设备 ID等,从而不影响服务器正常工作。


使用流程概述

open api注册使用流程

  1. 注册试用账号(目前需联系工程师爸爸注册:免费试用
  2. 登陆 控制台
  3. 创建一个 App ID,获取相应的 App Secret.
  4. 使用 App ID 和 App Secret 生成一次请求的授权信息。
  5. 对某api签名授权后,发起请求。

音频资源授权访问流程

我们生成的音频链接是设备无关的,这样,便于您缓存,但我方又需要知道您每次使用音频时的设备信息,以便于分析及业务结算,所以我方提供了一个设备token获取api,您应该在访问音频链接前,为设备获取相应的token,并拼装到音频链接上,为之进行资源访问授权,之后,再去访问改造后的音频链接。

  1. 用“声音”相关api获取音频url(可缓存),例如:http://cdn.open.idaddy.cn/xxxxxxxxx.mp3
  2. 刷新设备token api为X0001的设备换取其设备token : zzzzzzzzzzzzzzzzzzzzzzz
  3. 对音频url拼接token参数 :http://cdn.open.idaddy.cn/xxxxxxxxx.mp3?token=zzzzzzzzzzzzzzzzzzzzzzz
  4. 用拼接后的url下载播放音频资源

请求及响应

open-api 授权

授权请求

# 定义公共请求参数
APP_ID=my-app-id-test00001
APP_SECRET=my-app-secret-test00001
TIMESTAMP=$(date +%s)
SIGN_TYPE=sha1
SIGNATURE=$(echo -n "${APP_ID}${APP_SECRET}${TIMESTAMP}" | openssl dgst -$SIGN_TYPE -hex | cut -d' ' -f2)
NONCE=$(openssl rand -base64 12)

# 使用上面定义的公共参数作为鉴权参数(每行结尾的“\”指明此为多行命令,便于阅读)
curl --request POST --data "app_id=${APP_ID}\
&device_id=x1000\
&timestamp=${TIMESTAMP}\
&nonce=${NONCE}\
&sign_type=${SIGN_TYPE}\
&signature=${SIGNATURE}\
&offset=0\
&limit=5\
&cat_ids=[]" http://open.idaddy.cn/api/v3/cat/list

# 或者用下面更推荐的命令格式
curl --request POST \
  --data-urlencode "app_id=${APP_ID}" \
  --data-urlencode "device_id=x1000" \
  --data-urlencode "timestamp=${TIMESTAMP}" \
  --data-urlencode "nonce=${NONCE}" \
  --data-urlencode "sign_type=${SIGN_TYPE}" \
  --data-urlencode "signature=${SIGNATURE}" \
  --data-urlencode "offset=0" \
  --data-urlencode "limit=5" \
  --data-urlencode 'cat_ids=[]' \
  http://open.idaddy.cn/api/v3/cat/list

请把代码中的my-app-id-test00001my-app-secret-test00001替换为您自己的 API Key和API Secret。

服务授权基于App ID、Service Key,用户可以根据需要生成多个不同的App ID、Service Key对应于不同的应用。

  1. 生成当前时间的 timestamp;
  2. 用(app_id+app_secret+timestamp)生成 signature;
  3. 用 app_id,timestamp,signature 等值作为公共参数请求开放API服务。

公共参数:

名称 类型 必选 描述
app_id string 必选 App ID
timestamp int 必选 调用时间戳,单位秒,会用作超时验证(5分钟)
nonce string 必选 最长32位随机字符串,每次请求都不同,防止重放攻击
sign_type string 可选 签名类型,默认sha1,支持md5、sha1、sha256
signature string 必选 签名字符串,小写,hash(app_id+secret+timestamp)

音频资源授权

获取play_url(请求或缓存)

# 原始音频链接,不能直接访问资源
http://cdn.open.idaddy.cn/xxxxxxxxxx.mp3

刷新设备token-请求

curl --request POST \
  --data-urlencode "app_id=${APP_ID}" \
  --data-urlencode "timestamp=${TIMESTAMP}" \
  --data-urlencode "nonce=${NONCE}" \
  --data-urlencode "sign_type=${SIGN_TYPE}" \
  --data-urlencode "signature=${SIGNATURE}" \
  --data-urlencode "device_id=x1000" \  # 用device_id换token
  http://open.idaddy.cn/api/v3/token/refresh

刷新设备token-响应

{
    "data": {
        "device_token": "zzzzzzzzzzzzz",
        "device_id": "x1000",
        "created_at": "2017-06-18T00:07:08Z",
        "expires_at": "2017-06-25T00:00:00Z"
    },
    "retcode": 0
}

拼接token,访问音频资源:

curl -o idaddy.mp3 http://cdn.open.idaddy.cn/xxxxxxxxxx.mp3?token=zzzzzzzzzzzzz

refresh_device_token

token规则:

响应及错误

response success : http code = 200 , ret = 0

{
    "data": {
        "cats": [
            {
                "id": 6707,
                "name": "儿歌",
                "icon": "http://img.idaddy.cn/f/h/0/161756jkqdhs00z30ri3ji.png",
                "count": 0,
                "age_scope": "-1-8",
                "parent": 0
            }
        ]
    },
    "retcode": 0
}
{
    "data": {
        "works": [
            {
                "id": "ADQGN1A9DTI=",
                "name": "不爱睡觉的小猴子",
                "icon": "http://img.idaddy.cn//b/7/hn4atvn7.jpg",
                "status": 0
            }
        ]
    },
    "retcode": 0
}
{
    "data": {
        "audios": [
            {
                "id": "ADQGNVA2DTxRYA==",
                "name": "宝宝的睡袍",
                "type": 0,
                "play_url": "http://cdn.open.idaddy.cn/apsmp3/dadb/idaddy0000000001/201711210000/0_adidaddy/ADAGMVAzDTQ.ADQGNVA2DTxRYA.YTY0LzEvcWFnNXQ1bDMuYXVkaW8.mp3",
                "status": 0
            }
        ]
    },
    "retcode": 0
}

response error : http code = 200 , retcode > 0

{
    "message": "signature error.",
    "retcode": 2
}

api调用,除了404无服务外,不管成功失败,http status都等于200,响应体均为json格式,其中包含应用级响应码”retcode”:

retcode success description
0 ok 返回成功
1 error 系统错误
2 error 输出内容出错、缺失

失败时附带”message”字段,包含出错信息

api - 设备token

刷新设备token

刷新设备token-请求

curl --request POST \
  --data-urlencode "app_id=${APP_ID}" \
  --data-urlencode "timestamp=${TIMESTAMP}" \
  --data-urlencode "nonce=${NONCE}" \
  --data-urlencode "sign_type=${SIGN_TYPE}" \
  --data-urlencode "signature=${SIGNATURE}" \
  --data-urlencode "device_id=x1000" \
  http://open.idaddy.cn/api/v3/token/refresh

刷新设备token-响应

{
    "data": {
        "device_id": "x1000",
        "device_token": "kT19O456Q0Cwn3xaHwjnSg.MlxyeDEwMDBccjIwMTgtMDIt",
        "created_at": "2018-01-05T01:28:10Z",
        "expires_at": "2018-02-04T00:00:00Z"
    },
    "retcode": 0
}

HTTP Request

POST http://open.idaddy.cn/api/v3/token/refresh

POST参数(application/x-www-form-urlencoded)

name type required description
app_id string 必选 App Id
device_id string 必选 设备ID,不能包含回车换行等特殊字符,建议长度不要超过40字节
app_uid string 可选 客户端用户名
timestamp int 必选 调用时间戳,单位秒,会用作超时验证(5分钟)
nonce string 必选 最长32位随机字符串,每次请求都不同,防止重放攻击
sign_type string 可选 签名类型,默认sha1,支持md5、sha1、sha256
signature string 必选 签名字符串,小写,hash(app_id+secret+timestamp)

response

name type description
data.device_id string 设备ID
data.device_token string device_token
data.created_at string token创建时间,utc 零时区时间
data.expires_at string token截止时间,utc 零时区时间

api - 分类

作品是按分类树组织的,目前分为两级。

分类字段如下:

name description
id 分类id
name 分类名称
icon 分类图标url(144x144)
age_scope 适合年龄范围
works_num 作品数量,仅叶子分类有值
audios_num 声音数量,仅叶子分类有值
parent 父分类id,0表示没有
children 子类列表, depth>1时有值

获取分类列表

查询一级分类-请求

curl -v --request POST \
  --data-urlencode "app_id=${APP_ID}" \
  --data-urlencode "device_id=x1000" \
  --data-urlencode "timestamp=${TIMESTAMP}" \
  --data-urlencode "nonce=${NONCE}" \
  --data-urlencode "sign_type=${SIGN_TYPE}" \
  --data-urlencode "signature=${SIGNATURE}" \
  --data-urlencode "cat_ids=[]" \
  http://open.idaddy.cn/api/v3/cat/list

查询一级分类-响应

{
    "data": {
        "cats": [
            {
                "id": 6707,
                "name": "儿歌",
                "icon": "http://img.idaddy.cn/f/h/0/161756jkqdhs00z30ri3ji.png",
                "age_scope": "-1-8",
                "parent": 0
            },
            {
                "id": 6708,
                "name": "故事",
                "icon": "http://img.idaddy.cn/f/h/0/161810d2n0b0sgtsgmr6gr.png",
                "age_scope": "1+",
                "parent": 0
            }
        ]
    },
    "retcode": 0
}

查询子分类-请求

curl --request POST \
  --data-urlencode "app_id=${APP_ID}" \
  --data-urlencode "device_id=x1000" \
  --data-urlencode "timestamp=${TIMESTAMP}" \
  --data-urlencode "nonce=${NONCE}" \
  --data-urlencode "sign_type=${SIGN_TYPE}" \
  --data-urlencode "signature=${SIGNATURE}" \
  --data-urlencode "cat_ids=[6707,6708]" \
  http://open.idaddy.cn/api/v3/cat/list

查询子分类-响应

{
    "data": {
        "cats": [
            {
                "id": 6709,
                "name": "睡前故事",
                "icon": "http://img.idaddy.cn/f/h/4/ee76icrb.jpg",
                "age_scope": "1+",
                "works_num": 243,
                "audios_num": 352,
                "parent": 6708
            },
            {
                "id": 6711,
                "name": "历史故事",
                "icon": "http://img.idaddy.cn/f/h/4/2emvlhmi.jpg",
                "age_scope": "4+",
                "works_num": 19,
                "audios_num": 65,
                "parent": 6708
            },
            {
                "id": 7672,
                "name": "成语故事",
                "icon": "http://img.idaddy.cn/f/h/4/oj5ty56b.jpg",
                "age_scope": "3+",
                "works_num": 4,
                "audios_num": 21,
                "parent": 6708
            },
            {
                "id": 8118,
                "name": "热门儿歌",
                "icon": "http://img.idaddy.cn/f/h/4/xs4ozwyc.jpg",
                "age_scope": "-1-6",
                "works_num": 230,
                "audios_num": 898,
                "parent": 6707
            },
            {
                "id": 10047,
                "name": "科普故事",
                "icon": "http://img.idaddy.cn/f/h/4/nemc7qvb.jpg",
                "age_scope": "3+",
                "works_num": 176,
                "audios_num": 645,
                "parent": 6708
            }
        ]
    },
    "retcode": 0
}

HTTP Request

POST http://open.idaddy.cn/api/v3/cat/list

POST参数(application/x-www-form-urlencoded)

name type required description
app_id string 必选 App Id
device_id string 必选 设备ID
app_uid string 可选 客户端用户名
timestamp int 必选 调用时间戳,单位秒,会用作超时验证(5分钟)
nonce string 必选 最长32位随机字符串,每次请求都不同,防止重放攻击
sign_type string 可选 签名类型,默认sha1,支持md5、sha1、sha256
signature string 必选 签名字符串,小写,hash(app_id+secret+timestamp)
cat_ids string 可选 欲查询的分类id,JSON数组格式
depth int 可选 分类树查询深度 默认:1

api - 作品

作品类似于音乐专辑的概念,里面包含若干声音。

可设置详情选项调整输出内容:

可设置是否输出作品所属的分类列表:

可设置是否输出作品对应的声音列表:

可设置输出播放链接是否自带token:

作品字段如下:

name verbose description
id 0/1 作品ID
name 0/1 作品名
icon 0/1 作品图标
tariff 1 建议收费等级 (0免费 1VIP 2单购)
price 1 作品参考价格(单位分)
terms 1 词语
tags 1 标签
performer 1 演播
author 1 作者
age_from 1 适合年龄下限
age_to 1 适合年龄上限
comment 1 编辑推荐
description 1 简介
score 1 用户评分
rank 1 综合得分(热度)
status 0/1 状态(0正常 4停用)
cats * 所属分类列表
cats.id 0/1 分类id
cats.name 0/1 分类名
audios * 声音列表
audios.id 0/1 声音id
audios.name 0/1 声音名
audios.type 0/1 声音类型(0内容 1花絮 2预告片)
audios.free 1 是否免费(1免费 0付费)
audios.play_url 0/1 声音播放链接
audios.file_size 1 声音文件大小(字节)
audios.duration 1 声音时长(秒)
audios.lyrics 1 声音歌词
audios.status 0/1 声音状态(0正常 4停用)

获取作品列表

获取指定分类下的作品列表。

获取作品列表-请求

curl --request POST \
  --data-urlencode "app_id=${APP_ID}" \
  --data-urlencode "device_id=x1000" \
  --data-urlencode "timestamp=${TIMESTAMP}" \
  --data-urlencode "nonce=${NONCE}" \
  --data-urlencode "sign_type=${SIGN_TYPE}" \
  --data-urlencode "signature=${SIGNATURE}" \
  --data-urlencode "offset=0" \
  --data-urlencode "limit=1" \
  --data-urlencode "cat_ids=[8120]" \
  --data-urlencode "verbose=1" \
  http://open.idaddy.cn/api/v3/work/list

获取作品列表-响应

{
    "data": {
        "works": [
            {
                "id": "ADcGMFAwDTM",
                "name": "东周列国故事",
                "icon": "http://img.idaddy.cn/b/6/o4yaclbl.jpg",
                "tariff": 0,
                "price": 999,
                "terms": "中国历史,东周列国故事,中国名著,历史故事,教育部推荐书目",
                "tags": "东周列国,春秋五霸,战国七雄,历史人物",
                "performer": "曹灿",
                "author": "冯梦龙",
                "age_from": 7,
                "age_to": 12,
                "comment": "曹灿,著名老一辈演播艺术家,中国国家话剧院国家一级演员。演播代表作有少儿版四大名著之《红楼梦的故事》。",
                "description": "在东周这个动荡的乱世中,春秋五霸、战国七雄等历史人物轮番登场推动着东周历史车轮的前进,上演了一出出精彩的历史剧目。",
                "rank": 168,
                "score":111,
                "status": 0
            }
        ]
    },
    "retcode": 0
}

HTTP Request

POST http://open.idaddy.cn/api/v3/work/list

POST参数(application/x-www-form-urlencoded)

name type required description
app_id string 必选 App Id
device_id string 必选 设备ID
app_uid string 可选 客户端用户名
timestamp int 必选 调用时间戳,单位秒,会用作超时验证(5分钟)
nonce string 必选 最长32位随机字符串,每次请求都不同,防止重放攻击
sign_type string 可选 签名类型,默认sha1,支持md5、sha1、sha256
signature string 必选 签名字符串,小写,hash(app_id+secret+timestamp)
offset int 可选 起始位置 默认: 0
limit int 可选 分页记录限制,默认: 10 最大:100
cat_ids string 必选 分类id,JSON格式数组
verbose int 可选 详情选项:0 输出简版内容 1 输出完整版内容 默认: 0
with_cats int 可选 是否输出分类列表: 0 不输出 1 输出 默认: 0
with_audios int 可选 是否输出声音列表: 0 不输出 1 输出 默认: 0
with_token int 可选 播放链接是否自带token: 0 不带token 1 带token 默认: 0

获取作品信息

获取指定作品ID的作品信息。

获取作品信息-请求

curl --request POST \
  --data-urlencode "app_id=${APP_ID}" \
  --data-urlencode "device_id=x1000" \
  --data-urlencode "timestamp=${TIMESTAMP}" \
  --data-urlencode "nonce=${NONCE}" \
  --data-urlencode "sign_type=${SIGN_TYPE}" \
  --data-urlencode "signature=${SIGNATURE}" \
  --data-urlencode 'work_ids=["ADIGM1A1DTw"]' \
  --data-urlencode "verbose=0" \
  --data-urlencode "with_cats=1" \
  --data-urlencode "with_audios=1" \
  http://open.idaddy.cn/api/v3/work/info

获取作品信息-响应

{
    "data": {
        "works": [
            {
                "id": "ADIGM1A1DTw",
                "name": "白雪公主(卉卉阿姨)",
                "icon": "http://img.idaddy.cn/b/9/d3vrh48k.jpg",
                "status": 0,
                "cats": [
                    {
                        "id": 6709,
                        "name": "睡前故事"
                    },
                    ......
                ],
                "audios": [
                    {
                        "id": "ADcGMFA3DTNRYA",
                        "name": "第1集",
                        "type": 0,
                        "play_url": "http://cdn.open.idaddy.cn/apsmp3/a261/idaddy0000000001/201711210000/0_adidaddy/ADIGM1A1DTw.ADcGMFA3DTNRYA.YTY0LzAvOW55MGxyd2guYXVkaW8.mp3",
                        "status": 0
                    },
                    ......
                ]
            }
        ]
    },
    "retcode": 0
}

HTTP Request

POST http://open.idaddy.cn/api/v3/work/info

POST参数(application/x-www-form-urlencoded)

name type required description
app_id string 必选 App Id
device_id string 必选 设备ID
app_uid string 可选 客户端用户名
timestamp int 必选 调用时间戳,单位秒,会用作超时验证(5分钟)
nonce string 必选 最长32位随机字符串,每次请求都不同,防止重放攻击
sign_type string 可选 签名类型,默认sha1,支持md5、sha1、sha256
signature string 必选 签名字符串,小写,hash(app_id+secret+timestamp)
work_ids string 必选 作品id,JSON数组格式
verbose int 可选 详情选项:0 输出简版内容 1 输出完整版内容 默认: 0
with_cats int 可选 是否输出分类列表: 0 不输出 1 输出 默认: 0
with_audios int 可选 是否输出声音列表: 0 不输出 1 输出 默认: 0
with_token int 可选 播放链接是否自带token: 0 不带token 1 带token 默认: 0

获取热门作品列表

获取不同类型的热门作品列表。

获取热门作品列表-请求

curl --request POST \
  --data-urlencode "app_id=${APP_ID}" \
  --data-urlencode "device_id=x1000" \
  --data-urlencode "timestamp=${TIMESTAMP}" \
  --data-urlencode "nonce=${NONCE}" \
  --data-urlencode "sign_type=${SIGN_TYPE}" \
  --data-urlencode "signature=${SIGNATURE}" \
  --data-urlencode "offset=0" \
  --data-urlencode "limit=2" \
  --data-urlencode "hot_type=0" \
  --data-urlencode "verbose=0" \
  http://open.idaddy.cn/api/v3/work/hot_list

获取热门作品列表-响应

{
    "data": {
        "works": [
            {
                "id": "ADQGN1A9DTI",
                "name": "不爱睡觉的小猴子",
                "icon": "http://img.idaddy.cn//b/7/hn4atvn7.jpg",
                "status": 0
            },
            {
                "id": "AD0GMVAy",
                "name": "森林狂想曲",
                "icon": "http://img.idaddy.cn/b/6/iu5ke6zg.jpg",
                "status": 0
            }
        ]
    },
    "retcode": 0
}

HTTP Request

POST http://open.idaddy.cn/api/v3/work/hot_list

POST参数(application/x-www-form-urlencoded)

name type required description
app_id string 必选 App Id
device_id string 必选 设备ID
app_uid string 可选 客户端用户名
timestamp int 必选 调用时间戳,单位秒,会用作超时验证(5分钟)
nonce string 必选 最长32位随机字符串,每次请求都不同,防止重放攻击
sign_type string 可选 签名类型,默认sha1,支持md5、sha1、sha256
signature string 必选 签名字符串,小写,hash(app_id+secret+timestamp)
offset int 可选 起始位置,默认: 0
limit int 可选 分页记录限制,默认: 10 最大:100
hot_type int 可选 热门榜单类型:0 周榜 1 月榜 2 年榜 默认: 0
cat_ids string 可选 分类id过滤,JSON格式数组
age_from int 可选 年龄下限过滤
age_to int 可选 年龄上限过滤
verbose int 可选 详情选项:0 输出简版内容 1 输出完整版内容 默认: 0
with_cats int 可选 是否输出分类列表: 0 不输出 1 输出 默认: 0
with_audios int 可选 是否输出声音列表: 0 不输出 1 输出 默认: 0
with_token int 可选 播放链接是否自带token: 0 不带token 1 带token 默认: 0

搜索作品

采用全文检索技术,用同一个关键词在不同属性组成的搜索域中搜索作品,搜索结果按匹配度+智能因子综合排序。

同时还可用不同的关键词在指定的单独属性中过滤作品,达到组合搜索的效果。

搜索作品(默认)-请求

curl --request POST \
  --data-urlencode "app_id=${APP_ID}" \
  --data-urlencode "device_id=x1000" \
  --data-urlencode "timestamp=${TIMESTAMP}" \
  --data-urlencode "nonce=${NONCE}" \
  --data-urlencode "sign_type=${SIGN_TYPE}" \
  --data-urlencode "signature=${SIGNATURE}" \
  --data-urlencode "offset=0" \
  --data-urlencode "limit=2" \
  --data-urlencode "content=世上只有妈妈好" \
  --data-urlencode "verbose=0" \
  http://open.idaddy.cn/api/v3/work/query

搜索作品(默认)-响应

{
    "data": {
        "total": 128,
        "works": [
            {
                "id": "ADcGM1Aw",
                "name": "世上只有妈妈好",
                "icon": "http://img.idaddy.cn/b/4/3bexb022.jpg",
                "status": 0
            },
            {
                "id": "ADYGNFA3DTw",
                "name": "世上只有妈妈好(粤)",
                "icon": "http://img.idaddy.cn/b/9/d4n8ecp7.jpg",
                "status": 0
            }
        ]
    },
    "retcode": 0
}

搜索作品(拼音)-请求

curl --request POST \
  --data-urlencode "app_id=${APP_ID}" \
  --data-urlencode "device_id=x1000" \
  --data-urlencode "timestamp=${TIMESTAMP}" \
  --data-urlencode "nonce=${NONCE}" \
  --data-urlencode "sign_type=${SIGN_TYPE}" \
  --data-urlencode "signature=${SIGNATURE}" \
  --data-urlencode "offset=0" \
  --data-urlencode "limit=2" \
  --data-urlencode "content=xiaozhu" \
  --data-urlencode "lang=1" \
  --data-urlencode "verbose=0" \
  http://open.idaddy.cn/api/v3/work/query

搜索作品(拼音)-响应

{
    "data": {
        "total": 69,
        "works": [
            {
                "id": "ADYGNFAx",
                "name": "三只小猪",
                "icon": "http://img.idaddy.cn/b/5/syr9s7sf.jpg",
                "status": 0
            },
            {
                "id": "ADYGMFA0DTQ",
                "name": "小猪数数",
                "icon": "http://img.idaddy.cn/b/1/quocno26.jpg",
                "status": 0
            }
        ]
    },
    "retcode": 0
}

搜索作品(自定义搜索域)-请求

curl --request POST \
  --data-urlencode "app_id=${APP_ID}" \
  --data-urlencode "device_id=x1000" \
  --data-urlencode "timestamp=${TIMESTAMP}" \
  --data-urlencode "nonce=${NONCE}" \
  --data-urlencode "sign_type=${SIGN_TYPE}" \
  --data-urlencode "signature=${SIGNATURE}" \
  --data-urlencode "offset=0" \
  --data-urlencode "limit=2" \
  --data-urlencode "content=白雪公主" \
  --data-urlencode 'fields={"work_name":2, "audio_name":1}' \
  --data-urlencode "with_audios=1" \
  http://open.idaddy.cn/api/v3/work/query

搜索作品(自定义搜索域)-响应

{
    "data": {
        "total": 77,
        "works": [
            {
                "id": "ADIGM1A1DTw",
                "name": "白雪公主(卉卉阿姨)",
                "icon": "http://img.idaddy.cn/b/9/d3vrh48k.jpg",
                "status": 0,
                "audios": [
                    {
                        "id": "ADcGMFA3DTNRYA",
                        "name": "第1集",
                        "type": 0,
                        "play_url": "http://cdn.open.idaddy.cn/apsmp3/a261/idaddy0000000001/201711210000/0_adidaddy/ADIGM1A1DTw.ADcGMFA3DTNRYA.YTY0LzAvOW55MGxyd2guYXVkaW8.mp3",
                        "status": 0
                    },
                    ......
                ]
            },
            {
                "id": "ADYGP1A0DTU",
                "name": "【经典】格林童话(第一季)",
                "icon": "http://img.idaddy.cn/b/0/849jvv89.jpg",
                "status": 0,
                "audios": [
                    {
                        "id": "ADMGN1A2",
                        "name": "白雪公主(一)",
                        "type": 0,
                        "play_url": "http://cdn.open.idaddy.cn/apsmp3/51bf/idaddy0000000001/201711210000/0_adidaddy/ADYGP1A0DTU.ADMGN1A2.YTk2LzAva3FkODVvNWYuYXVkaW8.mp3",
                        "status": 0
                    },
                    ......
                ]
            }
        ]
    },
    "retcode": 0
}

搜索作品(过滤器)-请求

curl --request POST \
  --data-urlencode "app_id=${APP_ID}" \
  --data-urlencode "device_id=x1000" \
  --data-urlencode "timestamp=${TIMESTAMP}" \
  --data-urlencode "nonce=${NONCE}" \
  --data-urlencode "sign_type=${SIGN_TYPE}" \
  --data-urlencode "signature=${SIGNATURE}" \
  --data-urlencode "offset=0" \
  --data-urlencode "limit=2" \
  --data-urlencode "content=故事" \
  --data-urlencode 'filters={"cat_name":"睡前故事", "performer":"狄菲菲"}' \
  http://open.idaddy.cn/api/v3/work/query

搜索作品(过滤器)-响应

{
    "data": {
        "total": 5,
        "works": [
            {
                "id": "ADEGP1AxDTw",
                "name": "【领声·好声音】白雪公主",
                "icon": "http://img.idaddy.cn/b/9/urgrufyi.jpg",
                "status": 0
            },
            {
                "id": "ADEGP1AyDTw",
                "name": "【领声·好声音】小红帽",
                "icon": "http://img.idaddy.cn/b/9/vkf39wqv.jpg",
                "status": 0
            }
        ]
    },
    "retcode": 0
}

HTTP Request

POST http://open.idaddy.cn/api/v3/work/query

POST参数(application/x-www-form-urlencoded)

name type required description
app_id string 必选 App Id
device_id string 必选 设备ID
app_uid string 可选 客户端用户名
timestamp int 必选 调用时间戳,单位秒,会用作超时验证(5分钟)
nonce string 必选 最长32位随机字符串,每次请求都不同,防止重放攻击
sign_type string 可选 签名类型,默认sha1,支持md5、sha1、sha256
signature string 必选 签名字符串,小写,hash(app_id+secret+timestamp)
offset int 可选 起始位置 默认: 0
limit int 可选 分页记录限制,默认: 10 最大:100
content string 必选 查询关键词
lang int 可选 语言:0 汉字 1 拼音 默认: 0
fields string 可选 自定义搜索域字段,JSON格式字典 {“FIELD” : BOOST}
FIELD string 字段名,支持
– work_name 作品名
– audio_name 声音名
– tag_name 标签名
– cat_name 分类名
– author 作者名
– performer 演播名
BOOST number 提权系数
matching int 可选 最低匹配度百分比 默认: 0
filters string 可选 过滤器,JSON格式字典 {“FIELD”:”VALUE”} 或
{“FIELD”:{
  ”content”:”VALUE”,
  ”boost”:BOOST,
  ”lang”:LANG,
  ”matching”:MATCHING
}}
FIELD string 字段名
VALUE string 查询关键词
BOOST number 提权系数
LANG int 关键词语言
MATCHING int 关键词匹配度
cat_ids string 可选 分类id过滤,JSON数组格式
verbose int 可选 详情选项:0 输出简版内容 1 输出完整版内容 默认: 0
with_cats int 可选 是否输出分类列表: 0 不输出 1 输出 默认: 0
with_audios int 可选 是否输出声音列表: 0 不输出 1 输出 默认: 0
with_token int 可选 播放链接是否自带token: 0 不带token 1 带token 默认: 0

获取作品元数据信息

此查询一次性输出全部有效作品的元数据信息,方便合作伙伴下载为本地缓存。

获取作品元数据信息-请求

curl --request POST \
  --data-urlencode "app_id=${APP_ID}" \
  --data-urlencode "device_id=x1000" \
  --data-urlencode "timestamp=${TIMESTAMP}" \
  --data-urlencode "nonce=${NONCE}" \
  --data-urlencode "sign_type=${SIGN_TYPE}" \
  --data-urlencode "signature=${SIGNATURE}" \
  --data-urlencode "offset=0" \
  --data-urlencode "limit=2" \
  http://open.idaddy.cn/api/v3/work/metadata

获取作品元数据信息-响应

{
    "data": {
        "works": [
            {
                "id": "ADQGNw",
                "name": "口袋故事-孩子身边的故事大王",
                "icon": "http://img.ilisten.idaddy.cn/b/0/o36m1r5f.jpg",
                "tariff": 0,
                "price": 0,
                "terms": "",
                "tags": "口袋故事",
                "performer": "口袋故事",
                "author": "口袋故事",
                "age_from": -1,
                "age_to": 18,
                "comment": "",
                "description": "口袋故事App是国内最大的精选儿童故事平台,全球3000万华人家长的选择!适合0-12岁儿童及家长使用,内容涵盖音乐、儿歌、童谣、诵读、故事、英语、小学课文等各种有声读物,是国内最全、质量最高的有声资料库。",
                "score": 3,
                "rank": 533,
                "status": 0,
                "audios": [
                    {
                        "id": "ADAGMlAwDTBRZg",
                        "name": "口袋故事-孩子身边的故事大王",
                        "type": 0,
                        "free": 1,
                        "file_size": 85505,
                        "duration": 10,
                        "lyrics": ""
                    }
                ],
                "cats": []
            },
            {
                "id": "ADQGNQ",
                "name": "太阳妈妈和她的儿女",
                "icon": "http://img.ilisten.idaddy.cn/b/2/qmqpnp8n.jpg",
                "tariff": 2,
                "price": 1,
                "terms": "天文地理",
                "tags": "天文,太阳,妈妈",
                "performer": "佚名",
                "author": "佚名",
                "age_from": 2,
                "age_to": 7,
                "comment": "",
                "description": "这是一则围绕太阳展开的科普儿童故事,用生动活泼的寓言向孩子们普及太阳和九大行星的科学常识,为小朋友打开探索宇宙世界的窗口。",
                "score": 9,
                "rank": 256,
                "status": 0,
                "audios": [
                    {
                        "id": "ADAGMlAwDTBRZQ",
                        "name": "太阳妈妈和她的儿女",
                        "type": 0,
                        "free": 1,
                        "file_size": 2763047,
                        "duration": 345,
                        "lyrics": ""
                    }
                ],
                "cats": [
                    {
                        "id": "19286",
                        "name": "天文地理"
                    }
                ]
            }
        ]
    },           
   "retcode": 0
}

HTTP Request

POST http://open.idaddy.cn/api/v3/work/metadata

POST参数(application/x-www-form-urlencoded)

name type required description
app_id string 必选 App Id
device_id string 必选 设备ID
app_uid string 可选 客户端用户名
timestamp int 必选 调用时间戳,单位秒,会用作超时验证(5分钟)
nonce string 必选 最长32位随机字符串,每次请求都不同,防止重放攻击
sign_type string 可选 签名类型,默认sha1,支持md5、sha1、sha256
signature string 必选 签名字符串,小写,hash(app_id+secret+timestamp)
offset int 可选 起始位置 默认: 0
limit int 可选 分页记录限制,默认全部
update_ts int 可选 增量更新时间,时间戳(秒),传入则增量拉取该时间以后的数据,不传则全量拉取

api - 声音

声音为可播放的最小单位,一个声音只能属于一个作品。

可设置详情选项调整输出内容:

可设置是否输出声音所属的分类列表:

可设置是否输出声音对应的作品信息:

可设置输出播放链接是否自带token:

声音字段如下:

name verbose description
id 0/1 声音id
name 0/1 声音名
type 0/1 类型(0内容 1花絮 2预告片)
free 1 是否免费(1免费 0付费)
play_url 0/1 播放链接
file_size 1 文件大小(字节)
duration 1 时长(秒)
lyrics 1 歌词
status 0/1 状态(0正常 4停用)
cats * 所属分类列表
cats.id 0/1 分类id
cats.name 0/1 分类名
work_id * 作品ID,with_work=0时输出
work * 所属作品对象
work.id 0/1 作品ID
work.name 0/1 作品名
work.icon 0/1 作品图标
work.tariff 0/1 建议收费等级 (0免费 1VIP 2单购)
work.price 1 作品参考价格(单位分)
work.terms 0/1 词语
work.tags 1 标签
work.performer 1 演播
work.author 1 作者
work.age_from 1 适合年龄下限
work.age_to 1 适合年龄上限
work.comment 1 编辑推荐
work.description 1 简介
work.score 1 用户评分
work.rank 1 综合得分 (热度)
work.status 0/1 状态(0正常 4停用)

获取声音列表

获取指定分类下的声音列表。

获取声音列表-请求

curl --request POST \
  --data-urlencode "app_id=${APP_ID}" \
  --data-urlencode "device_id=x1000" \
  --data-urlencode "timestamp=${TIMESTAMP}" \
  --data-urlencode "nonce=${NONCE}" \
  --data-urlencode "sign_type=${SIGN_TYPE}" \
  --data-urlencode "signature=${SIGNATURE}" \
  --data-urlencode "offset=0" \
  --data-urlencode "limit=2" \
  --data-urlencode "cat_ids=[6708]" \
  --data-urlencode "with_work=1" \
  http://open.idaddy.cn/api/v3/audio/list

获取声音列表-响应

{
    "data": {
        "audios": [
            {
                "id": "ADAGMVAwDTRRZg",
                "name": "不爱睡觉的小猴子",
                "type": 0,
                "play_url": "http://cdn.open.idaddy.cn/apsmp3/9fc6/idaddy0000000001/201808040000/0/ADQGN1A9DTI.ADAGMVAwDTRRZg.YS83L3BwaXJtNGNiLmF1ZGlv.mp3",
                "status": 0,
                "work": {
                    "id": "ADQGN1A9DTI",
                    "name": "不爱睡觉的小猴子",
                    "icon": "http://img.ilisten.idaddy.cn/b/7/9ow5gusy.jpg",
                    "status": 0
                }
            },
            {
                "id": "ADcGMlAxDTQ",
                "name": "引子",
                "type": 0,
                "play_url": "http://cdn.open.idaddy.cn/apsmp3/681f/idaddy0000000001/201808040000/0_adidaddy/ADEGM1AyDTw.ADcGMlAxDTQ.YTk2LzkvdWJocmZqaWguYXVkaW8.mp3",
                "status": 0,
                "work": {
                    "id": "ADEGM1AyDTw",
                    "name": "少儿版希腊神话(上)",
                    "icon": "http://img.ilisten.idaddy.cn/b/9/xv8m3125.jpg",
                    "status": 0
                }
            }
        ]
    },
    "retcode": 0
}

HTTP Request

POST http://open.idaddy.cn/api/v3/audio/list

POST参数(application/x-www-form-urlencoded)

name type required description
app_id string 必选 App Id
device_id string 必选 设备ID
app_uid string 可选 客户端用户名
timestamp int 必选 调用时间戳,单位秒,会用作超时验证(5分钟)
nonce string 必选 最长32位随机字符串,每次请求都不同,防止重放攻击
sign_type string 可选 签名类型,默认sha1,支持md5、sha1、sha256
signature string 必选 签名字符串,小写,hash(app_id+secret+timestamp)
offset int 可选 起始位置 默认: 0
limit int 可选 分页记录限制,默认: 10 最大:100
cat_ids string 必选 分类id,JSON格式数组
verbose int 可选 详情选项:0 输出简版内容 1 输出完整版内容 默认: 0
with_cats int 可选 是否输出分类列表: 0 不输出 1 输出 默认: 0
with_work int 可选 是否输出作品信息: 0 不输出 1 输出 默认: 0
with_token int 可选 播放链接是否自带token: 0 不带token 1 带token 默认: 0

获取声音信息

获取指定声音ID的声音信息。

获取声音信息-请求

curl --request POST \
  --data-urlencode "app_id=${APP_ID}" \
  --data-urlencode "device_id=x1000" \
  --data-urlencode "timestamp=${TIMESTAMP}" \
  --data-urlencode "nonce=${NONCE}" \
  --data-urlencode "sign_type=${SIGN_TYPE}" \
  --data-urlencode "signature=${SIGNATURE}" \
  --data-urlencode 'audio_ids=["ADcGMFA3DTNRYA"]' \
  --data-urlencode "verbose=1" \
  --data-urlencode "with_cats=1" \
  --data-urlencode "with_work=1" \
  http://open.idaddy.cn/api/v3/audio/info

获取声音信息-响应

{
    "data": {
        "audios": [
            {
                "id": "ADcGMFA3DTNRYA",
                "name": "第1集",
                "type": 0,
                "free": 1,
                "play_url": "http://cdn.open.idaddy.cn/apsmp3/0c1b/idaddy0000000006/201711210000/0_adidaddy/ADIGM1A1DTw.ADcGMFA3DTNRYA.YTY0LzAvOW55MGxyd2guYXVkaW8.mp3",
                "file_size": 5688457,
                "duration": 711,
                "lyrics": "",
                "status": 0,
                "cats": [
                    {
                        "id": 6709,
                        "name": "睡前故事"
                    },
                    ......
                ],
                "work": {
                    "id": "ADIGM1A1DTw",
                    "name": "白雪公主(卉卉阿姨)",
                    "icon": "http://img.idaddy.cn/b/9/d3vrh48k.jpg",
                    "tariff": 0,
                    "price": 999,
                    "terms": "女孩故事,睡前故事,经典童话",
                    "tags": "白雪公主,经典童话,卉卉阿姨",
                    "performer": "卉卉阿姨",
                    "author": "格林童话",
                    "age_from": 3,
                    "age_to": 8,
                    "comment": "",
                    "description": "格林兄弟最经典的童话白雪公主,广受小朋友们欢迎,已改编为多个不同版本。该系列白雪公主连载故事,伴随着悠扬的圣诞歌曲,由嗓音优美的卉卉阿姨为小朋友们演播。",
                    "rank": 110,
                    "score":110,
                    "status": 0
                },
            }
        ]
    },
    "retcode": 0
}

HTTP Request

POST http://open.idaddy.cn/api/v3/audio/info

POST参数(application/x-www-form-urlencoded)

name type required description
app_id string 必选 App Id
device_id string 必选 设备ID
app_uid string 可选 客户端用户名
timestamp int 必选 调用时间戳,单位秒,会用作超时验证(5分钟)
nonce string 必选 最长32位随机字符串,每次请求都不同,防止重放攻击
sign_type string 可选 签名类型,默认sha1,支持md5、sha1、sha256
signature string 必选 签名字符串,小写,hash(app_id+secret+timestamp)
audio_ids string 必选 声音id,JSON数组格式
verbose int 可选 详情选项:0 输出简版内容 1 输出完整版内容 默认: 0
with_cats int 可选 是否输出分类列表: 0 不输出 1 输出 默认: 0
with_work int 可选 是否输出作品信息: 0 不输出 1 输出 默认: 0
with_token int 可选 播放链接是否自带token: 0 不带token 1 带token 默认: 0

搜索声音

采用全文检索技术,用同一个关键词在不同属性组成的搜索域中搜索声音,搜索结果按匹配度+智能因子综合排序。

同时还可用不同的关键词在指定的单独属性中过滤声音,达到组合搜索的效果。

搜索声音(默认)-请求

curl --request POST \
  --data-urlencode "app_id=${APP_ID}" \
  --data-urlencode "device_id=x1000" \
  --data-urlencode "timestamp=${TIMESTAMP}" \
  --data-urlencode "nonce=${NONCE}" \
  --data-urlencode "sign_type=${SIGN_TYPE}" \
  --data-urlencode "signature=${SIGNATURE}" \
  --data-urlencode "offset=0" \
  --data-urlencode "limit=2" \
  --data-urlencode "content=妈妈" \
  --data-urlencode "with_work=1" \
  http://open.idaddy.cn/api/v3/audio/query

搜索声音(默认)-响应

{
    "data": {
        "total": 1,
        "audios": [
            {
                "id": "ADcGN1AxDTdRYw",
                "name": "16 鸭妈妈和鸡阿姨",
                "type": 0,
                "play_url": "http://cdn.open.idaddy.cn/apsmp3/0498/idaddy0000000001/201801050000/1/ADMGM1A9DTw.ADcGN1AxDTdRYw.YTk2LzAvcTlieWppd3QuYXVkaW8.mp3",
                "status": 0,
                "work": {
                    "id": "ADMGM1A9DTw",
                    "name": "汉声童趣儿歌(小班篇)1",
                    "icon": "http://img.idaddy.cn/b/9/rew0s3wy_s150.jpg",
                    "status": "0"
                }
            }
        ]
    },
    "retcode": 0
}

搜索声音(拼音)-请求

curl --request POST \
  --data-urlencode "app_id=${APP_ID}" \
  --data-urlencode "device_id=x1000" \
  --data-urlencode "timestamp=${TIMESTAMP}" \
  --data-urlencode "nonce=${NONCE}" \
  --data-urlencode "sign_type=${SIGN_TYPE}" \
  --data-urlencode "signature=${SIGNATURE}" \
  --data-urlencode "offset=0" \
  --data-urlencode "limit=2" \
  --data-urlencode "content=xiaozhu" \
  --data-urlencode "lang=1" \
  --data-urlencode "matching=100" \
  http://open.idaddy.cn/api/v3/audio/query

搜索声音(拼音)-响应

{
    "data": {
        "total": 3,
        "audios": [
            {
                "id": "ADcGN1AxDTVRYQ",
                "name": "小猪睡觉",
                "type": 0,
                "play_url": "http://cdn.open.idaddy.cn/apsmp3/5de2/idaddy0000000001/201801050000/1/ADMGM1A9DTw.ADcGN1AxDTVRYQ.YTk2LzAvZ3lkNzAxYXAuYXVkaW8.mp3",
                "status": 0,
                "work_id": "ADMGM1A9DTw"
            },
            {
                "id": "ADQGMVA0DTRRZA",
                "name": "三只小猪(中文)",
                "type": 0,
                "play_url": "http://cdn.open.idaddy.cn/apsmp3/5eb4/idaddy0000000001/201801050000/1/ADMGNlAxDTE.ADQGMVA0DTRRZA.YTk2LzQvNWVxb2g0bW8uYXVkaW8.mp3",
                "status": 0,
                "work_id": "ADMGNlAxDTE"
            }
        ]
    },
    "retcode": 0
}

搜索声音(自定义搜索域)-请求

curl --request POST \
  --data-urlencode "app_id=${APP_ID}" \
  --data-urlencode "device_id=x1000" \
  --data-urlencode "timestamp=${TIMESTAMP}" \
  --data-urlencode "nonce=${NONCE}" \
  --data-urlencode "sign_type=${SIGN_TYPE}" \
  --data-urlencode "signature=${SIGNATURE}" \
  --data-urlencode "offset=0" \
  --data-urlencode "limit=2" \
  --data-urlencode "content=白雪公主" \
  --data-urlencode 'fields={"audio_name":2, "work_name":1}' \
  --data-urlencode "with_cats=1" \
  http://open.idaddy.cn/api/v3/audio/query

搜索声音(自定义搜索域)-响应

{
    "data": {
        "total": 3,
        "audios": [
            {
                "id": "ADQGMVA0DTVRYA",
                "name": "白雪公主(中文)",
                "type": 0,
                "play_url": "http://cdn.open.idaddy.cn/apsmp3/aaf8/idaddy0000000001/201801050000/1/ADMGNlAxDTE.ADQGMVA0DTVRYA.YTk2LzQvYmd2cjN6NTQuYXVkaW8.mp3",
                "status": 0,
                "cats": [
                    {
                        "id": "10716",
                        "name": "英语故事"
                    },
                    {
                        "id": "12029",
                        "name": "经典童话"
                    },
                    {
                        "id": "15016",
                        "name": "精品故事"
                    },
                    {
                        "id": "17467",
                        "name": "英语绘本"
                    }
                ],
                "work_id": "ADMGNlAxDTE"
            },
            {
                "id": "ADQGMVA0DTVRbw",
                "name": "白雪公主(英文)",
                "type": 0,
                "play_url": "http://cdn.open.idaddy.cn/apsmp3/1f76/idaddy0000000001/201801050000/1/ADMGNlAxDTE.ADQGMVA0DTVRbw.YTk2LzgvY2llN3RjaHcuYXVkaW8.mp3",
                "status": 0,
                "cats": [
                    {
                        "id": "10716",
                        "name": "英语故事"
                    },
                    {
                        "id": "12029",
                        "name": "经典童话"
                    },
                    {
                        "id": "15016",
                        "name": "精品故事"
                    },
                    {
                        "id": "17467",
                        "name": "英语绘本"
                    }
                ],
                "work_id": "ADMGNlAxDTE"
            }
        ]
    },
    "retcode": 0
}

搜索声音(过滤器)-请求

curl --request POST \
  --data-urlencode "app_id=${APP_ID}" \
  --data-urlencode "device_id=x1000" \
  --data-urlencode "timestamp=${TIMESTAMP}" \
  --data-urlencode "nonce=${NONCE}" \
  --data-urlencode "sign_type=${SIGN_TYPE}" \
  --data-urlencode "signature=${SIGNATURE}" \
  --data-urlencode "content=公主" \
  --data-urlencode 'filters={"cat_name":"睡前故事", "performer":"狄菲菲"}' \
  --data-urlencode "verbose=1" \
  --data-urlencode "with_cats=1" \
  --data-urlencode "with_work=1" \
  http://open.idaddy.cn/api/v3/audio/query

搜索声音(过滤器)-响应

{
    "data": {
        "total": 1,
        "audios": [
            {
                "id": "ADAGP1AzDTNRYw",
                "name": "【领声·好声音】白雪公主",
                "type": 0,
                "free": 1,
                "play_url": "http://cdn.open.idaddy.cn/apsmp3/e198/idaddy0000000001/201801050000/0/ADEGP1AxDTw.ADAGP1AzDTNRYw.YTY0LzkvM3BienVhanAuYXVkaW8.mp3",
                "file_size": 12894491,
                "duration": 1611,
                "lyrics": "",
                "status": 0,
                "cats": [
                    {
                        "id": "6709",
                        "name": "睡前故事"
                    },
                    {
                        "id": "11549",
                        "name": "女孩故事"
                    },
                    {
                        "id": "12029",
                        "name": "经典童话"
                    }
                ],
                "work": {
                    "id": "ADEGP1AxDTw",
                    "name": "【领声·好声音】白雪公主",
                    "icon": "http://img.idaddy.cn/b/9/5i40j1k8_s150.jpg",
                    "tariff": 0,
                    "price": 888,
                    "terms": "女孩故事,新年畅听攻略,睡前故事,经典童话",
                    "tags": "格林童话,童话,女孩故事,公主故事,领声,白雪公主和七个小矮人",
                    "performer": "狄菲菲",
                    "author": "格林兄弟",
                    "age_from": "2",
                    "age_to": "7",
                    "comment": "播讲:狄菲菲,国家一级演员、译制导演、配音演员。她的团队曾为众多国际大片配音:《哈利波特》系列、《冰雪奇缘》、《玩具总动员》、《冰川时代》、《E.T.外星人》、《功夫熊猫》、《里约大冒险》等。在听听里的作品还有猫饼干传奇、我是夏蛋蛋之蓝耳朵、奇妙学校之光头校长、童话相声系列等。这次可是狄老师倾情为小朋友们演绎的白雪公主哦,精彩不容错过。\r\n\r\n上海领声文化传播有限公司(Listen)是由国家一级演员、著名译制导演、语言艺术家狄菲菲创立的专业从事艺术语言教育咨询、有声读物制作、影视声音后期制作、演出等相关文化产业发展的公司。团队核心成员包括吴磊、黄雷、赵乾景、陶典等著名演员。上海领声目前是迪士尼、梦工厂等多家全球知名影视集团、出版社的专业合作伙伴。在有声读物领域,上海领声注重文化产品的质量和品味,力求创新、完美。领声追求专业、创意、完美,希望向孩子们传递令他们终生难忘的声音。",
                    "description": "本故事由上海领声团队出品。最经典的版本,最专业的演绎,献给童年的经典!",
                    "rank": "9.0",
                    "score":110,
                    "status": "0"
                }
            }
        ]
    },
    "retcode": 0
}

HTTP Request

POST http://open.idaddy.cn/api/v3/audio/query

POST参数(application/x-www-form-urlencoded)

name type required description
app_id string 必选 App Id
device_id string 必选 设备ID
app_uid string 可选 客户端用户名
timestamp int 必选 调用时间戳,单位秒,会用作超时验证(5分钟)
nonce string 必选 最长32位随机字符串,每次请求都不同,防止重放攻击
sign_type string 可选 签名类型,默认sha1,支持md5、sha1、sha256
signature string 必选 签名字符串,小写,hash(app_id+secret+timestamp)
offset int 可选 起始位置 默认: 0
limit int 可选 分页记录限制,默认: 10 最大:100
content string 必选 查询关键词
lang int 可选 语言:0 汉字 1 拼音 默认: 0
fields string 可选 自定义搜索域字段,JSON格式字典 {“FIELD” : BOOST}
FIELD string 字段名,支持
– work_name 声音名
– audio_name 声音名
– tag_name 标签名
– cat_name 分类名
– author 作者名
– performer 演播名
BOOST number 提权系数
matching int 可选 最低匹配度百分比 默认: 0
filters string 可选 过滤器,JSON格式字典 {“FIELD”:”VALUE”} 或
{“FIELD”:{
  ”content”:”VALUE”,
  ”boost”:BOOST,
  ”lang”:LANG,
  ”matching”:MATCHING
}}
FIELD string 字段名
VALUE string 查询关键词
BOOST number 提权系数
LANG int 关键词语言
MATCHING int 关键词匹配度
cat_ids string 可选 分类id过滤,JSON数组格式
verbose int 可选 详情选项:0 输出简版内容 1 输出完整版内容 默认: 0
with_cats int 可选 是否输出分类列表: 0 不输出 1 输出 默认: 0
with_work int 可选 是否输出作品信息: 0 不输出 1 输出 默认: 0
with_token int 可选 播放链接是否自带token: 0 不带token 1 带token 默认: 0

其他技术说明

URL超时说明

基于对版权和流量保护的考虑,开放平台输出的音频URL有防盗链设计,有效时间为1周,请定时刷新来避免失效。

DeviceToken超时说明

基于对版权和流量保护的考虑,开放平台输出的音频URL,需使用device token授权才能访问,token有效时间为1周,请定时刷新token来避免失效。

架构

工程师爸爸儿童教育资源开放平台以音频、书籍、应用等儿童在线教育资源作为基础库,通过开放平台形成统一的H5、API输出,并辅以日志、统计、计费、安全等基础应用组件形成一个专门针对儿童在线教育资源的开放平台。

图片出错

流量限制

免费用户每天URL调用次数上限为10000,每分钟调用次数上限为100次;流量输出上限为每天5G。开发人员可以根据实际需要申请更多资源。

CDN支持

所有输出均由CDN网络输出,CDN回源时间为24小时。如果使用过程中有内容变更,可能需要24小时才能看到变更结果。

服务

定制接入

如果第三方有更多接入需求,如变更页面布局,去除工程师爸爸Logo,口袋故事下载链接等内容,请与工程师爸爸协商洽谈。

付费接入

频道输出将分别提供免费、付费内容输出,如果需要付费内容输出请与工程师爸爸协商洽谈。