HTTP/HTTPS
请求协议
东梦接口平台 / 音乐xml接口 / 自动生成xml乐谱接口
自动生成xml乐谱接口
接口地址：https://dmapi.v3.doyure.com/api/music.php?s=Music.Xml.Create
接口描述： 自动生成xml乐谱接口，注意：拍号格式；关于音域,1)默认音域范围用-隔开；2）如果想换手（单行谱表），musicRange音域为两段，格式：c-d1,b-a1。（英文逗号隔开）并且需要配合changeHandNum字段，即指定多少个音换手；
接口参数
| 参数名字 | 类型 | 是否必须 | 默认值 | 其他 | 说明 |
|---|---|---|---|---|---|
| access_token | 字符串 | 可选 | 访问令牌，仅当开启签名验证时需要传递，生成令牌可使用App.Auth.ApplyToken接口 | ||
| xmlFormat | 字符串 | 可选 | - | 生成返回格式，默认：string将返回xml文本、url返回url地址、preview预览模式 | |
| scorePartId | 字符串 | 可选 | - | 乐谱中对应声部（乐器），用id标识。p1：表钢琴 | |
| partName | 字符串 | 可选 | - | 乐谱名称，如：Piano | |
| fifth | 字符串 | 可选 | - | 调号：0没有调号、1表G大调/e小调、2表D大调/b小调、3表A大调/f#小调、4表E大调/c#小调、5表B大调/g#小调、6表F#大调/d#小调、7表C#大调/a#小调。负数为降号 | |
| beatNo | 字符串 | 可选 | - | 拍号,格式：4/4，表四四拍,即每个小节长度是：四分音符*4拍 | |
| musicRange | 字符串 | 可选 | - | 音域,格式：c-c1,c1-c2。范围用“-”、两个音域用“,”隔开，前表低音、后表高音。注意：低音谱表不得高于f1（小字一组f）音，高音谱表不得低于g(小字组)音 | |
| intervalSpan | 字符串 | 可选 | - | 音程跨度，如：两度内为2 | |
| noteType | 字符串 | 可选 | - | 音符类型，为空则不限制，多个用英文逗号隔开。如：4表四分音符、8表八分音符..... | |
| noteCount | 字符串 | 可选 | - | 生成音符总个数 | |
| barNum | 字符串 | 可选 | - | 小节数 | |
| changeHandNum | 字符串 | 可选 | - | 多少个音开始换手,【注】结合拍号设定，系统最终按小节换手，并非按实际音符数 | |
| defaultHand | 字符串 | 可选 | - | 表示先用哪只手，默认为1(习惯性右手);0：表先用左手 | |
| beginFinger | 字符串 | 可选 | - | 开始指法，即第几根手指开始。会有指法标识 | |
| tempLifting | 字符串 | 可选 | - | 此曲谱中需要几个临时升降号 |
返回字段
| 返回结果 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务器错误 |
| data | 对象或混合类型 | 业务数据，由各自接口指定，通常为对象 |
| msg | 字符串 | 提示信息，失败时的错误提示 |
在线测试
| 参数 | 是否必须 | 值 |
|---|---|---|
| service | 必须 | |
| access_token | 可选 | |
| xmlFormat | 可选 | |
| scorePartId | 可选 | |
| partName | 可选 | |
| fifth | 可选 | |
| beatNo | 可选 | |
| musicRange | 可选 | |
| intervalSpan | 可选 | |
| noteType | 可选 | |
| noteCount | 可选 | |
| barNum | 可选 | |
| changeHandNum | 可选 | |
| defaultHand | 可选 | |
| beginFinger | 可选 | |
| tempLifting | 可选 |
客户端请求示例
# 暂无示例，可添加示例文件：./src/view/docs/demos/Music.Xml.Create.json错误列表
| 错误状态码 | 错误描述信息 |
|---|---|
| 400 | ret=400，客户端参数错误或非法请求 |
| 404 | 表示接口服务不存在 |
| 406 | ret=406，access_token令牌校验不通过 |
| 407 | ret=407，app_key权限不足，或未知应用 |
| 408 | ret=408，当前用户禁止使用，或用户未登录 |
| 500 | 表示服务端内部错误 |
本文档生成时间：2025-12-26 15:32:04