These APIs only exist to support existing Cedita PureSMS customers with a more streamlined migration over to Connect, where a change is not possible in a reasonable timeframe.
Where at all possible even as an existing PureSMS customer, we suggest you look at migrating to the new Connect SMS API. This will provide additional functionality and performance rather than using this compatibility layer.
To prevent usage of this API unintentionally, we only reference the change in endpoints that can be used in existing code rather than signatures.
Compatibility Layer
We've added the PureSMS compatibilty layer to divergent Connect to allow you to transparently transition to the divergent Connect platform with minimal API.
It's important to note that certain new features, including templating, are not available through this compatbility layer.
As part of the migration process, your existing API Keys will have been transitioned in to Connect, so there are no changes required. Please note that this API Key will not work for our Email API as it is restricted to SMS only.
Using our libraries
PureSMS has a .NET library available on NuGet (PureSms.Client).
A version 2.0 of this library will be released that will transition you automatically to this compatibility layer at the time of your migration. If you see this update available within NuGet, it is safe to update to this version even before your migration has been completed.
Every hour, the library will phone home to ascertain if your API Key has been migrated to Connect or not. If it has, the compatibility layer will be used. If it has not, the PureSMS API will continue to be used. Once the migration has been determined, this will be stored permanently at runtime meaning that no further phone home will be made unless the application restarts.
It is unfeasible to assess the migration status at a resolution higher than 1 hour (for example on each SMS sent). This may result in an effective maximum downtime of 1 hour where messages are not able to be sent through PureSMS.
Realistically, your migration is a managed process that will typically be performed overnight and at a specific time when your traffic is known to be low or non-existent. By time the library is used within your codebase, the phone home will determine that you have migrated and be correct.
The below applies to both the batch configuration and individual message configuration.
AutoUnicode maps to Connect's StripUnicode in reverse. If AutoUnicode is set to true, StripUnicode is set to false.
IsUnicode has no effect, this is automatically determined by Connect.
AutoSplit has no effect, Connect internally handles long messages.
WebhookUrl has no effect and will instead use the default Webhook URL that you have set up within Connect.
The below applies only to batch configuration.
FailBatchOnAnyError has no effect. Connect processes SMS differently and performs asynchronous validation of SMS messages. See Performance Targets for more information.