Contacts

List and search contacts

Cursor-paged contact listing. sort=desc reverses display order only; the since_id cursor always pages forward

get/get-contacts/

Request

  • Base URL: http://api.smsfusion.com.au
  • URL: http://api.smsfusion.com.au/get-contacts/
  • 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>

since_idinteger

Forward cursor - return rows with id greater than this. Always pages forward regardless of sort

listidinteger
msisdnstring

Exact digit match; searches across lists unless listid is also given

limitinteger

Default 100, max 500

sort'asc' | 'desc'

desc = newest-first display order (default asc). Display order only - the cursor still pages forward

Response

Successfull response

idinteger
listidinteger
createdinteger

Unix timestamp

msisdnstring
countrystring
dataobject

The contact's field values. Always a JSON object, {} when empty

unsubboolean
lastclickinteger
lastsendinteger

Example response

[
  {
    "msisdn": "61412345678",
    "country": "AU"
  }
]

Changes

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