10 DLC A2P Provisioning
Documentation /

V2 ESS and V1/V2 HTTP Error Codes

Campaign ESS NOTIFICATION error description

 

Campaign ESS NOTIFICATION structure

NOTIFICATION Event Topic: TenDlc-Provisioning-V2

NOTIFICATION Event Type: TenDlc_Campaign_V2

Field Data Type Mandatory Description
application_id INTEGER yes Application ID - SDC provides this parameter
company_id INTEGER yes Company ID - SDC provides this parameter
campaign_status STRING  yes Campaign state change (PENDING/REGISTERED/DEPLOYED/DEPLOYED_FAILED/MARK_REMOVED/REMOVED/REMOVE_FAILED)
campaign_status_description STRING  no Campaign status description
reason_code STRING  yes Request Reason code 
reason_description STRING yes Request Reason Description
tcr_campaignId STRING yes TCR Campaign ID

 

Campaign ESS NOTIFICATION error description

Since Campaign related actions are indirect, we do not present HTTP error codes for campaigns. In case of failure, syniverse will provide the following errors when the campaign provisioning automation sends a campaign_status": "DEPLOY_FAILED" ESS NOTIFICATION Event.

Simplified error notifications in campaign_description

INFO: Please review this number history with your customer, seems it belongs to another aggregator. If you think this is an error, please contact customer support and provide proof of ownership and authorization to text enable the number.

INFO: Campaign/Longcode already processed. Duplicate request ignored.

INFO: Campaign/Longcode could not be processed as one or more params are  invalid. Syniverse will remediate.

RETRY: Campaign/Longcode could not be processed even after system retries owing to intermittent MNO error. Longcode retry is advisable after 10 minutes before contacting Syniverse customer support. For failed campaigns contact Syniverse support directly.

RETRY: Campaign/Longcode could not be processed even after system retries owing to MNO throttling error. Longcode retry is advisable after 10 minutes before contacting Syniverse customer support. For failed campaigns contact Syniverse support directly.

RETRY: Carrier API error. Contact TCR to confirm Content Provider creation on T-Mobile. Then retry.

TICKET: Campaign/Longcode could not be processed as MNO error requires investigation/remediation. Please contact Syniverse customer support.
 

TICKET: Connection problem in the MNO carrier API. Please do not retry within the next 60 minutes. Contact Syniverse customer support.
 

TICKET: Please verify and fix the following fields in TCR, then contact Syniverse support for remediation. name <= 50 chars, contentprovider-name <= 50 chars, campaign-overview <= 4000 chars, messaging-flow <= 4000 chars, help-message <= 4000 chars, description <= 4000 chars, address <= 255 chars.

TICKET: Throttling problem in the MNO carrier API. Please do not retry within the next 60 minutes. Contact Syniverse customer support.

 

 

 

Application Address: Long Code HTTP Error and ESS Events

 

The flow of provisioning application addresses needs to consider 2 level of errors HTTP and ESS as higlighted in the following diagram.

 

Long Code API HTTP ERROR Response ADD/DELETE operations (V1/V2)

 

10DLC API REQUEST

10DLC API RESPONSE BODY

LONGCODE_ADDITION/LONGCODE_DELETION

when campaign is not in DEPLOYED state

{
"code": 400,
"message": "Longcode cannot be added/deleted as Campaign is not Deployed.",
"status": "BAD_REQUEST",
"timestamp": "06-07-2022 12:44:28",
"data": null
}

DUPLICATE LONGCODE_ADDITION/LONGCODE_DELETION

·         when Longcode is not in ADDED state for ADDITION

·     when Longcode is not in in DELETED state for DELETION

{
    "code": 202,
    "message": "Request already in Progress.",
    "status": "ACCEPTED",
    "timestamp": "07-07-2022 03:07:49",
    "data": null
}

CONFLICT LONGCODE_ADDITION/LONGCODE_DELETION 

·     when Longcode is already ADDED state for LONGCODE_ADDITION

·     when Longcode is already in DELETED state for LONGCODE_DELETION

 {
"code": 409,
"message": "Request already completed.",
"status": "CONFLICT",
"timestamp": "06-07-2022 12:45:06",
"data": null
}

LONGCODE_ADDITION/LONGCODE_DELETION with invalid longcode format

{
"code": 400,
"message": "Invalid Longcode. Longcode must be a number.",
"status": "BAD_REQUEST",
"timestamp": "06-07-2022 01:53:10",
"data": null
}

