API stands for Application Program Interface, and is a set of routines, protocols, and tools for building software applications.
The call structure of the APIs is as follows:
Topics in this Section |
Vibes throttles the number of requests that can hit the APIs at one time. The rates are the following:
NOTE: A “429 Too Many Requests” response will be sent in any cases where the number of requests hitting the API are over the defined rate limits.
Additional technical details are available here, including hosts, server end points, authentication, API details, IP addresses, and callback details.
This is the default version. It does not accept the international format, E.164 phone numbers.
Note: If you are using Version 1, you cannot use the E.164 format. If you do use it, you will get an error returned. |
To fully serve its international customers, Vibes released Version 2 of the Vibes Mobile Engagement Platform APIs in 2016 to include support for international E.164 phone numbers.
POST http://public-api.vibescm.com/companies/ABC123/campaigns/acquisition/abc123/participants/ Headers Content-Type: Application/JSON Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== BODY { "external_person_id":"EXT542342", "mobile_phone":{ "mdn":"2995551234" }, "custom_fields":{ "first_name":"John", "last_name":"Doe" } } |
POST http://public-api.vibescm.com/companies/ABC123/campaigns/acquisition/abc123/participants/ Headers Content-Type: Application/JSON Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== BODY { "external_person_id":"EXT542342", "mobile_phone":{ "mdn":"+12995551234" }, "custom_fields":{ "first_name":"John", "last_name":"Doe" } } |