TFNRegistry API: SMS Carrier Notification/Approval (UNS-SNA)

Added to Routing

01 - CIC addition.

Possible Routing Change

02 - possible CIC routing change.

Deleted from Routing at SCP (Working CR) Deleted from Routing at SCP (Disconnect CR)

03 - CIC deletion. CIC removed from routing at SCP for a Working (Active) and Disconnected CR.

this maps to Unsolicited Notification Notify field selected and a Domain and Port is entered

04 - Resp Org Change.

Added to Routing

05 - Cancel CIC addition. This is a cancellation of code 01.

Possible Routing Change

06 - Cancel routing change.

Possible Routing Change and/or Added to Routing

(this is applicable to the GNA page, not the Entity Notification & Approval Setup (ENA) page)

07 - Approval resent of ‘like’ ungranted CR.

Possible Routing Change and/or Added to Routing

08 - Pending CR deleted.

Possible Routing Change and/or Added to Routing

(this is applicable to the GNA page, not the ENA page)

09 - Cancel approval resend. This is a cancellation of code 07.

N/A

99 - This code is reserved for future use.

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 for the submitting (new) Resp Org.

Alphanumeric (5).

oldRespOrgId

The controlling (current, old) Resp Org ID for the record.

Alphanumeric (5).

custRecStat

Status of the Customer Record:

• SENDING
• ACTIVE
• DISCONNECT
• FAILED due to SCP Rejection
• FAILED due to Revalidation
• FAILED due to Incorrect Status
• FAILED due to rejection because of approvals

apprStat

Approval status of the Customer Record:

• NA - not applicable
• OK - all required approvals received
• AW - awaiting at least one carrier approval
• DN - at least one affected carrier denied the approval request
• NR - approvals are not required for this record
• RJ - record is rejected due to effective date of NOW

lastApprRcvdDt

The standard format for date and time is: YYYY-MM-DDTHH:MMZ

Corresponds to the date and time when TFNRegistry™ last received a response from a Carrier (CIC). Please refer to the API Overview document for more information.

apprReason

Record Activity Which Triggered Notification/Approval:

• 01 = CIC addition; added CIC (added your CIC on a CR).
• 02 = possible CIC routing change; routing change on a CR that uses your CIC.
• 03 = CIC deletion; deleted CIC (removed your CIC from a CR).
• 05 = Cancel CIC addition.
• 06 = Cancel routing change; cancel CIC change.
• 07 = Approval resend - previous pending record, with approval status of denied or awaiting, was copied and no record change was made; ungranted like record.
• 08 = Record deletion.
• 09 = Cancel approval resend; cancelled like record (similar CR).
• 99 = Other.

ptrRecCount

6 bytes numeric

Count of number of Pointer Records for the Template Record.

Mandatory if a Template Record is present.

interLATACarrier

List of 20 CICs.

Each CIC can have up to 8 characters.

InterLATA carrier used in the Customer Record.

intraLATACarrier

List of 20 CICs.

Each CIC can have up to 8 characters.

IntraLATA carrier used in the Customer Record

cprsectName->{priInterLT}

8 bytes text string (optional); format is: ACNA-CIC

cprSectName->{priIntraLT}

8 bytes text string (optional); format is: ACNA-CIC

Referral

Indicates the type of recorded message that the caller will hear for ‘Disconnect’ records:

• Yes = With referral - the announcement message will refer the caller to another number.
• No = Without referral - the announcement message will merely state that the number is no longer in service.

endInterceptDt

Date the Toll-Free Number will be removed from intercept, such that the caller will no longer receive disconnected announcements.

The standard format for date is: YYYY-MM-DD

Please refer to the API Overview document for more information.

endSub

The name of the business, organization or other entity of the Toll-Free subscriber as it is to appear in their Toll-Free directory listing.

Up to 30 alphanumeric characters.

endSubAddr

The address of the Toll-Free subscriber’s name, business, or organization.

Up to 75 alphanumeric characters.

aos->{aosLbl}

