--- title: "Get campaign" method: GET path: "/10dlc/campaign/{campaignId}" tags: ["Campaign"] --- # Get campaign `GET /10dlc/campaign/{campaignId}` ## Request - Base URL: `https://api.telnyx.com/v2` - URL: `https://api.telnyx.com/v2/10dlc/campaign/{campaignId}` - Auth: HTTP bearer Retrieve campaign details by `campaignId`. ## Path parameters - `campaignId` string, required ## Response `200` Successful Response - TelnyxCampaignCSP: Campaign is generated by the 10DLC registry once the corresponding campaign request is approved. Each campaign is assigned a unique identifier - **campaignId**. Once a campaign is activated, limited information is published to the NetNumber OSR service for consumption by members of the ecosystem. When a campaign is suspended(reversible) or expired(non-reversible), campaign data is deleted from the OSR service. Most attributes of campaignare immutable, including **usecase**, **vertical**, **brandId** and **cspId**. - `ageGated` boolean: Age gated content in campaign. - `autoRenewal` boolean: Campaign subscription auto-renewal status. - `billedDate` string: Campaign recent billed date. - `brandId` string, required: Unique identifier assigned to the brand. - `brandDisplayName` string: Display or marketing name of the brand. - `campaignId` string, required: Unique identifier for a campaign. - `tcrBrandId` string: Unique identifier assigned to the brand by the registry. - `tcrCampaignId` string: Unique identifier assigned to the campaign by the registry. - `createDate` string: Unix timestamp when campaign was created. - `cspId` string, required: Alphanumeric identifier of the CSP associated with this campaign. - `description` string, required: Summary description of this campaign. - `directLending` boolean - `embeddedLink` boolean: Does message generated by the campaign include URL link in SMS? - `embeddedPhone` boolean: Does message generated by the campaign include phone number in SMS? - `helpKeywords` string: Subscriber help keywords. Multiple keywords are comma separated without space. - `helpMessage` string: Help message of the campaign. - `messageFlow` string: Message flow description. - `mock` boolean, required: Campaign created from mock brand. Mocked campaign cannot be shared with an upstream CNP. - `nextRenewalOrExpirationDate` string: When the campaign would be due for its next renew/bill date. - `numberPool` boolean: Does campaign utilize pool of phone numbers? - `optinKeywords` string: Subscriber opt-in keywords. Multiple keywords are comma separated without space. - `optinMessage` string: Subscriber opt-in message. - `optoutKeywords` string: Subscriber opt-out keywords. Multiple keywords are comma separated without space. - `optoutMessage` string: Subscriber opt-out message. - `referenceId` string: Caller supplied campaign reference ID. If supplied, the value must be unique across all submitted campaigns. Can be used to prevent duplicate campaign registrations. - `resellerId` string: Alphanumeric identifier of the reseller that you want to associate with this campaign. - `sample1` string: Message sample. Some campaign tiers require 1 or more message samples. - `sample2` string: Message sample. Some campaign tiers require 2 or more message samples. - `sample3` string: Message sample. Some campaign tiers require 3 or more message samples. - `sample4` string: Message sample. Some campaign tiers require 4 or more message samples. - `sample5` string: Message sample. Some campaign tiers require 5 or more message samples. - `status` string: Current campaign status. Possible values: ACTIVE, EXPIRED. A newly created campaign defaults to ACTIVE status. - `subUsecases` string[], required: Campaign sub-usecases. Must be of defined valid sub-usecase types. Use `/10dlc/enum/usecase` operation to retrieve list of valid sub-usecases - `subscriberHelp` boolean: Does campaign responds to help keyword(s)? - `subscriberOptin` boolean: Does campaign require subscriber to opt-in before SMS is sent to subscriber? - `subscriberOptout` boolean: Does campaign support subscriber opt-out keyword(s)? - `termsAndConditions` boolean, required: Is terms & conditions accepted? - `usecase` string, required: Campaign usecase. Must be of defined valid types. Use `/10dlc/enum/usecase` operation to retrieve usecases available for given brand. - `vertical` string: Business/industry segment of this campaign (Deprecated). Must be of defined valid types. Use `/registry/enum/vertical` operation to retrieve verticals available for given brand, vertical combination. This field is deprecated. - `webhookURL` string: Webhook to which campaign status updates are sent. - `webhookFailoverURL` string: Failover webhook to which campaign status updates are sent. - `isTMobileRegistered` boolean: Indicates whether the campaign is registered with T-Mobile. - `isTMobileSuspended` boolean: Indicates whether the campaign is suspended with T-Mobile. - `isTMobileNumberPoolingEnabled` boolean: Indicates whether the campaign has a T-Mobile number pool ID associated with it. - `failureReasons` string: Failure reasons if campaign submission failed - `submissionStatus` 'CREATED' | 'FAILED' | 'PENDING': Campaign submission status - `campaignStatus` 'TCR_PENDING' | 'TCR_SUSPENDED' | 'TCR_EXPIRED' | 'TCR_ACCEPTED' | 'TCR_FAILED' | 'TELNYX_ACCEPTED' | 'TELNYX_FAILED' | 'MNO_PENDING' | 'MNO_ACCEPTED' | 'MNO_REJECTED' | 'MNO_PROVISIONED' | 'MNO_PROVISIONING_FAILED': Campaign status - `privacyPolicyLink` string: Link to the campaign's privacy policy. - `termsAndConditionsLink` string: Link to the campaign's terms and conditions. - `embeddedLinkSample` string: Sample of an embedded link that will be sent to subscribers. ## Other responses - `422`: Validation Error - `4XX`: Generic response error ## Changes - **2026-10-21** `67df31283a8a`: 1 breaking, 1 info - the `errors/items/code` response's property type changed from `integer` to `string`, and format from `int32` to no format for status `4XX` - added the optional property `errors/items/description` to the response with the `4XX` status - **2026-10-15** `a72569d69430`: 1 breaking, 1 info - the `errors/items/code` response's property type changed from `string` to `integer`, and format from no format to `int32` for status `4XX` - added the optional property `errors/items/meta` to the response with the `4XX` status [Operation history](https://skmtc.dev/team-telnyx/apis/telnyx-api/changes/10dlc/campaign/:campaignId/get.md) --- [API](https://skmtc.dev/team-telnyx/apis/telnyx-api.md) - [All operations](https://skmtc.dev/team-telnyx/apis/telnyx-api/llms.txt) - [OpenAPI document](https://skmtc.dev/team-telnyx/apis/telnyx-api/revisions/0f17b8167873?raw)