Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Last Updated:

Lastupdatedate

Livesearch
placeholderSearch the Vibes Developer Wiki
typepage




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


TermDescription
Acquisition APIs

...

Used to add or search for Participants and Get Acquisitions Campaigns.
Acquisition Campaign

...

An 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.
Callback

...

A callback entity is a registration to receive callback

...

to an external URL. It is identified by a CallbackID, which uniquely identifies the record. Additionally, each callback is unique for a given

...

callback 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.
CSV

...

Comma-Separated Value.
Custom Field

...

Data about a person that is custom to an account.
Custom Short Domain

...

Vibes provides a proprietary URL shortener for use in Short Message Service (SMS) campaigns

...

...

E.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
Event

...

In 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 Manager

...

The Incentives Manager is a module in the Vibes Mobile Engagement Platform that allows the issuance and redemption of incentive codes.
Incentive Code

...

A single code that can be issued or redeemed.
Incentive Code Issuance

...

A record of an issuance of an Incentive Code.
Incentive Code Redemption

...

A record of a redemption of an Incentive Code.
Incentive Pool

...

A collection of Incentive Codes.
Integration Files

...

Vibes-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.

Code Block
{
   "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"
}


MDN

...

Mobile Directory Number.
Message

...

An individual communication sent to or from a Person.
Message Extract

...

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.
MMA

...

Mobile 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).
Participant

...

A 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 Subscriber

...

A 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.
Person

...

An 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_id

...

...

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.
Push

...

Vibes 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.
Recipient List

...

An externally defined set of Persons that is used to target outbound content delivery.
SAML 2.0

...

Security 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.
SDK

...

Software 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.
SOAP

...

Simple Object Access Protocol.

...

Standard Field

...

The field is defined and available to all companies, but the data is always specific to a company.
Subscriber

...

A 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 List

...

A 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 Files

...

Text delimited files are standard text fields with one record per line, and the various columns separated by a delimiter

...

.

...

...

The 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.
UUID

...

A Universal Unique Identifier is a 128-bit number used to uniquely identify an object or entity on the Internet

...

.

...

...

The 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
Note:
Passbook was renamed as Apple Wallet.
Google Wallet was renamed as Android Pay.


Wallet Page View Extract

...

The 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 Labeling

...

Vibes Mobile Engagement Platform white labeling capability lets Partners easily customize their logos and URLs.