Getting Message Statuses

To request the current message status for a successfully submitted message simply pass the messageId returned from the send to this web service as detailed above.

The returned data on a successful call will be structured as follows:

Property

Type

Description

messageId

string

Unique id for this message

conversationId

string

Optional conversationId, used to correlate messages within COMAPI and on any external channels, if supported

to

object

Set of identifiers for the message recipient

title

string

The title to use to describe the message (if supported by the channel and specified in the request)

body

string

This is the text based body if specified

channelOptions

object

Configuration switches for specific channels if specified in the request

customBody

object

The custom body object if specified in the original request

metadata

object

The meta data passed with the send request if specified

sentOn

string

Date/Time (in UTC, ISO 8601 format) that the message sent was accepted

status

string

One of:

  • processing
  • sent
  • delivered
  • read
  • expired
  • failed

statusDetails

object

Specific details related to the current status.

expiresOn

string

Date/Time (in UTC, ISO 8601 format) that the should expire (if supported by the selected channel)

ruleSet

string

The rule set name if specified

rules

string[]

The channels to attempt for this message, in order of priority if specified in the original request

_createdOn

string

Date/Time (in UTC, ISO 8601 format) that the message was created

_createdBy

string

The profile id that created the message

_updatedOn

string

Date/Time (in UTC, ISO 8601 format) that the message was last updated

_updatedBy

string

The profile id that last updated the message

👍

Full API specification

Please see the full API specification for further details about getting statuses with the "One" API

Language
Authentication
Header
Response
Click Try It! to start a request and see the response here!