查询消息通知服务器 IP

更新时间不可用

查询声网消息通知服务器的 IP 地址。

GET
https://api.sd-rtn.com/v2/ncs/ip

在使用声网实时音视频功能时,你可以使用声网消息通知服务接收实时音视频业务中的频道状态。

开通消息通知服务后,当订阅的频道事件发生时,声网消息通知服务器会将事件通知投递给你的消息接收服务器。

如果你的消息接收服务器受防火墙限制,你可以调用该方法查询声网消息通知服务器的 IP 地址,并将获取到的所有 IP 地址都添加到防火墙白名单。

注意

声网可能会调整消息通知服务器的 IP 地址。强烈建议你至少每 24 小时查询一次,并自动更新防火墙配置,否则可能会影响你接收通知。

鉴权

Basic Auth

声网频道管理 RESTful API 仅支持 HTTPS。发送请求时,你需要使用声网提供的客户 ID 和客户密钥生成 Base64 编码凭证,并填入请求头部的 Authorization 字段中。详见实现 HTTP 基本认证。

响应

如果状态码为 200,则请求成功。

响应 Body

字段

请求示例

Example Request
curl --request GET \
  --url "https://api.sd-rtn.com/v2/ncs/ip" \
  --header 'Authorization: Basic <credentials>'

响应示例

{
  "data": {
    "service": {
      "hosts": [
        {
          "primaryIP": "xxx.xxx.xxx.xxx"
        },
        {
          "primaryIP": "xxx.xxx.xxx.xxx"
        }
      ]
    }
  }
}