LONGCODE_ADDITION/LONGCODE_DELETION with correct campaign id and incorrect Longcode size

{
"code": 400,
"message": "Invalid Longcode. Longcode must be 11 digits and must start with country code 1.",
"status": "BAD_REQUEST",
"timestamp": "28-07-2022 10:10:19",
"data": null
}

LONGCODE_ADDITION/LONGCODE_DELETION when Longcode is already associated with another campaign

{
"code": 400,
"message": "Longcode cannot be added as it is already associated with another campaign.",
"status": "BAD_REQUEST",
"timestamp": "06-07-2022 12:51:47",
"data": null
}

LONGCODE_ADDITION/LONGCODE_DELETION when customer daily requests limit exhausted

{
"code": 400,
"message": "Request failed. Daily quota exceeded.",
"status": "BAD_REQUEST",
"timestamp": "06-07-2022 01:53:10",
"data": null
}

 

LONGCODE_ADDITION when long code limit exhausted 

{
"code": 400,
"message": "Longcode cannot be added to campaign. Limit exceeded.",
"status": "BAD_REQUEST",
"timestamp": "06-07-2022 01:53:10",
"data": null
}

LONGCODE_DELETION request when long code is not added to the campaign

{
"code": 400,
"message": "Longcode cannot be deleted as it is not associated with campaign.",
"status": "BAD_REQUEST",
"timestamp": "06-07-2022 01:53:10",
"data": null
}

LONGCODE_ADDITION OR LONGCODE_DELETION

Throttling Error

HTTP/1.1 429

<amt:fault xmlns:amt=http://wso2.org/apimanager/throttling><amt:code>900804</amt:code><amt:message>Message throttled out</amt:message><amt:description>You have exceeded your quota</amt:description><amt:nextAccessTime>2022-Apr-13 19:24:00+0000 UTC</amt:nextAccessTime></amt:fault>

 

Long Code ESS NOTIFICATION structure

Field Data Type Mandatory Description
application_id INTEGER yes Application ID - SDC provides this parameter
company_id INTEGER yes Company ID - SDC provides this parameter
longcode STRING yes 10DLC Longcode Number
longcode_status STRING  yes Longcode state change (PENDING/DEPLOYED/ADDED/ADD_FAILED/MARK_DELETE/DELETED/DELETE_FAILED/REMOVED/REMOVE_FAILED)
longcode_description STRING  no Longcode status description
reason_code STRING  yes Request Reason code 
reason_description STRING yes Request Reason Description
tcr_campaignId STRING yes TCR Campaign ID

 

 Long Code ESS NOTIFICATION error description

Syniverse will provide the following errors when the campaign provisioning automation sends a longcode_description ": "*_FAILED" ESS NOTIFICATION Event.

Simplified error notifications in longcode_description field

INFO: Please review this number history with your customer, seems it belongs to another aggregator. If you think this is an error, please contact customer support and provide proof of ownership and authorization to text enable the number.

INFO: Campaign/Longcode already processed. Duplicate request ignored.

INFO: Campaign/Longcode could not be processed as one or more params are invalid. Syniverse will remediate.

RETRY: Campaign/Longcode could not be processed even after system retries owing to intermittent MNO error. Longcode retry is advisable after 10 minutes before contacting Syniverse customer support. For failed campaigns contact Syniverse support directly.

RETRY: Campaign/Longcode could not be processed even after system retries owing to MNO throttling error. Longcode retry is advisable after 10 minutes before contacting Syniverse customer support. For failed campaigns contact Syniverse support directly.

RETRY: Carrier API error. Contact TCR to confirm Content Provider creation on T-Mobile. Then retry.

TICKET: Campaign/Longcode could not be processed as MNO error requires investigation / remediation. Please contact Syniverse customer support.

TICKET: Connection problem in the MNO carrier API. Please do not retry within the next 60 minutes. Contact Syniverse customer support.

TICKET: Please verify and fix the following fields in TCR, then contact Syniverse support for remediation. name <= 50 chars, contentprovider-name <= 50 chars, campaign-overview <= 4000 chars, messaging-flow <= 4000 chars, help-message <= 4000 chars, description <= 4000 chars, address <= 255 chars.

TICKET: Throttling problem in the MNO carrier API. Please do not retry within the next 60 minutes. Contact Syniverse customer support.

 

