> ## Documentation Index > Fetch the complete documentation index at: https://docs.orbit.devotel.io/llms.txt > Use this file to discover all available pages before exploring further. # Get a unified notify cascade delivery receipt > Returns the aggregated delivery status of a `/notify` send: every hop (the primary binding plus any fan-out bindings or auto-escalated waterfall fallbacks) that shares this notify_id, an overall `status` (`delivered` once any hop reaches the recipient, `failed` once the cascade is exhausted with no delivery, or `in_progress` while a hop is still in flight or an escalation is still pending), the channel that ultimately delivered (if any), and the unified total price actually billed across every hop sent so far. ## OpenAPI ````yaml /openapi.yaml get /api/v1/notify/{notifyId} openapi: 3.1.0 info: title: Devotel CPaaS API description: Orbit by Devotel — Communications Platform as a Service API version: 1.0.0 contact: name: Devotel url: https://devotel.io email: support@devotel.io license: name: Proprietary servers: - url: https://api.orbit.devotel.io description: Production security: - Bearer: [] - ApiKey: [] tags: - name: Messages description: >- Send and manage messages across all channels (SMS, WhatsApp, RCS, Email, Viber, etc.) - name: Agents description: AI agent creation, configuration, and execution - name: Voice description: Voice calls, IVR, conferencing, and SIP trunking - name: Webhooks description: Webhook endpoint management and delivery logs - name: Numbers description: Phone number search, provisioning, and configuration - name: Contacts description: Contact management, segmentation, and lifecycle tracking - name: Campaigns description: Marketing campaign orchestration and analytics - name: Flows description: Automation flow builder and execution engine - name: Templates description: Message template management and approval workflows - name: Settings description: Organization, channel, and user preference settings - name: Verify description: OTP generation and verification across channels - name: Push description: Push notification delivery via FCM and APNs - name: Telegram description: >- Telegram bring-your-own-bot channel: connect a bot, verify a chat against the shared sandbox bot, and read unified channel state. Production sends go through the Messaging API. - name: USSD description: >- Menu-driven USSD for feature phones: define a menu tree, simulate session steps, and host the tenant-scoped aggregator callback. - name: Integrations description: Third-party service connections and OAuth management - name: Files description: >- Server-to-server media upload, listing, retrieval, and deletion (signed-URL backed) - name: Messaging Services description: >- Twilio MessagingService-parity containers bundling sender pool, opt-out list, inbound webhook, and sticky-sender/geomatch flags - name: Sender Pools description: >- Group sending numbers into pools with a selection strategy (sticky / round-robin / random) for outbound sends - name: Opt-Out Lists description: >- Per-list STOP / HELP / START keyword sets and auto-response copy (Twilio Advanced Opt-Out parity) - name: SMPP description: Tenant BYO-SMPP bind credentials and upstream termination carriers - name: Commerce description: >- Unified omnichannel conversational-commerce: cart/checkout state machine, cross-channel payment reconciliation, hosted pay-by-link, native WhatsApp checkout, and agentic-checkout payment mandates - name: Orby description: >- In-dashboard Orby operator assistant: streamed assistant turns, conversation threads, product knowledge-base search, and the tool-action approval gate. Available to signed-in operators only (dashboard session auth — API-key requests are rejected). paths: /api/v1/notify/{notifyId}: get: tags: - Messages summary: Get a unified notify cascade delivery receipt description: >- Returns the aggregated delivery status of a `/notify` send: every hop (the primary binding plus any fan-out bindings or auto-escalated waterfall fallbacks) that shares this notify_id, an overall `status` (`delivered` once any hop reaches the recipient, `failed` once the cascade is exhausted with no delivery, or `in_progress` while a hop is still in flight or an escalation is still pending), the channel that ultimately delivered (if any), and the unified total price actually billed across every hop sent so far. parameters: - schema: type: string pattern: ^notify_[0-9a-f]{32}$ in: path name: notifyId required: true description: The notify_id returned by POST /notify - name: X-Test-Mode in: header required: false description: >- Sandbox opt-in for Clerk-session-authenticated requests. Set to `true` to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response `meta.test_mode: true`. **Ignored for live API keys (`dv_live_sk_*`)** — server-to-server clients must use a test-prefixed key (`dv_test_sk_*`) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header. schema: type: string enum: - 'true' - 'false' responses: '200': description: The aggregated cascade delivery receipt. content: application/json: schema: type: object description: The aggregated cascade delivery receipt. properties: data: type: object properties: notify_id: type: string status: type: string enum: - delivered - failed - in_progress description: >- Overall cascade outcome — delivered (any hop reached the recipient), failed (every channel exhausted with no delivery), or in_progress (still live). hop_count: type: integer description: Number of hops sent so far (primary + fallbacks). hops: type: array description: Every hop, oldest (primary) first. items: type: object properties: hop: type: integer message_id: type: string channel: type: string to: type: string status: type: string delivered: type: boolean price: type: - 'null' - number currency: type: - 'null' - string fallback_of: type: - 'null' - string description: >- The message_id this hop escalated from, or null for the primary hop. error_code: type: - 'null' - string error_message: type: - 'null' - string sent_at: type: - 'null' - string format: date-time delivered_at: type: - 'null' - string format: date-time failed_at: type: - 'null' - string format: date-time created_at: type: - 'null' - string format: date-time delivered_channel: type: - 'null' - string description: The channel that delivered, or null if none has (yet). delivered_at: type: - 'null' - string format: date-time cost: type: object description: >- Unified price — the sum of every hop's actually-billed cost. properties: total: type: - 'null' - number currency: type: - 'null' - string truncated: type: boolean description: >- True when the cascade exceeded the server-side hop ceiling and the receipt was cut off at that limit; hop_count then reflects the ceiling, not the true total. meta: type: object properties: request_id: type: string description: >- Unique request identifier (also returned in X-Request-Id header) timestamp: type: string format: date-time description: ISO 8601 UTC timestamp of the response '400': $ref: '#/components/responses/StandardError' '401': $ref: '#/components/responses/StandardError' '403': $ref: '#/components/responses/StandardError' '404': description: No notify cascade exists for this notify_id in the caller's tenant. content: application/json: schema: type: object description: >- No notify cascade exists for this notify_id in the caller's tenant. properties: error: type: object properties: code: type: string enum: - NOTIFY_NOT_FOUND message: type: string status: type: integer enum: - 404 meta: type: object properties: request_id: type: string description: >- Unique request identifier (also returned in X-Request-Id header) timestamp: type: string format: date-time description: ISO 8601 UTC timestamp of the response '422': $ref: '#/components/responses/StandardError' '429': $ref: '#/components/responses/RateLimitedResponse' '500': $ref: '#/components/responses/StandardError' components: responses: StandardError: description: >- Standard error envelope. `error.code` is machine-readable; see the [error reference](https://docs.orbit.devotel.io/reference/error-codes) for the catalogue. content: application/json: schema: type: object properties: error: type: object required: - code - message - status properties: code: type: string description: Machine-readable error code (e.g. INVALID_PHONE_NUMBER) message: type: string description: Human-readable error description status: type: integer description: HTTP status code details: type: object additionalProperties: true description: Additional context about the error meta: type: object properties: request_id: type: string timestamp: type: string format: date-time docs_url: type: string format: uri description: Link to relevant error documentation RateLimitedResponse: description: >- Rate limit exceeded. Wait `error.retry_after` seconds (or read the `Retry-After` header) before retrying. Returned when the request would exceed the bucket identified by `X-RateLimit-Bucket`. headers: X-RateLimit-Limit: description: Total request quota for the current window. schema: type: integer minimum: 0 X-RateLimit-Remaining: description: Requests remaining in the current window. schema: type: integer minimum: 0 X-RateLimit-Reset: description: >- Absolute unix-epoch-seconds timestamp at which the current window resets. schema: type: integer minimum: 0 X-RateLimit-Bucket: description: >- Name of the rate-limit bucket the request was bound by (e.g. `auth-write`, `money`, `agent-invoke`, or `custom:/`). Stripe-style — lets clients see which named cap they hit. schema: type: string RateLimit-Limit: description: >- draft-ietf-httpapi-ratelimit-headers no-prefix mirror of `X-RateLimit-Limit`. Some SDKs read only this form. schema: type: integer minimum: 0 RateLimit-Remaining: description: >- draft-ietf-httpapi-ratelimit-headers no-prefix mirror of `X-RateLimit-Remaining`. schema: type: integer minimum: 0 RateLimit-Reset: description: >- draft-ietf-httpapi-ratelimit-headers no-prefix mirror — delta seconds from now until the window resets (NOT epoch). schema: type: integer minimum: 0 Retry-After: description: >- RFC 7231 §7.1.3 — number of seconds the client should wait before retrying. schema: type: integer minimum: 1 content: application/json: schema: type: object properties: error: type: object required: - code - message - status - retry_after properties: code: type: string enum: - RATE_LIMITED description: >- Always `RATE_LIMITED` — the global request-limiter 429. Distinct from `RATE_LIMIT_EXCEEDED`, the live per-recipient/per-tenant/per-resource frequency-cap 429 (not retired). message: type: string status: type: integer enum: - 429 retry_after: type: integer minimum: 1 description: >- Seconds to wait before retrying. Mirrors `Retry-After` header. meta: type: object properties: request_id: type: string timestamp: type: string format: date-time docs_url: type: string format: uri securitySchemes: Bearer: type: http scheme: bearer bearerFormat: JWT description: Dashboard JWT token from Clerk ApiKey: type: apiKey name: X-API-Key in: header description: Server-to-server API key (dv_live_sk_*) ````