APIs relating to 10DLC brand and campaign management
APIs relating to working with Brands
APIs relating to working with Campaigns
APIs relating to working with Numbers in Campaigns
APIs relating to working with Brands
List brands
GET
https://api-eu.vonage.com/v1/10dlc/brands
Host
https://api-eu.vonage.com
GET
/v1/10dlc/brands
| Key | Description | Example | Default |
|---|---|---|---|
| Authorization |
Base64 encoded API key and secret joined by a colon. Read more |
Basic <base64> |
None |
Page of results to jump to
Number of results per page
Items per page
Page Offset
Number of pages in the entire result set
Number of items in the entire result set
{
"page_size": 10,
"page": 2,
"total_pages": 100,
"total_items": 100,
"_embedded": {
"brands": [
{
"account_id": "abcd1234",
"primary_account_id": "abcd1234",
"entity_type": "PUBLIC_PROFIT",
"first_name": "John",
"last_name": "Smith",
"display_name": "Vonage",
"company_name": "Vonage",
"ein": "20-1111111",
"ein_issuing_country": "US",
"universal_ein": "20-1111111",
"alt_business_id_type": "DUNS",
"alt_business_id": "150483782",
"phone": "+15556660001",
"street": "23 Main Street",
"city": "Holmdel",
"state": "NJ",
"postal_code": "07733",
"country": "US",
"email": "devrel@vonage.com",
"stock_symbol": "VG",
"stock_exchange": "NASDAQ",
"website": "https://vonage.com",
"vertical": "TECHNOLOGY",
"campaign_count": 5,
"brand_relationship": "BASIC_ACCOUNT",
"partner": false,
"shared": false,
"owner": false,
"status": "abc123",
"reference_id": "abc123",
"brand_id": "BLQKOPK",
"created_date": "2020-01-02 05:12:14",
"last_updated": "2020-02-02 14:12:00",
"_links": {
"self": {
"href": "https://api.nexmo.com/10dlc/brands/BLQKOPK"
},
"campaigns": {
"href": "https://api.nexmo.com/10dlc/brands/BLQKOPK/campaigns"
}
}
}
]
},
"_links": {
"self": {
"href": "https://api.nexmo.com/v1/10dlc/brands/BLQKOPK?page=2"
},
"next": {
"href": "https://api.nexmo.com/v1/10dlc/brands/?page=1"
},
"previous": {
"href": "https://api.nexmo.com/v1/10dlc/brands/?page=1"
},
"first": {
"href": "https://api.nexmo.com/v1/10dlc/brands/?page=1"
},
"last": {
"href": "https://api.nexmo.com/v1/10dlc/brands/?page=10"
}
}
}{
"type": "https://developer.vonage.com/api-errors/10dlc#error-type",
"title": "There were some issues with your submission",
"detail": "There were some errors submitting your brand, and a more detailed message would appear here",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}{
"type": "https://developer.vonage.com/api-errors#unauthorized",
"title": "Invalid credentials supplied",
"detail": "You did not provide correct credentials.",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}{
"type": "https://developer.vonage.com/api-errors#not-found",
"title": "Not Found",
"detail": "ID 'ABC123' does not exist, or you do not have access",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}{
"type": "https://developer.vonage.com/api-errors/10dlc#invalid-brand-data",
"title": "There were some issues with the submitted data",
"detail": "There were some errors submitting your brand, please correct the requested fields",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c",
"invalid_parameters": [
{
"code": 503,
"field": "company_name",
"description": "Field 'company_name' is not unique"
}
]
}Create a new brand for your account. Register the brand under your CSP account. Mandatory fields vary depending on the type of entity being registered, so be sure to select the type that best represents the brand you wish to create at the top of the Request body table below. Most accounts will be created immediately, and you can move on to qualifying a new campaign for the brand. Some brands may require additional vetting. In such cases, please move on to the vetting API endpoints before attempting to create a campaign.
Please note the entity_type field, as that field value will help
determine which fields are required.
POST
https://api-eu.vonage.com/v1/10dlc/brands
Host
https://api-eu.vonage.com
POST
/v1/10dlc/brands
| Key | Description | Example | Default |
|---|---|---|---|
| Authorization |
Base64 encoded API key and secret joined by a colon. Read more |
Basic <base64> |
None |
The Vonage Account ID
Entity type behind the brand. This is the form of business establishment. Please refer to the /enum endpoint for an update list of valid values.
Must be one of:PRIVATE_PROFIT, PUBLIC_PROFIT, NON_PROFIT or SOLE_PROPRIETOR
Display or marketing name of the brand.
Legal company name.
(Required for Non-profit) Government assigned corporate tax ID. EIN is 9-digits in U.S.A.
Valid phone number in E.164 international format without the + prefix.
Street number and name.
City name
State. Must be 2 letters code for U.S.A.
Postal codes. Use 5 digit zipcode for United States
ISO3166-Alpha2 country code.
Valid email address of brand support contact.
Business/industry segment of this campaign.
Must be one of:UNKNOWN, REAL_ESTATE, HEALTHCARE, ENERGY, ENTERTAINMENT, RETAIL, AGRICULTURE, INSURANCE, EDUCATION, HOSPITALITY, FINANCIAL, GAMBLING, CONSTRUCTION, NGO, MANUFACTURING, GOVERNMENT, TECHNOLOGY or COMMUNICATION
The Vonage Primary Account ID (the parent account of account_id).
First name of business contact.
Last name of business contact.
ISO3166-Alpha2 country code.
Universal EIN of Brand, Read-Only
Required if alt_business_id is provided.
Must be one of:DUNS, GIIN or LEI
Required if alt_business_id_type is provided.
Stock Symbol - Required if entity_type=PUBLIC_PROFIT.
Required if entity_type=PUBLIC_PROFIT.
Must be one of:NONE, AMEX, AMX, ASX, B3, BME, BSE, FRA, ICEX, JSE, KRX, LON, NASDAQ, NSE, NYSE, OMX, SEHK, SSE, STO, SWX, SZSE, TSX, TWSE or VSE
Brand website URL.
The Vonage Account ID
Entity type behind the brand. This is the form of business establishment. Please refer to the /enum endpoint for an update list of valid values.
Must be one of:PRIVATE_PROFIT, PUBLIC_PROFIT, NON_PROFIT or SOLE_PROPRIETOR
Display or marketing name of the brand.
Legal company name.
(Required for Non-profit) Government assigned corporate tax ID. EIN is 9-digits in U.S.A.
Valid phone number in E.164 international format without the + prefix.
Street number and name.
City name
State. Must be 2 letters code for U.S.A.
Postal codes. Use 5 digit zipcode for United States
ISO3166-Alpha2 country code.
Valid email address of brand support contact.
Business/industry segment of this campaign.
Must be one of:UNKNOWN, REAL_ESTATE, HEALTHCARE, ENERGY, ENTERTAINMENT, RETAIL, AGRICULTURE, INSURANCE, EDUCATION, HOSPITALITY, FINANCIAL, GAMBLING, CONSTRUCTION, NGO, MANUFACTURING, GOVERNMENT, TECHNOLOGY or COMMUNICATION
The Vonage Primary Account ID (the parent account of account_id).
First name of business contact.
Last name of business contact.
ISO3166-Alpha2 country code.
Universal EIN of Brand, Read-Only
Required if alt_business_id is provided.
Must be one of:DUNS, GIIN or LEI
Required if alt_business_id_type is provided.
Stock Symbol - Required if entity_type=PUBLIC_PROFIT.
Required if entity_type=PUBLIC_PROFIT.
Must be one of:NONE, AMEX, AMX, ASX, B3, BME, BSE, FRA, ICEX, JSE, KRX, LON, NASDAQ, NSE, NYSE, OMX, SEHK, SSE, STO, SWX, SZSE, TSX, TWSE or VSE
Brand website URL.
The Vonage Account ID
Entity type behind the brand. This is the form of business establishment. Please refer to the /enum endpoint for an update list of valid values.
Must be one of:PRIVATE_PROFIT, PUBLIC_PROFIT, NON_PROFIT or SOLE_PROPRIETOR
Display or marketing name of the brand.
Legal company name.
(Required for Non-profit) Government assigned corporate tax ID. EIN is 9-digits in U.S.A.
Valid phone number in E.164 international format without the + prefix.
Street number and name.
City name
State. Must be 2 letters code for U.S.A.
Postal codes. Use 5 digit zipcode for United States
ISO3166-Alpha2 country code.
Valid email address of brand support contact.
Stock Symbol - Required if entity_type=PUBLIC_PROFIT.
Required if entity_type=PUBLIC_PROFIT.
Must be one of:NONE, AMEX, AMX, ASX, B3, BME, BSE, FRA, ICEX, JSE, KRX, LON, NASDAQ, NSE, NYSE, OMX, SEHK, SSE, STO, SWX, SZSE, TSX, TWSE or VSE
Business/industry segment of this campaign.
Must be one of:UNKNOWN, REAL_ESTATE, HEALTHCARE, ENERGY, ENTERTAINMENT, RETAIL, AGRICULTURE, INSURANCE, EDUCATION, HOSPITALITY, FINANCIAL, GAMBLING, CONSTRUCTION, NGO, MANUFACTURING, GOVERNMENT, TECHNOLOGY or COMMUNICATION
The Vonage Primary Account ID (the parent account of account_id).
First name of business contact.
Last name of business contact.
ISO3166-Alpha2 country code.
Universal EIN of Brand, Read-Only
Required if alt_business_id is provided.
Must be one of:DUNS, GIIN or LEI
Required if alt_business_id_type is provided.
Brand website URL.
The Vonage Account ID
Entity type behind the brand. This is the form of business establishment. Please refer to the /enum endpoint for an update list of valid values.
Must be one of:PRIVATE_PROFIT, PUBLIC_PROFIT, NON_PROFIT or SOLE_PROPRIETOR
First name of business contact.
Last name of business contact.
Display or marketing name of the brand.
Legal company name.
(Required for Non-profit) Government assigned corporate tax ID. EIN is 9-digits in U.S.A.
Valid phone number in E.164 international format without the + prefix.
Street number and name.
City name
State. Must be 2 letters code for U.S.A.
Postal codes. Use 5 digit zipcode for United States
ISO3166-Alpha2 country code.
Valid email address of brand support contact.
The Vonage Primary Account ID (the parent account of account_id).
ISO3166-Alpha2 country code.
Universal EIN of Brand, Read-Only
Required if alt_business_id is provided.
Must be one of:DUNS, GIIN or LEI
Required if alt_business_id_type is provided.
Stock Symbol - Required if entity_type=PUBLIC_PROFIT.
Required if entity_type=PUBLIC_PROFIT.
Must be one of:NONE, AMEX, AMX, ASX, B3, BME, BSE, FRA, ICEX, JSE, KRX, LON, NASDAQ, NSE, NYSE, OMX, SEHK, SSE, STO, SWX, SZSE, TSX, TWSE or VSE
Brand website URL.
Business/industry segment of this campaign.
Must be one of:UNKNOWN, REAL_ESTATE, HEALTHCARE, ENERGY, ENTERTAINMENT, RETAIL, AGRICULTURE, INSURANCE, EDUCATION, HOSPITALITY, FINANCIAL, GAMBLING, CONSTRUCTION, NGO, MANUFACTURING, GOVERNMENT, TECHNOLOGY or COMMUNICATION
{
"account_id": "abcd1234",
"entity_type": "PUBLIC_PROFIT",
"display_name": "Vonage",
"company_name": "Vonage",
"ein": "20-1111111",
"phone": "+15556660001",
"street": "23 Main Street",
"city": "Holmdel",
"state": "NJ",
"postal_code": "07733",
"country": "US",
"email": "devrel@vonage.com",
"vertical": "TECHNOLOGY"
}{
"account_id": "abcd1234",
"entity_type": "PUBLIC_PROFIT",
"display_name": "Vonage",
"company_name": "Vonage",
"ein": "20-1111111",
"phone": "+15556660001",
"street": "23 Main Street",
"city": "Holmdel",
"state": "NJ",
"postal_code": "07733",
"country": "US",
"email": "devrel@vonage.com",
"vertical": "TECHNOLOGY",
"primary_account_id": "abcd1234",
"first_name": "John",
"last_name": "Smith",
"ein_issuing_country": "US",
"universal_ein": "20-1111111",
"alt_business_id_type": "DUNS",
"alt_business_id": "150483782",
"stock_symbol": "VG",
"stock_exchange": "NASDAQ",
"website": "https://vonage.com"
}{
"account_id": "abcd1234",
"entity_type": "PUBLIC_PROFIT",
"display_name": "Vonage",
"company_name": "Vonage",
"ein": "20-1111111",
"phone": "+15556660001",
"street": "23 Main Street",
"city": "Holmdel",
"state": "NJ",
"postal_code": "07733",
"country": "US",
"email": "devrel@vonage.com",
"vertical": "TECHNOLOGY"
}{
"account_id": "abcd1234",
"entity_type": "PUBLIC_PROFIT",
"display_name": "Vonage",
"company_name": "Vonage",
"ein": "20-1111111",
"phone": "+15556660001",
"street": "23 Main Street",
"city": "Holmdel",
"state": "NJ",
"postal_code": "07733",
"country": "US",
"email": "devrel@vonage.com",
"vertical": "TECHNOLOGY",
"primary_account_id": "abcd1234",
"first_name": "John",
"last_name": "Smith",
"ein_issuing_country": "US",
"universal_ein": "20-1111111",
"alt_business_id_type": "DUNS",
"alt_business_id": "150483782",
"stock_symbol": "VG",
"stock_exchange": "NASDAQ",
"website": "https://vonage.com"
}{
"account_id": "abcd1234",
"entity_type": "PUBLIC_PROFIT",
"display_name": "Vonage",
"company_name": "Vonage",
"ein": "20-1111111",
"phone": "+15556660001",
"street": "23 Main Street",
"city": "Holmdel",
"state": "NJ",
"postal_code": "07733",
"country": "US",
"email": "devrel@vonage.com",
"stock_symbol": "VG",
"stock_exchange": "NASDAQ",
"vertical": "TECHNOLOGY"
}{
"account_id": "abcd1234",
"entity_type": "PUBLIC_PROFIT",
"display_name": "Vonage",
"company_name": "Vonage",
"ein": "20-1111111",
"phone": "+15556660001",
"street": "23 Main Street",
"city": "Holmdel",
"state": "NJ",
"postal_code": "07733",
"country": "US",
"email": "devrel@vonage.com",
"stock_symbol": "VG",
"stock_exchange": "NASDAQ",
"vertical": "TECHNOLOGY",
"primary_account_id": "abcd1234",
"first_name": "John",
"last_name": "Smith",
"ein_issuing_country": "US",
"universal_ein": "20-1111111",
"alt_business_id_type": "DUNS",
"alt_business_id": "150483782",
"website": "https://vonage.com"
}{
"account_id": "abcd1234",
"entity_type": "PUBLIC_PROFIT",
"first_name": "John",
"last_name": "Smith",
"display_name": "Vonage",
"company_name": "Vonage",
"ein": "20-1111111",
"phone": "+15556660001",
"street": "23 Main Street",
"city": "Holmdel",
"state": "NJ",
"postal_code": "07733",
"country": "US",
"email": "devrel@vonage.com"
}{
"account_id": "abcd1234",
"entity_type": "PUBLIC_PROFIT",
"first_name": "John",
"last_name": "Smith",
"display_name": "Vonage",
"company_name": "Vonage",
"ein": "20-1111111",
"phone": "+15556660001",
"street": "23 Main Street",
"city": "Holmdel",
"state": "NJ",
"postal_code": "07733",
"country": "US",
"email": "devrel@vonage.com",
"primary_account_id": "abcd1234",
"ein_issuing_country": "US",
"universal_ein": "20-1111111",
"alt_business_id_type": "DUNS",
"alt_business_id": "150483782",
"stock_symbol": "VG",
"stock_exchange": "NASDAQ",
"website": "https://vonage.com",
"vertical": "TECHNOLOGY"
}{
"account_id": "abcd1234",
"primary_account_id": "abcd1234",
"entity_type": "PUBLIC_PROFIT",
"first_name": "John",
"last_name": "Smith",
"display_name": "Vonage",
"company_name": "Vonage",
"ein": "20-1111111",
"ein_issuing_country": "US",
"universal_ein": "20-1111111",
"alt_business_id_type": "DUNS",
"alt_business_id": "150483782",
"phone": "+15556660001",
"street": "23 Main Street",
"city": "Holmdel",
"state": "NJ",
"postal_code": "07733",
"country": "US",
"email": "devrel@vonage.com",
"stock_symbol": "VG",
"stock_exchange": "NASDAQ",
"website": "https://vonage.com",
"vertical": "TECHNOLOGY",
"campaign_count": 5,
"brand_relationship": "BASIC_ACCOUNT",
"partner": false,
"shared": false,
"owner": false,
"status": "abc123",
"reference_id": "abc123",
"brand_id": "BLQKOPK",
"created_date": "2020-01-02 05:12:14",
"last_updated": "2020-02-02 14:12:00",
"_links": {
"self": {
"href": "https://api.nexmo.com/10dlc/brands/BLQKOPK"
},
"campaigns": {
"href": "https://api.nexmo.com/10dlc/brands/BLQKOPK/campaigns"
}
}
}{
"type": "https://developer.vonage.com/api-errors/10dlc#error-type",
"title": "There were some issues with your submission",
"detail": "There were some errors submitting your brand, and a more detailed message would appear here",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}{
"type": "https://developer.vonage.com/api-errors#unauthorized",
"title": "Invalid credentials supplied",
"detail": "You did not provide correct credentials.",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}{
"type": "https://developer.vonage.com/api-errors#not-found",
"title": "Not Found",
"detail": "ID 'ABC123' does not exist, or you do not have access",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}{
"type": "https://developer.vonage.com/api-errors/10dlc#brand-conflict",
"title": "An error occurred with this brand while communicating with a third party",
"detail": "An unknown error occurred while processing this brand with the carrier system. Please contact support or try again later.",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}{
"type": "https://developer.vonage.com/api-errors/10dlc#invalid-brand-data",
"title": "There were some issues with the submitted data",
"detail": "There were some errors submitting your brand, please correct the requested fields",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c",
"invalid_parameters": [
{
"code": 503,
"field": "company_name",
"description": "Field 'company_name' is not unique"
}
]
}Get a brand
GET
https://api-eu.vonage.com/v1/10dlc/brands/:brand_id
Host
https://api-eu.vonage.com
GET
/v1/10dlc/brands/:brand_id
| Key | Description | Example | Default |
|---|---|---|---|
| Authorization |
Base64 encoded API key and secret joined by a colon. Read more |
Basic <base64> |
None |
Brand ID associated with a number
{
"account_id": "abcd1234",
"primary_account_id": "abcd1234",
"entity_type": "PUBLIC_PROFIT",
"first_name": "John",
"last_name": "Smith",
"display_name": "Vonage",
"company_name": "Vonage",
"ein": "20-1111111",
"ein_issuing_country": "US",
"universal_ein": "20-1111111",
"alt_business_id_type": "DUNS",
"alt_business_id": "150483782",
"phone": "+15556660001",
"street": "23 Main Street",
"city": "Holmdel",
"state": "NJ",
"postal_code": "07733",
"country": "US",
"email": "devrel@vonage.com",
"stock_symbol": "VG",
"stock_exchange": "NASDAQ",
"website": "https://vonage.com",
"vertical": "TECHNOLOGY",
"campaign_count": 5,
"brand_relationship": "BASIC_ACCOUNT",
"partner": false,
"shared": false,
"owner": false,
"status": "abc123",
"reference_id": "abc123",
"brand_id": "BLQKOPK",
"created_date": "2020-01-02 05:12:14",
"last_updated": "2020-02-02 14:12:00",
"_links": {
"self": {
"href": "https://api.nexmo.com/10dlc/brands/BLQKOPK"
},
"campaigns": {
"href": "https://api.nexmo.com/10dlc/brands/BLQKOPK/campaigns"
}
}
}{
"type": "https://developer.vonage.com/api-errors/10dlc#error-type",
"title": "There were some issues with your submission",
"detail": "There were some errors submitting your brand, and a more detailed message would appear here",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}{
"type": "https://developer.vonage.com/api-errors#unauthorized",
"title": "Invalid credentials supplied",
"detail": "You did not provide correct credentials.",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}{
"type": "https://developer.vonage.com/api-errors#not-found",
"title": "Not Found",
"detail": "ID 'ABC123' does not exist, or you do not have access",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}{
"type": "https://developer.vonage.com/api-errors/10dlc#invalid-brand-data",
"title": "There were some issues with the submitted data",
"detail": "There were some errors submitting your brand, please correct the requested fields",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c",
"invalid_parameters": [
{
"code": 503,
"field": "company_name",
"description": "Field 'company_name' is not unique"
}
]
}This operation applies a partial update of a brand enabling the CSP to keep brand details updated in the registry. Please note that if vetting is successfully completed, the ein ein_issuing_country and entity_type fields will be locked and the associated values cannot be changed.
PATCH
https://api-eu.vonage.com/v1/10dlc/brands/:brand_id
Host
https://api-eu.vonage.com
PATCH
/v1/10dlc/brands/:brand_id
| Key | Description | Example | Default |
|---|---|---|---|
| Authorization |
Base64 encoded API key and secret joined by a colon. Read more |
Basic <base64> |
None |
Brand ID associated with a number
Legal company name.
First name of business contact.
Last name of business contact.
Display or marketing name of the brand.
(Required for Non-profit) Government assigned corporate tax ID. EIN is 9-digits in U.S.A.
ISO3166-Alpha2 country code.
Entity type behind the brand. This is the form of business establishment. Please refer to the /enum endpoint for an update list of valid values.
Brand website URL.
Valid phone number in E.164 international format without the + prefix.
Street number and name.
City name
State. Must be 2 letters code for U.S.A.
Postal codes. Use 5 digit zipcode for United States
ISO3166-Alpha2 country code.
Valid email address of brand support contact.
Stock Symbol - Required if entity_type=PUBLIC_PROFIT.
Required if entity_type=PUBLIC_PROFIT.
Must be one of:NONE, AMEX, AMX, ASX, B3, BME, BSE, FRA, ICEX, JSE, KRX, LON, NASDAQ, NSE, NYSE, OMX, SEHK, SSE, STO, SWX, SZSE, TSX, TWSE or VSE
Business/industry segment of this campaign.
{
"company_name": "Vonage",
"first_name": "John",
"last_name": "Smith",
"display_name": "Vonage",
"ein": "20-1111111",
"ein_issuing_country": "US",
"entity_type": "PUBLIC_PROFIT",
"website": "https://vonage.com",
"phone": "+15556660001",
"street": "23 Main Street",
"city": "Holmdel",
"state": "NJ",
"postal_code": "07733",
"country": "US",
"email": "devrel@vonage.com",
"stock_symbol": "VG",
"stock_exchange": "NASDAQ",
"vertical": "TECHNOLOGY"
}{
"account_id": "abcd1234",
"primary_account_id": "abcd1234",
"entity_type": "PUBLIC_PROFIT",
"first_name": "John",
"last_name": "Smith",
"display_name": "Vonage",
"company_name": "Vonage",
"ein": "20-1111111",
"ein_issuing_country": "US",
"universal_ein": "20-1111111",
"alt_business_id_type": "DUNS",
"alt_business_id": "150483782",
"phone": "+15556660001",
"street": "23 Main Street",
"city": "Holmdel",
"state": "NJ",
"postal_code": "07733",
"country": "US",
"email": "devrel@vonage.com",
"stock_symbol": "VG",
"stock_exchange": "NASDAQ",
"website": "https://vonage.com",
"vertical": "TECHNOLOGY",
"campaign_count": 5,
"brand_relationship": "BASIC_ACCOUNT",
"partner": false,
"shared": false,
"owner": false,
"status": "abc123",
"reference_id": "abc123",
"brand_id": "BLQKOPK",
"created_date": "2020-01-02 05:12:14",
"last_updated": "2020-02-02 14:12:00",
"_links": {
"self": {
"href": "https://api.nexmo.com/10dlc/brands/BLQKOPK"
},
"campaigns": {
"href": "https://api.nexmo.com/10dlc/brands/BLQKOPK/campaigns"
}
}
}{
"type": "https://developer.vonage.com/api-errors/10dlc#error-type",
"title": "There were some issues with your submission",
"detail": "There were some errors submitting your brand, and a more detailed message would appear here",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}{
"type": "https://developer.vonage.com/api-errors#unauthorized",
"title": "Invalid credentials supplied",
"detail": "You did not provide correct credentials.",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}{
"type": "https://developer.vonage.com/api-errors#not-found",
"title": "Not Found",
"detail": "ID 'ABC123' does not exist, or you do not have access",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}{
"type": "https://developer.vonage.com/api-errors/10dlc#invalid-vetting-data",
"title": "There were some issues with the submitted data",
"detail": "There were some errors submitting your vetting request, please correct the requested fields",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c",
"invalid_parameters": [
{
"code": 503,
"field": "evp_id",
"description": "Field 'evp_id' is not unique"
}
]
}This operation deletes a brand. A brand can be deleted if it does not have active campaigns. Once a brand is deleted, it will be in a DELETED state and it cannot be restored to an ACTIVE state. Deleted brands will remain in the system for a period of time and can be searched using the GET/brand endpoint with the query filter status = ACTIVE. While deleted brands are searchable, all other API endpoints involving a deleted brand will result in a 502 - Brand not found error.
DELETE
https://api-eu.vonage.com/v1/10dlc/brands/:brand_id
Host
https://api-eu.vonage.com
DELETE
/v1/10dlc/brands/:brand_id
| Key | Description | Example | Default |
|---|---|---|---|
| Authorization |
Base64 encoded API key and secret joined by a colon. Read more |
Basic <base64> |
None |
Brand ID associated with a number
No content{
"type": "https://developer.vonage.com/api-errors/10dlc#error-type",
"title": "There were some issues with your submission",
"detail": "There were some errors submitting your brand, and a more detailed message would appear here",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}{
"type": "https://developer.vonage.com/api-errors#unauthorized",
"title": "Invalid credentials supplied",
"detail": "You did not provide correct credentials.",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}{
"type": "https://developer.vonage.com/api-errors#not-found",
"title": "Not Found",
"detail": "ID 'ABC123' does not exist, or you do not have access",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}{
"type": "https://developer.vonage.com/api-errors/10dlc#brand-conflict",
"title": "An error occurred with this brand while communicating with a third party",
"detail": "An unknown error occurred while processing this brand with the carrier system. Please contact support or try again later.",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}{
"type": "https://developer.vonage.com/api-errors/10dlc#invalid-brand-data",
"title": "There were some issues with the submitted data",
"detail": "There were some errors submitting your brand, please correct the requested fields",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c",
"invalid_parameters": [
{
"code": 503,
"field": "company_name",
"description": "Field 'company_name' is not unique"
}
]
}Retrieve feedback of a specific brand with Brand ID.
GET
https://api-eu.vonage.com/v1/10dlc/brands/:brand_id/feedback
Host
https://api-eu.vonage.com
GET
/v1/10dlc/brands/:brand_id/feedback
| Key | Description | Example | Default |
|---|---|---|---|
| Authorization |
Base64 encoded API key and secret joined by a colon. Read more |
Basic <base64> |
None |
Brand ID associated with a number
{
"categories": [
{
"name": "abc123",
"description": "abc123",
"fields": [
{}
]
}
]
}{
"type": "https://developer.vonage.com/api-errors/10dlc#error-type",
"title": "There were some issues with your submission",
"detail": "There were some errors submitting your brand, and a more detailed message would appear here",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}{
"type": "https://developer.vonage.com/api-errors#unauthorized",
"title": "Invalid credentials supplied",
"detail": "You did not provide correct credentials.",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}{
"type": "https://developer.vonage.com/api-errors#not-found",
"title": "Not Found",
"detail": "ID 'ABC123' does not exist, or you do not have access",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}{
"type": "https://developer.vonage.com/api-errors/10dlc#invalid-brand-data",
"title": "There were some issues with the submitted data",
"detail": "There were some errors submitting your brand, please correct the requested fields",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c",
"invalid_parameters": [
{
"code": 503,
"field": "company_name",
"description": "Field 'company_name' is not unique"
}
]
}Check to see if a brand is qualified to run a campaign against a given use case. A brand must check this endpoint before attempting to generate a new campaign.
If the use case is not qualified, the brand may request additional third party vetting to see if the additional use cases can be added to their account.
GET
https://api-eu.vonage.com/v1/10dlc/brands/:brand_id/usecases/:usecase
Host
https://api-eu.vonage.com
GET
/v1/10dlc/brands/:brand_id/usecases/:usecase
| Key | Description | Example | Default |
|---|---|---|---|
| Authorization |
Base64 encoded API key and secret joined by a colon. Read more |
Basic <base64> |
None |
Brand ID associated with a number
Name of a use case
Must be one of:CUSTOMER_CARE, POLLING_VOTING, HIGHER_EDUCATION, PUBLIC_SERVICE_ANNOUNCEMENT, MARKETING, SECURITY_ALERT, DELIVERY_NOTIFICATION, ACCOUNT_NOTIFICATION, 2FA, FRAUD_ALERT, TRIAL, CHARITY, POLITICAL, EMERGENCY, SWEEPSTAKE, CONVERSATIONAL, MIXED, CARRIER_EXEMPT, SOCIAL or LOW_VOLUME
{
"usecase": "POLITICAL",
"quarterly_fee": 30,
"annual_fee": 30,
"mno_metadata": [
{
"network_id": "10017",
"min_msg_samples": 2,
"att_msg_class": "Q",
"req_subscriber_opt_in": false,
"req_subscriber_help": false,
"req_subscriber_opt_out": false,
"mno": "AT&T",
"att_tpm": 2000,
"mno_support": true,
"mno_review": true,
"no_embedded_link": true,
"qualify": true,
"tmo_brand_tier": null
},
{
"network_id": "10035",
"min_msg_samples": 2,
"req_subscriber_opt_in": false,
"req_subscriber_help": false,
"req_subscriber_opt_out": false,
"mno": "TMO",
"mno_support": true,
"mno_review": true,
"no_embedded_link": true,
"no_embedded_phone": true,
"qualify": true,
"tmo_brand_tier": "LOW",
"att_tpm": null,
"att_msg_class": null
}
]
}{
"type": "https://developer.vonage.com/api-errors/10dlc#invalid-usecase-data",
"title": "There were some issues with the submitted data",
"detail": "There were some errors qualifying the use case for your brand, please correct the requested fields",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c",
"errors": [
{
"code": 501,
"field": "usecase",
"description": "Unrecognized Usecase"
}
]
}{
"type": "https://developer.vonage.com/api-errors#unauthorized",
"title": "Invalid credentials supplied",
"detail": "You did not provide correct credentials.",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}{
"type": "https://developer.vonage.com/api-errors#not-found",
"title": "Not Found",
"detail": "ID 'ABC123' does not exist, or you do not have access",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}{
"type": "https://developer.vonage.com/api-errors/10dlc#invalid-brand-data",
"title": "There were some issues with the submitted data",
"detail": "There were some errors submitting your brand, please correct the requested fields",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c",
"invalid_parameters": [
{
"code": 503,
"field": "company_name",
"description": "Field 'company_name' is not unique"
}
]
}Retrieve a list of vetting records for a brand
GET
https://api-eu.vonage.com/v1/10dlc/brands/:brand_id/vetting/requests
Host
https://api-eu.vonage.com
GET
/v1/10dlc/brands/:brand_id/vetting/requests
| Key | Description | Example | Default |
|---|---|---|---|
| Authorization |
Base64 encoded API key and secret joined by a colon. Read more |
Basic <base64> |
None |
Brand ID associated with a number
The Vonage Account ID
ID associated with a vetting request
[
{
"account_id": "abcd1234",
"evp_id": "abc123",
"vetting_id": "abc123",
"vetting_token": "abc123",
"vetting_score": 1,
"vetting_class": "abc123",
"vetting_status": "abc123",
"vetted_date": "abc123",
"create_date": "abc123",
"_links": {
"self": {
"href": "https://api.nexmo.com/v1/10dlc/brands/BLQKOPK/vetting/requests/abcd1234"
},
"brand": {
"href": "https://api.nexmo.com/v1/10dlc/brands/BLQKOPK"
}
}
}
]{
"type": "https://developer.vonage.com/api-errors/10dlc#error-type",
"title": "There were some issues with your submission",
"detail": "There were some errors submitting your brand, and a more detailed message would appear here",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}{
"type": "https://developer.vonage.com/api-errors#unauthorized",
"title": "Invalid credentials supplied",
"detail": "You did not provide correct credentials.",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}{
"type": "https://developer.vonage.com/api-errors#not-found",
"title": "Not Found",
"detail": "ID 'ABC123' does not exist, or you do not have access",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}{
"type": "https://developer.vonage.com/api-errors/10dlc#invalid-vetting-data",
"title": "There were some issues with the submitted data",
"detail": "There were some errors submitting your vetting request, please correct the requested fields",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c",
"invalid_parameters": [
{
"code": 503,
"field": "evp_id",
"description": "Field 'evp_id' is not unique"
}
]
}This operation requests the specific vetting provider to perform vetting on a brand. This authorizes Vonage to allow the vetting partner access to the particular brand information stored in The Campaign Registry (TCR). This request can take anywhere from a few minutes to 48 hours.
POST
https://api-eu.vonage.com/v1/10dlc/brands/:brand_id/vetting/requests
Host
https://api-eu.vonage.com
POST
/v1/10dlc/brands/:brand_id/vetting/requests
| Key | Description | Example | Default |
|---|---|---|---|
| Authorization |
Base64 encoded API key and secret joined by a colon. Read more |
Basic <base64> |
None |
Brand ID associated with a number
This value must be the ID associated with one of the supported vetting providers.
Must be one of:Aegis, CV or WMC
Type of vetting to perform.
The Vonage Account ID
ID associated with a vetting request
{
"evp_id": "abcd123",
"vetting_class": "abcd123"
}{
"account_id": "abcd1234",
"evp_id": "abc123",
"vetting_id": "abc123",
"vetting_token": "abc123",
"vetting_score": 1,
"vetting_class": "abc123",
"vetting_status": "abc123",
"vetted_date": "abc123",
"create_date": "abc123",
"_links": {
"self": {
"href": "https://api.nexmo.com/v1/10dlc/brands/BLQKOPK/vetting/requests/abcd1234"
},
"brand": {
"href": "https://api.nexmo.com/v1/10dlc/brands/BLQKOPK"
}
}
}{
"type": "https://developer.vonage.com/api-errors/10dlc#invalid-vetting-data",
"title": "There were some issues with the submitted data",
"detail": "There were some errors submitting your vetting request, please correct the requested fields",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c",
"invalid_parameters": [
{
"code": 503,
"field": "evp_id",
"description": "Field 'evp_id' is not unique"
}
]
}{
"type": "https://developer.vonage.com/api-errors#throttled",
"title": "Too many requests",
"detail": "Your account has reached it's API limit and has been throttled",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c",
"retry_after": 30
}Vetting requests can either be automated or manual. In the case that a vetting request has been manually performed or was requested outside of Vonage, you can request that the request be imported. The vetting request will be validated and, if successful, saved with the brand in TCR and the vetting record will be considered for future campaign qualification. This validation process is not immediate.
PUT
https://api-eu.vonage.com/v1/10dlc/brands/:brand_id/vetting/requests
Host
https://api-eu.vonage.com
PUT
/v1/10dlc/brands/:brand_id/vetting/requests
| Key | Description | Example | Default |
|---|---|---|---|
| Authorization |
Base64 encoded API key and secret joined by a colon. Read more |
Basic <base64> |
None |
Brand ID associated with a number
The identity of the vetting partner. This value must be the ID associated with one of the supported vetting providers.
Must be one of:Aegis, CV or WMC
Type of vetting to perform. Not required for all vetting providers.
Unique ID that identifies a vetting transaction performed by a vetting provider. This ID is provided by the vetting provider at time of vetting.
The Vonage Account ID
ID associated with a vetting request
{
"evp_id": "abcd123",
"vetting_id": "abcd123"
}{
"evp_id": "abcd123",
"vetting_token": "abcd123",
"vetting_id": "abcd123"
}{
"account_id": "abcd1234",
"evp_id": "abc123",
"vetting_id": "abc123",
"vetting_token": "abc123",
"vetting_score": 1,
"vetting_class": "abc123",
"vetting_status": "abc123",
"vetted_date": "abc123",
"create_date": "abc123",
"_links": {
"self": {
"href": "https://api.nexmo.com/v1/10dlc/brands/BLQKOPK/vetting/requests/abcd1234"
},
"brand": {
"href": "https://api.nexmo.com/v1/10dlc/brands/BLQKOPK"
}
}
}{
"type": "https://developer.vonage.com/api-errors/10dlc#vetting-conflict",
"title": "An error occurred while requesting third party vetting",
"detail": "An unknown error occurred while requesting vetting with the carrier system. Please contact support or try again later.",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}{
"type": "https://developer.vonage.com/api-errors/10dlc#invalid-vetting-data",
"title": "There were some issues with the submitted data",
"detail": "There were some errors submitting your vetting request, please correct the requested fields",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c",
"invalid_parameters": [
{
"code": 503,
"field": "evp_id",
"description": "Field 'evp_id' is not unique"
}
]
}{
"type": "https://developer.vonage.com/api-errors#throttled",
"title": "Too many requests",
"detail": "Your account has reached it's API limit and has been throttled",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c",
"retry_after": 30
}This operation allows you to revet the brand; however, revetting is
allowed once after the successful brand registration. Search for campaigns you registered by any combination of brand_id, reseller_id, status, usecase, and vertical. This operation supports pagination with a maximum of 500 records per fetch. Values for brand_id, reseller_id, status, usecase, and vertical must be exact matches if supplied.
POST
https://api-eu.vonage.com/v1/10dlc/brands/:brand_id/revet
Host
https://api-eu.vonage.com
POST
/v1/10dlc/brands/:brand_id/revet
| Key | Description | Example | Default |
|---|---|---|---|
| Authorization |
Base64 encoded API key and secret joined by a colon. Read more |
Basic <base64> |
None |
Brand ID associated with a number
{
"account_id": "abcd1234",
"primary_account_id": "abcd1234",
"entity_type": "PUBLIC_PROFIT",
"first_name": "John",
"last_name": "Smith",
"display_name": "Vonage",
"company_name": "Vonage",
"ein": "20-1111111",
"ein_issuing_country": "US",
"universal_ein": "20-1111111",
"alt_business_id_type": "DUNS",
"alt_business_id": "150483782",
"phone": "+15556660001",
"street": "23 Main Street",
"city": "Holmdel",
"state": "NJ",
"postal_code": "07733",
"country": "US",
"email": "devrel@vonage.com",
"stock_symbol": "VG",
"stock_exchange": "NASDAQ",
"website": "https://vonage.com",
"vertical": "TECHNOLOGY",
"campaign_count": 5,
"brand_relationship": "BASIC_ACCOUNT",
"partner": false,
"shared": false,
"owner": false,
"status": "abc123",
"reference_id": "abc123",
"brand_id": "BLQKOPK",
"created_date": "2020-01-02 05:12:14",
"last_updated": "2020-02-02 14:12:00",
"_links": {
"self": {
"href": "https://api.nexmo.com/10dlc/brands/BLQKOPK"
},
"campaigns": {
"href": "https://api.nexmo.com/10dlc/brands/BLQKOPK/campaigns"
}
}
}{
"type": "https://developer.vonage.com/api-errors#unauthorized",
"title": "Invalid credentials supplied",
"detail": "You did not provide correct credentials.",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}{
"type": "https://developer.vonage.com/api-errors#not-found",
"title": "Not Found",
"detail": "ID 'ABC123' does not exist, or you do not have access",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}{
"type": "https://developer.vonage.com/api-errors/#invalid-json",
"title": "Unable to parse incoming request",
"detail": "invalid character 'f' after object key:value pair",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}When requesting brand vetting, a vetting class must be supplied. This determines the scope of the vetting to be performed by the vetting provider.
GET
https://api-eu.vonage.com/v1/10dlc/enum/vetting/classes
Host
https://api-eu.vonage.com
GET
/v1/10dlc/enum/vetting/classes
| Key | Description | Example | Default |
|---|---|---|---|
| Authorization |
Base64 encoded API key and secret joined by a colon. Read more |
Basic <base64> |
None |
[
{
"id": "abc123",
"enabled": false,
"display_name": "abc123",
"description": "abc123",
"validity_months": 12
}
]When requesting external vetting, a user must select from a list of approved vetting providers.
GET
https://api-eu.vonage.com/v1/10dlc/enum/vetting/providers
Host
https://api-eu.vonage.com
GET
/v1/10dlc/enum/vetting/providers
| Key | Description | Example | Default |
|---|---|---|---|
| Authorization |
Base64 encoded API key and secret joined by a colon. Read more |
Basic <base64> |
None |
[
{
"evp_id": "abc123",
"display_name": "abc123",
"tcr_billable": false,
"vetting_classes": [
"class1",
"class2"
],
"vetting_instruction": "abc123"
}
]APIs relating to working with Campaigns
List campaigns
GET
https://api-eu.vonage.com/v1/10dlc/brands/:brand_id/campaigns
Host
https://api-eu.vonage.com
GET
/v1/10dlc/brands/:brand_id/campaigns
| Key | Description | Example | Default |
|---|---|---|---|
| Authorization |
Base64 encoded API key and secret joined by a colon. Read more |
Basic <base64> |
None |
Brand ID associated with a number
Page of results to jump to
Number of results per page
Items per page
Page Offset
Number of pages in the entire result set
Number of items in the entire result set
{
"page_size": 10,
"page": 2,
"total_pages": 100,
"total_items": 100,
"_embedded": {
"campaigns": [
{
"account_id": "abcd1234",
"vertical": "TECHNOLOGY",
"usecase": "ACCOUNT_NOTIFICATION",
"sub_usecases": [
"2FA",
"SECURITY_ALERT"
],
"reseller_id": "string",
"description": "User notifications",
"embedded_link": false,
"embedded_phone": false,
"number_pool": false,
"age_gated": true,
"direct_lending": true,
"subscriber_opt_in": false,
"subscriber_opt_out": false,
"subscriber_help": false,
"sample_one": "Sample Message",
"sample_two": "Additional Sample Message",
"sample_three": "Additional Sample Message",
"sample_four": "Additional Sample Message",
"sample_five": "Additional Sample Message",
"message_flow": "string",
"help_message": "string",
"affiliate_marketing": true,
"label": "This is a sample campaign",
"auto_renewal": true,
"brand_id": "BLQKOPK",
"mno_metadata": [
{
"network_id": "10017",
"min_msg_samples": 1,
"msg_class": "A",
"req_subscriber_opt_out": false,
"mno_review": "false,",
"no_embedded_phone": "true,",
"mno": "AT&T",
"tpm": 3000,
"req_subscriber_help": false,
"req_subscriber_opt_in": true,
"mno_support": true,
"no_embedded_link": true,
"qualify": true,
"status": "APPROVED"
},
{
"network_id": "10035",
"min_msg_samples": 1,
"req_subscriber_help": false,
"req_subscriber_opt_out": false,
"req_subscriber_opt_in": true,
"mno_review": false,
"mno_support": true,
"no_embedded_phone": "true,",
"no_embedded_link": true,
"qualify": true,
"brand_tier": "LOW",
"mno": "TMO",
"status": "APPROVED"
}
],
"status": "ACTIVE",
"campaign_id": "C1DEB879",
"created_date": "abc123",
"last_updated": "abc123",
"_links": {
"self": {
"href": "https://api.nexmo.com/v1/10dlc/brands/BLQKOPK/campaigns/C1DEB879"
},
"brand": {
"href": "https://api.nexmo.com/v1/10dlc/brands/BLQKOPK"
},
"numbers": {
"href": "https://api.nexmo.com/v1/10dlc/brands/BLQKOPK/campaigns/C1DEB879/numbers"
}
}
}
]
},
"_links": {
"brand": {
"href": "https://api.nexmo.com/v1/10dlc/brands/BLQKOPK"
},
"self": {
"href": "https://api.nexmo.com/v1/10dlc/brands/BLQKOPK/campaigns/?page=2"
},
"next": {
"href": "https://api.nexmo.com/v1/10dlc/brands/BLQKOPK/campaigns/?page=1"
},
"previous": {
"href": "https://api.nexmo.com/v1/10dlc/brands/BLQKOPK/campaigns/?page=1"
},
"first": {
"href": "https://api.nexmo.com/v1/10dlc/brands/BLQKOPK/campaigns/?page=1"
},
"last": {
"href": "https://api.nexmo.com/v1/10dlc/brands/BLQKOPK/campaigns/?page=10"
}
}
}{
"type": "https://developer.vonage.com/api-errors/10dlc#error-type",
"title": "There were some issues with your submission",
"detail": "There were some errors submitting your brand, and a more detailed message would appear here",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}{
"type": "https://developer.vonage.com/api-errors#unauthorized",
"title": "Invalid credentials supplied",
"detail": "You did not provide correct credentials.",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}{
"type": "https://developer.vonage.com/api-errors#not-found",
"title": "Not Found",
"detail": "ID 'ABC123' does not exist, or you do not have access",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}{
"type": "https://developer.vonage.com/api-errors/#invalid-json",
"title": "Unable to parse incoming request",
"detail": "invalid character 'f' after object key:value pair",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}Create Campaign
POST
https://api-eu.vonage.com/v1/10dlc/brands/:brand_id/campaigns
Host
https://api-eu.vonage.com
POST
/v1/10dlc/brands/:brand_id/campaigns
| Key | Description | Example | Default |
|---|---|---|---|
| Authorization |
Base64 encoded API key and secret joined by a colon. Read more |
Basic <base64> |
None |
Brand ID associated with a number
The Vonage Account ID
Business/industry segment of this campaign. (Required if entity_type != SOLE_PROPRIETOR). Please refer to the /enum endpoint for an update list of valid values.
Must be one of:UNKNOWN, REAL_ESTATE, HEALTHCARE, ENERGY, ENTERTAINMENT, RETAIL, AGRICULTURE, INSURANCE, EDUCATION, HOSPITALITY, FINANCIAL, GAMBLING, CONSTRUCTION, NGO, MANUFACTURING, GOVERNMENT, TECHNOLOGY or COMMUNICATION
Campaign usecase
Must be one of:CUSTOMER_CARE, POLLING_VOTING, HIGHER_EDUCATION, PUBLIC_SERVICE_ANNOUNCEMENT, MARKETING, SECURITY_ALERT, DELIVERY_NOTIFICATION, ACCOUNT_NOTIFICATION, 2FA, FRAUD_ALERT, TRIAL, CHARITY, POLITICAL, EMERGENCY, SWEEPSTAKE, CONVERSATIONAL, MIXED, CARRIER_EXEMPT, SOCIAL or LOW_VOLUME
Campaign sub-usecases
Alphanumeric identifier of the reseller that you want to associate with this campaign
Summary description of this campaign
Does message generated by the campaign include URL link in SMS?
Does message generated by the campaign include phone number in SMS?
Does campaign utilize pool of phone numbers?
Age gated message content in campaign.
Direct lending or loan arrangement
Does campaign require subscriber to opt-in before SMS is sent to subscriber?
Does campaign support subscriber opt-out keyword(s)?
Does campaign responds to help keyword(s)?
Message sample. Some campaign tiers require 1 or more message samples.
Message sample. Some campaign tiers require 2 or more message samples.
Message sample. Some campaign tiers require 3 or more message samples.
Message sample. Some campaign tiers require 4 or more message samples.
Message sample. Some campaign tiers require 5.
Message flow description
Help message of the campaign
Does message content controlled by affiliate marketing other than the brand?
Fields that are editable for a campaign
Fields that are editable for a campaign
{
"account_id": "abcd1234",
"usecase": "ACCOUNT_NOTIFICATION",
"description": "User notifications"
}{
"account_id": "abcd1234",
"vertical": "TECHNOLOGY",
"usecase": "ACCOUNT_NOTIFICATION",
"sub_usecases": [
"2FA",
"SECURITY_ALERT"
],
"reseller_id": "string",
"description": "User notifications",
"age_gated": true,
"direct_lending": true,
"sample_one": "Sample Message",
"sample_two": "Additional Sample Message",
"sample_three": "Additional Sample Message",
"sample_four": "Additional Sample Message",
"sample_five": "Additional Sample Message",
"message_flow": "string",
"help_message": "string",
"affiliate_marketing": true,
"label": "This is a sample campaign",
"auto_renewal": true
}{
"account_id": "abcd1234",
"vertical": "TECHNOLOGY",
"usecase": "ACCOUNT_NOTIFICATION",
"sub_usecases": [
"2FA",
"SECURITY_ALERT"
],
"reseller_id": "string",
"description": "User notifications",
"embedded_link": false,
"embedded_phone": false,
"number_pool": false,
"age_gated": true,
"direct_lending": true,
"subscriber_opt_in": false,
"subscriber_opt_out": false,
"subscriber_help": false,
"sample_one": "Sample Message",
"sample_two": "Additional Sample Message",
"sample_three": "Additional Sample Message",
"sample_four": "Additional Sample Message",
"sample_five": "Additional Sample Message",
"message_flow": "string",
"help_message": "string",
"affiliate_marketing": true,
"label": "This is a sample campaign",
"auto_renewal": true,
"brand_id": "BLQKOPK",
"mno_metadata": [
{
"network_id": "10017",
"min_msg_samples": 1,
"msg_class": "A",
"req_subscriber_opt_out": false,
"mno_review": "false,",
"no_embedded_phone": "true,",
"mno": "AT&T",
"tpm": 3000,
"req_subscriber_help": false,
"req_subscriber_opt_in": true,
"mno_support": true,
"no_embedded_link": true,
"qualify": true,
"status": "APPROVED"
},
{
"network_id": "10035",
"min_msg_samples": 1,
"req_subscriber_help": false,
"req_subscriber_opt_out": false,
"req_subscriber_opt_in": true,
"mno_review": false,
"mno_support": true,
"no_embedded_phone": "true,",
"no_embedded_link": true,
"qualify": true,
"brand_tier": "LOW",
"mno": "TMO",
"status": "APPROVED"
}
],
"status": "ACTIVE",
"campaign_id": "C1DEB879",
"created_date": "abc123",
"last_updated": "abc123",
"_links": {
"self": {
"href": "https://api.nexmo.com/v1/10dlc/brands/BLQKOPK/campaigns/C1DEB879"
},
"brand": {
"href": "https://api.nexmo.com/v1/10dlc/brands/BLQKOPK"
},
"numbers": {
"href": "https://api.nexmo.com/v1/10dlc/brands/BLQKOPK/campaigns/C1DEB879/numbers"
}
}
}{
"type": "https://developer.vonage.com/api-errors/10dlc#error-type",
"title": "There were some issues with your submission",
"detail": "There were some errors submitting your brand, and a more detailed message would appear here",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}{
"type": "https://developer.vonage.com/api-errors#unauthorized",
"title": "Invalid credentials supplied",
"detail": "You did not provide correct credentials.",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}{
"type": "https://developer.vonage.com/api-errors#not-found",
"title": "Not Found",
"detail": "ID 'ABC123' does not exist, or you do not have access",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}{
"type": "https://developer.vonage.com/api-errors/10dlc#brand-not-qualified",
"title": "This brand has not been qualified for the given use case",
"detail": "A campaign use case must be checked before a campaign can be created. Please verify the brand use case before submitting this campaign.",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}{
"type": "https://developer.vonage.com/api-errors/10dlc#invalid-campaign-data",
"title": "There were some issues with the submitted data",
"detail": "There were some errors submitting your campaign, please correct the requested fields",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c",
"invalid_parameters": [
{
"code": 503,
"field": "usecase",
"description": "Field 'usecase' is not a valid value"
}
]
}Get a campaign
GET
https://api-eu.vonage.com/v1/10dlc/brands/:brand_id/campaigns/:campaign_id
Host
https://api-eu.vonage.com
GET
/v1/10dlc/brands/:brand_id/campaigns/:campaign_id
| Key | Description | Example | Default |
|---|---|---|---|
| Authorization |
Base64 encoded API key and secret joined by a colon. Read more |
Basic <base64> |
None |
Brand ID associated with a number
ID associated with a specific campaign
{
"account_id": "abcd1234",
"vertical": "TECHNOLOGY",
"usecase": "ACCOUNT_NOTIFICATION",
"sub_usecases": [
"2FA",
"SECURITY_ALERT"
],
"reseller_id": "string",
"description": "User notifications",
"embedded_link": false,
"embedded_phone": false,
"number_pool": false,
"age_gated": true,
"direct_lending": true,
"subscriber_opt_in": false,
"subscriber_opt_out": false,
"subscriber_help": false,
"sample_one": "Sample Message",
"sample_two": "Additional Sample Message",
"sample_three": "Additional Sample Message",
"sample_four": "Additional Sample Message",
"sample_five": "Additional Sample Message",
"message_flow": "string",
"help_message": "string",
"affiliate_marketing": true,
"label": "This is a sample campaign",
"auto_renewal": true,
"brand_id": "BLQKOPK",
"mno_metadata": [
{
"network_id": "10017",
"min_msg_samples": 1,
"msg_class": "A",
"req_subscriber_opt_out": false,
"mno_review": "false,",
"no_embedded_phone": "true,",
"mno": "AT&T",
"tpm": 3000,
"req_subscriber_help": false,
"req_subscriber_opt_in": true,
"mno_support": true,
"no_embedded_link": true,
"qualify": true,
"status": "APPROVED"
},
{
"network_id": "10035",
"min_msg_samples": 1,
"req_subscriber_help": false,
"req_subscriber_opt_out": false,
"req_subscriber_opt_in": true,
"mno_review": false,
"mno_support": true,
"no_embedded_phone": "true,",
"no_embedded_link": true,
"qualify": true,
"brand_tier": "LOW",
"mno": "TMO",
"status": "APPROVED"
}
],
"status": "ACTIVE",
"campaign_id": "C1DEB879",
"created_date": "abc123",
"last_updated": "abc123",
"_links": {
"self": {
"href": "https://api.nexmo.com/v1/10dlc/brands/BLQKOPK/campaigns/C1DEB879"
},
"brand": {
"href": "https://api.nexmo.com/v1/10dlc/brands/BLQKOPK"
},
"numbers": {
"href": "https://api.nexmo.com/v1/10dlc/brands/BLQKOPK/campaigns/C1DEB879/numbers"
}
}
}{
"type": "https://developer.vonage.com/api-errors/10dlc#error-type",
"title": "There were some issues with your submission",
"detail": "There were some errors submitting your brand, and a more detailed message would appear here",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}{
"type": "https://developer.vonage.com/api-errors#unauthorized",
"title": "Invalid credentials supplied",
"detail": "You did not provide correct credentials.",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}{
"type": "https://developer.vonage.com/api-errors#not-found",
"title": "Not Found",
"detail": "ID 'ABC123' does not exist, or you do not have access",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}{
"type": "https://developer.vonage.com/api-errors/10dlc#invalid-campaign-data",
"title": "There were some issues with the submitted data",
"detail": "There were some errors submitting your campaign, please correct the requested fields",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c",
"invalid_parameters": [
{
"code": 503,
"field": "usecase",
"description": "Field 'usecase' is not a valid value"
}
]
}Partial update of a campaign
PATCH
https://api-eu.vonage.com/v1/10dlc/brands/:brand_id/campaigns/:campaign_id
Host
https://api-eu.vonage.com
PATCH
/v1/10dlc/brands/:brand_id/campaigns/:campaign_id
| Key | Description | Example | Default |
|---|---|---|---|
| Authorization |
Base64 encoded API key and secret joined by a colon. Read more |
Basic <base64> |
None |
Brand ID associated with a number
ID associated with a specific campaign
Fields that are editable for a campaign
Fields that are editable for a campaign
Fields that are editable for a campaign
Fields that are editable for a campaign
Fields that are editable for a campaign
Fields that are editable for a campaign
Fields that are editable for a campaign
Fields that are editable for a campaign
Fields that are editable for a campaign
Fields that are editable for a campaign
{
"label": "This is a sample campaign",
"reseller_id": "string",
"sample_one": "Sample Message",
"sample_two": "Additional Sample Message",
"sample_three": "Additional Sample Message",
"sample_four": "Additional Sample Message",
"sample_five": "Additional Sample Message",
"message_flow": "string",
"help_message": "string",
"auto_renewal": true
}{
"account_id": "abcd1234",
"vertical": "TECHNOLOGY",
"usecase": "ACCOUNT_NOTIFICATION",
"sub_usecases": [
"2FA",
"SECURITY_ALERT"
],
"reseller_id": "string",
"description": "User notifications",
"embedded_link": false,
"embedded_phone": false,
"number_pool": false,
"age_gated": true,
"direct_lending": true,
"subscriber_opt_in": false,
"subscriber_opt_out": false,
"subscriber_help": false,
"sample_one": "Sample Message",
"sample_two": "Additional Sample Message",
"sample_three": "Additional Sample Message",
"sample_four": "Additional Sample Message",
"sample_five": "Additional Sample Message",
"message_flow": "string",
"help_message": "string",
"affiliate_marketing": true,
"label": "This is a sample campaign",
"auto_renewal": true,
"brand_id": "BLQKOPK",
"mno_metadata": [
{
"network_id": "10017",
"min_msg_samples": 1,
"msg_class": "A",
"req_subscriber_opt_out": false,
"mno_review": "false,",
"no_embedded_phone": "true,",
"mno": "AT&T",
"tpm": 3000,
"req_subscriber_help": false,
"req_subscriber_opt_in": true,
"mno_support": true,
"no_embedded_link": true,
"qualify": true,
"status": "APPROVED"
},
{
"network_id": "10035",
"min_msg_samples": 1,
"req_subscriber_help": false,
"req_subscriber_opt_out": false,
"req_subscriber_opt_in": true,
"mno_review": false,
"mno_support": true,
"no_embedded_phone": "true,",
"no_embedded_link": true,
"qualify": true,
"brand_tier": "LOW",
"mno": "TMO",
"status": "APPROVED"
}
],
"status": "ACTIVE",
"campaign_id": "C1DEB879",
"created_date": "abc123",
"last_updated": "abc123",
"_links": {
"self": {
"href": "https://api.nexmo.com/v1/10dlc/brands/BLQKOPK/campaigns/C1DEB879"
},
"brand": {
"href": "https://api.nexmo.com/v1/10dlc/brands/BLQKOPK"
},
"numbers": {
"href": "https://api.nexmo.com/v1/10dlc/brands/BLQKOPK/campaigns/C1DEB879/numbers"
}
}
}{
"type": "https://developer.vonage.com/api-errors/10dlc#error-type",
"title": "There were some issues with your submission",
"detail": "There were some errors submitting your brand, and a more detailed message would appear here",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}{
"type": "https://developer.vonage.com/api-errors#not-found",
"title": "Not Found",
"detail": "ID 'ABC123' does not exist, or you do not have access",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}{
"type": "https://developer.vonage.com/api-errors/10dlc#invalid-campaign-data",
"title": "There were some issues with the submitted data",
"detail": "There were some errors submitting your campaign, please correct the requested fields",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c",
"invalid_parameters": [
{
"code": 503,
"field": "usecase",
"description": "Field 'usecase' is not a valid value"
}
]
}Stop a brand
DELETE
https://api-eu.vonage.com/v1/10dlc/brands/:brand_id/campaigns/:campaign_id
Host
https://api-eu.vonage.com
DELETE
/v1/10dlc/brands/:brand_id/campaigns/:campaign_id
| Key | Description | Example | Default |
|---|---|---|---|
| Authorization |
Base64 encoded API key and secret joined by a colon. Read more |
Basic <base64> |
None |
Brand ID associated with a number
ID associated with a specific campaign
No content{
"type": "https://developer.vonage.com/api-errors/10dlc#error-type",
"title": "There were some issues with your submission",
"detail": "There were some errors submitting your brand, and a more detailed message would appear here",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}{
"type": "https://developer.vonage.com/api-errors#unauthorized",
"title": "Invalid credentials supplied",
"detail": "You did not provide correct credentials.",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}{
"type": "https://developer.vonage.com/api-errors#not-found",
"title": "Not Found",
"detail": "ID 'ABC123' does not exist, or you do not have access",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}APIs relating to working with Numbers in Campaigns
Get numbers in campaign
GET
https://api-eu.vonage.com/v1/10dlc/brands/:brand_id/campaigns/:campaign_id/numbers
Host
https://api-eu.vonage.com
GET
/v1/10dlc/brands/:brand_id/campaigns/:campaign_id/numbers
| Key | Description | Example | Default |
|---|---|---|---|
| Authorization |
Base64 encoded API key and secret joined by a colon. Read more |
Basic <base64> |
None |
Brand ID associated with a number
ID associated with a specific campaign
Page of results to jump to
Number of results per page
Items per page
Page Offset
Number of pages in the entire result set
Number of items in the entire result set
Telephone Number
The two character country code in ISO 3166-1 alpha-2 format
Current status of a number in a campaign
One of:UNKNOWN, APPROVED, REJECTED or PENDING
List of compliance flags.
{
"page_size": 10,
"page": 2,
"total_pages": 100,
"total_items": 100,
"_embedded": {
"numbers": [
{
"number": "14155550110",
"country": "US",
"status": "APPROVED",
"compliance": [
{}
],
"_links": {
"self": {
"href": "https://api.nexmo.com/v1/10dlc/brands/BLQKOPK/campaigns/C1DEB879/numbers/14155550110"
},
"campaign": {
"href": "https://api.nexmo.com/v1/10dlc/brands/BLQKOPK/campaigns/C1DEB879/"
},
"brand": {
"href": "https://api.nexmo.com/v1/10dlc/brands/BLQKOPK"
}
}
}
]
}
}{
"type": "https://developer.vonage.com/api-errors#unauthorized",
"title": "Invalid credentials supplied",
"detail": "You did not provide correct credentials.",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}{
"type": "https://developer.vonage.com/api-errors#not-found",
"title": "Not Found",
"detail": "ID 'ABC123' does not exist, or you do not have access",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}{
"type": "https://developer.vonage.com/api-errors/10dlc#invalid-number-data",
"title": "There were some issues with the submitted data",
"detail": "There were some errors submitting your campaign, please correct the requested fields",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c",
"invalid_parameters": [
{
"field": "country",
"description": "Field 'country' is not a valid value"
}
]
}Links an existing Vonage number to a 10DLC campaign.
POST
https://api-eu.vonage.com/v1/10dlc/brands/:brand_id/campaigns/:campaign_id/numbers
Host
https://api-eu.vonage.com
POST
/v1/10dlc/brands/:brand_id/campaigns/:campaign_id/numbers
| Key | Description | Example | Default |
|---|---|---|---|
| Authorization |
Base64 encoded API key and secret joined by a colon. Read more |
Basic <base64> |
None |
Brand ID associated with a number
ID associated with a specific campaign
The two character country code in ISO 3166-1 alpha-2 format
Telephone Number
Telephone Number
The two character country code in ISO 3166-1 alpha-2 format
Current status of a number in a campaign
One of:UNKNOWN, APPROVED, REJECTED or PENDING
List of compliance flags.
{
"country": "US",
"number": "14155550110"
}{
"number": "14155550110",
"country": "US",
"status": "APPROVED",
"compliance": [
{}
],
"_links": {
"self": {
"href": "https://api.nexmo.com/v1/10dlc/brands/BLQKOPK/campaigns/C1DEB879/numbers/14155550110"
},
"campaign": {
"href": "https://api.nexmo.com/v1/10dlc/brands/BLQKOPK/campaigns/C1DEB879/"
},
"brand": {
"href": "https://api.nexmo.com/v1/10dlc/brands/BLQKOPK"
}
}
}{
"type": "https://developer.vonage.com/api-errors#unauthorized",
"title": "Invalid credentials supplied",
"detail": "You did not provide correct credentials.",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}{
"type": "https://developer.vonage.com/api-errors#not-found",
"title": "Not Found",
"detail": "ID 'ABC123' does not exist, or you do not have access",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}{
"type": "https://developer.vonage.com/api-errors/10dlc#number-already-linked",
"title": "Number Already Linked",
"detail": "The number requested has already been linked to another campaign",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}{
"type": "https://developer.vonage.com/api-errors/10dlc#invalid-number-data",
"title": "There were some issues with the submitted data",
"detail": "There were some errors submitting your campaign, please correct the requested fields",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c",
"invalid_parameters": [
{
"field": "country",
"description": "Field 'country' is not a valid value"
}
]
}Retrieve information about a number in a campaign
GET
https://api-eu.vonage.com/v1/10dlc/brands/:brand_id/campaigns/:campaign_id/numbers/:number
Host
https://api-eu.vonage.com
GET
/v1/10dlc/brands/:brand_id/campaigns/:campaign_id/numbers/:number
| Key | Description | Example | Default |
|---|---|---|---|
| Authorization |
Base64 encoded API key and secret joined by a colon. Read more |
Basic <base64> |
None |
Brand ID associated with a number
ID associated with a specific campaign
Number to work with inside a campaign
Telephone Number
The two character country code in ISO 3166-1 alpha-2 format
Current status of a number in a campaign
One of:UNKNOWN, APPROVED, REJECTED or PENDING
List of compliance flags.
{
"number": "14155550110",
"country": "US",
"status": "APPROVED",
"compliance": [
{}
],
"_links": {
"self": {
"href": "https://api.nexmo.com/v1/10dlc/brands/BLQKOPK/campaigns/C1DEB879/numbers/14155550110"
},
"campaign": {
"href": "https://api.nexmo.com/v1/10dlc/brands/BLQKOPK/campaigns/C1DEB879/"
},
"brand": {
"href": "https://api.nexmo.com/v1/10dlc/brands/BLQKOPK"
}
}
}{
"type": "https://developer.vonage.com/api-errors#unauthorized",
"title": "Invalid credentials supplied",
"detail": "You did not provide correct credentials.",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}{
"type": "https://developer.vonage.com/api-errors#not-found",
"title": "Not Found",
"detail": "ID 'ABC123' does not exist, or you do not have access",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}{
"type": "https://developer.vonage.com/api-errors/10dlc#invalid-number-data",
"title": "There were some issues with the submitted data",
"detail": "There were some errors submitting your campaign, please correct the requested fields",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c",
"invalid_parameters": [
{
"field": "country",
"description": "Field 'country' is not a valid value"
}
]
}Unlink a number from a campaign
DELETE
https://api-eu.vonage.com/v1/10dlc/brands/:brand_id/campaigns/:campaign_id/numbers/:number
Host
https://api-eu.vonage.com
DELETE
/v1/10dlc/brands/:brand_id/campaigns/:campaign_id/numbers/:number
| Key | Description | Example | Default |
|---|---|---|---|
| Authorization |
Base64 encoded API key and secret joined by a colon. Read more |
Basic <base64> |
None |
Brand ID associated with a number
ID associated with a specific campaign
Number to work with inside a campaign
No Content{
"type": "https://developer.vonage.com/api-errors#unauthorized",
"title": "Invalid credentials supplied",
"detail": "You did not provide correct credentials.",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}{
"type": "https://developer.vonage.com/api-errors#not-found",
"title": "Not Found",
"detail": "ID 'ABC123' does not exist, or you do not have access",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}{
"type": "https://developer.vonage.com/api-errors/10dlc#invalid-number-data",
"title": "There were some issues with the submitted data",
"detail": "There were some errors submitting your campaign, please correct the requested fields",
"instance": "797a8f199c45014ab7b08bfe9cc1c12c",
"invalid_parameters": [
{
"field": "country",
"description": "Field 'country' is not a valid value"
}
]
}The following is a non-exhaustive list of error codes that may occur while using this API. These codes are in addition to any of our generic error codes.
| Code | Details |
|---|---|
| brand-conflict | A conflict when a brand is being created or edited and there is an issue with a 3rd party vendor. |
| brand-parameters | There are errors in the brand data submitted. |
| invalid-usecase-data | There are errors in the data submitted for use case qualification. |
| use-case-denied | The use case requested has been denied for this brand. |
| vetting-conflict | A conflict during the brand vetting request has occurred. |
| invalid-vetting-data | There are errors in the vetting request data submitted. |
| invalid-json | Your request cannot be parsed. |
| brand-not-qualified | A conflict when a campaign is being created under a brand that hasn't qualified for the specified use case. |
| invalid-campaign-data | There are errors in the campaign data submitted. |
| numbers-already-linked | The number you are attempting to link is already linked to another campaign. |
| invalid-number-data | There are errors in the number data submitted. |