The Use Case object represents details for a campaign use case.
usecase
string
Campaign use case.
monthlyFee
number (double)
Campaign monthly subscription fee.
quarterlyFee
number (double)
Campaign quarterly subscription fee.
annualFee
number (double)
Campaign annual subscription fee.
minSubUsecases
integer (int32)
Minimum number of sub use cases declaration required.
maxSubUsecases
integer (int32)
Maximum number of sub use cases declaration required.
mnoMetadata
array
Use case attributes and restrictions for each MNO.
tpmScope
string enum, values: CAMPAIGN, PHONE_NUMBER
Message TPM (throughput per minute) restriction scope. Possible values are:
minMsgSamples
integer (int32)
Minimum number of message samples required by the MNO for submission of the desired use case.
msgClass
string
Message class assigned to the campaign by the MNO. Required for AT&T. Please refer to the AT&T 10DLC guide for complete list of available message class and definition.
reqSubscriberOptout
boolean
If true, the MNO requires the campaign to support an opt-out mechanism through MO stop key words such as STOP and QUIT. If a STOP message is received from a subscriber, the campaign must stop sending messages to the subscriber immediately.
mnoReview
boolean
If true, the MNO requires the subscriber to opt-into the campaign before messages may be sent to the subscriber. Opt-in mechanism can be mobile or web opt-in.
noEmbeddedPhone
boolean
If true, the MNO forbids a call-to-action phone number to be embedded in all messages sent to the subscriber.
mno
string
Name of the MNO.
tpm
integer (int32)
Message TPM (throughput per minute) qualified by the brand for the desired use case. Required for AT&T.
reqSubscriberHelp
boolean
If true, the MNO requires the campaign to support a help mechanism through MO help key words such as HELP and INFO.
reqSubscriberOptin
boolean
If true, the MNO requires the subscriber to opt-into the campaign before messages may be sent to the subscriber. The opt-in mechanism can be mobile or web opt-in.
mnoSupport
boolean
If false, the desired use case is not supported by the MNO.
noEmbeddedLink
boolean
If true, the MNO forbids a call-to-action link/URL to be embedded in all messages sent to the subscriber.
qualify
boolean
If false, the brand does not qualify for the desired use case on the MNO.
brandDailyCap
integer (int32)
Number of messages allowed per day on the T-mobile network. If brandTier is UNCAPPED, then this attribute will be NULL.
brandTier
string
Brand tier. Daily message volume is restricted based on brand tier or brand qualification. The daily volume restriction applies to brand across campaigns and CSPs.
Use Case Object
{
"usecase": "Marketing",
"monthlyFee": 0,
"quarterlyFee": 0,
"annualFee": 0,
"minSubUsecases": 0,
"maxSubUsecases": 0,
"mnoMetadata": [
{
"tpmScope": "string",
"minMsgSamples": 0,
"msgClass": "string",
"reqSubscriberOptout": true,
"mnoReview": true,
"noEmbeddedPhone": true,
"mno": "AT&T",
"tpm": 0,
"reqSubscriberHelp": true,
"reqSubscriberOptin": true,
"mnoSupport": true,
"noEmbeddedLink": true,
"qualify": true,
"brandDailyCap": 0,
"brandTier": "string"
}
]
}
© 2023 Rocket Financial. All rights reserved. RocketFNCL, RocketKOR, RocketBNK are trade names of Rocket Financial Inc.
Services Agreement | Privacy Policy | RocketFNCL | © 2023 by Rocket Financial Inc. All rights reserved.
Services Agreement | Privacy Policy | RocketFNCL | © 2023 by Rocket Financial Inc. All rights reserved.
Services Agreement | Privacy Policy | RocketFNCL
© 2023 by Rocket Financial Inc. All rights reserved.