Skip to end of metadata
Go to start of metadata

Last Updated: Monday, January 7, 2019




The following Vibes Mobile Engagement Platform terminology is commonly used when working with the Platform APIs and Callbacks.


TermDescription
Acquisition APIsUsed to add or search for Participants and Get Acquisitions Campaigns.
Acquisition CampaignAn Acquisition Campaign defines a keyword or keywords, and/or API methods that you can use to opt into a Mobile Database list.

API

Application Program Interface.

  • Body: Represents the body of the request or response and allows you to declare what the content type is and how it should be handled.
  • Method: HTTP is the format used to enable communication between clients (like Web browsers) and servers. The most common methods are GET, POST, PUT and DELETE.
  • URL: The Web address. The URL host is the Vibes public API site.
  • Header: A unit of information that contains information about the file. Vibes APIs use a JSON file.
API KeyThe API Key is found at the top of the Campaign page. Your Vibes account manager can help you with your API Key when you create an Acquisition Campaign in the Vibes Platform.
BroadcastMessages sent to a set of Subscribers.
CallbackA callback entity is a registration to receive callback events to an external URL. It is identified by a CallbackID, which uniquely identifies the record. Additionally, each callback is unique for a given event type and active date range.
Campaign ManagerCampaign Manager enables interactive campaigns, which includes acquiring People to lists, as well as running contests, voting, and info-on-demand campaigns and incentives.
Client Certificate AuthenticationVibes supports Client Certificate Authentication as an extra layer of security for API calls.
CRMCustomer Relationship Management.
CSVComma-Separated Value.
Custom FieldData about a person that is custom to an account.
Custom Short DomainVibes provides a proprietary URL shortener for use in Short Message Service (SMS) campaigns.
E.164E.164 is the official format for all international phone numbers that includes a plus sign (+) followed by a country code and phone number.
For example:
  • U.S.: +12025550132
  • U.K.: +441632960964
  • Brazil: +5511991234567
EventIn Vibes Mobile Engagement Platform, Events are occurrences that can be submitted into the system and linked to actions that will be executed within the system. Each event is an individual occurrence that will be checked and routed to an appropriate action for execution based on the event_type.
Event Triggered MessageYou can use events to trigger Vibes Mobile Engagement Platform messages. You need to work with your Vibes account manager to help you pre-configure any message content. You also need to define the event data ahead of time.
external_person_idA Person entity is an identified entity that has interacted with or been loaded into the Mobile Database. It is identified by a person_id, which uniquely identifies the record, or an external_person_id, which is a unique identifier from the customer system for reference and cross-linking.
IEInformation Elements.
Incentive ManagerThe Incentives Manager is a module in the Vibes Mobile Engagement Platform that allows the issuance and redemption of incentive codes.
Incentive CodeA single code that can be issued or redeemed.
Incentive Code IssuanceA record of an issuance of an Incentive Code.
Incentive Code RedemptionA record of a redemption of an Incentive Code.
Incentive PoolA collection of Incentive Codes.
Integration FilesVibes-supported Integration files are an alternative way to load and update data into Vibes Mobile Engagement Platform.
JSON

(JavaScript Object Notation) is a lightweight data-interchange format. Example: The following shows the JSON representation of a Subscription entity within the APIs.

