Getting Started
How to Use These Docs
Choose the right FutureSMS docs page for the integration task in front of you.
Use the left navigation to move between documentation areas. Use search when you know the object, status, error, or endpoint name you need.
Recommended path
- Start with API Conventions to understand authentication, response shape, pagination, time values, and idempotency.
- Move to Messaging Workflows when you are implementing a concrete SMS task such as sending, tracking, bulk execution, or delivery reports.
- Use Integrations when a third-party product, such as Yeastar P-Series, calls FutureSMS through its own integration contract.
- Use Reference when you need shared field meanings, status values, live OpenAPI resources, or SDK links.
Page structure
Workflow pages use a consistent shape so you can scan them quickly:
| Section | What it tells you |
|---|---|
Overview | When to use this workflow. |
Endpoint or Endpoints | The API route or callback route involved. |
Before You Begin | Required account, credential, sender, template, file, or callback setup. |
Request fields | Fields you send for this workflow. |
Response fields | Fields you should read from the response. |
Behavior | Processing order, state changes, async behavior, and retry expectations. |
Status codes | Scenario-specific success and failure meanings. |
Examples | JSON examples for the main request and response shapes. |
How examples are written
Examples use JSON so request and response shapes stay focused on data. The docs avoid language-specific snippets inside business pages.
Live API resources
The OpenAPI and SDK page links to OpenAPI Docs, OpenAPI ReDoc, the OpenAPI JSON document, and SDK artifacts. Treat the live OpenAPI schema as the precise contract when implementation details matter.
These written pages are meant to explain process, intent, and integration behavior in plain language. They should complement the OpenAPI contract, not duplicate every schema field from it.