Qualify a 10DLC Brand for a use case

curl --request GET \
  --url 'https://api.wavix.com/v1/10dlc/brands/{brand_id}/usecases/{use_case}?appid='

{
  "mno_metadata": [
    {
      "att_mms_tpm": null,
      "att_msg_class": null,
      "att_sms_tpm": null,
      "att_tpm_scope": null,
      "help_required": true,
      "min_msg_samples": 1,
      "mno": "T-Mobile",
      "mno_qualify": true,
      "mno_review": false,
      "mno_support": true,
      "no_embedded_links": false,
      "no_embedded_phone": false,
      "optin_required": true,
      "optout_required": false,
      "tmobile_brand_dcap": 2000,
      "tmobile_brand_tier": "LOW"
    }
  ],
  "monthly_fee": 10,
  "usecase": "2FA"
}

GET

10dlc

brands

{brand_id}

usecases

{use_case}

Qualify a 10DLC Brand for a use case

curl --request GET \
  --url 'https://api.wavix.com/v1/10dlc/brands/{brand_id}/usecases/{use_case}?appid='

{
  "mno_metadata": [
    {
      "att_mms_tpm": null,
      "att_msg_class": null,
      "att_sms_tpm": null,
      "att_tpm_scope": null,
      "help_required": true,
      "min_msg_samples": 1,
      "mno": "T-Mobile",
      "mno_qualify": true,
      "mno_review": false,
      "mno_support": true,
      "no_embedded_links": false,
      "no_embedded_phone": false,
      "optin_required": true,
      "optout_required": false,
      "tmobile_brand_dcap": 2000,
      "tmobile_brand_tier": "LOW"
    }
  ],
  "monthly_fee": 10,
  "usecase": "2FA"
}

Authorizations

appid

string

query

required

An API key to authorize your request

Path Parameters

brand_id

string

required

Unique identifier of a Brand

Example:

"BMQFB7X"

use_case

enum<string>

required

The use case name

Available options:

AGENTS_FRANCHISES,

CARRIER_EXEMPT,

CHARITY,

EMERGENCY,

K12_EDUCATION,

LOW_VOLUME,

M2M,

MIXED,

POLITICAL,

PROXY,

SOCIAL,

SOLE_PROPRIETOR,

SWEEPSTAKE,

TRIAL,

UCAAS_HIGH,

UCAAS_LOW,

2FA,

ACCOUNT_NOTIFICATION,

CUSTOMER_CARE,

DELIVERY_NOTIFICATION,

FRAUD_ALERT,

HIGHER_EDUCATION,

MARKETING,

POLLING_VOTING,

PUBLIC_SERVICE_ANNOUNCEMENT,

SECURITY_ALERT

Example:

"2FA"

Response

mno_metadata

10DLCMNOmetadata · object[]

required

An array MNO-specific attributes (e.g. AT&T message class) for every MNO the Brand is qualified to run a Campaign with the specified use case.

Show child attributes

mno_metadata.att_mms_tpm

integer<int32> | null

required

MMS message throughput on the AT&T mobile networks

mno_metadata.att_msg_class

string | null

required

The message class assigned by AT&T

mno_metadata.att_sms_tpm

integer<int32> | null

required

MMS message throughput on the AT&T mobile networks

mno_metadata.att_tpm_scope

string<int32> | null

required

The message throughput score on the AT&T mobile networks

mno_metadata.help_required

boolean

required

Indicates whether the HEPL keywords and acknowledgement is mandatory for the use case

Example:

true

mno_metadata.optin_required

boolean

required

Indicates whether the opt in mechanism is mandatory for the use case

Example:

true

mno_metadata.optout_required

boolean

required

Indicates whether the opt out mechanism is mandatory for the use case

Example:

false

mno_metadata.min_msg_samples

integer<int32>

required

The minimal number of message samples required by the MNO

Example:

1

mno_metadata.mno

string

required

The MNO name

Example:

"T-Mobile"

mno_metadata.mno_qualify

boolean

required

Indicates whether the Brand is qualified by the MNO for the selected use case

Example:

true

mno_metadata.mno_review

boolean

required

Indicates whether the use case post-approval review is request by the MNO

Example:

false

mno_metadata.mno_support

boolean

required

Indicates whether the use case is supported by the MNO

Example:

true

mno_metadata.no_embedded_links

boolean

required

Indicates whether embedded links are prohibited in the message content for the use case

Example:

false

mno_metadata.no_embedded_phone

boolean

required

Indicates whether embedded phone numbers are prohibited in the message content for the use case

Example:

false

mno_metadata.tmobile_brand_dcap

integer<int32> | null

required

Message daily cap on the T-Mobile mobile networks

Example:

2000

mno_metadata.tmobile_brand_tier

string | null

required

The Brand tier for the T-Mobile mobile networks

Example:

"LOW"

monthly_fee

number

required

Monthly fee associated with any Campaign with this use case

Example:

10

usecase

string

required

The use case name

Example:

"2FA"

Appeal an external vetting for a 10DLC Brand

List all 10DLC Campaigns on your account

Using the APIs

API reference

Qualify a 10DLC Brand for a use case

Authorizations

Path Parameters

Response