Get information

https://api.alert.alertinghub.co.uk/api/json/getinfo

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
    }
}

{

Back to API guide

Getting information

Parameter		Requirement	Default	Description
version		Mandatory	None	See API guide
apiKey		Mandatory	None	See API guide
options
	getCapacityInfo	Optional	false	If true then capacity info is also returned
	getStoredContentInfo	Optional	false	If true then the set of stored content is also returned
	getScheduledAlertInfo	Optional	false	If true then pending schedule info is also returned

Response

Parameter			Description
success			One of “true”, “false”. If false then failureReason should also be returned
info
	apiKey		Api key
	defaultNotification		Notification mode (polled or callback)
	defaultNotificationFormat		Notification format json or form
	defaultCallbackUrl		Only returned if defaultNotification = callback
	sandboxed		true\|false - denotes whether the API key is sandboxed or not. See API guide
	capacities		Only returned if getCapacityInfo = true on request. Values indicate the maximum number of items that could be sent at this time.
		call
		email
		sms
	stored		Array, only returned if getStoredContentInfo = true on request
		storeId	Store unique id
		type	One of "call","sms", "email","inboundCall","recipientList" or "alert"
		expiresUnlessUsed	Expiry
	scheduled		Array, only returned if getScheduledAlertInfo = true on request
		scheduledAlertId	The unique reference for the scheduled alert.
		storedAlertId	The content store unique reference for the scheduled alert
		paused	Whether the schedule is currently paused or not
		nextRunAt	When the schedule is next due to run (if it is paused this will not occur)
		expires	When the schedule is due to run out
		repeats	How often the schedule will repeat

Back to API guide