---
title: "Get a US Program Brief by id."
method: GET
path: "/shortCodes/countries/US/programBriefs/{programBriefId}"
tags: ["ShortCodes - ProgramBrief"]
---

# Get a US Program Brief by id.

`GET /shortCodes/countries/US/programBriefs/{programBriefId}`

## Path parameters

- `programBriefId` string, uuid, required

## Query parameters

- `api-version` string, required

## Response `200`

Success

- 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.
  - `id` string, uuid, required — Program Brief Id.
  - `status` 'submitted' | 'approved' | 'submitNewVanityNumbers' | 'updateProgramBrief' | 'draft' | 'denied' — Program Brief status e.g. 'submitted', 'approved', etc
  - `number` string — Number provisioned for the Program Brief e.g. 555555, 'CONTOSO'
  - `reviewNotes` ReviewNote[] — Notes added to the Program Brief after being reviewed to help customer understand review results and necessary follow up actions.
    - `message` string — Note related to a Program Brief that may imply changes needed from the client.
    - `date` string, date-time — Date and time when the note was added to the Program Brief.
  - `costs` ShortCodeCost[] — Represents the costs tied to the number.
    - `amount` number, double, required — The cost amount.
    - `currencyCode` string, required — The ISO 4217 currency code for the cost amount, e.g. USD.
    - `billingFrequency` 'monthly' | 'once', required — The frequency with which the cost gets billed.
  - `submissionDate` string, date-time — Date and time when the Program Brief was submitted.
  - `statusUpdatedDate` string, date-time — Last date and time when the Program Brief status was updated.
  - `programDetails` ProgramDetails
    - `isVanity` boolean — Set to true if the request is for a vanity number.
    - `preferredVanityNumbers` string[] — Priority ordered list of preferred vanity numbers. Vanity numbers should be 5 or 6 digit when number type is ShortCode. e.g. 555555, 222222.
    - `numberType` 'shortCode' | 'alphaId' — Type for desired numbers e.g. 'shortCode' or 'alphaId'.
    - `isPoliticalCampaign` boolean — Indicates whether the number will be used for political campaigns or not.
    - `name` string — 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'
    - `description` string — Describes how and why the number will be used for messaging as part of the program.
    - `url` string, uri — URL for the program or company.
    - `signUpTypes` string[] — Indicates how the consumer can sign up to the program e.g. 'website', 'pointOfSale' and/or 'sms'.
    - `signUpUrl` string, uri — URL for "call to action" image for the program.
    - `termsOfServiceUrl` string, uri — URL for program terms of service.
    - `privacyPolicyUrl` string, uri — URL for privacy policy.
    - `expectedDateOfService` string, date-time — 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.
  - `companyInformation` CompanyInformation
    - `name` string — Legal entity name for customer submitting Program Brief.
    - `url` string, uri — Company URL for customer submitting Program Brief.
    - `address` string — Company's address for the customer submitting the Program Brief.
    - `contactInformation` ContactInformation — Contact Information
      - `name` string — Name of authorized user for purposes of submitting the Program Brief.
      - `phone` string — Contact phone number for the authorized user for the customer. Use E164 format. e.g. +14086111111.
      - `email` string, email — Contact email address number for the authorized user for the customer.
    - `customerCareInformation` CustomerCareInformation — Customer Care Information
      - `tollFreeNumber` string — Customer support phone number for the customer submitting the Program Brief. Use E164 format. e.g. +18005551212
      - `email` string, email — Customer support email address for the customer submitting the Program Brief.
  - `messageDetails` MessageDetails
    - `supportedProtocols` string[] — Applicable message protocols used in the program e.g. SMS, MMS.
    - `recurrence` 'subscription' | 'transaction' — Indicates the nature of the messaging associated with the program e.g. 'subscription', 'transaction'.
    - `helpMessage` string — Message text for mobile terminated message associated with HELP keyword e.g 'This is the HELP message test.'.
    - `optOutMessage` string — "Message text for mobile terminated message associated with STOP keyword e.g. 'This is the STOP message test.'.
    - `optInMessage` string — OptInMessage.
    - `optInReply` string — Keyword used to confirm double Opt-In method e.g. 'JOIN'.
    - `confirmationMessage` string — ConfirmationMessage.
    - `directionality` 'oneWay' | 'twoWay' — Describes directionality e.g. oneWay or twoWay
    - `useCases` UseCase[] — Provides message exchange examples from and to end user for each supported message content type.
      - `contentCategory` 'ringTones' | 'smsChat' | 'video' | 'loyaltyProgramPointsPrizes' | 'gifting' | 'inApplicationBilling' | 'textToScreen' | 'games' | 'audioChat' | 'mmsPictures' | 'sweepstakesContestAuction' | 'financialBanking' | 'premiumWap' | 'queryService' | 'wallpaperScreensaver' | 'voting' | 'application' | 'mobileGivingDonations' | 'coupons' | 'loyaltyProgram' | 'noPointsPrizes' | 'informationalAlerts' | 'microBilling' | 'trivia' | 'entertainmentAlerts' | 'accountNotification' | 'ageGatedContent' | 'conversationalMessaging' | 'deliveryNotification' | 'education' | 'emergencyAlerts' | 'fraudAlerts' | 'loanArrangement' | 'onBehalfOfCarrier' | 'political' | 'promotionalMarketing' | 'publicServiceAnnouncements' | 'securityAlerts' | 'socialMedia' | 'twoFactorAuthentication' | 'other' — Indicates the messaging content category used in the program e.g. 'ringTones', 'smsChat', 'video', 'loyaltyProgramPointsPrizes', 'gifting', 'inApplicationBilling', 'textToScreen'.
      - `examples` MessageExampleSequence[] — Example messages to be sent to and from the end user for the indicated content type.
        - `messages` MessageExample[] — Example messages to be sent to and from the end user.
          - `direction` 'toUser' | 'fromUser' — Indicates whether the message example is supposed to be sent to or from the end user e.g. toUser
          - `text` string — Actual example text for the message e.g. 'Want me to notify you when package in the way?'
  - `trafficDetails` TrafficDetails
    - `totalMonthlyVolume` integer — Estimated total messages per month.
    - `monthlyAverageMessagesFromUser` integer — Estimated number of Mobile-Originated messages likely to be received from a user per month.
    - `monthlyAverageMessagesToUser` integer — Estimated number of Mobile-Terminated messages likely to be sent per user per month.
    - `isSpiky` boolean — Indicates if the nature of the messaging traffic will be bursty.
    - `spikeDetails` string — If isSpiky=true, then explain additional details about the traffic pattern e.g. 'Higher traffic expected during holiday season and Black Friday.'.
    - `estimatedRampUpTimeInDays` integer — Numbers of days in which is expected to start sending messages from the short code.

## Other responses

- `default` — Failure

---

[API](https://skmtc.dev/azure/apis/shortcodesnumbersclient.md) · [All operations](https://skmtc.dev/azure/apis/shortcodesnumbersclient/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/azure/shortcodesnumbersclient/revisions/e6782b139001/schema)