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


getDIDNumber

Gets the selected direct inward dialing (DID) number data; returns null if the selection is empty.

Request

Syntax

getDIDNumber(): Promise<OperationResult<DIDNumber | null>>

Where:

type DIDNumber = {

    id: string

    number: string

    isSMS: boolean

    isVoice: boolean

}

Parameters

(None)

Example Request

    getDIDNumberButton.onclick = () => {

        adApi.getDIDNumber()

    }

Return Value

Object Object Values Data Type Optional?

(Y/N)

Value Description
DIDNumber
id String N The service’s unique ID
number String The available DID number
isSMS Boolean Returns true if you can initiate SMS interactions with this DID number; returns false if you cannot
isVoice Boolean Returns true if you can initiate a voice call with this DID number; returns false if you cannot
< Previous | Next >