Documentation

Seshnova Partner API

Version 0.1.5 · Download OpenAPI YAML

Partner-facing contract for the Seshnova API Gateway REST API.

The public surface is the API Gateway/Lambda facade exposed to partners. All operations are JSON POST endpoints on the deployed API Gateway stage.

Post-call HTTPS callbacks and Flow Blocks delivery features are outside this Gateway contract. Contact Seshnova if you need those integration patterns.

Environment-specific connection details are issued during partner onboarding (not published on the public docs host).

Connection details

API hostname, AWS region, Cognito app client ID, and credentials are issued per partner during onboarding. They are not published on this public reference.

Public contract base URL for documentation: https://api.seshnova.com

Balance

Balance read/write operations.

Usage

Read-only usage and billed call history.

Accounts

Account lifecycle and caller ID management.

Calls

Call setup operations.

Operations

POST /call_history

Recent billed call history for an account

Returns up to 10 most recent billed calls for the account within the last 30 days (UTC). Each row exposes called_number, duration_seconds, and amount_charged. Tenant is always taken from the JWT; product_id and currency in the JSON body take precedence over Cognito claims when present. Send currency explicitly when it is not on the token. Empty history returns 200 with an empty calls array.

Tags: Usage

POST /change_cli

Change account caller ID

Updates the account external_user_id, also referred to as CLI or caller id. Clients may send either external_user_id or cli. If both are sent, they must match.

Tags: Accounts

POST /create_account

Create account

Creates a prepaid account for the authenticated tenant. This operation is idempotent by tenant, operation, and Idempotency-Key.

Tags: Accounts

POST /debit_balance

Debit monetary balance

Debits credit from an existing account. This operation is idempotent by tenant, operation, and Idempotency-Key.

Tags: Balance

POST /delete_account

Deactivate account

Soft-deletes or deactivates an account. This does not hard-delete account rows. Idempotent by tenant, operation, and Idempotency-Key.

Tags: Accounts

POST /get_balance

Get account balance

Returns the current monetary balance for a 12-digit account code. Tenant, product, and currency context are derived from the authenticated partner credential and authorizer claims.

Tags: Balance

POST /setup_call

Store number translation for a call

Stores a short-lived number translation for the calling path. The default partner contract is Cognito authorization plus Lambda partner RBAC. An API Gateway key gate is not part of the default partner contract.

Tags: Calls

POST /topup

Add monetary balance

Adds credit to an existing account. This operation is idempotent by tenant, operation, and Idempotency-Key.

Tags: Balance

Interactive reference

Schema explorer (requires JavaScript). Styled to match the Seshnova marketing site.