Application Address: NumberPool (Campaign Id based) HTTP and ESS Errors

Campaign Id based Number Pool API HTTP Error Response ADD operations (V1/V2)

10DLC API REQUEST

10DLC API RESPONSE

CAMPAIGNID BASED NUMBERPOOL_ADDITION request with wrong Number Pool type

URL(POST)https://api-int.syniverse.com/engage/tendlc-services/v2/campaigns/CQJBKWO/pools/CQJBKWO-103776/types/CampaignIdxxx

{
"code": 400,
"message": "Number Pool type is invalid.",
"status": "BAD_REQUEST",
"timestamp": "08-07-2022 01:02:43",
"data": null
}

CAMPAIGNID BASED NUMBERPOOL_ADDITION request but campaign is different

URL(POST):https://api-int.syniverse.com/engage/tendlc-services/v2/campaigns/CQJBKWO/pools/CQJBKWP-103776/types/CampaignId

{
"code": 400,
"message": "Number Pool does not match with campaign.",
"status": "BAD_REQUEST",
"timestamp": "08-07-2022 01:02:21",
"data": null
}

CAMPAIGNID BASED NUMBERPOOL_ADDITION request but NNID is not valid.

{
"code": 400,
"message": "NNID invalid.",
"status": "BAD_REQUEST",
"timestamp": "08-07-2022 01:03:49",
"data": null
}

CAMPAIGNID BASED NUMBERPOOL_ADDITION request but Campaign is not in DEPLOYED state.

{
"code": 400,
"message": "Number Pool cannot be added/deleted as Campaign is not Deployed.",
"status": "BAD_REQUEST",
"timestamp": "08-07-2022 01:03:29",
"data": null
}

CAMPAIGNID BASED NUMBERPOOL_ADDITION request

when the Number Pool is already associated with other campaign.

{
"code": 400,
"message": "Number Pool cannot be added as it is already associated with another campaign.",
"status": "BAD_REQUEST",
"timestamp": "08-07-2022 01:04:29",
"data": null
}

CAMPAIGNID BASED NUMBERPOOL_ADDITION request

when the Number Pool Limit exceeded

{
"code": 400,
"message": "Number Pool cannot be added to campaign. Limit exceeded.",
"status": "BAD_REQUEST",
"timestamp": "06-07-2022 01:53:10",
"data": null
}

CAMPAIGNID BASED NUMBERPOOL_ADDITION when daily limit is exhausted

{
"code": 400,
"message": "Request failed. Daily quota exceeded.",
"status": "BAD_REQUEST",
"timestamp": "06-07-2022 01:53:10",
"data": null
}

 

Campaign Id based Number Pool API HTTP Error Response DELETE operations (V1/V2)

10DLC API REQUEST

10DLC API RESPONSE

CAMPAIGN BASED NUMBERPOOL_DELETION request when campaign id is different

URL(DELETE): https://api-int.syniverse.com/engage/tendlc-services/v2/campaigns/CQJBKWO/pools/CQJBKWP-104102

{
"code": 400,
"message": "Number pool does not match with campaign.",
"status": "BAD_REQUEST",
"timestamp": "08-07-2022 01:06:22",
"data": null
}

CAMPAIGN BASED NUMBERPOOL_DELETION request when NNID is not valid.

{
"code": 400,
"message": "NNID invalid.",
"status": "BAD_REQUEST",
"timestamp": "08-07-2022 01:07:55",
"data": null
}

CAMPAIGN BASED NUMBERPOOL_DELETION request when Campaign is not in DEPLOYED state.

{
"code": 400,
"message": "Number Pool cannot be added/deleted as Campaign is not Deployed.",
"status": "BAD_REQUEST",
"timestamp": "08-07-2022 01:08:29",
"data": null
}

CAMPAIGN BASED NUMBERPOOL_DELETION when the Number Pool is not in ADDED state.

{
"code": 400,
"message": "Number Pool cannot be deleted as it is not associated to the campaign.",
"status": "BAD_REQUEST",
"timestamp": "08-07-2022 01:09:45",
"data": null
}

CAMPAIGN BASED NUMBERPOOL_DELETION when daily limit is exhausted

{
"code": 400,
"message": "Request failed. Daily quota exceeded.",
"status": "BAD_REQUEST",
"timestamp": "06-07-2022 01:53:10",
"data": null
}

 

 

Number Pool ESS NOTIFICATION error description

NOTIFICATION Event Topic: TenDlc-Provisioning-V2

