1. Reference
  2. API reference

​
Build against the canonical contract

The WhooshBang OpenAPI 3.1 contract is the same generated bundle that the service, JavaScript SDK, fixtures, and contract mock validate in CI. After the organization contract batch is published, download it to generate a client, load the API into an HTTP tool, or inspect every schema and response.

The production base URL is https://api.whooshbang.com. The core integration journey uses these operations:

  • GET /v1/capabilities discovers the currently supported provider features.
  • POST /v1/subscription-links creates a one-time Telegram consent link.
  • GET /v1/subscription-links/{subscription_link_id} reads activation state.
  • POST /v1/messages accepts a durable notification or interaction.
  • GET /v1/messages/{message_id} reads delivery progress.
  • POST /v1/messages/{message_id}/cancel requests cancellation.
  • GET /v1/interactions/{interaction_id} reads a human answer or terminal outcome.

Start with the quickstart for complete runnable requests and the integration reference for retries, failure handling, and the meaning of each delivery state.