Notification Service Addresses
Egress addresses integrators allow-list for callbacks.
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.
| Method | Path | Summary |
|---|---|---|
GET | /v1/ncs/ip | Query the message notification service addresses (cloud recording spelling) |
GET | /v2/ncs/ip | Query 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 codes | Description / schema |
|---|---|
200 | notification addresses — object{ data } |
400 | Invalid parameter — Error |
401 | Missing/invalid credentials — Error |
403 | Banned or service not enabled — Error |
404 | Resource not found — Error |
415 | Content-Type must be application/json — Error |
429 | Quota exceeded — Error |
Example call
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 codes | Description / schema |
|---|---|
200 | notification addresses — object{ data } |
400 | Invalid parameter — Error |
401 | Missing/invalid credentials — Error |
403 | Banned or service not enabled — Error |
404 | Resource not found — Error |
415 | Content-Type must be application/json — Error |
429 | Quota exceeded — Error |
Example call
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 }
| Field | Type | Required | Description |
|---|---|---|---|
code | string | is | stable machine code, see errors.json |
message | string | is | |
reason | string | ||
sdkCode | integer | Agora-aligned client error number | |
details | object |