Get information

The return of this API tells you information such as the notification mode, capacities (e.g. how many calls could be made at the present time), stored items and so forth.

JSON sample

    "version": "latest",
    "apiKey": "abcdefghijklmnopqrstuvwxyz",
    "options": {
        "getStoredContentInfo": true,
        "getCapacityInfo": true,
        "getScheduledAlertInfo": true

Getting information

Parameter  RequirementDefaultDescription
versionMandatoryNoneSee API guide
apiKeyMandatoryNoneSee API guide
getCapacityInfoOptionalfalseIf true then capacity info is also returned
getStoredContentInfoOptionalfalseIf true then the set of stored content is also returned
getScheduledAlertInfoOptionalfalseIf true then pending schedule info is also returned


Parameter  Description
successOne of “true”, “false”. If false then failureReason should also be returned
apiKeyApi key
defaultNotificationNotification mode (polled or callback)
defaultNotificationFormatNotification format json or form
defaultCallbackUrlOnly returned if defaultNotification = callback
sandboxedtrue|false - denotes whether the API key is sandboxed or not. See API guide
capacitiesOnly returned if getCapacityInfo = true on request. Values indicate the maximum number of items that could be sent at this time.
storedArray, only returned if getStoredContentInfo = true on request
storeIdStore unique id
typeOne of "call","sms", "email","inboundCall","recipientList" or "alert"
scheduledArray, only returned if getScheduledAlertInfo = true on request
scheduledAlertIdThe unique reference for the scheduled alert.
storedAlertIdThe content store unique reference for the scheduled alert
pausedWhether the schedule is currently paused or not
nextRunAtWhen the schedule is next due to run (if it is paused this will not occur)
expiresWhen the schedule is due to run out
repeatsHow often the schedule will repeat