API Version: Development

Reference

/

Classes

/

IPCortex.Types.Extension

   
  • IPCortex.Types.Extension
  • Properties
  • Methods
  • extension.dial
  • extension.addListener
  • extension.removeListener
  • Events

    • IPCortex.Types.Extension

    An Extension instance represents a callable extension number.

    Properties

    Name Type Description
    extension String Number with company scope if private. Private extension format (no.)_(company ID) e.g. 654_ipcortex
    number String Number without any company scope.
    name String Friendly/descriptive name or extension number if not set.
    owner Contact Owners contact instance or null if unowned.
    canOpt Boolean True if the extension can be opted in/out.
    company String Unique identifer of the extensions company, company ID or ‘default’.
    contacts Array A list of Contact instances called by this extension.
    ddis Array A list of DDI numbers that call this extension.
    type String The extension type.
    • A - Ring all
    • H - Hunt Grouop
    • H - IVR Menu
    • Q - Queue
    • C - Conference access
    • T - Tannoy
    • O - Park
    • o - Park orbit / Pickup
    • V - Voicemail Pickip
    • P - External Voicemail Pickup
    • X - External dialin access
    blf Number Rolled-up call state indication. 6.3+
    • 0 - available
    • 1 - on call
    • 2 - ringing
    • 3 - on call and ringing

    Methods

    extension.dial(device, [callback]) ⇒ Promise

    Kind: class method of IPCortex.Types.Extension
    Dial the number on this Extension using Device of device. See the Device.dial() documentation for further detail or more advanced dial options.
    Parameter Type Description
    device Device Device to dial on.
    Equivalent to device.dial(extension, callback)

    extension.addListener(event, callback)

    Kind: class method of IPCortex.Types.Extension
    Add listener method, inherited from Api base class and common to all classes.
    Parameter Type Description
    event String Name of event, e.g. 'update'
    callback Function Callback which is passed a reference to the updated Class object

    extension.removeListener(event, callback)

    Kind: class method of IPCortex.Types.Extension
    Remove listener method, inherited from Api base class and common to all classes. event and callback must be identical to those used in addListener() in order for the remove to succeed.
    Parameter Type Description
    event String Name of event, e.g. 'update'
    callback Function Callback which is passed a reference to the updated Class object

    Events

    NOTE: The 'extension' of an extension for a private extension is represented as 'nnn_company', so a private extension of number '201' in company 'grommit' has a number of '201_grommit'. For the number part only read the 'number' attribute.