Skip to content

开发者必读

API介绍

开发者使用此API可以将微信直播的功能集成在自己的应用程序中,满足您的个性化需求。

API需要使用签名发起请求,未携带签名参数的请求不能正常调取接口内容。具体的签名方法请参照下一章节。

API使用步骤

  1. 申请获得AppKey和AppSecret。
  2. 使用上一步中得到的AppKey和AppSecret,携带秘钥或者生成签名访问API接口服务。

API域名说明

平台目前有以下两个API域名:

注意:新旧接口的域名不可混用。

  • 访问旧接口时,只能使用 https://gateway.nuoyunlive.com
  • 访问新接口时,只能使用 https://gateway.nuoyunapi.com

如接口文档没有提供完整的请求 host+path,则默认使用旧域名 https://gateway.nuoyunlive.com

在本文档中:

  • 如果接口只提供了 path(如 /live/getChannelList),则示例请求 URL 默认使用旧域名 https://gateway.nuoyunlive.com,例如:

    http
    https://gateway.nuoyunlive.com/live/getChannelList
  • 如果接口文档已提供完整的 host+path(如 https://gateway.nuoyunapi.com/Api/live/getNewFeature/2.0.0),则直接使用文档中的完整 URL,例如:

    http
    https://gateway.nuoyunapi.com/Api/live/getNewFeature/2.0.0

返回值

本文档中若无特殊说明则接口的默认返回值均为json字符串

状态码说明

HttpCode

200:请求成功;4xx:业务错误。

一般为请求格式错误、请求方式错误、必填参数丢失、参数格式错误、签名错误、流控限制等问题。此时需查看具体错误码,针对性解决问题。