From Bright Pattern Documentation
< 5.19:AgentDesktop-client-side-javascript-api-specification
Revision as of 04:01, 29 May 2024 by BpDeeplTranslateMaintenance (talk | contribs) (Updated via BpDeleteTranslateTags script)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
• 5.19


getPhoneDevice

Returns the selected phone device and its phone number (i.e., if it's configurable for this phone device).

Request

Syntax

getPhoneDevice(): Promise<OperationResult<PhoneDeviceData>>

Where:

type PhoneDeviceData = {

    type: PhoneDevice

    phone?: string

}

Parameters

(None)

Example Request

getPhoneDeviceButton.onclick = () => {

    adApi.getPhoneDevice()

}

Return Value

This method returns the list of available PhoneDevice types (i.e., as defined in the method getPhoneDevicesList) and its corresponding phone number.

< Previous | Next >