Reporting

List campaigns by status

A few historical rows carry the legacy status misspelling 'canceled' (one l); it is not in the filter whitelist, so those rows appear unfiltered but cannot be filtered for

get/get-campaigns/

Request

  • Base URL: http://api.smsfusion.com.au
  • URL: http://api.smsfusion.com.au/get-campaigns/
  • Auth: one of:
    • API key in query parameter key
    • HTTP basic

Query parameters

keystring required

API Key as generated from the <a href='https://www.smsfusion.com.au/admin/api/'>admin panel</a>

status'pending' | 'review' | 'sent' | 'cancelled' | 'draft' | 'sending' | 'low balance'

One of pending, review, sent, cancelled, draft, sending, low balance (contains a literal space - URL-encode it)

limitinteger

Default 50, max 200

offsetinteger

Row offset for paging, default 0

Response

Successfull response

idinteger
createdinteger
scheduledinteger
statusstring

pending, review, sent, cancelled, draft, sending, or low balance (historical rows may carry the legacy misspelling canceled)

campaignNamestring
listinteger
sourcestring
segmentsinteger
intervalinteger
validityinteger
messagesstring[]
addSubscribeTointeger
addIncomingTointeger
addUnsubTointeger
addClicksTointeger
supressionListsinteger[]

Changes

No recorded changes to this operation across all 1 revision of this API.