CammSoft Line Controller | Documentation

Endpoint

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

Info

This endpoint returns IVR blocks based on provided filters.

IVR blocks are interactive voice response segments. Using blocks, callers can be directed based on various triggers including, Time, Country, State, Number, Keypad Press.

IVR blocks can also be used to place callers into defined agent queues for answering by online agents or be forwarded to alternative phone numbers.

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.

accountIdsOptionalAccount IDs separated by commas.

lineIdOptionalFilter results by line ID.

lineIdsOptionalLine IDs separated by commas.

POST

Input JSON Parameters

{}Object {}RequiredROOT

accountIdStringOptionalFilter records by accountId.

accountIdsArray []OptionalFilter records included in accountIds.

lineIdStringOptionalFilter records by lineId.

lineIdsArray []OptionalFilter records included in lineIds.

On Success

Output JSON Parameters

{}Object {}ROOT

blocksArray []Array of IVR blocks.

{}Object {}Example returned record.

applicationIdStringApplication ID.

accountIdStringAccount ID.

lineIdStringLine ID

blockIdStringBlock ID

conditionsArray []Conditions to jump to another block.

{}Object {}Example of condition object.

enabledBooleanEnabled

typeStringCondition types, [TIME, FROM, COUNTRY, STATE, AND].

notBooleanIf filter is not truth.

blockIdStringID of block to jump to on truth.

queueIdStringID of agent queue to add call to.

queueDelayNumberMilliseconds before adding call to queue. 1000 = 1 second

If (type === TIME)

weekdaysArray []As Numbers [0, 1, 6] for [Sunday, Monday, Saturday]

timeStartString24 hour time, Ex: 9:00

timeEndString24 hour time, Ex: 17:30

If (type === FROM)

fromsArray []Array of phone numbers.

If (type === COUNTRY)

countriesArray []Array of countries.

If (type === STATE)

statesArray []Array of states/provinces.

If (type === AND)

conditionsArray []Array of conditions combined.

responseArray []Voice response segment.

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_FILTER

List IVR Blocks

CammSoft Line