USProgramBrief interface
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.
Properties
| attachments | A list of summarized data of attachments currently added to the Program Brief |
| company |
|
| costs | Represents the costs tied to the number. |
| id | Program Brief Id. |
| message |
|
| number | Number provisioned for the Program Brief e.g. 555555, 'CONTOSO' |
| program |
|
| review |
Notes added to the Program Brief after being reviewed to help customer understand review results and necessary follow up actions. |
| status | Program Brief status e.g. 'submitted', 'approved', etc |
| status |
Last date and time when the Program Brief status was updated. |
| submission |
Date and time when the Program Brief was submitted. |
| traffic |
Property Details
attachments
A list of summarized data of attachments currently added to the Program Brief
attachments?: ProgramBriefAttachmentSummary[]Property Value
companyInformation
costs
id
Program Brief Id.
id: stringProperty Value
string
messageDetails
number
Number provisioned for the Program Brief e.g. 555555, 'CONTOSO'
number?: stringProperty Value
string
programDetails
reviewNotes
Notes added to the Program Brief after being reviewed to help customer understand review results and necessary follow up actions.
reviewNotes?: ReviewNote[]Property Value
status
Program Brief status e.g. 'submitted', 'approved', etc
status?: ProgramBriefStatusProperty Value
statusUpdatedDate
Last date and time when the Program Brief status was updated.
statusUpdatedDate?: DateProperty Value
Date
submissionDate
Date and time when the Program Brief was submitted.
submissionDate?: DateProperty Value
Date
