Skip to main content
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);
import os
from telnyx import Telnyx

client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
response = client.messaging_10dlc.campaign_builder.brand.qualify_by_usecase(
usecase="usecase",
brand_id="brandId",
)
print(response.annual_fee)
package main

import (
"context"
"fmt"

"github.com/team-telnyx/telnyx-go"
"github.com/team-telnyx/telnyx-go/option"
)

func main() {
client := telnyx.NewClient(
option.WithAPIKey("My API Key"),
)
response, err := client.Messaging10dlc.CampaignBuilder.Brand.QualifyByUsecase(
context.TODO(),
"usecase",
telnyx.Messaging10dlcCampaignBuilderBrandQualifyByUsecaseParams{
BrandID: "brandId",
},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", response.AnnualFee)
}
package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.messaging10dlc.campaignbuilder.brand.BrandQualifyByUsecaseParams;
import com.telnyx.sdk.models.messaging10dlc.campaignbuilder.brand.BrandQualifyByUsecaseResponse;

public final class Main {
private Main() {}

public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();

BrandQualifyByUsecaseParams params = BrandQualifyByUsecaseParams.builder()
.brandId("brandId")
.usecase("usecase")
.build();
BrandQualifyByUsecaseResponse response = client.messaging10dlc().campaignBuilder().brand().qualifyByUsecase(params);
}
}
require "telnyx"

telnyx = Telnyx::Client.new(api_key: "My API Key")

response = telnyx.messaging_10dlc.campaign_builder.brand.qualify_by_usecase("usecase", brand_id: "brandId")

puts(response)
<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
$response = $client->messaging10dlc->campaignBuilder->brand->qualifyByUsecase(
'usecase', brandID: 'brandId'
);

var_dump($response);
} catch (APIException $e) {
echo $e->getMessage();
}
telnyx messaging-10dlc:campaign-builder:brand qualify-by-usecase \
--api-key 'My API Key' \
--brand-id brandId \
--usecase usecase
curl --request GET \
--url https://api.telnyx.com/v2/10dlc/campaignBuilder/brand/{brandId}/usecase/{usecase} \
--header 'Authorization: Bearer <token>'
{
  "annualFee": 123,
  "maxSubUsecases": 123,
  "minSubUsecases": 123,
  "mnoMetadata": {},
  "monthlyFee": 123,
  "quarterlyFee": 123,
  "usecase": "<string>"
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}
{
"errors": [
{
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<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

Unique identifier of the usecase.

brandId
string
required

Unique identifier of the brand.

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