Get 10DLC Campaign by ID | Pinnacle

import { PinnacleClient } from "rcs-js";
async function main() {
    const client = new PinnacleClient({
        environment: "https://api.pinnacle.sh",
    });
    await client.campaigns.dlc.get("dlc_1234567890");
}
main();

{
  "autoRenew": false,
  "brand": {
    "createdAt": "2024-08-17T08:00:30.632",
    "id": "b_1234567890",
    "isArchived": false,
    "status": "VERIFIED",
    "updatedAt": "2024-12-09T10:03:54.934",
    "address": "500 Folsom Street, San Francisco, CA 94105",
    "contact": {
      "email": "janedoe1@pinnacle.example",
      "name": "Jane Doe",
      "phone": "+14155550123",
      "title": "Customer Support Specialist"
    },
    "dba": "Pinnacle RCS",
    "ein": "12-3456789",
    "email": "founders@trypinnacle.app",
    "name": "Pinnacle",
    "sector": "TECHNOLOGY",
    "type": "PRIVATE_PROFIT",
    "website": "https://www.pinnacle.sh/"
  },
  "campaignId": "dlc_1234567890",
  "keywords": {
    "HELP": {
      "values": [
        "HELP",
        "SUPPORT",
        "INFO"
      ],
      "message": "Pinnacle Software Development Inc.: For assistance, visit https://pinnacle.sh/support or email founders@trypinnacle.app. Msg&data rates may apply. Reply STOP to cancel."
    },
    "OPT_IN": {
      "values": [
        "START",
        "YES",
        "SUBSCRIBE"
      ],
      "message": "Pinnacle Software Development Inc.: You're enrolled in account & security alerts. Msg&data rates may apply. Message frequency varies. Reply HELP for help, STOP to cancel. Terms: https://pinnacle.sh/terms Privacy: https://pinnacle.sh/privacy"
    },
    "OPT_OUT": {
      "values": [
        "STOP",
        "CANCEL",
        "UNSUBSCRIBE"
      ],
      "message": "Pinnacle Software Development Inc.: You're unsubscribed and will receive no further texts. For assistance, visit https://pinnacle.sh or call 877-389-0460. Reply START to resubscribe."
    }
  },
  "options": {
    "affiliateMarketing": false,
    "ageGated": false,
    "directLending": false,
    "embeddedPhone": false,
    "numberPooling": false
  },
  "status": "VERIFIED",
  "links": {
    "privacyPolicy": "https://www.pinnacle.sh/privacy",
    "termsOfService": "https://www.pinnacle.sh/terms"
  },
  "messageFlow": "The user fills out a paper form during onboarding at [Address] which they learn about at our website (https://pinnacle.sh) in which they provide their phone number and sign their consent. The form includes a disclaimer: \"By signing this form and providing your phone number, you agree to receive SMS Mixed - Account Notification, Customer Care, Security Alert, Delivery Notification from Pinnacle Software Development Inc. Message frequency may vary. Standard Message and Data Rates may apply. Reply STOP to opt out. Reply HELP for help. Consent is not a condition of purchase. Your mobile information will not be sold or shared with third parties for promotional or marketing purposes.\" Once the information is entered into the system, the user receives a confirmation SMS: \"Thank you for signing up for SMS updates from Pinnacle Software Development Inc. Msg freq may vary. Std msg & data rates apply. Reply STOP to opt out, HELP for help.\" Link to paper form: https://www.pinnacle.sh/opt-in",
  "name": "Pinnacle",
  "sampleMessages": [
    "Pinnacle Software Development Inc.: We're here to help. Visit https://pinnacle.sh or call 877-389-0460. Msg&data rates may apply. Reply STOP to cancel.",
    "Pinnacle Software Development Inc.: You're enrolled in account & security alerts. Msg&data rates may apply. Message frequency varies. Reply HELP for help, STOP to cancel. Terms: https://pinnacle.sh/terms/ Privacy: https://pinnacle.sh/privacy/",
    "Pinnacle Software Development Inc.: An update has been made to your account. Read it in the portal.",
    "Pinnacle Software Development Inc.: We received your message. A team member will reply shortly. For immediate help call 877-389-0460. Msg&data rates may apply. Reply STOP to cancel."
  ],
  "useCase": {
    "sub": [
      "ACCOUNT_NOTIFICATION",
      "CUSTOMER_CARE",
      "SECURITY_ALERT"
    ],
    "value": "MIXED"
  },
  "mnoBrandTier": "LOW",
  "mnoTcrTier": "G"
}

Retrieve 10DLC campaign.

Authentication

PINNACLE-API-KEYstring

API Key authentication via header

Path parameters

campaignIdstringRequired

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

Whether the campaign renews automatically.

brandobject

Brand associated with this campaign.

campaignIdstring

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

keywordsobject

Keyword response configuration.

optionsobject

Campaign configuration options.

statusenum

Current review status of the campaign.

INCOMPLETE: Not submitted.

IN REVIEW: Being reviewed by carriers.

VERIFIED: Approved and ready to send messages.

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

Allowed values:

descriptionstring or null

Description of the campaign.

linksobject or null

Legal documentation links.

messageFlowstring or null

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

namestring or null

Display name of the campaign.

sampleMessageslist of strings or null

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

useCaseobject or null

Use case for the campaign.

mnoBrandTierenum or null

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.

Allowed values:

mnoTcrTierenum or null

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.

Authentication

Path parameters

Response

Errors