Skip to main content
Conversational AI Engine: Create advanced voice apps by combining Agora's real-time audio with powerful conversational AI.

Query message notification server IP

Query message notification server IP

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

Obtain the address list of the query message notification server. Add the IP addresses to your whitelist.

The Agora message notification service can notify your server of some cloud transcoding events through HTTPS requests. Agora dynamically adjusts the IP address of the message notification server in a 24-hour cycle. Agora strongly recommends that you query at least once every 24 hours and automatically update your firewall configuration.

Response​

  • If the returned status code is 200, the request was successful. The response body contains the result of the request.

    OK
    • data object
      Show propertiesHide properties
      • service object
        Show propertiesHide properties
        • hosts array
          Show propertiesHide properties
          • primaryIP string

            The IP address of the Agora message notification server.

Authorization

This endpoint requires Basic Auth.

Request example


_3
curl --request get \
_3
--url https://api.sd-rtn.com/v1/ncs/ip \
_3
--header 'Authorization: Basic <credentials>'

Response example


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