Telnyx

GET

10dlc

campaignBuilder

brand

{brandId}

usecase

{usecase}

JavaScript

import Telnyx from 'telnyx';

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

const response = await client.messaging10dlc.campaignBuilder.brand.qualifyByUsecase('usecase', {
  brandId: 'brandId',
});

console.log(response.annualFee);

{
  "annualFee": 123,
  "maxSubUsecases": 123,
  "minSubUsecases": 123,
  "mnoMetadata": {},
  "monthlyFee": 123,
  "quarterlyFee": 123,
  "usecase": "<string>"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

usecase

string

required

brandId

string

required

Response

Successful Response

annualFee

number

Campaign annual subscription fee

maxSubUsecases

integer

Maximum number of sub-usecases declaration required.

minSubUsecases

integer

Minimum number of sub-usecases declaration required.

mnoMetadata

Mnometadata · object

Map of usecase metadata for each MNO. Key is the network ID of the MNO (e.g. 10017), Value is the mno metadata for the usecase.

monthlyFee

number

Campaign monthly subscription fee

quarterlyFee

number

Campaign quarterly subscription fee

usecase

string

Campaign usecase

Submit Campaign

List Brands

⌘I

JavaScript

import Telnyx from 'telnyx';

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

const response = await client.messaging10dlc.campaignBuilder.brand.qualifyByUsecase('usecase', {
  brandId: 'brandId',
});

console.log(response.annualFee);

{
  "annualFee": 123,
  "maxSubUsecases": 123,
  "minSubUsecases": 123,
  "mnoMetadata": {},
  "monthlyFee": 123,
  "quarterlyFee": 123,
  "usecase": "<string>"
}

Documentation Index

Authorizations

Path Parameters

Response