From Bright Pattern Documentation
Jump to: navigation, search
• 5.19


getDIDNumbersList

Gets an array of available direct inward dialing (DID) numbers for the logged in user. From this list, you may select any of these numbers to use for outgoing interactions.

Request

Syntax

getDIDNumbersList(): Promise<OperationResult<DIDNumber[]>>

Where:

type DIDNumber = {

    id: string

    number: string

    isSMS: boolean

    isVoice: boolean

}

Parameters

(None)

Example Request

    getDIDNumbersListButton.onclick = () => {

        adApi.getDIDNumbersList()

    }

Return Value

Object Object Values Data Type Optional?

(Y/N)

Value Description
DIDNumber N
id String 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 >