{
   "person":{
      "id":"ABC123",
      "url":"/companies/:id/mobiledb/persons/:person_id"
   },
   "subscription_list":{
      "id":"1234",
      "url":"/companies/:id/mobiledb/subscription_lists/:id"
   },
   "opt_in_date":"2017-01-15T15:34:52Z",
   "url":"/companies/:id/mobiledb/persons/:person_id/subscriptions/:subscription_list_id"
}
MDNMobile Directory Number.
MessageAn individual communication sent to or from a Person.
Message ExtractThe daily Message extract is used to sync message data between Vibes Mobile Engagement Platform and a Customer Relationship Management (CRM) or Campaign Management system.
MMAMobile Marketing Association.
MOMobile Originated (A message the client sends from their mobile phone).
Mobile DatabaseThe Vibes Mobile Database stores information about Persons who have already interacted with, or may interact with your campaigns. It also lets you segment, target, and personalize messages to Subscribers.
MTMobile Terminated (A message sent to a client’s mobile phone).
ParticipantA Person who has one or more mobile interactions, such as sending a text message, with a company but has not yet subscribed to a Subscription List.
Pending SubscriberA Participant that has requested to opt-in to a Subscription List, has been sent a prompt to join a Subscription List that has not expired, but has not yet confirmed their opt-in.
PersonAn individual in your Mobile Database. A Person entity is an identified entity that has interacted with or been loaded into the Mobile Database. It is identified by a person_id, which uniquely identifies the record, or an external_person_id, which is a unique identifier from the customer system for reference and cross-linking.
person_idA Person entity is an identified entity that has interacted with or been loaded into the Mobile Database. It is identified by a person_id, which uniquely identifies the record, or an external_person_id, which is a unique identifier from the customer system for reference and cross-linking.
PushVibes offers a Push Notifications SDK to let you send push messages to consumers, track your App interactions with notifications, and allow mobile applications to register themselves to receive push messages from Vibes Mobile Engagement Platform.
Push DevicesA Push Device is a device that has the Vibes Push SDK and has registered itself with the Vibes Platform. It is uniquely identified by a vibes_device_id. 
Recipient ListAn externally defined set of Persons that is used to target outbound content delivery.
SAML 2.0Security Assertion Markup Language is an XML-based data format for exchanging authentication and authorization data between parties. Vibes Mobile Engagement Platform allows customers and Partners to use SAML 2.0 to authenticate users into the Platform.
SDKSoftware Development Kit. An SDK is a programming package that enables a programmer to develop applications for the Vibes Platform.
SFTPSecure File Transfer Protocol. The use of integration files requires a Vibes’ Secure File Transfer Protocol (SFTP) account. Contact your Vibes account manager to get your SFTP account set up.
SMSShort Message Service.
SOAPSimple Object Access Protocol.
Standard FieldThe field is defined and available to all companies, but the data is always specific to a company.
SubscriberA Participant who is subscribed to one or more Subscription Lists.
SubscriptionA Person's membership in a Subscription List.
Subscription EntityThe Subscription entity contains the information and metadata for a Person's Subscription to a Subscription List.
Subscription Extract The daily Subscription extract is used to sync Subscriptions between Vibes Mobile Engagement Platform and a Customer Relationship Management (CRM) or Campaign Management system.
Subscription ListA collection of Subscribers that have all subscribed to the same type of certain content. A Subscription List entity contains the information about a particular Subscription List.
Text Delimited FilesText delimited files are standard text fields with one record per line, and the various columns separated by a delimiter.
URL Click ExtractThe daily URL Click Extract is used to sync URL click data between Vibes Mobile Engagement Platform and a Customer Relationship Management (CRM) or Campaign Management system.
UUIDA Universal Unique Identifier is a 128-bit number used to uniquely identify an object or entity on the Internet.
vibes_device_id

A Push Device is a device that has the Vibes Push SDK and has registered itself with the Vibes Platform. It is uniquely identified by a vibes_device_id.  

To effectively target by Person and Person custom fields, the Platform needs to have associated a device with a Person. This association is done by a sever-to-server call sending the vibes_device_id  and external_person_id to associate the device to the Person.
Wallet Instance ExtractThe daily Wallet Instance extract is used to sync Wallet data between Vibes Mobile Engagement Platform and a Customer Relationship Management (CRM) or Campaign Management system. It will contain all of the Wallet instances that have been registered or unregistered since the last data extract.
Wallet Manager

Vibes’ Wallet Manager platform enables updates to offers and loyalty cards already saved to a Person's Apple Wallet/Passbook or Google Wallet/Android Pay application.

Note:
Passbook was renamed as Apple Wallet.
Google Wallet was renamed as Android Pay.
Wallet Page View ExtractThe daily Wallet Page View extract is used to sync Wallet data between Vibes Mobile Engagement Platform and a Customer Relationship Management (CRM) or Campaign Management system.
White LabelingVibes Mobile Engagement Platform white labeling capability lets Partners easily customize their logos and URLs.



  • No labels

2 Comments

  1. define participant

    • Pending Subscriber: a 

      Person 

      Unknown macro: {PARTICIPANT}

      ?

       who has been sent a prompt to join a Subscription List, but has not replied "Y"
  2. Terms we should add:

    • Company
    • User?