Name
BatchCarrierExpressChange Send a change request for a group of toll-free numbers to a single carrier via the Carrier Express system.
Description
BatchCarrierExpressChange sends a change 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 change.
  • ATT
  • Sinch
* dnlist The list of numbers to be changed.

The following parameters are used only when carrier is set to ATT.
* action The type of service to be changed. Valid values are:
  • iptf360
* profilename Name of profile containing a group of shared values used in place of individual values.
distgroup Distribution group
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.
* changetype The type of change being made.

Valid values include any combination of: R, P, and D

where

  • R = RespOrg
  • P = Payphone Indicator
  • D = Distribution Group
changetype restrictions include:
  • all values must be upper-case.
  • values should not be separated by any characters, e.g. "R,D" or "R D" are invalid.
  • values should match the change fields that are set: resporg, payphoneind, and distgroup.
  • values may be combined in any order, e.g. when setting resporg and distgroup, "RD" or "DR" are both valid.
* 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.

The following parameters are used only when carrier is set to Sinch. These parameters are all required for this carrier.
customerOrderReference The alpha-numeric customer order reference identifier.
* changetype The type of change being made.

Valid values are one of: R, D, T or X

where

  • R = set Routing Label
  • D = set DNIS
  • T = set Term TN
  • X = remove DNIS
changetype restrictions include:
  • all values must be upper-case.
  • only one character is allowed to be specified.
  • values should match the change field that is set:
    R: routingLabel must be set
    D: dnis must be set
    T: termTn must be set
    X: Indicates dnis will be removed at Sinch. No fields (except customerOrderReference) may be set.
routingLabel The routing option to assign the Toll-Free Number. Alpha-numeric and dash are valid characters.
dnis The DNIS digits passed on during the call. Must be numeric.
termTn The terminating Toll-Free Number. If specified, it must be 10 digits.
Example
The following request parameters will change a list of numbers in AT&T's network.
carrier~ATT;dnlist~8005551212,8885551212;mcn~F1234567;action~iptf360;contactname~Joe Q. Contact;contactphone~7323020222;