nimeet Docs
中文

Notification Service Addresses

Egress addresses integrators allow-list for callbacks.

Generated from the public REST API definitions

Version v1.1.0 · Updated 2026-10-26 · revision 1

Group overview

Generated at build time from the public REST API definition: tag notifications, 2 operations (out of 189). For authentication, envelope and pagination conventions see REST API overview.

MethodPathSummary
GET/v1/ncs/ipQuery the message notification service addresses (cloud recording spelling)
GET/v2/ncs/ipQuery the message notification service addresses

Operation details

GET /v1/ncs/ip

Query the message notification service addresses (cloud recording spelling)

Authentication: project credentials (Base64 of customerId:customerSecret)

Response

Status codesDescription / schema
200notification addresses — object{ data }
400Invalid parameter — Error
401Missing/invalid credentials — Error
403Banned or service not enabled — Error
404Resource not found — Error
415Content-Type must be application/json — Error
429Quota exceeded — Error

Example call

bash
curl -s -X GET "$NIMEET_API_BASE/v1/ncs/ip" \
  -H "Authorization: Basic $NIMEET_CUSTOMER_BASIC"

GET /v2/ncs/ip

Query the message notification service addresses

Returns the addresses this control plane delivers callbacks from; allow-list them if the receiving server is behind a firewall.

Authentication: project credentials (Base64 of customerId:customerSecret)

Response

Status codesDescription / schema
200notification addresses — object{ data }
400Invalid parameter — Error
401Missing/invalid credentials — Error
403Banned or service not enabled — Error
404Resource not found — Error
415Content-Type must be application/json — Error
429Quota exceeded — Error

Example call

bash
curl -s -X GET "$NIMEET_API_BASE/v2/ncs/ip" \
  -H "Authorization: Basic $NIMEET_CUSTOMER_BASIC"

Schemas used by this group

Error — object{ code, message, reason, sdkCode, details }
FieldTypeRequiredDescription
codestringisstable machine code, see errors.json
messagestringis
reasonstring
sdkCodeintegerAgora-aligned client error number
detailsobject

Generated by the documentation build pipeline · 2026-10-31 01:24:02 UTC · Documentation center v1.1.0.

Content follows the public API definitions.

ni-meet is a self-hosted RTC PaaS with a LiveKit-based media plane (Apache-2.0) and an Agora-compatible API.