Skip to content

7.3.1 网易云账号绑定API(小程序)

1. API 地址

环境域名
测试https://uat-api.joyinside.com
生产https://api.joyinside.com

2. 鉴权方式(与设备注册时鉴权一致)

详见:4.1 Token 鉴权

3. 登录设计视觉规范

详见:https://developer.music.163.com/st/developer/document?docId=abd9c5a3bd5c489fbee31b54b2b0905d

4. 接口文档

4.1 获取网易云音乐 H5 登录配置

  • URL/soulmate/wyy/getWyyH5LoginConfig
  • 请求方式:POST

请求参数

名称数据类型备注
requestIdString请求 ID
vendorIdString企业 ID
uidString用户 ID(小程序用户 id)
h5TokenStringJoyInside-accessToken(用于回调验签)

返回

名称数据类型备注
traceIdString链路追踪 ID
stateState返回状态,枚举值:SUCCESSFAILUREERROR
codeString返回码
resultString返回描述
dataWyyH5LoginConfigDto登录配置数据

data:WyyH5LoginConfigDto

名称数据类型备注
clientIdString网易云应用 Id(非 JoyInside appId)
stateString自定义随机字符串,oauth 回跳时会原样带回
clientTypeString接入方端类型,通常为 web
redirectUrlString服务端已做 urlEncode,无需再 encode

跳转网易云 H5 登录页面

https://music.163.com/st/platform/oauth/authorize?clientId=xxx&state=xxxx&clientType=xxx&redirectUrl=xxx

4.2 获取网易云音乐 H5 登录结果(小程序开启 webview 后轮询此接口)

  • URL/soulmate/wyy/getWyyH5LoginResult
  • 请求方式:POST

请求参数

名称数据类型备注
requestIdString请求 ID
vendorIdString企业 ID
stateString登录配置接口获取到的 state

返回

名称数据类型备注
traceIdString链路追踪 ID
stateString返回状态,枚举值:SUCCESSFAILUREERROR
codeString返回码
resultString返回描述
dataBoolean是否已完成绑定,true 表示已绑定

4.3 获取网易云音乐账号用户信息

  • URL/soulmate/wyy/getWyyAccountUser
  • 请求方式:POST

请求参数

名称数据类型备注
requestIdString请求 ID
vendorIdString企业 ID
uidString用户 ID(小程序用户 id)

返回

名称数据类型备注
traceIdString链路追踪 ID
stateState返回状态,枚举值:SUCCESSFAILUREERROR
codeString返回码
resultString返回描述
dataWyyAccountUserDto网易云账户用户信息

data:WyyAccountUserDto

名称数据类型备注
idString用户 ID
nicknameString用户昵称
avatarUrlString头像 URL
genderInteger性别,1 男,2
signatureString个人签名
vipDetailList<VipDetail>VIP 详情列表
fullVipDetailList<FullVipDetail>完整 VIP 详情列表
redVipLevelInteger红 VIP 等级

vipDetail 元素:VipDetail

名称数据类型备注
typeIntegerVIP 类型
expireTimeLong过期时间戳

fullVipDetail 元素:FullVipDetail

名称数据类型备注
typeIntegerVIP 类型
expireTimeLong过期时间戳

4.4 解绑网易云音乐账号

  • URL/soulmate/wyy/unbindWyyAccount
  • 请求方式:POST

请求参数

名称数据类型备注
requestIdString请求 ID
vendorIdString企业 ID
uidString用户 ID(小程序用户 id)

返回

名称数据类型备注
traceIdString链路追踪 ID
stateState返回状态,枚举值:SUCCESSFAILUREERROR
codeString返回码
resultString返回描述
dataBoolean是否解绑成功

4.5 获取网易云音乐账号绑定的设备列表

  • URL/soulmate/wyy/getWyyAccountBotList
  • 请求方式:POST

请求参数

名称数据类型备注
requestIdString请求 ID
vendorIdString企业 ID
uidString用户 ID(小程序用户 id)

返回

名称数据类型备注
traceIdString链路追踪 ID
stateState返回状态,枚举值:SUCCESSFAILUREERROR
codeString返回码
resultString返回描述
dataList<ResourceAccountBotDto>账号绑定的设备列表

data 元素:ResourceAccountBotDto

名称数据类型备注
idLong主键 ID
createPinString创建人
createTimeDate创建时间
modifyPinString更新人
modifyTimeDate更新时间
ynInteger删除标识
bindIdString业务 ID
accountIdString账号 ID
botIdString设备 ID

4.6 网易云音乐账号绑定设备

  • URL/soulmate/wyy/bindBotWyyAccount
  • 请求方式:POST

请求参数

名称数据类型备注
requestIdString请求 ID
vendorIdString企业 ID
uidString用户 ID(小程序用户 id)
botIdListList<String>需要绑定的设备 ID 列表

返回

名称数据类型备注
traceIdString链路追踪 ID
stateState返回状态,枚举值:SUCCESSFAILUREERROR
codeString返回码
resultString返回描述
dataBoolean是否绑定成功

4.7 为网易云音乐账号解绑设备

  • URL/soulmate/wyy/unbindBotWyyAccount
  • 请求方式:POST

请求参数

名称数据类型备注
requestIdString请求 ID
vendorIdString企业 ID
uidString用户 ID(小程序用户 id)
botIdListList<String>需要解绑的设备 ID 列表

返回

名称数据类型备注
traceIdString链路追踪 ID
stateState返回状态,枚举值:SUCCESSFAILUREERROR
codeString返回码
resultString返回描述
dataBoolean是否解绑成功

附 1:公共返回对象

名称数据类型备注
traceIdString链路追踪 ID
stateState返回状态,枚举值:SUCCESSFAILUREERROR
codeString返回码
resultString返回描述信息
data<T>业务返回数据

附 2:响应结果 code 枚举

code说明
ok正确状态码
500参数 | 服务端逻辑异常
1001未绑定网易云音乐账号
1002绑定的网易云音乐账号已过期
其它未知错误