Object which includes the Area of Service (AOS) label type, its name and the definition of the label (defined in ASL):

• List – maximum of 16 objects (Labels).
• Label Type – 3 alpha.
• Label Name – 7 alpha numeric.

aos ->{aosNPA}

A valid Network code from the table ‘AOS Network Codes:

• List - Maximum 0f 34 values.
• Each value - 2 byte numeric.

aos->{aosLATA}

A valid LATA code from the table ‘Latas Table’:

• List - Maximum 0f 34 values.
• Each value - 3 byte numeric.

aos->{aosNet}

A valid Network code from the table ‘AOS Network Codes’:

• List - Maximum 0f 23 values.
• Each value - 2 byte alpha numeric.

aosState

A valid State code from the table ‘State/Province/Territory Codes’:

• List - Maximum 0f 46 values.
• Each value - 2 byte alpha numeric.

aosRecord

Array of Listing Names.

Each is 75 bytes text string (optional).

destNums->{destNum}

destNums->{numTermLine}

destNums->{forServOff}

destNums->{localServOff}

List of destination numbers and related attributes to which calls to the TFN may be routed:

• List – Maximum of 999 objects

Attributes include:

• Destination Number (DTN): 10 numeric
• Number of Terminating Lines (NTL): 1-9999 numeric
• Local Serving Office (LSO): 6 numeric
• Foreign Serving Office (FSO): 6 numeric

lbl ->{lblType}

lbl->{lblName}

lbl->{lblVals}

Label definitions for that Customer Record (CR or TR):

• Label Name, Label Type, Label Value

cprSectName -> {name}

cprSectName -> {nodeSeq}

Call Processing Record (CPR) for that Customer Record or Template Record (CR or TR).

List of CPR Nodes.

cicList->{cicCode}

cicList->{networkId}

Indicates the CIC listed on the Customer Record, to whom the message applies:

• 6 bytes text string maximum (required).
• 4 bytes supported for the CIC and 2 bytes supported for the network identifier (such as BA, PC, etc.).
• All CICs except 0110 are candidates for approval requests.

Carrier

Indicates the CIC listed on the Customer Record, to whom the message applies.

Maximum of 8 characters

conName

The name of the Customer or Contact Person who initiated the Service Order for creating the CR.

Up to 30 alphanumeric characters.

conTel

The phone number of the contact person who initiated the Service Order (svcOrderNum) for creating the CR.

Can be a Toll-Free Number or POTS number.

Notes

Descriptive information related to the Service Order (svcOrderNum) or Supplementary Form (suppFormNum), that needs to be stored in the Customer Record.

Up to 151 alphanumeric characters.

hldIndFlag

Indicates that the record is to be held in the TFNRegistry and not activated and sent to the SCPs even if the effective date and time is reached or passed.

svcOrderNum

Required field, unless the Supplementary Form (suppFormNum) is entered.

Alphanumeric (4-13).

suppFormNum

Required field, unless the Service Order (svcOrderNum) is entered.

Alphanumeric (1-6).

Agent

Identifies an agent subscriber who has on-line access to the CR in the TFNRegistry.

Alphanumeric (5).

Telco

Identifies the company that provided the TFNRegistry access to a subscriber or agent.

The first 4 characters of the user’s Resp Org ID when creating a new CR.

cprSectName->{tmZn}

Time zone indicator for the entire Call Processing Record (CPR) portion of the CR or for specific value of node.

1 byte identifier (optional)

Allowable values are: A (Atlantic), B (Bering), C (Central), E (Eastern), H (Hawaiian-Aleutian), M (Mountain), N (Newfoundland), P (Pacific), or Y (Alaska) default value: C

cprSectName-> {dayLightSavings}

1 byte identifier (optional) allowable values are:

• Y (Yes)
• N (No)

Default value: Y

errList-> errCode

Error explanation:

• 01 = Warning - Record data returned is incomplete due to size.
• 02 = Warning - Record contains more sections not supported by UNS-SNA.

apprReq

Indicates that approval is requested of carrier prior to SCP record download:

• Boolean (Yes or No)