Key Takeaways
- API how-to document runbooks means on-call can send, pause, and fail over without guessing live field names.
- Do not rewrite the Android-app runbook how-to; that is device ops. This is the HTTPS/JSON path.
- Developer Center owns parameters. The runbook owns who, when, and rollback.
- Include device offline, allowance pause (Free/Developer), and operator voucher as first-class failures.
- A runbook without a last-drilled date is fiction.
- You bring the phone and operator credit. The doc must say that out loud.
Runbooks for the API path
API how to document runbooks is the on-call packet for sending SMS through the Android gateway: auth, idempotency, who pauses bulk, what “device offline” means, and where live fields actually live. It is not a second API reference and not a novel about the product pillar.
API hub: Android SMS gateway API. Parameters: Developer Center. HTTPS samples: PHP / C# — not a packaged SDK.
“If the wiki says ‘call the API’ and the phone is in a drawer, you documented a wish.”
App runbooks are a different spoke
Pairing, OEM, and charging live on how to document runbooks (app). Link it. Do not paste it. API on-call still needs a one-liner: “pick up the phone first.”
Pages a send runbook must name
| Failure | Runbook must point to | Owner |
|---|---|---|
| 4xx/5xx from API | Developer Center + your idempotency key | Backend |
| Device offline | Device offline KB | Whoever can touch the handset |
| Missing DLR | Webhook practices | Backend |
| Free/Developer pause | Pricing (300 lifetime / 25,000 year) | Billing + on-call |
| Empty voucher | Operator / USSD — not a ticket to us for airtime | SIM owner |
Owners, not a wiki ghost
Name a human for keys, phones, and top-ups. Rotate keys after contractors. Setup. OTP vs bulk isolation must be in the same doc or they will share a SIM at 02:00.
Drill the doc
Quarterly: kill pairing, follow the runbook, time OTP canary. Update the date. External incident shape: Google SRE: managing incidents.
Cost
Drills spend operator credit and platform volume. Budget them. Starter/Pro/Business uncap platform volume with device caps; they do not fund the SIM. Pricing.
Checklist
- Links to Developer Center, not pasted JSON.
- App runbook linked, not duplicated.
- Owners with backups.
- Last drill date.
- Pause vs voucher vs Doze distinguished.
Next steps
API hub, app runbooks, Android app.
Related product pages
Jump to the live product docs for this topic—not another long-form article.
- SMS API documentationLive endpoint reference
- device and SMS volume pricingPlans and allowances
- Android SMS gateway product guideDefinition, product, and how to buy
- download the Android gateway appGet the APK
