ProgramDetails interface

Package:

@azure-tools/communication-short-codes

Properties

callToAction	Call to action text. To be provided when InteractiveVoiceResponse is specified as call to action type
callToActionTypes	Indicates how the consumer can sign up to the program e.g. 'website', 'pointOfSale' and/or 'sms'.
callToActionUrl	URL for "call to action" image for the program.
description	Describes how and why the number will be used for messaging as part of the program.
expectedDateOfService	Date in which SMS messages will start to be sent out. Should follow ISO 8601 internet format for datetimes. e.g. 2021-08-17T22:02:51.316Z, 2021-08-17T16:39:57-08:00, etc.
isPoliticalCampaign	Indicates whether the number will be used for political campaigns or not.
isVanity	Set to true if the request is for a vanity number.
name	A program name that indicates the purpose of filling the Program Brief and how the number will be used for messaging. e.g. 'CONTOSO Shipping'
numberType	Type for desired numbers e.g. 'shortCode' or 'alphaId'.
preferredVanityNumbers	Priority ordered list of preferred vanity numbers. Vanity numbers should be 5 or 6 digit when number type is ShortCode. e.g. 555555, 222222.
privacyPolicyUrl	URL for privacy policy.
termsOfServiceUrl	URL for program terms of service.
url	URL for the program or company.

Property Details

callToAction

Call to action text. To be provided when InteractiveVoiceResponse is specified as call to action type

callToAction?: string

Property Value

string

callToActionTypes

Indicates how the consumer can sign up to the program e.g. 'website', 'pointOfSale' and/or 'sms'.

callToActionTypes?: CallToActionType[]

Property Value

CallToActionType[]

callToActionUrl

URL for "call to action" image for the program.

callToActionUrl?: string

Property Value

string

description

Describes how and why the number will be used for messaging as part of the program.

description?: string

Property Value

string

expectedDateOfService

Date in which SMS messages will start to be sent out. Should follow ISO 8601 internet format for datetimes. e.g. 2021-08-17T22:02:51.316Z, 2021-08-17T16:39:57-08:00, etc.

expectedDateOfService?: Date

Property Value

Date

isPoliticalCampaign

Indicates whether the number will be used for political campaigns or not.

isPoliticalCampaign?: boolean

Property Value

boolean

isVanity

Set to true if the request is for a vanity number.

isVanity?: boolean

Property Value

boolean

name

A program name that indicates the purpose of filling the Program Brief and how the number will be used for messaging. e.g. 'CONTOSO Shipping'

name?: string

Property Value

string

numberType

Type for desired numbers e.g. 'shortCode' or 'alphaId'.

numberType?: NumberType

Property Value

NumberType

preferredVanityNumbers

Priority ordered list of preferred vanity numbers. Vanity numbers should be 5 or 6 digit when number type is ShortCode. e.g. 555555, 222222.

preferredVanityNumbers?: string[]

Property Value

string[]

privacyPolicyUrl

URL for privacy policy.

privacyPolicyUrl?: string

Property Value

string

termsOfServiceUrl

URL for program terms of service.

termsOfServiceUrl?: string

Property Value

string

url

URL for the program or company.

url?: string

Property Value

string