API Changelog
API Changelog
Section titled “API Changelog”Every change to the SIPSTACK API is recorded here, newest first. Entries are dated with the API’s version scheme (YYYY-MM-DD). Deprecations list the replacement and the cool-down window during which the old and new surfaces run concurrently — see Versioning → Deprecation Policy.
2026-09-XX
Section titled “2026-09-XX”SMS send limits on the messaging API, and one delivery-rate definition for Flare campaigns.
delivery_statson Flare campaign list rows anddeliveryStatson the campaign detail —attempted,delivered,failed,undelivered,failed_total,awaiting,no_receipt,delivery_rate,failure_rateandprovisional(camelCase on the detail). The delivery rate is delivered ÷ attempted, where attempted = delivered + failed + undelivered + messages still waiting for a carrier receipt; queued and cancelled messages are not counted.awaitingis messages sent within the last 72 hours without a receipt (the rate isprovisionalwhile it is above 0);no_receiptis messages sent more than 72 hours ago that the carrier never confirmed. The existingmessages_sent/messages_delivered/messages_failed/message_countfields are unchanged. Computing a rate asmessages_delivered / messages_sentignores failures — usedelivery_rateinstead.- Campaign analytics adds
attempted,awaiting,noReceiptandprovisional.
Changed
Section titled “Changed”-
Campaign analytics
deliveryRateandfailureRatenow use the same definition asdelivery_stats, so they match the campaign list and detail. -
POST /api/v2/messages/sendreturns a specific status andcodewhen a plan SMS limit refuses a send, instead of a generic500:429PAID_LIMIT_REACHED(withreasonand aRetry-Afterheader),429TRIAL_LIMIT_REACHED,403CARD_NOT_VERIFIED,402CAPABILITY_RESTRICTED_BY_STATE, and503when a limit can’t be checked. See Rate Limits → Plan Message Limits. -
Segments are counted with the GSM-7 character set. Accented letters in that set (for example é, ñ, ü) no longer switch a message to 70-character Unicode segments, and
€ ^ { } [ ] ~ \ |each count as two characters. See how segments are counted.
2026-06-10
Section titled “2026-06-10”The baseline public API reference, grouped by product.
- Public API Reference, organized by product — the Developer API documented across Nova (voice / calls, numbers, extensions, voicemails, recordings, transcriptions), Flare (SMS/MMS send and history, contacts, campaigns, contact lists), and Aura (AI voice-agent calls, agents, knowledge bases), plus account-level Numbers, API keys, and Webhooks.
- API-key authentication (
x-api-key) with per-key scopes — see Authentication and API Keys. - Pagination contract across list endpoints — offset paging (
page/limit/total/totalPages) everywhere, plus keyset paging (next_cursor) on the high-volume history endpoints. See Pagination. - Webhooks for real-time event delivery, with signed payloads and a subscribable event catalog. See Webhooks.
- Rate limits with standard
RateLimit-*response headers. See Rate Limits.
Spot something missing or want an endpoint that isn’t here yet? Tell support — demand drives what gets added.