SMS subscription

The Android Batch SDK allows you to:

• Add and remove phone number from a user profile. The profile will automatically be created if needed.

• Edit a profile's marketing subscription for the SMS channel.

In order to set a phone number and subscription status on a profile, the creation of a project is required. If no project is set up, any calls made for these actions will be ignored.

Here is how to set a phone number with a marketing subscription:

Kotlin

// This requires to have a custom user ID registered 
// by calling the `identify` method beforehand.
Batch.Profile.editor()
  .setPhoneNumber("[phone]") // Null to erase. A valid E.164 phone number.
  .setSMSMarketingSubscription(BatchSMSSubscriptionState.SUBSCRIBED) // or BatchSMSSubscriptionState.UNSUBSCRIBED
  .save();

Java

// This requires to have a custom user ID registered 
// by calling the `identify` method beforehand.
Batch.Profile.editor().apply {
  setPhoneNumber("[phone]") //  // Null to erase. A valid E.164 phone number.
  setSMSMarketingSubscription(BatchSMSSubscriptionState.SUBSCRIBED) // or BatchSMSSubscriptionState.UNSUBSCRIBED
  save()
}

Note: the phone number must be an E.164 formatted string starting with a + and not longer than 15 digits without any special characters. It should match the following regular expression : ^\+[0-9]{1,15}$