NOTIFICATION Event Type: TenDlc_Campaign_NumberPool_Update_V2

Field Data Type Mandatory Description
application_id INTEGER yes Application ID - SDC provides this parameter
company-id INTEGER yes Company ID - SDC provides this parameter
campaign_status STRING  yes Campaign state change (DEPLOYED/REGISTERED/EXPIRED/FAILED/PENDING)
reason_code STRING  yes Response Reason code : state change (PENDING/ADDED/ADD_FAILED/MARK_DELETE/DELETED/DELETE_FAILED)
reason_description STRING yes Response Reason Description
tcr_campaignId STRING yes TCR Campaign ID
number_pool_type STRING yes Type of Number Pool based on SubId or based on Campaign Id
number_pool_id STRING yes Number Pool Id that represents the Number Pool in TMO

 

Syniverse will provide the following errors when the Number Pool (CampaignId and Sub Id) provisioning automation sends ESS NOTIFICATION error description with "reason_code" : "*_FAILED".

Simplified error notifications in reason_description field

INFO: Please review this number history with your customer, seems it belongs to another aggregator. If you think this is an error, please contact customer support and provide proof of ownership and authorization to text enable the number.

INFO: Campaign/Longcode already processed. Duplicate request ignored.

INFO: Campaign/Longcode could not be processed as one or more params are invalid. Syniverse will remediate.

RETRY: Campaign/Longcode could not be processed even after system retries owing to intermittent MNO error. Longcode retry is advisable after 10 minutes before contacting Syniverse customer support. For failed campaigns contact Syniverse support directly.

RETRY: Campaign/Longcode could not be processed even after system retries owing to MNO throttling error. Longcode retry is advisable after 10 minutes before contacting Syniverse customer support. For failed campaigns contact Syniverse support directly.

RETRY: Carrier API error. Contact TCR to confirm Content Provider creation on T-Mobile. Then retry.

TICKET: Campaign/Longcode could not be processed as MNO error requires investigation / remediation. Please contact Syniverse customer support.

TICKET: Connection problem in the MNO carrier API. Please do not retry within the next 60 minutes. Contact Syniverse customer support.
 

TICKET: Please verify and fix the following fields in TCR, then contact Syniverse support for remediation. name <= 50 chars, content provider name <= 50 chars, campaign-overview <= 4000 chars, messaging-flow <= 4000 chars, help-message <= 4000 chars, description <= 4000 chars, address <= 255 chars.

TICKET: Throttling problem in the MNO carrier API. Please do not retry within the next 60 minutes. Contact Syniverse customer support.

 

 

 

Application Address: Number Pool  (SubId based) HTTP and ESS Errors

 

 

Sub Id based Number Pool API HTTP Error Response ADD operations (V1/V2)

10DLC API REQUEST

10DLC API RESPONSE

SUBIDBASED NUMBERPOOL_ADDITION request with wrong Number pool type

Send POST request

URL (POST):-https://api-int.syniverse.com/engage/tendlc-services/v2/campaigns/CQJBKWO/pools/CUST_SYN3-999000/types/SubId

{
"code": 400,
"message": "Number Pool type is invalid.",
"status": "BAD_REQUEST",
"timestamp": "08-07-2022 01:15:43",
"data": null
}

SUBID BASED NUMBERPOOL_ADDITION request when NNID is not valid.

{
"code": 400,
"message": "NNID invalid.",
"status": "BAD_REQUEST",
"timestamp": "08-07-2022 01:16:49",
"data": null
}

SUBID BASED NUMBERPOOL_ADDITION request but Campaign is not in DEPLOYED state.

{
"code": 400,
"message": "Number Pool cannot be added/deleted as Campaign is not Deployed.",
"status": "BAD_REQUEST",
"timestamp": "08-07-2022 01:17:29",
"data": null
}

SUBID BASED NUMBERPOOL_ADDITION request when
Number Pool is already associated with other campaign.

{
"code": 400,
"message": "Number Pool cannot be added as it is already associated with another campaign.",
"status": "BAD_REQUEST",
"timestamp": "08-07-2022 01:18:34",
"data": null
}

SUBID BASED NUMBERPOOL_ADDITION request when
Number Pool limit exceeded

{
"code": 400,
"message": "Number Pool cannot be added to campaign. Limit exceeded.",
"status": "BAD_REQUEST",
"timestamp": "06-07-2022 01:53:10",
"data": null
}

