Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "types"

Index

Type aliases

APIError

APIError: object

Type declaration

  • details: string
  • message: string
  • type: string

Account

Account: object

Accounts

Type declaration

  • available_apps: string[]
  • billing: object
    • available_packs: LabelID[]
    • available_products: LabelID[]
    • available_spending_plans: LabelID[]
    • children: string[]
    • created: Date
    • credit_limit: number
    • credit_limit_theshold: number
    • custom_files: string[]
    • failover_number: string
    • hostname_suffix: string
    • internal_phonebook: boolean
    • max_number_fwd_calls: number
    • max_number_incoming_calls: number
    • max_number_outgoing_calls: number
    • max_number_sim_calls: number
    • parkings: object
    • pickup: boolean
    • platform_trunk_enabled: boolean
    • prov_key: string
    • rate_plan: number
    • realm: string
    • spending_plan: number
    • volume_pack: number
  • caller_id: CallerID
  • category: string
  • country: string
  • Optional id?: ID
  • language: string
  • music_on_hold_id: ID
  • name: string
  • notes: string
  • postal_address: object
  • provision: object
    • admin_password: string
    • admin_pin: string
  • restriction: string
  • time_zone: string

Calendar

Calendar: object

Calendars

Type declaration

  • ics: string
  • Optional id?: ID
  • is_external_calendar: boolean
  • name: string
  • time_zone: string
  • url: string

CallForward

CallForward: object

Type declaration

  • direct_calls_only: boolean
  • enabled: boolean
  • keep_caller_id: boolean
  • number: string
  • require_key_press: boolean

CallerID

CallerID: object

Caller ID

Type declaration

  • emergency: object
    • name: string
    • number: string
  • external: object
    • anonymous: boolean
    • name: string
    • number: string
  • fax: object
    • name: string
    • number: string
  • internal: object
    • name: string
    • number: string

Callflow

Callflow: object

Type declaration

  • featurecode: FeatureCode
  • flow: Flow
  • Optional id?: ID
  • name: string
  • numbers: string[]

Conference

Conference: object

Conferences

Type declaration

  • Optional id?: ID
  • language: string
  • members_announce_join_leave: boolean
  • members_join_muted: boolean
  • members_maximum: number
  • members_pin: string
  • name: string
  • owner_id: ID

Contact

Contact: object

Directories

Type declaration

  • details: object
    • company: object
      • name: string
    • names: object
      • first: string
      • last: string
    • phone_numbers: object
      • faxes: string[]
      • land_lines: string[]
      • mobiles: string[]
  • Optional id?: ID
  • phonebook: string
  • user_id: ID

ContactDeleteResponse

ContactDeleteResponse: object

Type declaration

  • deleted: ID[]

ContactUpdate

ContactUpdate: object

Type declaration

  • contacts: Contact[]
  • phonebook: string

Device

Device: object

Devices

Type declaration

  • always_registered: boolean
  • call_forward: CallForward
  • caller_id: CallerID
  • country: string
  • hardware: Hardware
  • hardware_order: number
  • hostname: string
  • Optional id?: ID
  • language: string
  • missed_calls_log: boolean
  • music_on_hold_id: ID
  • name: string
  • owner_association_category: string
  • owner_id: ID
  • password: string
  • restriction: string
  • retries: object
    • max: number
    • wait_until_next_retry: number
  • status: boolean
  • time_zone: string
  • transport: NetworkTransport
  • username: string

DeviceRegistration

DeviceRegistration: object

Type declaration

  • category: string
  • contact_ip: string
  • contact_port: number
  • name: string
  • owner_id: ID
  • user_agent: string
  • username: string

DeviceStatus

DeviceStatus: object

Type declaration

  • Optional id?: ID
  • registered: boolean
  • Optional state?: string

FeatureCode

FeatureCode: object

Callflows

Type declaration

  • name: string
  • number: string

Flow

Flow: object

Type declaration

  • children: Flow
  • data: object
    • caption: string
    • id: ID
  • Optional id?: ID
  • module: string

FunctionKey

FunctionKey: object

Function Keys

Type declaration

  • key_id: ID
  • label: string
  • line_id: ID
  • type: string
  • value: string

Group

Group: object

Type declaration

  • global_timeout: number
  • Optional id?: ID
  • login_logout_authorized: boolean
  • members: Member[]
  • music_on_hold_id: ID
  • name: string
  • pickup: boolean
  • strategy: string
  • waiting_queue: boolean

