Application Address Mechanics
Application Address Management API
This REST API shall be used to manage number associations with campaigns in the DEPLOYED status. This is required to allow A2P 10 Digit Long Code (a.k.a. T-Mobile Application Address Management) to successfully run in through the T-Mobile A2P messaging network.
In this case customers will perform direct actions via their provisioning systems, must send HTTP Request to Syniverse 10DLC Provisioning endpoints. This is applicable to both Long Codes and Number Pool association ADD/DELETE operations.
We have updated the v2 HTTP responses to include a JSON Payload for example, adding a request for adding a long code to a campaign should look like:
Adding Long Code to Campaign
POST https://api.syniverse.com/engage/tendlc-services/v2/campaigns/Cxxx001/longcodes/12345678900
Deleting Long Code from Campaign
DEL https://api.syniverse.com/engage/tendlc-services/v2/campaigns/Cxxx001/longcodes/12345678900
In both cases, if accepted for provisioning a 200K HTTP Response will be provided with the following payload
{
"code": 200,
"message": "Request received",
"status": "OK",
"timestamp": "2022-07-28T09:59:25.523Z",
"data": null
}
Full list of API Calls and Responses (Including HTTP errors) are provided in the API Specification (YAML).
About Syniverse Long Code Status
Once accepted into queue for processing a 10 Digit Long Code can have one of the following statuses:
PENDING = is an interim status that implies a customer requested association of an Application Address Long Code with a campaign. It implies customer waited for DEPLOYED notification from the campaign.
DEPLOYED = means Syniverse managed to create the Application Address with the long code prior the association happens, thus it is a interim status.
DEPLOYED_FAILED / ADD_FAILED = the system receives non-retriable error from the MNO API or exhausts the retry mechanism while trying to deploy and add that application address to a campaign.
ADDED = expected outcome when trying to associate an application address with a campaign.
MARK_DELETE = Customer API call requesting number to be removed from the campaign has arrived.
DELETE_FAILED / REMOVE_FAILED = the system receives non-retriable error from the MNO API or exhausts the retry mechanism while trying to remove the application address from the campaign or set long code free and in remove state.
REMOVED = expected outcome when a number removal has been requested or when a campaign expiration happened, and this number was contained in that campaign. Long Codes in this status can be recycled.
REST API Response Codes and ESS NOTIFICATIONS
When calling the API to perform Long Code or Number Pool provisioning, the new version of the API has increased the level of validations to avoid requests to enter the provisioning queue if basic conditions are not met like:
· Campaign Status is not DEPLOYED
· Format related issues
On version 2.0 Syniverse will perform new validations at the HTTP Request level, providing a new set of HTTP Response Error Codes.
Add / Delete Long Code to Campaign HTTP Response and ESS NOTIFICATIONS
Successful operation ESS Notification Event Payload
|
NOTIFICATION final notification successful Long Code addition |
|
|
{ } |
|
|
NOTIFICATION final notification successful Long Code Delete operation |
|
|
{ |
|
Failed operation ESS Notification Event Payload
|
NOTIFICATION failure of Long Code Add operation |
|
|
{ } { } |
|
|
NOTIFICATION failure of Long Code Delete operation |
|
{ } |