List campaign network statuses
Returns the campaign’s status at each US carrier network, read live from the US 10DLC registry. Each entry names the network and its state, plus the message class, throughput and brand tier when the network reports them.
curl --request GET \
--url https://api.vobiz.ai/api/v1/sms/10dlc/campaigns/{id}/network-statuses \
--header 'X-Auth-ID: <api-key>' \
--header 'X-Auth-Token: <api-key>'from vobiz import Vobiz
client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")
client.sms.campaigns.campaign_network_statuses(
id="4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24",
)
const options = {
method: 'GET',
headers: {'X-Auth-ID': '<api-key>', 'X-Auth-Token': '<api-key>'}
};
fetch('https://api.vobiz.ai/api/v1/sms/10dlc/campaigns/{id}/network-statuses', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));[
{
"network": "T_MOBILE",
"state": "ACTIVE",
"messageClass": "24",
"throughput": 2000,
"brandTier": "LOW"
},
{
"network": "ATT",
"state": "ACTIVE",
"messageClass": "T",
"throughput": 75
},
{
"network": "VERIZON",
"state": "ACTIVE"
}
]{
"error": "missing or invalid credentials"
}{
"error": "campaign not found"
}{
"error": "internal error"
}{
"error": "registration provider unavailable",
"providerError": "registration error 500 (HTTP 500): upstream timeout"
}Authorizations
Your Vobiz account Auth ID (MA_XXXXXXXX).
Your Vobiz account Auth Token.
Path Parameters
Campaign ID (UUID) returned by POST /10dlc/campaigns or POST /10dlc/campaigns/toll-free. An unknown ID, an ID from another account, or a value that is not a UUID returns 404 with {"error":"campaign not found"}.
Response
One entry per US carrier network.
Carrier network the entry describes, for example T_MOBILE, ATT or VERIZON.
"T_MOBILE"
The campaign's registration state on that network, for example ACTIVE once provisioned.
"ACTIVE"
Message class the network assigned to the campaign. null when the network does not report one.
"T"
Throughput the network grants the campaign. The unit depends on the network (messages per minute on some, a daily cap on others). null when the network does not report one.
75
Brand tier the network applies, for example LOW. null when the network does not use tiers.
"LOW"
Was this page helpful?
curl --request GET \
--url https://api.vobiz.ai/api/v1/sms/10dlc/campaigns/{id}/network-statuses \
--header 'X-Auth-ID: <api-key>' \
--header 'X-Auth-Token: <api-key>'from vobiz import Vobiz
client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")
client.sms.campaigns.campaign_network_statuses(
id="4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24",
)
const options = {
method: 'GET',
headers: {'X-Auth-ID': '<api-key>', 'X-Auth-Token': '<api-key>'}
};
fetch('https://api.vobiz.ai/api/v1/sms/10dlc/campaigns/{id}/network-statuses', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));[
{
"network": "T_MOBILE",
"state": "ACTIVE",
"messageClass": "24",
"throughput": 2000,
"brandTier": "LOW"
},
{
"network": "ATT",
"state": "ACTIVE",
"messageClass": "T",
"throughput": 75
},
{
"network": "VERIZON",
"state": "ACTIVE"
}
]{
"error": "missing or invalid credentials"
}{
"error": "campaign not found"
}{
"error": "internal error"
}{
"error": "registration provider unavailable",
"providerError": "registration error 500 (HTTP 500): upstream timeout"
}