Description
Gets the status of all messages. The messages that are retrieved can be filtered via the parameters.
Parameters
| Name | Type | Description |
|---|---|---|
| templateType | String, optional | Retrieves all messages that use a template type |
| status | String, optional | Retrieves all messages with that have that status. You can filter by "sending", "delivered", "failed", "permanent-failure", "temporary-failure" and "technical-failure" |
| reference | String, optional | Retrieves all messages with a given reference |
| olderThan | String, optional | The ID of a message. Retrieves all messages that are older than the message ID provided |
| apiKeyName | String, optional | Specify the name of the API key you want to use. Names and keys are defined in the worker configuration. If not supplied the default will be used |
Example Request
function(params, credentials) {
let result = this.callWorkerMethod("govnotify", "messageStatus", {
"templateType": "sms",
"status": "delivered",
"reference": "Reference"
});
return result;
}
Last modified on 1 August 2023
Share this page
