Campaign Automation Details
Campaign provisioning:
As part of the campaign provisioning flow, Syniverse triggers the campaign creation via its API as part of the campaign vetting process when the brand and campaign has been registered on TCR and Syniverse has been elected as DCA.
There is no customer action required for the registering of the campaign to T-Mobile.
ESS events for campaign registration:
As part of the campaign provisioning flow, the customer will receive 2 ESS events from Syniverse:
PENDING webhook that advises the customer the campaign has been sent for T-Mobile provisioning.
DEPLOYED webhook to confirm the campaign has been successfully provisioned and is ready for longcodes to be provisioned.
Please refer to the section 'Registering for ESS events' at the bottom of this page for details on how to set up your subscription to receive these.
Note: customers who are implemented with the legacy v1 version of the Syniverse API and ESS events receive a REGISTERED event when their campaign has been successfully provisioned.
Customer GET API’s for campaigns:
A GET API is available for customers that that returns campaign data for self-service troubleshooting and validations.
GET https://api.syniverse.com/engage/tendlc-services/v2/campaigns/{CampaignId}
|
200 OK RESPONSE |
| { "code": 200, "message": "Request received", "status": "Ok", "timestamp": "2022-07-27T12:05:30.631Z", "data": { "campaignId": "CQWFXXX", "status": "DEPLOYED", "cspId": "S73Gxxx", "brandId": "BU6VXXX", "customerActorId": "S73GXXX", "policy": "policy_10dlc", "useCase": "two-factor-authentication", "subUseCase": null, "msgServiceType": "two-factor-authentication", "firstDeployedTime": "2022-06-30T17:40:55.807", "insertedTime": "2022-07-20T18:33:55.807", "updatedTime": "2022-07-20T18:34:26.865", "applicationAddresses": [ { "applicationAddress": "12345678999", "status": "ADDED", "updatedTime": "2022-09-12T15:48:12.641" } ] } } |
Suspend/Resume Campaign
Customers can suspend the campaign at T-Mobile by calling the Syniverse ‘suspend’ api endpoint - POST https://api.syniverse.com/engage/tendlc-services/v2/campaigns/{CampaignId}/suspend.
This is a function for existing campaigns that have had no longcodes provisioned to them for > 30 days, but the campaign remains in an active state on TCR.
This will remove the campaign from T-Mobile only and will avoid the customer from incurring penalty fees from T-Mobile for ‘ghost’ campaigns (i.e. campaigns registered > 30 days with no longcodes provisioned’).
When the customer is ready to add/re-add longcodes to the campaign it can be re-registered at T-Mobile by call the ‘resume’ endpoint - POST https://api.syniverse.com/engage/tendlc-services/v2/campaigns/{CampaignId}/resume.
Note: The suspend / resume functions will only work for campaigns that are 'active' in TCR.
About Syniverse Campaign Status
In order to better understand the mechanics of the backend process, v2 release, the different statuses a campaign can have as part of the campaign provisioning flow are as follows:
PENDING = an interim status that confirms a new campaign is pending provisioning to T-Mobile
DEPLOYED = means a campaign is successfully provisioned and is ready to receive longcodes.
DEPLOYED_FAILED = the campaign has failed to provision at T-Mobile. Note: When the campaign is in this state, it is not possible to add longcodes to it. Any longcode add request received will be rejected
MARK_REMOVED = A TCR request for campaign removal has been received (i.e. campaign is expired on TCR) and indicates the beginning of the removal process, where Syniverse will remove all the associated application addresses in that campaign and set the campaign as removed.
REMOVE_FAILED = the system receives non-retriable errors from the MNO API or exhausts the retry mechanism while trying to remove the campaign or the application addresses (Long Codes and Number Pools) in it.
REMOVED = Means the campaign is no longer active, has been set to Remove in T-Mobile, typically due to a TCR DELETE/EXPIRE request.
Campaign Status Customer Managed Options (Direct API SUSPEND/RESUME methods)
MARK_SUSPENDED=Customer initiated the suspension of a campaign and the activity is in progress. Suspension of a campaign will remove all long code and number pool associations.
SUSPENDED=Capaign is in suspended status, that means the Syniverse system knows about the campaign but it has been removed from MNO platforms. Campaigns in this status will not accept changes. Suspension of a campaign will automatically remove all long code and number pool associations.
SUSPEND_FAILED the system receives non-retriable errors from the MNO API or exhausts the retry mechanism while trying to Suspend the campaign and REMOVE the application addresses (Long Codes and Number Pools) in it.
- TIP: Please contact customer support and open only 1 ticket for all the campaigns you have in SUSPEND_FAILED status.
If the customer wants to use the campaign in the future it shall use the Resume Campaign Method :
-- At this step the platform will set the status to PENDING and attempt to move this campaign back to DEPLOYED state. From here customers can add long codes / or number pool as required to run traffic.
If a campaign expires in TCR then the customer shall not expect this request to be successful.
Registering for ESS events:
Syniverse recommends that customers subscribe to ESS events in order to track the provisioning of your campaigns and longcode requests.
To register for ESS events, you need to perform the following steps:
1. Login to Syniverse Development Community (SDC) portal
ESS events for campaign provisioning (v2)
| Ess Event | Description on ESS event | Additional Info |
| DEPLOYED | Your request to deploy campaign Cxxx001 has been processed. You may add longcodes to this campaign. | |
| DEPLOY_FAILED | There is no standard description for deploy failed scenarios. The text will be variable, dependent on the reason for failure. | |
| SUSPEND | Your request to suspend campaign Cxxx001 has been processed. All longcodes have been deleted from the campaign. | This event is generated when the customer has triggered a campaign suspension for T-Mobile. |
| MARK_REMOVED | Your request to delete campaign CVT9Y4D has been received and will be processed shortly. | This event is usually generated where the campaign has expired on TCR. |
| REMOVED | Campaign Cxxx001 removed/expired successfully. | Campaign has been removed from the T-Mobile platform. |
|
ESS Notification Body example for successful campaign provisioning: final notification DEPLOYED {
|