API Docs for:
Show:

ParkedCaller Class

Module: astproxy

Abstraction of a parked caller.

It can throw exception.

Constructor

ParkedCaller

(
  • data
)
Object

Parameters:

  • data Object

    The caller information object

    • channel String

      The parked channel

    • callerNum String

      The caller number

    • callerName String

      The caller name

    • parking String

      The parking identifier

    • timeout String

      The timestamp of waited time elapsed in the parking

Returns:

Object:

The parked caller object.

Methods

getChannel

() String

Return the caller channel.

Returns:

String:

The caller channel.

getName

() String

Return the name.

Returns:

String:

The name.

getNumber

() String

Return the number of the caller.

Returns:

String:

The number of the caller.

getParking

() String

Return the number of the parking.

Returns:

String:

The number of the parking.

getTimeout

() Number

Return the timestamp of the timeout.

Returns:

Number:

The timestamp of the timeout.

toJSON

(
  • [privacyStr]
)
Object

Returns the JSON representation of the object.

{
    num:        "221",              // the number of the parked channel
    name:       "Alessandro",       // the name of the parked channel
    parkeeNum:  "205",              // the number of the parker
    parkeeName: "Andrea",           // the name of the parker
    parking:    "71",               // the parking identifier
    channel:    "SIP/214-00000573", // the asterisk channel
    timeout:    "40"                // seconds to exit from parking
}

Parameters:

  • [privacyStr] String optional

    If it's specified, it hides the last digits of the phone number

Returns:

Object:

The JSON representation of the object.

toString

() String

Return the readable string description of the parked caller.

Returns:

String:

The readable description of the parked caller.

updateTimeout

()

Update the timeout in seconds.

Properties

channel

String private

The caller channel.

name

String private

The caller name.

num

String private

The caller number.

parkeeName

String private

The name of the parker.

parkeeNum

String private

The number of the parker.

parking

String private

The number of the parking.

timeout

Number private

The timeout in seconds to exit from the parking.

timestampTimeout

Number private

The timestamp of the timeout. It is the countdown to exit from the parking. It's necessary to update timeout.