Store content API

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

The store content API allows you to upload either alerts, recipient lists or content data and store directly onto the system. Multiple content blocks can be included within a single transaction allowing you to upload a variety of pre-prepared items at the same time. All content stored using this API is held securely using high-grade encryption.

You can then use these stored items when sending alerts instead of specifying all the details in the API call.

Stored items generally have a ‘unused’ lifetime associated with them, which is automatically applied by Alerting Hub. If the content is not used within that time it will be deleted. You can override this automated setting but only if your API key has permission to do so (contact your account manager for details).

Json sample

{
    "version": "latest",
    "apiKey": "abcdefghijklmnopqrstuvwxyz",
    "content": [
        {
            "contentType": "sms",
            "tag": "t1",
            "storeDetails":  {
                "storeName": "myStoredSms"
            },
            "content": "This is an SMS 1",
            "contentEncoding": "utf8",
            "options": {
                "lifetime": "10d"
            }
        }
    ]
}

Store content for alerts

ParameterRequirementDefaultDescription
versionMandatoryNoneSee API guide
apiKeyMandatoryNoneSee API guide
contentMandatoryArray of items to be stored
  contentTypeMandatoryNoneThe type of content which is being stored. One of "call","sms", "email","inboundCall","recipientList", "alert", "contactGroup", "contactList" or "contactSetList"
  contentMandatoryActual content
  contentEncodingMandatoryEncoding of content, one of: "base64" | "utf8" | "json" (the latter only valid if contentType is 'alert' or 'contactGroup')
  tagMandatoryClient defined tag - freeform
  storeDetailsOptionalNoneOptional storage details, see API guide. If an existing store is found with the given details it is replaced with this new content. If the storeName element is specified the store is tagged with that name and can be referenced by it later.
If contentType is 'email'
  emailBodyIsMultipartOptionalFalseIf the body of the email message is multi-part
  emailBodyContentTypeOptionaltext/plain; charset=us-asciiUsed if emailBodyIsMultipart is false
  multipartBoundaryOptionalBlankIf emailBodyIsMultipart: true then this flag is used to denote start of a new mulitpart bounday
If contentType is 'call' or 'inboundCall'
  voiceFormatMandatoryNoneOne of "mp3","wav","aiff", "tts". The format of the audio which is encoded in the contentData. For 'tts' the contentData should decode to simple text.
  ttsOptionalNoneOptional tts block used if voiceFormat is 'tts'. See API guide
  options
    lifetimeOptionalLifetime of stored item if not used - only valid if client is permitted to set. Lifetime is specified as {n}{M|w|d|h|m|s} where M = months, w = weeks, d = days, h = hours and s = seconds. Values will be rounded up to the nearest day. A value of 0d will mean no expiration.

Response

ParameterDescription
successOne of “true”, “false”. If false then failureReason should also be returned
contentArray of stored items processed for deletion
  successOne of “true”, “false”. If false then failureReason should also be returned
  storeIdA unique identifier for the stored content
  storeNameIf you specified a storeName as part of the initiating /storecontent api call this will be reflected here.
  contentTypeType of content as per api call
  tagClient defined tag as per api call
  expirationInDaysThe stored data will be removed after 'n' days if not used