Skip to Content
Bulk & Campaign Messaging

Submit asynchronous bulk SMS job

View Markdown (.md)
POST
/api/v1/public/sms/bulk/jobs

Submits a bulk campaign for asynchronous processing. Recipients can be supplied as an inline array of phone numbers or pre-uploaded via file. Unit credits are reserved upfront and unconsumed units are refunded if cancelled prior to dispatch.

Authorization

headerX-Api-Key<token>

SMS Pro API Key (sk_live_... or sk_test_...)

Request Body

application/json
  1. body
jobName?string
message*string
senderId?string
Lengthlength <= 11
recipients?array<string>
fileId?string

Pre-uploaded CSV or Excel file ID

Formatuuid
scheduledAt?string
Formatdate-time
deliveryCallbackUrl?string
Formaturi

Response Body

Bulk job queued for asynchronous dispatch

application/json
  1. response
status?string
message?string
data?
Example Request
curl -X POST 'https://api.smspro.com/api/v1/public/sms/bulk/jobs' \  -H 'Content-Type: application/json' \  -d '{  "message": "string"}'
Example Response
{  "status": "string",  "message": "string",  "data": {    "batchId": "string",    "jobName": "string",    "recipientCount": 0,    "status": "string",    "totalUnits": 0  }}