Skip to end of metadata
Go to start of metadata

Mobile Engagement APIs

NOTE: These Documents are available only to Internal Phunware Users. Click here if you are a Phunware Developer and need access.

If you are a customer who needs access to these documents, contact Phunware support at support@phunware.com.

API - Mobile Engagement

Document Title/LinkDocument DescriptionLast Updated
Introduction to Marketing Automation API

This document is intended to help developers getting started with our Mobile Engagement SDK and related APIs for our Marketing Automation product. It provides key features and functions, getting started links and info, and use cases to explore.

8/2016
Mobile Engagement API ArchitectureRequest/response format, HTTP methods, date/time format, bracketed IDs, ellipses, PUT methods and partial updates, GET methods and query strings8/2016
Messaging API Methods - Device Registration

Android Method, URL, Headers, Sample Request, Response, Sample Response

This method will accept device registration requests.

9/1/2016
Messaging API Methods - Download Geofences

Android Method, URL, Headers, Sample Request, Response, Sample Response

This method will accept device download geofence requests

9/1/2016
Messaging API Methods - Geofence Entry

Android Method, URL, Headers, Sample Request, Response, Sample Response

This method will accept device geofence entry requests.

9/1/2016
Messaging API Methods - Geofence Exit

Android Method, URL, Headers, Sample Request, Response, Sample Response

This method will accept device geofence exit requests

9/1/2016
Messaging API Methods - Download Promotion

Android Method, URL, Headers, Sample Request, Response, Sample Response

This method will accept device download promotion requests. +SDK dependencies

9/1/2016
Messaging API Methods - Retrieve a Collection of Attribute Metadata

Android Method, URL, Headers, Sample Request, Response, Sample Response

This method is used to retrieve all attribute metadata for an org.

8/3/2016
Messaging API Methods - Create Device Attributes

Android Method, URL, Headers, Sample Request, Response, Sample Response

This method will accept requests to associate attributes with a device

9/1/2016
Messaging API Methods - Get All Device Attributes

Android Method, URL, Headers, Sample Request, Response, Sample Response

This method will accept device attribute GET requests.

9/1/2016

PWMessaging Class

iOS Method for app registration and setup12/9/2016

PWMSGAttributeManager Class

iOS Method, the central point for fetching and updating attributes associated with the device or user. You use an instance of this class to fetch and update profile and user attributes.12/9/2016

PWMSGLocalNotification Class

iOS Method, a PWLPLocalNotification object holds the information related to a local notification that will be shown to the user. The PWLPLocalNotification object allows the alert title and alert body to be modified if needed.12/9/2016

PWMSGZone Class

iOS Method, a PWMSGGeozone object represents a circular region in a map with some associated data for that region.12/9/2016

PWMSGZoneMessage Class

iOS Method, a PWZoneMessage is a communication (generally marketing-related) sent from the server.12/9/2016

PWMSGZone Protocol

iOS Method, this protocol represents the zone data generated by an object which implements the PWMSGZone protocol. This object incorporates a name, identifier, code, tags and several other properties that can be useful to query. Typical implementations will append additional data to zone object.12/9/2016
Mobile Engagement API Response HandlingHTTP Status Codes and payloads8/1/2016
Use of this software requires review and acceptance of our terms and conditions for developer use located at http://www.phunware.com/terms/
  • No labels