CammSoft Line Controller | Documentation

Endpoint

https://line.cammsoft.com/v1/application/lines/availableNumbers.api

Info

Returns a list of available phone numbers based on provided filters.

Warning

This resource is only accessible to authorized applications.

Repeated authentication failures will result in the banning of the offending IP address.

GET

Input Header Parameters

application-keyRequired

Input Query String Parameters

ccRequired2 letter 'Country Code'. Reference: Country Codes

typeRequired1 letter phone number type code. L = Local, M = Mobile, T = TollFree

acOptionalFilter by 'Area Code'. (Canada & US Only)

smsOptionalLine supports SMS. Supports [1, true, 0, false].

mmsOptionalLine supports MMS. Supports [1, true, 0, false].

voiceOptionalLine supports Voice. Supports [1, true, 0, false].

faxOptionalLine supports Fax. Supports [1, true, 0, false].

pcOptionalFilter to a specific Postal Code. (Canada & US Only) Ex: 12345, A1A1A1

stateOptionalFilter by State/Province. (Canada & US Only)

cityOptionalFilter by City. (Canada & US Only)

sizeOptionalLimit results to 1 - 1000. 50 results returned if omitted.

On Success

Output JSON Parameters

{}Object {}ROOT

numbersArray []Array of phone number records

{}Object {}Phone number record example.

Pending...Exact results are pending...

On Failed

Output JSON Parameters

{}Object {}Root parameter type.

errorObject {}

codeStringError short code string.

messageStringGreater description of error.

Codes: METHOD_NOT_ALLOWED, BAD_REQUEST, INTERNAL_ERROR, ACCESS_DENIED, BANNED, INVALID_COUNTRY_CODE, INVALID_TYPE_CODE, INVALID_FILTER

Available Numbers