10DLC Registration
List campaign numbers
Returns the numbers attached to the campaign at the US 10DLC registry, as {"numberPreviews": [...]}. Each entry gives the number, its country and the registry numberKey, which you can pass in numberKeys on the number endpoints.
GET
/
10dlc
/
campaigns
/
{id}
/
numbers
cURL
curl --request GET \
--url https://api.vobiz.ai/api/v1/sms/10dlc/campaigns/{id}/numbers \
--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.list_campaign_numbers(
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}/numbers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"numberPreviews": [
{
"numberKey": "6f5e4d3c2b1a4c9d8e7f0a1b2c3d4e5f",
"number": "14155550100",
"countryCode": "US"
}
]
}{
"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
Numbers attached to the campaign.
Numbers the US 10DLC registry associates with a campaign.
One entry per attached number. Empty when no numbers are attached.
Show child attributes
Show child attributes
Was this page helpful?
⌘I
cURL
curl --request GET \
--url https://api.vobiz.ai/api/v1/sms/10dlc/campaigns/{id}/numbers \
--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.list_campaign_numbers(
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}/numbers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"numberPreviews": [
{
"numberKey": "6f5e4d3c2b1a4c9d8e7f0a1b2c3d4e5f",
"number": "14155550100",
"countryCode": "US"
}
]
}{
"error": "missing or invalid credentials"
}{
"error": "campaign not found"
}{
"error": "internal error"
}{
"error": "registration provider unavailable",
"providerError": "registration error 500 (HTTP 500): upstream timeout"
}