Query notification service IP address
Updated
Retrieves Agora message notification service IP addresses.
https://api.agora.io/v2/ncs/ipWhen using Agora real-time audio and video, you can use the Agora Notifications service to receive channel events.
After activating the service, when a channel event occurs, the Agora Notifications service server will deliver the event notification to your message receiving server.
If your server is behind a firewall, you need to call the IP address query API to retrieve the IP addresses of Agora Notifications service and configure your firewall to trust all these IP addresses.
Agora adjusts the Agora Notifications service IP addresses every 24 hours. Best practice is to call this endpoint at least every 24 hours and automatically update the firewall configuration.
- Method:
GET - Endpoint:
https://api.agora.io/v2/ncs/ip
Note
If your server is behind a firewall, configure your firewall to trust the returned IP addresses. Agora adjusts message notification service IP addresses every 24 hours. Best practice is to call this endpoint at least every 24 hours and automatically update the firewall configuration.
Response Body
The request succeeded and returned notification service IP addresses.
dataobjectserviceobjecthostsarray<object>primaryIPstringIP address of the Agora message notification service server. Add this IP address, or returned IP address list, to your firewall whitelist.
Request examples
curl -X GET "https://example.com/v2/ncs/ip"Response example
{ "data": { "service": { "hosts": [ { "primaryIP": "string" } ] } }}