@azure-tools/communication-short-codes package
Classes
| ShortCodesClient |
Interfaces
| CompanyInformation | |
| ContactInformation |
Contact Information |
| CustomerCareInformation |
Customer Care Information |
| DeleteUSProgramBriefOptions |
Additional options for the delete US Program Brief request. |
| GetUSProgramBriefOptions |
Additional options for the Get US Program Brief request. |
| ListShortCodesOptions |
Additional options for the List Short Codes request. |
| ListUSProgramBriefsOptions |
Additional options for the List US Program Brief request. |
| MessageDetails | |
| MessageExample |
Represents a message example to be sent from or to the end user. |
| MessageExampleSequence |
A sequence of example messages to and from the end user. |
| ProgramBriefAttachment |
A File Attachment for a Program Brief |
| ProgramBriefAttachmentSummary |
A summary of Program Brief File Attachment data |
| ProgramDetails | |
| ReviewNote |
Holds a note about a Program Brief that has gone thru stages of review process. |
| ShortCode |
Represents a number, ShortCode or AlphaId, acquired in a given country. |
| ShortCodeCost |
The incurred cost for a single short code. |
| ShortCodesClientOptions |
Client options used to configure the ShortCodesClient API requests. |
| ShortCodesCreateOrReplaceUSProgramBriefAttachmentOptionalParams |
Optional parameters. |
| ShortCodesDeleteUSProgramBriefAttachmentOptionalParams |
Optional parameters. |
| ShortCodesGetShortCodesOptionalParams |
Optional parameters. |
| ShortCodesGetUSProgramBriefAttachmentOptionalParams |
Optional parameters. |
| ShortCodesGetUSProgramBriefAttachmentsOptionalParams |
Optional parameters. |
| ShortCodesUpsertUSProgramBriefOptionalParams |
Optional parameters. |
| SubmitUSProgramBriefOptions |
Additional options for the Submit US Program Brief request. |
| TrafficDetails | |
| USProgramBrief |
Represents a US Program Brief for acquiring a short code in the United States. A Program Brief provides vital information to the carriers about a messaging program or campaign that would be associated with a short code or alpha sender number. A Program Brief also provides specifics about the use case, the purpose and the consumer experience receiving the message. |
| UseCase |
Describes a messaging use case for a given content type by providing example messages. |
Type Aliases
| AttachmentType |
Defines values for AttachmentType. |
| BillingFrequency |
Defines values for BillingFrequency. |
| CallToActionType |
Defines values for CallToActionType. |
| FileType |
Defines values for FileType. |
| MessageContentType |
Defines values for MessageContentType. |
| MessageDirection |
Defines values for MessageDirection. |
| MessageDirectionality |
Defines values for MessageDirectionality. |
| MessageProtocol |
Defines values for MessageProtocol. |
| NumberType |
Defines values for NumberType. |
| ProgramBriefStatus |
Defines values for ProgramBriefStatus. |
| Recurrence |
Defines values for Recurrence. |