Skip to end of metadata
Go to start of metadata

fLast Updated: Thursday, July 2, 2020



The daily Message extract is used to sync message data between Vibes Mobile Engagement Platform and a Customer Relationship Management (CRM) or Campaign Management system. 

File Name

messagesYYYY-MM-DD.txt

Tab Delimited Files

Tab delimited files are standard Comma-Separated Value (CSV) text files. Each of the various columns is separated by a tab.

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 can contain the following fields as data, separated by the delimiter and a header row.

Field Name

Data Type

Field LengthAllows Nulls

Description

person_id

String

255

Unique Vibes-specified GUID representing the Person.

external_person_id

String

255✔︎

External system's Person identifier to include in the Subscription List.

mdn

String

20

Mobile phone number added to the Subscription List. The Mobile Directory Number (MDN) must be in E.164 format. Example: +12295551234.

carrier_codeString50✔︎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

Unique message ID defined by Vibes.

client_message_id

String

255✔︎

Message ID defined by the customer.

timestampDate/TimeN/A
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_statusString255

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_typeString2✔︎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_codeStringInteger✔︎

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_typeString255

Type of activity the message is associated with.

See 38535887 for a list of activity types.

activity_idString255✔︎ID of the activity the message is associated with.
company_idString255
ID representing the customer account at Vibes.
shortcodeString255
The short code that a message was sent to/from.
messageString1000✔︎Message body - optional because message can be blank.

List of Activity Types


ACQUISITIONalertsendBroadcast
Campaigns::SiteCampaigns::Walletchat
ContestDateTriggeredBroadcastdefault
EventTriggeredMessageFileAlertSenderhelp
INCENTIVEInfoLast played
MessageApiv2MessageApiv3MSG
NONEonscreenOSP_CAMPAIGN
ProvisionedKeywordRecipientListTriggeredBroadcastRequest
SmscstopSUB
TriviaUNKNOWNVote
WebApi



Example File

 


  • No labels