This how to covers the essential configuration to get SMSSync up and running. The application has been designed to be intuitive enough to easily get it running. **Note:** SMSSync works on any SMS-enabled device running Android 2.1 and above.
Here you can manage multiple Sync URLs. Sync URLs are the URLs of your webservices. These are where the messages from SMSSync are actually pushed to.

Add new Sync URL

To add a new Sync URL:

  1. Tap on the Sync URL from the navigation drawer.
  2. Tap on the Add icon icon on the actionbar. An input dialog should open.
  3. Enter a title for the Sync URL.
  4. Enter a secret key if required by the webservices. Make sure you enter the exact key here. The secret key should be presented as string of any characters without spaces.
  5. Enter a comma separated value for the keyword(s). These keywords will be used by SMSSync to filter incoming SMS and pending messages to the Sync URL you are adding. As of v2.0.2. You can now add Regular Expresssion code for filtering. This means, it can either be CSV or RegExp. It cannot be both.
  6. Enter the URL for your webservice. Don't forget to start with the HTTP or HTTPS protocol. e.g. https://example.com/api-v1/add-record/
  7. Tap OK to save the new entry.

Note: Version 2.5 or higher supports basic auth credentials in the URL, e.g. https://username:pass@example.com/api-v1/add-record/.

Edit a Sync URL

To edit an existing Sync URL:

  1. Long press on the Sync URL you want to edit by tapping and holding it until the actionbar menu changes.
  2. Tap on the Edit icon icon on the actionbar. An input dialog should open repopulated with the details of the Sync URL.
  3. Edit the necessary field(s) accordinlgy.
  4. Tap OK to save the edited entry.

Change Sync Scheme

The default sync scheme uses URLEncoded. However, with version 2.5 and above you can now customize which sync scheme should be used for synchronization. The supported formats are URLEncoded, JSON, XML

To change the sync scheme:

  1. Long press on the Sync URL you want to edit by tapping and holding it until the actionbar menu changes.
  2. Tap on the Change sync scheme icon on the actionbar. A dialog will pop up.
  3. Select the HTTP Method to use. POST and PUT are supported
  4. Select the Data Format. URLEncoded, JSON and XML are supported for now.
  5. Set the Payload Keys to use. You can only set 5 keys. Make sure the keys matches what is expected on the server. In most cases it is safe to stick to the default keys.

Delete All Existing Sync URLs

Delete all Sync URL by:

  1. If there are any Sync URLs enabled(checked), disable(uncheck) them.
  2. Stop the SMSSync service if it's running(checked).
  3. Tap on the Delete icon icon on the actionbar. A confirmation dialog should open.
  4. Tap Yes to delete all Sync URL or No to cancel the deletion.

Delete An Existing Sync URL

Delete an existing Sync URL by:

  1. If the Sync URL to be deleted is enabled (checked), disable it. Otherwise, move to the next item.
  2. Long press on the Sync URL you want to delete by tapping and holding it until the actionbar menu changes.
  3. Tap on the Delete icon icon on the actionbar. A confirmation dialog should open.
  4. Tap Yes to delete it or No to cancel the deletion.

Start SMSSync service

To start the SMSSync service:

  1. Make sure you have added and enabled (checked) at least one Sync URL.
  2. On the SYNC URL screen, tap on the Start SMSSync service to start the service. You do this if the service is disabled.

Stop SMSSync service

To stop the SMSSync service:

  1. On the SYNC URL screen, uncheck the Start SMSSync service option to stop the service.

Using the options available in the app settings, you can configure the behaviour however you like.

General Settings

  1. Go to Settings screen by tapping the Settings icon icon on the actionbar or option menu.
  2. Tap on Enter Unique ID to enter a Unique ID to identify the device SMSSync is installed on.

Reply Message Settings

This is where you set auto reply message to be sent to the user that sent SMS to SMSSync. You can specify a message on the phone or get the message from the server. To set a reply message:

  1. Go to Settings screen by tapping the Settings icon icon on the actionbar or option menu.
  2. Tap on Get Reply From Server if you want to send an instant reply message from the Sync URL. Otherwise, tap on Reply Messages to set the instant reply message on the phone.

Auto Sync Settings

This is where you enable SMSSync to periodically send pending messages to the enabled Sync URLs. To enable auto sync:

  1. Go to Settings screen by tapping the Settings icon icon on the actionbar or option menu.
  2. Tap on Enable Auto Sync to enable the auto sync service.
  3. Tap on Auto sync frequency to set the frequency at which the auto sync should run.

Task Settings

The Task feature allows you to send SMS to users as defined by the server. It works by regularly checking the server for new messages to be sent. To enable Task Checking feature:

  1. Go to Settings screen by tapping the Settings icon icon on the actionbar or option menu.
  2. Tap on Enable Task Checking to enable the task service.
  3. Tap on Frequency to set the frequency at which the task checking service should run.

Pending messages are failed SMS that couldn't make it to any of the enabled Sync URLs. SMSSync allows you to manage these pending messages. You can either configure the app to automatically or manually sync these failed messages or delete them.

Manually sync all pending messages

  1. Tap on the Sync icon icon on the actionbar. The sync icon should spin for a while.
  2. After the sync icon spins for a while, a Toast should show up with a status message.

Manaully sync a single pending message

  1. Long press on the pending message you want to sync by tapping and holding it until the actionbar menu changes.
  2. Tap on the Sync icon icon on the actionbar. The sync icon should spin for a while.
  3. After the sync icon stops spinning, a popup should appear with a status message.

Delete pending messages

Delete all pending messages saved on the device.

  1. Tap on the Delete icon icon on the actionbar. A confirmation dialog should open.
  2. Tap Yes to delete all pending messages or No to cancel the deletion.

Import SMS

Import SMS from the device's messages inbox.

  1. Tap on the Import icon icon on the actionbar. A progress dialog should open. Leave it to run until it finishes. Depending on the number of messages in your inbox, this could take a while.

Sent messages are SMS or pending messages that have successfully been sync'd to the enabled Sync URL. This is to allow you to see which messages were successfully sent. Here you can view and delete these sent messages. This section will show you how to delete sent messages individually or all at the same time.

Delete An Individual Sent Message

  1. Long press on the sent message you want to delete by tapping and holding it until the actionbar menu changes.
  2. Tap on the Delete icon icon on the actionbar. A confirmation dialog should open.
  3. Tap Yes to delete it or No to cancel the deletion.

Delete All Sent Messages

  1. Tap on the Delete icon icon on the actionbar. A confirmation dialog should open.
  2. Tap Yes to delete all sent messages or No to cancel the deletion.