Getting Started
There are 3 main functions in BlipNow API, you can integrate with us via these functions. AppId and ApiKey are required while calling our functions, so each function takes these two firstly as input. Below you can find integration methods and techinal details along with code samples.
API Url: https://buffer.blipnow.com/BufferService.svc (POST Request)
AppId: GUID given for your community at BlipNow App.
ApiKey: API Key given for your community at BlipNow App.
UserRegister Method
Description: Takes “BlipUser” object as input.
Should be used for both user and device registration. User can login to https://app.blipnow.com with email and password (if provided) info later.
Parameter | Description | Required for Notification |
ApplicationId | The Community ID for your application (GUID ID) | Yes |
NameSurname | Name and surname of end-user | No |
Phone | Mobile phone number of end-user (+countrycode *** *** ** ** formatted) | No (Yes for SMS) |
Email address of end-user | Yes | |
WebAuth | Authorization of email, should be “1” for not to apply additional verification of email address. | Yes |
Password | Login password for end-user | No |
DeviceID | ID of end-user’s device | No |
DeviceToken | Token of end-user’s device | No (Yes for Push) |
DeviceType | Type of end-user’s device, could be: “WEB, Android, IPHONE, WEB (Safari, MacOS), SMS, EMAIL” | Yes |
IpAddress | Ip Address of end-user’s device | No |
Country | Country info of end-user’s device | No |
ExternalUserID | ID of user in external system | No |
AuthPush | Authorization of mobile push notification 1: authorized 0: non-authorized | No |
AuthSms | Authorization of mobile push notification 1: authorized 0: non-authorized | No |
AuthEmail | Authorization of mobile push notification 1: authorized 0: non-authorized | No |
DeviceRegister Method
Description: Takes “BlipDevice” object as input.
Should be used for device registration only. User can NOT login to https://app.blipnow.com.
Parameter | Description | Required for Notification |
ApplicationId | The Community ID for your application (GUID ID) | Yes |
Phone | Mobile phone number of end-user (+countrycode *** *** ** ** formatted) | No (Yes for SMS) |
Email address of end-user | Yes | |
DeviceID | ID of end-user’s device | No |
DeviceToken | Token of end-user’s device | No (Yes for Push) |
IpAddress | Ip Address of end-user’s device | No |
Country | Country info of end-user’s device | No |
ExternalUserID | ID of user in external system | No |
SendNotification Method
Description: Takes list of “BlipNotification” object as input.
Should be used for mobile push, email and sms notifications to devices specified.
Parameter | Description | Required for Notification |
ApplicationId | The Community ID for your application (GUID ID) | Yes |
Devices | Device list of end-users devices, can contain: DeviceID, Email, ExternalUserID, UserID, NonFollowerEmail, NonFollowerPhone | Yes |
MessageTitle | Notification Title | Yes |
Message | Notification Body | Yes |
MessageHtml | Notification Html body for Email Only | No |
MessageType | Notification Type (Json, Pdf, Text, Txt, Image, Video, Word, Excel) | Yes |
MessageAttachment | Attachment is base-64 format of image/document | Yes (for specific types) |
MessageTag | Message Tags separated with comma | No |
AdditionalData | Should be set for data-carrying notifications | No |
MessageType Details:
Type | Description |
Json | Notification body should be in JSON format |
Text | Notification body should be string |
Attachment should contain base-64 format of pdf file | |
Txt | Attachment should contain base-64 format of txt file |
Image | Attachment should contain base-64 format of image file |
Video | Attachment should contain video link |
Word | Attachment should contain base-64 format of word file |
Excel | Attachment should contain base-64 format of excel file |
Devices Details:
Property | Description |
DeviceID | Notification will be send particular device |
UserID | Notification will be send user’s all registered devices (regarding authorization flags) |
ExternalUserID | Notification will be send external user’s all registered devices |
Notification will be send user’s all registered devices (regarding authorization flags) | |
NonFollowerEmail | Notification will be send as Email |
NonFollowerPhone | Notification will be send as SMS |
Additional Data Details:
- is <key (string),value (object)> pair
- key string cannot be “messageId” and “deviceId“
- Example: <userType, admin>, <flightNumber, 33210> etc.
Unsubscribe Method
Description: Takes “BlipUser” object as input.
Should be used for unsubscribing BlipDevice. There are 3 ways to unsubscribe a device or all devices of a user.
1. Unsubscribe all devices of a user:
Parameter | Description | Required for Notification |
ApplicationId | The Community ID for your application (GUID ID) | Yes |
Email address of end-user | Yes |
2. Unsubscribe all devices of an external user:
Parameter | Description | Required for Notification |
ApplicationId | The Community ID for your application (GUID ID) | Yes |
ExternalUserID | ID of user in external system | Yes |
3. Unsubscribe only device:
Parameter | Description | Required for Notification |
ApplicationId | The Community ID for your application (GUID ID) | Yes |
Email address of end-user |
One of these is required | |
Phone | Mobile phone number of end-user (+countrycode *** *** ** ** formatted) | |
ExtAppUserID | User information of Slack, Telegram, WhatsApp etc. | |
DeviceToken | Token of end-user’s device |
GetNotifications Method
Description: Takes “ApplicationId” as input and returns first 50 notification for the specified community.
Parameter | Description | Required for Notification |
ApplicationId | The Community ID for your application (GUID ID) | Yes |
WebPush Integration
To integrate web push to your site:
1. You should include “BlipNowSDK.js” (https://app.blipnow.com/BlipNowSDK.js.
2. You should call initialization functions from your main page.* For Chrome, Firefox and Edge;
initializeBlipNow(ApiKey, ApplicationId);
* For Safari;
initializeSafariBlipNow(ApiKey, ApplicationId);
Parameter | Description | Required for Notification |
ApplicationId | The Community ID for your application (GUID ID) | Yes |