Name
BatchCarrierExpressActivate Send an activate request for a group of toll-free numbers to a single carrier via the Carrier Express system.
Description
BatchCarrierExpressActivate sends an activate request to a single carrier for a group of toll-free numbers. The following are the allowed fields in reqparams:
* carrier The carrier on which the specified number is to be activated. Valid values are:
  • ATT
  • Lumen-5102
  • Sinch
  • Verizon-0222
* dnlist The list of numbers to be activated.
The following parameters are used only when carrier is set to ATT.
* action The type of service to be activated. Valid values are:
  • iptf360
* profilename Name of profile containing a group of shared values used in place of individual values.
* contactname The contact name for this toll-free number. Its maximum size is 30 characters.
* contactphone The contact phone number for this toll-free number.
clientorderno The purchase order number/client order number for this toll-free number. Its maximum size is 21 characters.
* payphoneind Indicates whether or not payphone calls are blocked.

Valid values are upper-case Y or N.

* resporg The RespOrg of the toll-free number.
The following parameters are used only when carrier is set to Lumen-5102.
customernumber The Lumen customer number. This parameter is required for this carrier.
billingaccount The Lumen billing account. This parameter is required for this carrier.
billingtelno The billing telephone number which must be a valid POTS number. This parameter is required for this carrier.
resellerclientid The Reseller Client ID.
servicearea The network area of service. Valid values are:
  • US
  • XA
  • XB
  • XC
This parameter is required for this carrier.
Lumen allows 2 forms of routing, based on the type of termination for this record. The two termination types are known as shared and unique. All parameters above this note are common values associated with all Lumen records. All parameters below this note are associated with either shared or unique routing.

A shared record only sets the routename parameter.

A unique record uses a combination of all remaining parameters: priringtonumber, priswitch, pritrunk, pridnis, altringtonumber altswitch, alttrunk, altdnis, secaltswitch, secalttrunk, secaltdnis.

If shared and unique routing parameters are both specified in a single API call, 8MS will reject that call with a validation error indicating that conflicting parameters have been specified in a single call.

routename The Route Name for this toll-free number.

This field is associated with the shared termination type.

priringtonumber The primary Ring To Number (Translated WTN) which must be a valid POTS number. This can be the same as billingtelno.

This field is associated with the unique termination type.

altringtonumber An alternate Ring To Number (Translated WTN) which must be a valid POTS number.

This field is associated with the unique termination type.

priswitch The primary Switch used for routing calls for this toll-free number.

This field is associated with the unique termination type.

pritrunk The Trunk Group associated with the specified priswitch.

This field is associated with the unique termination type.

pridnis The DNIS digits passed on during the call, associated with the specified priswitch. If specified it must be 2-10 digits or the string "TFN".

This field is associated with the unique termination type.

altswitch The alternate Switch used for routing calls for this toll-free number.

This field is associated with the unique termination type.

alttrunk The Trunk Group associated with the specified altswitch.

This field is associated with the unique termination type.

altdnis The DNIS digits passed on during the call, associated with the specified altswitch. If specified it must be 2-10 digits or the string "TFN".

This field is associated with the unique termination type.

secaltswitch The secondary alternate Switch used for routing calls for this toll-free number.

This field is associated with the unique termination type.

secalttrunk The Trunk Group associated with the specified secaltswitch.

This field is associated with the unique termination type.

secaltdnis The DNIS digits passed on during the call, associated with the specified secaltswitch. If specified it must be 2-10 digits or the string "TFN".

This field is associated with the unique termination type.

* productAbbr The abbreviation identifying the product. Valid values are:
  • 8XX
customerOrderReference The customer order reference identifier.
routingLabel The routing option to assign the Toll-Free Number. This is optional for Dedicated service and must not be set for Switched service. Alpha-numeric and dash are valid characters.
dnis The DNIS digits passed on during the call. This is optional for Dedicated service and must not be set for Switched service. Must be numeric.
billingTn The billing Toll-Free Number. If specified, it must be 10 digits.
termTn The terminating Toll-Free Number. If specified, it must be 10 digits.

This is optional for Switched service and must not be set for Dedicated service.

dnis, termTn and routingLabel are mutually exclusive. Only one of these parameters may be set.
The following parameters are used only when carrier is set to Verizon-0222. These parameters are all required for this carrier.
* corpid The Verizon Corp ID in which to activate this number.
* planid The Verizon Plan ID to be used for routing this number.
Example
The following request parameters will activate a group of numbers in Verizon's CIC 0222 network.
carrier~Verizon-0222;dnlist~8005551212,8885551212;corpid~ABC123;planid~1