Open a network-initiated (push) USSD session
Programmatically opens a USSD session on a subscriber’s handset via the configured aggregator — for balance prompts, mobile-money confirmations and feature-phone OTP flows. action: CON keeps the session open for a reply; END shows a one-shot notice. Requires a push provider configured via PUT /ussd/push/config.
Authorizations
Dashboard JWT token from Clerk
Headers
Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.
1 - 255Sandbox 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.
true, false Body
Destination handset in E.164 (e.g. +234801234567).
First screen text (≤182 chars).
CON awaits a reply; END is one-shot. Defaults to CON.
CON, END Override the default service code.
Idempotency / correlation key echoed to the aggregator.