OS1 Services
Messaging and Mobile Push Notifications
15 min
introduction the messaging service empowers developers by enhancing and streamlining communication across various channels and applications the https //docs getos1 com/messaging and mobile push notifications#jqmxx 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 https //docs getos1 com/messaging and mobile push notifications#gafzt 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 https //docs getos1 com/reference/send messages send single or bulk sms, email, and whatsapp messages https //docs getos1 com/reference/send notifications send one way notification messages to multiple recipients https //docs getos1 com/reference/send two way messages 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 https //docs getos1 com/reference/create service provider configs registers new service providers https //docs getos1 com/reference/modify specific service provider instance updates or deactivates service providers https //docs getos1 com/reference/get configs of all provider types gets the details of all service provider types supported by the messaging service https //docs getos1 com/reference/get provider type gets details of a single service provider type https //docs getos1 com/reference/get all providers gets all service provider configurations for a tenant https //docs getos1 com/reference/get specific provider instance by name 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 https //docs getos1 com/reference/create templates creates a new message template https //docs getos1 com/reference/get all templates gets all message templates for a tenant https //docs getos1 com/reference/get template with template name gets a single template by name https //docs getos1 com/reference/update template with template name updates an existing template https //docs getos1 com/reference/update default external ref 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 https //docs getos1 com/reference/register tenant config registers the tenant specific configuration https //docs getos1 com/reference/update tenant config updates the existing tenant configuration https //docs getos1 com/reference/get tenant config 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 https //docs getos1 com/reference/get the statistics for messages sent get the statistics for messages sent notification management https //docs getos1 com/reference/create notification create notification templates https //docs getos1 com/reference/get all notifications get list of notifications based on app and mode https //docs getos1 com/reference/update notifications templates update template associated with notification https //docs getos1 com/reference/get notifications details get notification group https //docs getos1 com/reference/update notification modes 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 https //docs getos1 com/reference/register new app register a new mobile app notification https //docs getos1 com/reference/get all registered apps retrieve the details for all registered apps https //docs getos1 com/reference/get app registration detail retrieve the details of a specific app by id https //docs getos1 com/reference/update app registration detail update the app notification configuration by id mobile app configuration registration https //docs getos1 com/reference/add app notification configuration register an app notification configuration https //docs getos1 com/reference/get app notification config retrieve the app notification configuration by id https //docs getos1 com/reference/update app notification config update the app notification configuration send mobile push notifications https //docs getos1 com/reference/ aso send notifications send mobile push notifications to android or ios users event deprecating push event ap by end of may deprecating push event ap by end of may the https //docs getos1 com/reference/push event to kafka endpoint will be deprecated by the end of may we recommend that developers use the https //docs getos1 com/reference/ aso send notifications endpoint https //docs getos1 com/reference/push event to kafka forward an event to kafka