OS1 Services
Messaging and Mobile Push Notifications

15min
Introduction
The Messaging Service empowers developers by enhancing and streamlining communication across various channels and applications. The Messaging APIs focus on integrating messaging and notification features into apps, supporting multiple communication channels such as SMS, email, and WhatsApp. With customizable templates and multiple service provider options, developers can tailor their messaging solutions to their needs. As a subset of the Messaging Service, the Mobile Push Notifications APIs handle push notifications for iOS and Android-based mobile apps. 
While both APIs aim to improve communication, the Messaging APIs target integration across with email, SMS, and WhatsApp channels. In contrast, the Mobile Push Notifications APIs focus specifically on delivering notifications to iOS and Android mobile apps.
Messaging APIs
Messages
The Send Messages APIs enable applications to send single and bulk messages using various channels such as SMS, email, or WhatsApp. These APIs allow sending single or bulk messages, with the ability to specify templates and placeholders for dynamic content.
In addition to one-way messaging, the APIs also support two-way messaging, enabling interactive conversations between the application and recipients. With the SendTwoWayMessage API, developers can send messages that expect a response from the recipient. The API allows defining accepted responses and corresponding webhooks to handle each specific response. It also supports specifying a default webhook for handling unmatched responses and a timeout for how long responses will be accepted.
API
﻿SendMessages: Send single or bulk SMS, email, and WhatsApp messages
﻿SendMessageNotifications: Send one-way notification messages to multiple recipients
﻿SendTwoWayMessages: Send two-way messages and receive responses via callbacks
Service Provider Management
The Service Provider Management APIs enable developers to register and manage external messaging providers, such as Amazon Pinpoint, AWS SES ,and Infobip. These APIs offer capabilities like registering new providers, listing available providers, updating provider configuration, and specifying default provider configuration for tenants.
APIs
﻿RegisterServiceProviders: Registers new service providers
﻿UpdateServiceProviders: Updates or deactivates service providers
﻿GetServiceProviderTypes: Gets the details of all service provider types supported by the messaging service.
﻿GetServiceProviderType: Gets details of a single service provider type.
﻿GetServiceProviders: Gets all service provider configurations for a tenant.
﻿GetServiceProvider: Gets a single service provider configuration by name.
Templates Management
The Templates Management APIs enable app developers to create, update, retrieve, and delete reusable message templates that allow for dynamic content injection using placeholders at both the tenant and app level. Some of the key capabilities of these APIs include registering templates with parameters such as name, body, and supported channels and listing and retrieving existing templates. These APIs also provide the option to update template status and content.
APIs
﻿CreateTemplate: Creates a new message template.
﻿GetAllTemplates: Gets all message templates for a tenant.
﻿GetTemplate: Gets a single template by name.
﻿UpdateTemplate: Updates an existing template.
﻿UpdateDefaultExternalRef: Update default external ref for template template as active/inactive
Tenant Config Management
The Tenant Configuration Management APIs enable business administrators to personalize messaging provider configuration and business rules for a tenant. These APIs allow administrators to register tenant-specific settings such as sender IDs, footer texts, email domains, etc. They also allow the retrieval of the tenant configuration, updating tenant-specific business rules and provider activation status per channel, and deleting existing configurations.
APIs
﻿RegisterTenantConfig: Registers the tenant-specific configuration.
﻿UpdateTenantConfig: Updates the existing tenant configuration.
﻿GetTenantConfig: Gets the tenant's configured business rules and settings.
Metering
The Metering API enables developers to retrieve usage data metrics for messages sent through the platform, sorted by tenant. This feature allows message send counts to be broken down by various metrics such as templates, channels, date ranges, and status.
API
﻿GetStatistics: Get the statistics for messages sent.
Notification Management
﻿CreateMessageNotification: Create notification templates
﻿GetMessageNotifications: Get list of notifications based on app and mode.
﻿UpdateMessageNotificationTemplate: Update template associated with notification.
﻿GetMessageNotificationDetails: Get notification group.
﻿UpdateMessageNotificationModes: Enable or disable modes for the notification.
﻿
Mobile Push Notifications APIs
Developers can use the Mobile Push Notification API endpoints to perform the following operations for app and device registration for mobile notifications.
Mobile App Registration
﻿RegisterMobileAppNotification: Register a new mobile app notification.
﻿GetAllRegisteredMobileApps: Retrieve the details for all registered apps.
﻿GetRegisteredMobileApp: Retrieve the details of a specific app by ID.
﻿UpdateMobileAppRegistration: Update the app notification configuration by ID. 
Mobile App Configuration Registration
﻿RegisterAppNotificationConfig: Register an app notification configuration
﻿GetAppNotificationConfig: Retrieve the app notification configuration by ID. 
﻿UpdateAppNotificationConfig: Update the app notification configuration. 
Send Mobile Push Notifications
﻿SendMobilePushNotifications: Send mobile push notifications to Android or iOS users.
Event
﻿Deprecating Push Event AP by End of May﻿
The Push Event to Kafka endpoint will be deprecated by the end of May. We recommend that developers use the SendMobilePushNotifications  endpoint. 
﻿PushEvent: Forward an event to Kafka
﻿
Country Data
Use Cases and Features