The TFNRegistry™ API sends the Customer Record Audit/Resend (UNS-SCP) Unsolicited Message to Resp Orgs that have this message configured on the Unsolicited Notice Control (GUN) page in the TFNRegistry and. Additionally, the Resp Org will receive this message via the TFNRegistry API when they have first sent the SCP Status Query/Resend/Audit (REQ-SCP) API call on regular Customer Records, Pointer Records and Template Records. REQ-SCP message is sent by providing the CrResendAuditResults (Domain Name and Port). Please Note: All Asynchronous Callback URLs can only be utilized via Port 443 with SSL/TLS encryption. The messages that are sent from the Production and Sandbox TFNRegistry are sent over the public internet. Please refer to the Chapter titled, "How to Register for Unsolicited Messages" in this document for more information.
The TFNRegistry sends back the results which include indication of whether or not the resend or audit succeeded or indication that the resend or audit is queued and still waiting for a response from the SCP.
The TFNRegistry sends this message as each group of SCPs respond. Because SCPs may respond at various times, this message may be sent multiple times to the users as each separate set of SCPs respond to the request.
If the resend is queued at the SCP, whenever the SCP responds, a new message is sent indicating the success or failure of the resend/audit.
End Point URL
/v3/ext/uns/scp
JSON Format
JSON message structure for UNS-SCP message.
{
“tfNum”: “”,
“tmplName”: “”,
“effDtTm”: “”,
“RespOrgId”: “”,
“scpResult": { => array of objects {
{
“scpId”: “”,
“resultCode”: “”
},
{
“scpId”: “”,
“resultCode”: “”
}
}
},
“crResendAuditResults”: { =>array of objects {
{
“callbackDestList” : [
{
“domainName”: “”,
“port”: “”
}
}
}
}
Parameter Descriptions
Table 5: UNS-SCP Parameter Descriptions
|
Table 5: UNS-SCP Parameter Descriptions |
|
|
Parameter |
Description |
|
tfNum |
Populated if the Customer Record is a regular Customer Record or a Pointer Record.
xxx-nxx-xxxx, where:
xxx = (NPA), 800 and other open 8xx codes nxx = (NXX) digits xxxx= (LINE) digits |
|
tmplName |
A unique template name which identifies the template, this contains the routing information for the Pointer Record. 15-character identifier starting with an asterisk (*). |
|
effDtTm |
The standard format for date and time is: YYYY-MM-DDTHH:MMZ Effective Date and Time of the Customer Record that is sent in the notification. Please refer to the API Overview document for more information. |
|
RespOrgId |
Resp Org that sent the corresponding REQ-SCP message that this UNS-SCP message was triggered by. Alphanumeric (5). |
|
scpResult ->{scpId} |
Name of an affected SCP (in Area of Service (AOS)). Alphanumeric (4). |
|
crResendAuditResults |
It indicates requested Customer Record Audit/Resend (CRA/CRR) through REQ-SCP message. |
|
scpResult ->{result} |
The result of the sent request to the affected SCP:
|