Hardware

Hardware: object

Hardwares

Type declaration

  • brand: string
  • category: string
  • config: object
  • family: string
  • Optional id?: ID
  • mac_address: string
  • model: string
  • provisioning_version: string
  • remote_logging: boolean
  • version: string
  • zero_touch_provisioning: boolean

HistoryCall

HistoryCall: object

Type declaration

  • billing_seconds: number
  • call_direction: CallDirection
  • callee_callid: string
  • callee_id_number: string
  • caller_callid: string
  • caller_id_number: string
  • cost: number
  • detected_country: string
  • detected_operator: string
  • detected_type: string
  • duraction_seconds: number
  • hangup_cause: string
  • Optional id?: ID
  • owner_id: ID
  • timestamp: number

ID

ID: string | number

LabelID

LabelID: object

Type declaration

  • Optional id?: ID
  • label: string

Media

Media: object

Medias

Type declaration

  • available_as_moh: boolean
  • content_type: string
  • file_name: string
  • Optional id?: ID
  • name: string

Member

Member: object

Groups

Type declaration

  • delay: number
  • logged: boolean
  • member_id: ID
  • member_type: string
  • timeout: number

Menu

Menu: object

Menus

Type declaration

  • hunt: object
    • allow: string[]
    • deny: string[]
  • Optional id?: ID
  • media_id: ID
  • name: string
  • retries: number
  • timeout: number

Network

Network: object

Type declaration

  • address: string
  • netmask: string
  • network: string

NetworksResponse

NetworksResponse: object

Networks

Type declaration

Parking

Parking: object

Type declaration

  • enabled: boolean
  • first_slot: string
  • last_slot: string
  • park_extension: string
  • timeout: number

PhoneNumber

PhoneNumber: object

Phone Numbers

Type declaration

  • assigned_to: string
  • Optional bypass_enabled?: boolean
  • Optional bypass_number?: string
  • carrier: string
  • category: string
  • country: string
  • features: string[]
  • Optional id?: ID
  • state: string
  • trunk_id: ID
  • trunk_name: string
  • used_by: string
  • used_by_id: ID
  • used_by_name: string

PhoneNumberCreate

PhoneNumberCreate: object

Type declaration

  • carrier: string
  • state: string
  • trunk_id: ID

PhoneNumberUpdate

PhoneNumberUpdate: object

Type declaration

  • phone_numbers: string[]
  • state: string

PostalAddress

PostalAddress: object

Type declaration

  • address_line_1: string
  • address_line_2: string
  • address_number: string
  • city: string
  • company_name: string
  • postal_code: string
  • vat: string

ReadAllShort

ReadAllShort: object

Type declaration

  • id: ID
  • name: string

Recording

Recording: object

Type declaration

Trunk

Trunk: object

Type declaration

TrunkAdvancedOpts

TrunkAdvancedOpts: object

Type declaration

  • add_country_prefix_for_emergency_calls: boolean
  • incoming: object
    • prepend_numbers: string
    • strip_numbers: number
  • override_from_domain: boolean
  • override_from_user: boolean
  • vpn: boolean

User

User: object

Users

Type declaration

  • advanced: boolean
  • apps: Object
  • browserphone_id: ID
  • call_forward: CallForward
  • caller_id: CallerID
  • country: string
  • email: string
  • enabled: boolean
  • first_name: string
  • hotdesk_enabled: boolean
  • hotdesk_id: ID
  • hotdesk_keep_logged_in_elsewhere: boolean
  • hotdesk_pin: string
  • hotdesk_require_pin: boolean
  • Optional id?: ID
  • language: string
  • last_name: string
  • mobile_number: string
  • music_on_hold_id: ID
  • no_service: boolean
  • password: string
  • priv_level: PrivLevel
  • quickcall_device: ID
  • require_password_update: boolean
  • restriction: string
  • subscriptions: Object
  • time_zone: string
  • username: string
  • vm_to_email_enabled: boolean

VoicemailBox

VoicemailBox: object

Voicemails Boxes

Type declaration

  • delete_after_notify: boolean
  • Optional id?: ID
  • mailbox: string
  • name: string
  • owner_id: ID
  • pin: string
  • require_pin: boolean
  • time_zone: string

Generated using TypeDoc