Get Single Shared Campaign

Retrieve campaign details by campaignId.

GET /10dlc/partner_campaigns/{campaignId}

JavaScript

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const telnyxDownstreamCampaign = await client.messaging10dlc.partnerCampaigns.retrieve(
  'campaignId',
);

console.log(telnyxDownstreamCampaign.tcrBrandId);

200

{
  "tcrBrandId": "BBRAND1",
  "tcrCampaignId": "CCAMP1",
  "ageGated": true,
  "assignedPhoneNumbersCount": 3,
  "brandDisplayName": "ABC Mobile",
  "campaignStatus": "TCR_ACCEPTED",
  "description": "<string>",
  "directLending": true,
  "embeddedLink": true,
  "embeddedLinkSample": "<string>",
  "embeddedPhone": true,
  "failureReasons": "<string>",
  "helpKeywords": "<string>",
  "helpMessage": "<string>",
  "isNumberPoolingEnabled": true,
  "messageFlow": "<string>",
  "numberPool": true,
  "optinKeywords": "<string>",
  "optinMessage": "<string>",
  "optoutKeywords": "<string>",
  "optoutMessage": "<string>",
  "privacyPolicyLink": "<string>",
  "usecase": "<string>",
  "sample1": "<string>",
  "sample2": "<string>",
  "sample3": "<string>",
  "sample4": "<string>",
  "sample5": "<string>",
  "subUsecases": [
    "<string>"
  ],
  "subscriberOptin": true,
  "subscriberOptout": true,
  "termsAndConditions": true,
  "termsAndConditionsLink": "<string>",
  "webhookURL": "https://example.com/webhook",
  "webhookFailoverURL": "https://example.com/failover-webhook",
  "createdAt": "2021-03-08T17:57:48.801186",
  "updatedAt": "2021-03-08T17:57:48.801186"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

campaignId · string · required

Unique identifier of the campaign.

Response

200

application/json

Successful Response

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.

tcrBrandId · string · required

Unique identifier assigned to the brand by the registry.

Example:

"BBRAND1"

tcrCampaignId · string · required

Unique identifier assigned to the campaign by the registry.

Example:

"CCAMP1"

ageGated · boolean

Age gated content in campaign.

assignedPhoneNumbersCount · number

Number of phone numbers associated with the campaign

Example:

3

brandDisplayName · string

Display or marketing name of the brand.

Example:

"ABC Mobile"

campaignStatus · enum<string>

Campaign status

Available options: 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

Example:

"TCR_ACCEPTED"

description · string

Summary description of this campaign.

directLending · boolean

Direct lending or loan arrangement.

embeddedLink · boolean

Does message generated by the campaign include URL link in SMS?

embeddedLinkSample · string

Sample of an embedded link that will be sent to subscribers.

embeddedPhone · boolean

Does message generated by the campaign include phone number in SMS?

failureReasons · string

Failure reasons if campaign submission failed

helpKeywords · string

Subscriber help keywords. Multiple keywords are comma separated without space.

helpMessage · string

Help message of the campaign.

isNumberPoolingEnabled · boolean

Indicates whether the campaign has a T-Mobile number pool ID associated with it.

messageFlow · string

Message flow description.

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.

privacyPolicyLink · string

Link to the campaign's privacy policy.

usecase · string

Campaign usecase. Must be of defined valid types. Use /10dlc/enum/usecase operation to retrieve usecases available for given brand.

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.

subUsecases · string[]

Campaign sub-usecases. Must be of defined valid sub-usecase types. Use /10dlc/enum/usecase operation to retrieve list of valid sub-usecases

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

Is terms & conditions accepted?

termsAndConditionsLink · string

Link to the campaign's terms and conditions.

webhookURL · string

Webhook to which campaign status updates are sent.

Example:

"https://example.com/webhook"

webhookFailoverURL · string

Failover webhook to which campaign status updates are sent.

Example:

"https://example.com/failover-webhook"

createdAt · string

Date and time that the brand was created at.

Example:

"2021-03-08T17:57:48.801186"

updatedAt · string

Date and time that the brand was last updated at.

Example:

"2021-03-08T17:57:48.801186"