ShortCode interface

Package:

@azure-tools/communication-short-codes

Represents a number, ShortCode or AlphaId, acquired in a given country.

Properties

countryCode	ISO 3166 2-char code representing the country e.g. 'US'.
number	The value of the ShortCode or the alpha numeric e.g. '555555', 'CONTOSO', etc.
numberType	The type of number e.g. 'ShortCode', 'AlphaId'.
programBriefIds	Program Brief Name.
purchaseDate	Date in which number was purchased.

Property Details

countryCode

ISO 3166 2-char code representing the country e.g. 'US'.

countryCode?: string

Property Value

string

number

The value of the ShortCode or the alpha numeric e.g. '555555', 'CONTOSO', etc.

number?: string

Property Value

string

numberType

The type of number e.g. 'ShortCode', 'AlphaId'.

numberType?: NumberType

Property Value

NumberType

programBriefIds

Program Brief Name.

programBriefIds?: string[]

Property Value

string[]

purchaseDate

Date in which number was purchased.

purchaseDate?: Date

Property Value

Date