| arg | required? | syntax | info |
|---|---|---|---|
custID | N | posint | custID of account that owns the number (default is your own account) |
number | N | list:posint | optional filter to limit the phone numbers returned; can be an array of numbers or a comma separated list |
number.starts | N | unsint | optional filter; eg if you supply "08238" then output is limited to numbers starting with 08238 |
number.ends | N | unsint | optional filter; similar to number.starts but for specifying the ending instead |
number.contains | N | unsint | optional filter; similar to number.starts |
destnumber | N | posint | optional filter; limits results to numbers pointing at a specific terminating number |
destnumber.starts | N | unsint | optional filter; similar to number.starts but filtering on the terminating number |
destnumber.ends | N | unsint | optional filter; similar to destnumber.starts |
destnumber.contains | N | unsint | optional filter; similar to destnumber.starts |
edit_timestamp.min | N | posint | optional filter; limits results to numbers last altered at this time or later |
edit_timestamp.max | N | posint | optional filter; limits results to numbers last altered at this time or earlier |
notes.match | N | string | optional filter; search notes |
routeto_type | N | set:nowhere|externally-routed|fax2email|number|routeplan|dayparting|sip|voicemail|ivr | optional filter; limits results to numbers routing to one of these destination types |
routeplanID | N | posint | optional filter; limits results to numbers pointing at this specific route plan |
daypartID | N | posint | optional filter; limits results to numbers pointing at this specific day parting |
mailboxID | N | posint | optional filter; limits results to numbers pointing at this specific voicemail mailbox |
ivrID | N | posint | optional filter; limits results to numbers pointing at this specific IVR menu |
soundclipID | N | posint | optional filter; limits results to numbers pointing to a pre-recorded announcement with this soundclipID |
optfields | N | list:enum | allows you to specify additional information to fetch (info that is not supplied by default) |
Optional filter (and sort criteria, depending on other args). If this argument is specified, then a fulltext match is done with the supplied string against the notes field for each number. If you supply several words in your search string, then a number will be matched if any of the words in its notes match any of the words in your search string.
Match relevance will be higher if more than one word matches, and/or the matching words are rarer. Note that word rarity will be measured across notes against numbers on our entire system, not just numbers on an individual account. There are also a list of "stopwords" that will be ignored by the search (for further information, read documentation on MySQL fulltext searches).
If the sort argument is NOT also defined, then supplying the notes.match argument will cause the results to be sorted in descending order of match relevance (ie strongest matches first).
Optional filter. If you supply this argument, only numbers that are routing to one of the supplied destination types will be
returned. Supply a list of one or more routeto_type values. See telecoms.num.route:routeto_type for
a list and explanation of possible values.
A list of extra fields to fetch with the call data. Fields specified here will be returned as well as the fields that are returned by default.
Supply the value as a string of field names separated by commas, or as an array of field names. Values are:
telecoms.num.ref.set)telecoms.facility.attr.set functiontelecoms.num.route functiontelecoms.num.ref.set and telecoms.num.ref.del functionstelecoms.num.note.add function