API Version: Development

Reference

/

Methods

/

Error Helper

   
  • IPCortex.PBX.error
  • IPCortex.PBX.Auth.errtype
  • IPCortex.PBX.Auth.errstr
  • IPCortex.PBX.Auth.Error

    • IPCortex.PBX.error

    A helper method for translating result/error codes into error text.
    Kind: static object IPCortex.PBX.error

    IPCortex.PBX.Auth.errtype(errcode) ⇒ String

    Kind: static object IPCortex.PBX.error
    Returns: null or String - A 4 letter string indicating the type of error:
    • CHAT - A Chat or Room error response
    • HOOK - An error related to the now obsolete 'Hook' mechanism
    • ADDR - Address related errors
    • XMPP - An Xmpp related error code
    • DTMF - A keevio phone DTMF error
    • MUTE - A keevio phone MUTE error
    Parameter Type Description
    errcode Number 0 for no error, or a negative number

    IPCortex.PBX.Auth.errstr(errcode) ⇒ String

    Kind: static object IPCortex.PBX.error
    Returns: String - Plain description of the error.
    Parameter Type Description
    errcode Number 0 for no error, or a negative number

    IPCortex.PBX.Auth.Error(errcode) ⇒ Error

    Kind: static object IPCortex.PBX.error
    Returns: Error - Based on plain description of the error.
    Parameter Type Description
    errcode Number 0 for no error, or a negative number