The TFNRegistry™ API sends the Carrier Approval Status (UNS-ACT) Unsolicited Message to Resp Orgs that have this message configured on the Unsolicited Notice Control (GUN) page in the TFNRegistry.
This message is sent to the controlling Resp Org when all approvals are received for a Customer Record (regular Customer Record or Pointer Record) or Template Record; or when an involved carrier has denied an approval request.
End Point URL
/v3/ext/uns/act
JSON Format
JSON message structure for UNS-ACT message.
{
“tfNum”: “”,
“tmplName”: “”,
“effDtTm”: “”,
“RespOrgId”: “”,
“apprInf”: “”,
“cicCode”: “”,
“respTime”: “”,
“reason”: “”
}
Parameter Descriptions
Table 2: UNS-ACT Parameter Descriptions
|
Table 2: UNS-ACT 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 |
It is the Resp Org ID of the user.
Alphanumeric (5). |
|
apprInf |
Approval Information: · 01 = all approvals have been received. · 02 = an involved routing carrier has denied an approval request. |
|
cicCode |
Carrier Identification Code (CIC) Code: Identifies the affected carrier to whom this message applies. Sent only in case the message is not sent to the controlling (current, old) Resp Org.
Alphanumeric (6). |
|
respTime |
The standard format for respTime is: YYYY-MM-DDTHH:MMZ
Time of Response Receipt by TFNRegistry™ from carrier.
Returned only if apprInf is 02.
Please refer to the API Overview document for more information. |
|
Reason |
Reason for Denial: Specifies why the carrier denied the approval request returned only if apprInf is 02.
2 bytes text string |