Create Free API Account

Campaigns

Get Campaign

get
Authorizations
Path parameters
campaignIdstringRequired
Responses
200

Success

application/json
Responseall of
get
GET /v3/campaigns/{campaignId} HTTP/1.1
Host: api.mobile-text-alerts.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "error": "text",
  "message": "text",
  "data": {
    "id": 1,
    "name": "text",
    "description": "text",
    "lastMessageActivity": "2025-10-14T03:23:27.708Z",
    "deliveredCount": 1,
    "unsubscribeCount": 1,
    "responseCount": 1,
    "clickCount": 1,
    "clickRate": 1,
    "conversionCount": 1,
    "conversionRevenue": 1
  }
}

List Campaigns

get
Authorizations
Query parameters
pagenumberOptional
pageSizenumberOptional
sortBystringOptional
sortDirectionstring · enumOptionalPossible values:
querystringOptional
Responses
200

Success

application/json
Responseall of
get
GET /v3/campaigns HTTP/1.1
Host: api.mobile-text-alerts.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "error": "text",
  "message": "text",
  "data": {
    "rows": [
      {
        "id": 1,
        "name": "text",
        "description": "text",
        "lastMessageActivity": "2025-10-14T03:23:27.708Z",
        "deliveredCount": 1,
        "unsubscribeCount": 1,
        "responseCount": 1,
        "clickCount": 1,
        "clickRate": 1,
        "conversionCount": 1,
        "conversionRevenue": 1
      }
    ],
    "page": 1,
    "pageSize": 1,
    "total": 1
  }
}

Get Campaign Analytics

get
Authorizations
Path parameters
campaignIdstringRequired
Query parameters
startDatestringRequired
endDatestringRequired
intervalstring · enumRequiredPossible values:
Responses
200

Success

application/json
Responseall of
get
GET /v3/campaigns/{campaignId}/analytics?startDate=text&endDate=text&interval=days HTTP/1.1
Host: api.mobile-text-alerts.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "error": "text",
  "message": "text",
  "data": {
    "id": 1,
    "name": "text",
    "description": "text",
    "isArchived": true,
    "linkRecipientCount": 1,
    "timespanAnalytics": [
      {
        "ANY_ADDITIONAL_PROPERTY": {
          "deliveredCount": 1,
          "clickCount": 1,
          "spend": 1,
          "replyCount": 1,
          "unsubscribeCount": 1,
          "creditCount": 1,
          "conversionCount": 1
        }
      }
    ]
  }
}

List Campaign Options

get
Authorizations
Query parameters
pagenumberOptional
pageSizenumberOptional
sortBystringOptional
sortDirectionstring · enumOptionalPossible values:
querystringOptional
Responses
200

Success

application/json
Responseall of
get
GET /v3/campaigns/options HTTP/1.1
Host: api.mobile-text-alerts.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "error": "text",
  "message": "text",
  "data": {
    "rows": [
      {
        "id": 1,
        "name": "text"
      }
    ],
    "page": 1,
    "pageSize": 1,
    "total": 1
  }
}

List Campaign Messages

get
Authorizations
Path parameters
campaignIdstringRequired
Query parameters
pagenumberOptional
pageSizenumberOptional
sortBystringOptional
sortDirectionstring · enumOptionalPossible values:
querystringOptional
Responses
200

Success

application/json
Responseall of
get
GET /v3/campaigns/{campaignId}/messages HTTP/1.1
Host: api.mobile-text-alerts.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "error": "text",
  "message": "text",
  "data": {
    "rows": [
      {
        "id": 1,
        "isMMS": true,
        "message": "text",
        "createdAt": "text",
        "recipientCount": 1,
        "processedCount": 1,
        "emailRecipientCount": 1,
        "deliveredCount": 1,
        "unsubscribeCount": 1,
        "responseCount": 1,
        "clickCount": 1,
        "clickRate": 1,
        "conversionCount": 1
      }
    ],
    "page": 1,
    "pageSize": 1,
    "total": 1
  }
}
PreviousAutomated RepliesNextChatbots

Last updated

Was this helpful?