Reach API
This section contains the REST API reference topics for the Azure Mobile Engagement Reach API.
The Reach API is an HTTP API allowing to manage Reach campaigns without having to use Mobile Engagement’s Web interface manually.
The Reach API is a high level API allowing to leverage the Web interface of Mobile Engagement’s Reach campaign manager. A Reach campaign address all the users of an application globally (even if the audience can be restricted) to deliver announcements or polls.
In order to be addressable by the Reach service, applications must embed the Mobile Engagement SDK and the Mobile Engagement Reach SDK.
The documentation of the Mobile Engagement SDK provides all the information required to integrate Reach on the application side.
Campaign life-cycle
Before using the Reach Service API, it’s important to understand the life-cycle of a Reach campaign. The following diagram shows the important state paths of a campaign.
.jpeg "AzME Campaign life cycle")
Draft
This is the intial state of a campaign after it has been created (via Create campaign command) The campaign can be freely destroyed in this state. When a campaign has been created, it can be activated using the Activate campaign command. In this case the campaign moved to the scheduled state.
Scheduled
A campaign that has been validated and that is ready to send to end-users. It is still possible to suspend a scheduled campaign, if so it will go back to the draft state.
In progress
A campaign that is currently being sent to end-users. Such a campaign is being sent to end-users. The only way to stop the delivery of an in progress campaign is by waiting for the campaign to expire (i.e. through its end date) or by finishing it. When the campaign is explicitly finished, the campaign is moved to the finished state as it would have normally do when it would have expired.
Finished
A campaign that has finished its life cycle. Data have been collected and can still been seen and used but the campaign is “inactive”. A finished campaign can be destroyed but in this case all data collected are lost.