Skip to main content
POST
/
v1
/
messaging
/
sms
/
campaigns
Create an SMS campaign
curl --request POST \
  --url http://localhost:2222/v1/messaging/sms/campaigns \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "src": "<string>",
  "dests": [
    "<string>"
  ],
  "message": "<string>",
  "priority": "<string>",
  "callbackUrl": "<string>"
}
'
{
  "success": true,
  "message": "<string>",
  "data": {
    "status": "<string>",
    "timestamp": "<string>",
    "campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workspaceId": 123,
    "src": "<string>",
    "encoding": "<string>",
    "segments": 123,
    "unitsPerMessage": 123,
    "recipients": 123,
    "totalUnits": 123,
    "totalCost": 123,
    "priority": "<string>",
    "messages": [
      {
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dest": "<string>"
      }
    ]
  }
}

Body

application/json
name
string
required
Maximum string length: 64
src
string
required
Maximum string length: 16
dests
string[]
required
Maximum array length: 1000
Maximum string length: 32
Pattern: ^(?:\+?[1-9]\d{7,14}|0\d{9})$
message
string
required
Maximum string length: 2000
priority
string
Pattern: (?i)normal|medium|high
callbackUrl
string
Maximum string length: 512

Response

OK

success
boolean
message
string
data
object