Type alias PhoneEvent

Type declaration

• callObject: { accountId: string; callId: string; ringingStartTime: string; answerStartTime?: string; callEndTime: string; callee: { deviceId?: string; extensionId?: string; extensionNumber?: string; extensionType?: string; phoneNumber: string; timezone?: string; userId?: string }; caller: { extensionId?: string; extensionNumber?: string; extensionType?: string; phoneNumber: string; timezone?: string; userId?: string }; forwardedBy?: { name?: string; extensionNumber?: string; extensionType?: string }; eventTs?: string; timestamp: string }

  • accountId: string

    account ID of the callee

  • callId: string

    unique identifier of the call

  • ringingStartTime: string

    the GMT time at which the ringing started in "yyyy-MM-dd'T'HH:mm:ss'Z'" format.

  • Optional answerStartTime?: string

    the GMT timer (in "yyyy-MM-dd'T'HH:mm:ss'Z'" format) at which the call was answered

  • callEndTime: string

    the GMT time (in "yyyy-MM-dd'T'HH:mm:ss'Z'" format) at which the call was ended by the callee.

  • callee: { deviceId?: string; extensionId?: string; extensionNumber?: string; extensionType?: string; phoneNumber: string; timezone?: string; userId?: string }

    represents the person who is called by the caller

    • Optional deviceId?: string

    • Optional extensionId?: string

      extension ID of the callee

    • Optional extensionNumber?: string

      extension number of the callee

    • Optional extensionType?: string

      extension type of a the callee. Values: user | callQueue| autoReceptionist ┃ commonArea ┃ commonAreaPhone ┃ sharedLineGroup ┃ zoomRoom ┃ ciscoRoom/PolycomRoom ┃ contactCenter ┃ pstn ┃ five9 ┃ twilio

    • phoneNumber: string

      phone number of the callee in E164 format. Phone number and extension number can't be empty at the same time

    • Optional timezone?: string

      timezone of the callee

    • Optional userId?: string

      Zoom User ID of the callee

  • caller: { extensionId?: string; extensionNumber?: string; extensionType?: string; phoneNumber: string; timezone?: string; userId?: string }

    • Optional extensionId?: string

      extension ID of the caller

    • Optional extensionNumber?: string

    • Optional extensionType?: string

      extension type of a the caller. Values: user | callQueue| autoReceptionist ┃ commonArea ┃ commonAreaPhone ┃ sharedLineGroup ┃ zoomRoom ┃ ciscoRoom/PolycomRoom ┃ contactCenter ┃ pstn ┃ five9 ┃ twilio

    • phoneNumber: string

      phone number of the caller in E164 format

    • Optional timezone?: string

      timezone of the caller

    • Optional userId?: string

      Zoom User ID of the caller

  • Optional forwardedBy?: { name?: string; extensionNumber?: string; extensionType?: string }

    • Optional name?: string

      the name of the extension the call was forwaded from

    • Optional extensionNumber?: string

      extension number the call was forwarded from

    • Optional extensionType?: string

      type of extension the call was forwarded from. Values: callQueue | sharedLineGroup | sharedLine

  • Optional eventTs?: string

  • timestamp: string