The daily Message Extract is used to sync message data between the Vibes platform and your Customer Relationship Management (CRM) or Campaign Management system.

Standard File Name

The following is the recommended best practice for file names. File naming conventions may be changed upon request.

messages_<company_key>_<date>.<extension>

How to Read Files

Extract files will be delivered in tab-separated value (TSV) text files. The information is separated into rows and columns. Column data will be separated by tabs, while each new row will be separated by a hard return.

The message field is quoted with double quotes. Any double quotes within the message body will be escaped with two double quotes.

File Body

The file body may contain any the following fields as data, separated by the delimiter and a header row.

Field Name	Data Type	Field Length	Allows Nulls	Description
person_id	String	255	No	Unique Vibes-specified GUID representing the person. Note that while the field is labeled person_id, the value is the `person_key`.
external_person_id	String	255	Yes	External system's person identifier to include in the subscription list.
mdn	String	20	No	Mobile phone number added to the subscription list. The MDN must be in E.164 format. Example: +12295551234.
carrier_code	String	50	Yes	The carrier code indicates a specific carrier. See Appendix - Carrier Codes for all valid carriers, and note that new carriers are added frequently.
message_id	String	255	No	Unique message ID defined by Vibes.
client_message_id	String	255	Yes	Message ID defined by the customer.
timestamp	Date/Time	N/A	No	The date/time when the message was generated on our platform or received from the carrier. Format example: "2017-04-15 14:30:00 -0600".
message_status	String	255	No	SUCCESS means the message was successful. FAILURE values are: Premium Product Not Found Premium Preprocess Config Error Negative Premium Charge Not Within Delivery Window Invalid Delivery Window Param Message Stopped manually or with a tool Route Not Found Mdn on blocked list Not all parts of a MultiPart Message was received Rejected message from ART Capped Message Multipart message waiting for more parts Duplicate part to a Multipart message Subscription not found Shortcode Lease not found
message_type	String	2	Yes	Indicates whether the message was sent or received. Mobile Originated (MO) is sent from the device to the short code. Mobile Terminated (MT) is sent from the short code to the device.
response_code	String	Integer	Yes	A numeric code indicating whether the message was successfully sent to the carrier or not. Value of 0 is success, all other codes are failure. For detailed list of error values, see: Error Code Responses
activity_type	String	255	No	Type of campaign or activity the message is associated with. See here for a list of activity types.
activity_id	String	255	Yes	ID of the activity the message is associated with.
company_id	String	255	No	ID representing the customer account at Vibes.
shortcode	String	255	No	The short code that a message was sent to/from.
message	String	1000	Yes	Message body - optional because message can be blank.

Example File

Download an example file.