Name
Reserve Reserve numbers
Description
Reserve is used to reserve numbers in the SMS/800 database. The following are the allowed fields in reqparams:
numbers A comma-separated list of up to 10 particular numbers to be reserved, or a single number containing either * or & (i.e., a pattern or wildcard search).
* resporg The resporg to be associated with any numbers reserved.
npa The NPA of the toll-free number(s).
nxx The starting NXX of the toll-free number(s).
line The starting line of the toll-free number(s).
npalist A comma-separated list of NPA's: 800, 888, 877, 866, 855, 844 or 833.
numberword The number being searched for. The format is 1-7 characters. Valid characters include:
  • alpha-numeric,
  • * (match any character),
  • & (repeat a digit - e.g. &0&1 finds 7071, 8081)
  • % (a second repeating digit - e.g. &%&% finds 7070, 8080, 1212, 3434)
  • ^ (starts with), and
  • $ (ends with).
trailingdigits The number of trailing digits: 0, 1 or 2.
If trailingdigits is 0, 1 or 2 the search will return results that match up to the trailingdigits value.

If no trailingdigits parameter is specified, the search is first executed with a trailingdigits value of 0. If no results are returned then a second search is executed with a trailingdigits value of 2.

count The count of numbers to be reserved. Note that if count is not specified, it is defaulted to 1, regardless of the actual amount of numbers specified in the numbers field.
contiguous Whether or not the reserved numbers must be contiguous; value must be 0 or 1.
minimum For a contiguous request, the minimum count of numbers that is acceptable. For example, if a request for 100 contiguous numbers cannot be satisfied, with a minimum of 50, 50 contiguous numbers will be returned if available.
* cname The contact person name.
* cphone The contact person phone number.
notes Descriptive notes.
numlist If set to 1, number lists will be created containing the numbers successfully reserved, and those that were not reserved. If set to 0 or omitted, no such lists are made.
nlname The name of the number list to be created. This is only used if numlist is set to 1.
custname This field is used for individual company auditing and tracking purposes, allowing a company to track the customer for which this number was reserved. This field is stored on 8MS only; it is not sent to SMS/800.
btn This field is used for individual company auditing and tracking purposes, allowing a company to track the billing telephone number for which this number was reserved. This field is stored on 8MS only; it is not sent to SMS/800.
onum_sreq This field is used for individual company auditing and tracking purposes, allowing a company to track the order number or service request for which this number was reserved. This field is stored on 8MS only; it is not sent to SMS/800.
Depending on what fields are used for the query, a Search request may first be generated to 800ForAll. The following fields will generate a Search to 800ForAll: npalist, numberword, trailingdigits.
MGI Messages
Reserve sends a REQ-NSR message with an action code of R. The response message is a RSP-NSR.

The SMS/800 MGI will allow, at most, 10 numbers to be reserved in a single REQ-NSR request. If the specified count is greater than ten, 8MS will automatically generate additional REQ-NSR messages.

Example
The following will attempt to reserve ten 800 numbers starting at NXX 777:
npa~800;nxx~777;count~10;resporg~ART01;cname~BSO;cphone~7323566999
The following will attempt to reserve two specific numbers:
numbers~8007765555,877CALLCSF;resporg~ART01;cname~BSO;cphone~7323566999
The following is an example of using SMS/800 wildcards in the requested number; these parameters specify a search for any 800 number where the last four digits are the same:
numbers~800***&&&&;resporg~ART01;cname~BSO;cphone~7323566999