Name
SearchSP Search for spare numbers from 800ForAll
Description
SearchSP is used to search for available numbers in the 800ForAll database. The following are the allowed fields in reqparams:
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 searched.
showvanity If set to 1, if a vanity name was indicated in the numberword field, then the vanity name as well as the number is returned. The number and vanity name are colon-separated in the response.
For a consistent formatting of the returned data, it is highly recommended that this parameter always be set to 1.

In the returned results, the vanity number will contain any overdial trailing digits.

At least one of npalist or numberword must be specified. If neither parameter is specified, a Search API request to SMS/800 will be executed.
MGI Messages
None.
Results
A SearchSP response is an "MGI-like" document embedded within the normal API response. For each number found, a response will contain the 10-digit number, the vanity number and, optionally, a Resp Org. If the Resp Org is shown, this number is coming from the special pool of 800ForAll numbers. The two or three fields in a single line of data will be separated by a colon. Each number found is separated from the next by a newline.

A typical response will appear as shown below.

<msgparams>
NUM=first-10-digit-number:first-vanity-number
NUM=second-10-digit-number:second-vanity-number:RespOrg
NUM=third-10-digit-number:third-vanity-number
</msgparams>
Example
The following request parameters search for any numbers containing the word flowers:
numberword~flowers;trailingdigits~0;showvanity~1