SUBID BASED NUMBERPOOL_ADDITION request when
daily limit is exhausted

{
"code": 400,
"message": "Request failed. Daily quota exceeded.",
"status": "BAD_REQUEST",
"timestamp": "06-07-2022 01:53:10",
"data": null
}

 

 

Sub Id based Number Pool API HTTP Error Response DELETE operations (V1/V2) 

10DLC API REQUEST

10DLC API RESPONSE

SUBID BASED NUMBERPOOL_DELETION request when NNID is not valid.

{
"code": 400,
"message": "NNID invalid.",
"status": "BAD_REQUEST",
"timestamp": "08-07-2022 01:40:49",
"data": null
}

SUBID BASED NUMBERPOOL_DELETION request but Campaign is not in DEPLOYED state.

{
"code": 400,
"message": "Number Pool cannot be added/deleted as Campaign is not Deployed.",
"status": "BAD_REQUEST",
"timestamp": "08-07-2022 01:50:29",
"data": null
}

SUBID BASED NUMBERPOOL_DELETION when the Number Pool is not in ADDED state.

{
"code": 400,
"message": "Number Pool cannot be deleted as it is not associated to the campaign.",
"status": "BAD_REQUEST",
"timestamp": "08-07-2022 01:59:45",
"data": null
}

SUBID BASED NUMBERPOOL_DELETION when daily limit is exhausted

{
"code": 400,
"message": "Request failed. Daily quota exceeded.",
"status": "BAD_REQUEST",
"timestamp": "06-07-2022 01:53:10",
"data": null
}

 

Number Pool ESS NOTIFICATION error description

NOTIFICATION Event Topic: TenDlc-Provisioning-V2

NOTIFICATION Event Type: TenDlc_Campaign_NumberPool_Update_V2

Field Data Type Mandatory Description
application_id INTEGER yes Application ID - SDC provides this parameter
company-id INTEGER yes Company ID - SDC provides this parameter
campaign_status STRING  yes Campaign state change (DEPLOYED/REGISTERED/EXPIRED/FAILED/PENDING/SUSPEND)
reason_code STRING  yes Response Reason code : state change (PENDING/ADDED/ADD_FAILED/MARK_DELETE/DELETED/DELETE_FAILED)
reason_description STRING yes Response Reason Description
tcr_campaignId STRING yes TCR Campaign ID
number_pool_type STRING yes Type of Number Pool based on SubId or based on Campaign Id
number_pool_id STRING yes Number Pool Id that represents the Number Pool in TMO

 

Number Pool ESS NOTIFICATION error description

 

Syniverse will provide the following errors when the Number Pool (CampaignId and Sub Id) provisioning automation sends ESS NOTIFICATION error description with "reason_code" : "*_FAILED".

Simplified error notifications in reason_description field

INFO: Please review this number history with your customer, seems it belongs to another aggregator. If you think this is an error, please contact customer support and provide proof of ownership and authorization to text enable the number.

INFO: Campaign/Longcode already processed. Duplicate request ignored.

INFO: Campaign/Longcode could not be processed as one or more params are invalid. Syniverse will remediate.

RETRY: Campaign/Longcode could not be processed even after system retries owing to intermittent MNO error. Longcode retry is advisable after 10 minutes before contacting Syniverse customer support. For failed campaigns contact Syniverse support directly.

RETRY: Campaign/Longcode could not be processed even after system retries owing to MNO throttling error. Longcode retry is advisable after 10 minutes before contacting Syniverse customer support. For failed campaigns contact Syniverse support directly.

RETRY: Carrier API error. Contact TCR to confirm Content Provider creation on T-Mobile. Then retry.

TICKET: Campaign/Longcode could not be processed as MNO error requires investigation / remediation. Please contact Syniverse customer support.

TICKET: Connection problem in the MNO carrier API. Please do not retry within the next 60 minutes. Contact Syniverse customer support.
 

TICKET: Please verify and fix the following fields in TCR, then contact Syniverse support for remediation. name <= 50 chars, content provider name <= 50 chars, campaign-overview <= 4000 chars, messaging-flow <= 4000 chars, help-message <= 4000 chars, description <= 4000 chars, address <= 255 chars.

TICKET: Throttling problem in the MNO carrier API. Please do not retry within the next 60 minutes. Contact Syniverse customer support.

 

 

 

Copyright © 2023 Syniverse Technologies