List Lines

Endpoint

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

Info

This endpoint returns line records 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, POST

Input Header Parameters

application-keyRequired

GET

Input Query String Parameters

accountIdOptionalFilter results by account ID.

POST

Input JSON Parameters

{}Object {}RequiredROOT

accountIdStringOptionalFilter records by accountId

accountIdsArray []OptionalFilter records included in accountIds

On Success

Output JSON Parameters

{}Object {}ROOT

linesArray []Array of line records

{}Object {}Line Record

applicationIdStringApplication ID

accountIdStringAccount ID

lineIdStringLine ID

numberStringLine phone number. Ex: +12225554444

initBlockIdStringDefault IVR block on inbound call.

stampCreatedNumberDateStamp of record creation.

enabledBooleanLine is enabled and accepting calls.

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_ACCOUNT_ID, INVALID_LINE_ID

CammSoft Line