A2P 10DLC - BrandVetting Resource
The BrandVetting resource represents the association between a Campaign Verify(link takes you to an external page) token and a BrandRegistration resource .
The BrandVetting resource is a subresource of the BrandRegistration resource.
Resource properties brand_sid
type: SID<BN>
The unique string to identify Brand Registration.
Pattern:
^BN[0-9a-fA-F]{32}$
brand_vetting_sid
type: SID<VT>
The Twilio SID of the third-party vetting record.
Pattern:
^VT[0-9a-fA-F]{32}$
date_updated
type: string<date-time>
date_created
type: string<date-time>
vetting_id
type: string
The unique identifier of the vetting from the third-party provider.
vetting_class
type: string
The type of vetting that has been conducted. One of “STANDARD” (Aegis) or “POLITICAL” (Campaign Verify).
vetting_status
type: string
The status of the import vetting attempt. One of “PENDING,” “SUCCESS,” or “FAILED”.
vetting_provider
type: enum<string>
The third-party provider that has conducted the vetting. One of “CampaignVerify” (Campaign Verify tokens) or “AEGIS” (Secondary Vetting).
Possible values:
campaign-verify
url
type: string<uri>
The absolute URL of the Brand Vetting resource.
POST https://messaging.twilio.com/v1/a2p/BrandRegistrations/{BrandSid}/Vettings
This API request creates a BrandVetting resource. This associates a BrandRegistration resource and a Campaign Verify token.
The VettingProvider
is campaign-verify
, and the Campaign Verify token is provided in the VettingId
parameter.
URI parameters BrandSid
type: SID<BN>
The SID of the Brand Registration resource of the vettings to create .
Pattern:
^BN[0-9a-fA-F]{32}$
Request body parameters VettingProvider
type: enum<string> Required
The third-party provider of the vettings to create .
Possible values:
campaign-verify
VettingId
type: string
The unique ID of the vetting
_14 // Download the helper library from https://www.twilio.com/docs/node/install
_14 // Find your Account SID and Auth Token at twilio.com/console
_14 // and set the environment variables. See http://twil.io/secure
_14 const accountSid = process.env.TWILIO_ACCOUNT_SID;
_14 const authToken = process.env.TWILIO_AUTH_TOKEN;
_14 const client = require('twilio')(accountSid, authToken);
_14 client.messaging.v1.brandRegistrations('BNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_14 vettingId: 'cv|1.0|tcr|10dlc|9975c339-d46f-49b7-a399-2e6d5ebac66d|EXAMPLEjEd8xSlaAgRXAXXBUNBT2AgL-LdQuPveFhEyY',
_14 vettingProvider: 'campaign-verify'
_14 .then(brand_vetting => console.log(brand_vetting.brandSid));
_12 "account_sid": "AC78e8e67fc0246521490fb9907fd0c165",
_12 "brand_sid": "BNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12 "brand_vetting_sid": "VT12445353",
_12 "vetting_provider": "campaign-verify",
_12 "vetting_id": "cv|1.0|tcr|10dlc|9975c339-d46f-49b7-a399-2e6d5ebac66d|EXAMPLEjEd8xSlaAgRXAXXBUNBT2AgL-LdQuPveFhEyY",
_12 "vetting_class": "POLITICAL",
_12 "vetting_status": "IN_PROGRESS",
_12 "date_created": "2021-01-27T14:18:35Z",
_12 "date_updated": "2021-01-27T14:18:35Z",
_12 "url": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings/VT12445353"
Warning Don't create a UsAppToPerson resource until the BrandVetting resource's vetting_status
is SUCCESS
.
You can check the vetting_status
of the BrandVetting resource using the Fetch request below .
Once the BrandVetting status is SUCCESS
, the Campaign Verify token has been successfully associated with your Brand. This allows you to use the POLITICAL
special use case.
GET https://messaging.twilio.com/v1/a2p/BrandRegistrations/{BrandSid}/Vettings/{BrandVettingSid}
This API request fetches an individual BrandVetting resource using a BrandVettingSid
.
You can use this request to check the vetting_status
of a BrandVetting resource.
URI parameters BrandSid
type: SID<BN>
The SID of the Brand Registration resource of the vettings to read .
Pattern:
^BN[0-9a-fA-F]{32}$
BrandVettingSid
type: SID<VT>
The Twilio SID of the third-party vetting record.
Pattern:
^VT[0-9a-fA-F]{32}$
_11 // Download the helper library from https://www.twilio.com/docs/node/install
_11 // Find your Account SID and Auth Token at twilio.com/console
_11 // and set the environment variables. See http://twil.io/secure
_11 const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11 const authToken = process.env.TWILIO_AUTH_TOKEN;
_11 const client = require('twilio')(accountSid, authToken);
_11 client.messaging.v1.brandRegistrations('BNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11 .brandVettings('VTXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11 .then(brand_vetting => console.log(brand_vetting.brandSid));
_12 "account_sid": "AC78e8e67fc0246521490fb9907fd0c165",
_12 "brand_sid": "BNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12 "brand_vetting_sid": "VTXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12 "vetting_provider": "campaign-verify",
_12 "vetting_id": "cv|1.0|tcr|10dlc|9975c339-d46f-49b7-a399-EXAMPLETOKEN|GQ3EXAMPLETOKENAXXBUNBT2AgL-LdQuPveFhEyY",
_12 "vetting_class": "POLITICAL",
_12 "vetting_status": "IN_PROGRESS",
_12 "date_created": "2021-01-27T14:18:35Z",
_12 "date_updated": "2021-01-27T14:18:35Z",
_12 "url": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings/VT12445353"
GET https://messaging.twilio.com/v1/a2p/BrandRegistrations/{BrandSid}/Vettings
This request returns all BrandVetting resources associated with a BrandRegistration resource .
URI parameters BrandSid
type: SID<BN>
The SID of the Brand Registration resource of the vettings to read .
Pattern:
^BN[0-9a-fA-F]{32}$
VettingProvider
type: enum<string>
The third-party provider of the vettings to read
Possible values:
campaign-verify
PageSize
type: integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
Page
type: integer
The page index. This value is simply for client state.
PageToken
type: string
The page token. This is provided by the API.
_11 // Download the helper library from https://www.twilio.com/docs/node/install
_11 // Find your Account SID and Auth Token at twilio.com/console
_11 // and set the environment variables. See http://twil.io/secure
_11 const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11 const authToken = process.env.TWILIO_AUTH_TOKEN;
_11 const client = require('twilio')(accountSid, authToken);
_11 client.messaging.v1.brandRegistrations('BNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11 .then(brandVettings => brandVettings.forEach(b => console.log(b.brandSid)));
_25 "first_page_url": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings?PageSize=50&Page=0",
_25 "previous_page_url": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings?PageSize=50&Page=0",
_25 "next_page_url": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings?PageSize=50&Page=1",
_25 "url": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings?PageSize=50&Page=0"
_25 "account_sid": "AC78e8e67fc0246521490fb9907fd0c165",
_25 "brand_sid": "BN0044409f7e067e279523808d267e2d85",
_25 "brand_vetting_sid": "VT12445353",
_25 "vetting_provider": "campaign-verify",
_25 "vetting_id": "cv|1.0|tcr|10dlc|9975c339-d46f-49b7-a399-EXAMPLETOKEN|GQ3EXAMPLETOKENAXXBUNBT2AgL-LdQuPveFhEyY",
_25 "vetting_class": "POLITICAL",
_25 "vetting_status": "IN_PROGRESS",
_25 "date_created": "2021-01-27T14:18:35Z",
_25 "date_updated": "2021-01-27T14:18:35Z",
_25 "url": "https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings/VT12445353"