SMS Broadcast System - API Documentation

App Command (API Call)
POST your request to https://api.aiappsapi.com with your API key and account ID in the POST body. The fields described in each section below go inside the jsonData POST field as a JSON-encoded string. Use this method when your server is making the call and you have your API credentials available.

Mode / Webhook (Direct URL)
POST directly to the endpoint URL shown in each section. The fields go in the POST body as standard form fields (the same fields you would include in an HTML form POST). Use this method for provider webhooks, website forms, or any third-party system that sends form data. No API key is required - the account ID is part of the URL.

Each supported provider gets a dedicated webhook URL. Enter this URL in your provider account wherever it asks for a delivery status callback URL, an incoming message URL, or both. If the provider has separate fields for each type, use the same URL in all of them.

Adds a new subscriber record to your list. This is the primary way to get contacts into the system - from a web form, a data feed partner, or any lead source. Records are stored with full profile information and organized by carrier group for routing.

Removes a phone number from your active subscriber list and adds it to your suppression file. Once suppressed, that number will not receive any future broadcasts regardless of how it was added. Incoming STOP and END replies are handled automatically by the system, but you can also trigger an unsubscribe manually using this endpoint.

Sends an individual SMS message to one phone number immediately. The sending number you specify must already be configured in your account with a valid provider and API key. This endpoint is for on-demand single sends - for sending to a list, use the broadcast scheduling features in the dashboard.

Enrolls a phone number into an automated responder series. Once enrolled, the contact receives a sequence of messages at scheduled intervals, as configured in the series settings in your dashboard. A responder series is different from a broadcast - each subscriber gets their own independent schedule starting from when they enrolled.

Stops a phone number from receiving further messages in a responder series. You can remove a subscriber from one specific series or from all series at once. This does not add the number to your global suppression list - it only affects the responder schedule. To fully suppress a number from all sends, also call the unsubscribe endpoint.