campaigns > dlc

Get 10DLC Campaign by ID

Retrieve 10DLC campaign.

get/campaigns/dlc/{campaignId}

Request

  • Base URL: https://api.pinnacle.sh
  • URL: https://api.pinnacle.sh/campaigns/dlc/{campaignId}
  • Auth: API key in header PINNACLE-API-KEY

Path parameters

campaignIdstring required

Unique identifier of the 10DLC campaign. This identifier is a string that always begins with the prefix dlc_, for example: dlc_1234567890.

Response

Successfully retrieved.

autoRenewboolean required

Whether the campaign renews automatically.

campaignIdstring required

Unique identifier for the campaign. This identifier is a string that always begins with the prefix dlc_, for example: dlc_1234567890.

descriptionstring

Description of the campaign.

messageFlowstring

Describe the flow of how users will opt in to this campaign. See the Opt-In Methods and Workflow section for requirements.

namestring

Display name of the campaign.

sampleMessagesstring[]

Example messages for the campaign. See the Sample Messages section for requirements.

status'INCOMPLETE' | 'IN REVIEW' | 'VERIFIED' | 'FAILED' required

Current review status of the campaign. <br>

INCOMPLETE: Not submitted. <br>

IN REVIEW: Being reviewed by carriers. <br>

VERIFIED: Approved and ready to send messages.<br>

FAILED: Issues and errors related to the campaign's details.

mnoBrandTier'TOP' | 'HIGH_MID' | 'LOW_MID' | 'LOW'

The MNO brand tier for T-Mobile rate limits. Tiers range from TOP (highest) to LOW (lowest), based on your brand's vetting score.

See SMS Rate Limits for details.

mnoTcrTier'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G' | 'N' | 'T' | 'S'

The MNO TCR message class for AT&T, Verizon, and other carriers. Classes A-G are standard (based on vetting score), while T, N, and S are for special use cases.

See SMS Rate Limits for details.

Changes

No recorded changes to this operation across all 1 revision of this API.