Data dictionary

Inbound Messages

account_id

The internal ID number of the account this message is associated with.

body

The content of the message.

created

The time this participant was added to the program (in UTC).

customer_id

The external ID value of the participant that sent the message (you set this when you create the participant).

flagged

Has this message been flagged on the platform.

groups

The group(s) the participant that sent this message belongs to.

handled

Shows whether an associated handler recognized this response and sent out an automated response.

handler

Shows the message’s associated handler. Handlers look for pre-programmed responses and trigger automated follow ups.

interval

The time interval (in seconds) between when this message came in and a response went out to this participant.

last_template_time

The last time this participant was sent a Program Message.

media

If media was attached to the message the AWS link to that media will appear here.

next_template_time

The next time this participant is scheduled to receive a Program Message.

participant_active

Is the participant active or inactive (opted-out) in this program.

participant_id

The internal Message ID for this participant (automatically assigned when they are created on Message).

participant_name

The name of the participant.

participant_phone

The phone number of the participant.

program_id

The id associated with the program that this message came in to.

program_name

The name of the program that this message came in to.

signal

Relates to the Signal Strength color of this message on the platform. Determines whether it will appear as red, green, or gray.

time

The time this message sent or was received (in the program’s time zone).

valid_responses

The responses that could trigger the handler associated with this message, if there was one.

 

Outbound Messages

account_id

The internal ID number of the account this message is associated with.

body

The content of the message.

created

The time this participant was added to the program (in UTC).

customer_id

The external ID value of the participant that received the message (you set this when you create the participant).

groups

The group(s) the participant that was sent this message belongs to.

interval

The time interval (in seconds) between when this message went out and the participant responded.

media

If media was attached to the message the AWS link to that media will appear here.

participant_id

The internal Message ID for this participant (automatically assigned when they are created on Message).

participant_name

The name of the participant.

participant_phone

The phone number of the participant.

program_id

The id associated with the program that sent out this message.

program_name

The name of the program that sent this message.

sent_by

What user sent this message. If it was an automated (program) message, the program name will appear here.

template_id

The internal name given to this message – will vary based on Type.

• Program: Internal ID set by customer and Message, can be found on message template
• Quick: Automatically assigned when message is created, always starts with “qm”
• Adhoc: Is not assigned a template_id

type

The type of the message. Message has three major message types:

• Program: These messages are programmed in by our engineers. They contain Message’s more advanced features such as automated responses, saved responses, and event triggering. Automated response messages are also classified as Program messages.
• Quick: Quick Messages are messages sent out through our Quick Message tool. Users can send and schedule Quick Messages entirely through the platform and send them out to an entire program, or a group within that program.
• Adhoc: These are 1-to-1 messages sent directly from the participant’s profile.

time

The time this message sent or was received (in the program’s time zone).