Sign inGet started

TCR Enums

Brands

verticals

GET
/numbers-tcr/verticals
A vertical refers to a specific industry, market, or niche in which a company operates or targets its products and services. This endpoint returns the available ones here at Bird.
Payload respons
results
array of object
wajib
Tampilkan atribut turunan
results.name
string
wajib
results.industryId
string
wajib
results.displayName
string
wajib
results.description
string
wajib
Contoh kode
curl -X GET 'https://api.bird.com/numbers-tcr/verticals' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'

entityType

ValueDescription
PRIVATE_PROFITPublic company
PUBLIC_PROFITPrivate company
NON_PROFITA non profit
GOVERNMENTA government entity

altBusinessIdType

ValueDescription
DUNSSet if altBusinessId is DUNS number
LEISet if altBusinessId is LEI code
GIINSet if altBusinessId is GIIN number

stockExchange

NASDAQ, NYSE, AMEX, AMX, ASX, B3, BME, BSE, FRA, ICEX, JPX, JSE, KRX, LON, NSE, OMX, SEHK, SGX, SSE, STO, SWX, SZSE, TSX, TWSE, VSE

stockSymbol

stockSymbol must belong to a stockExchange

brandStatus

ValueDescription
FAILEDFailed to submit Brand to the campaign registry
PENDINGBrand is pending approval
REJECTEDBrand has been rejected by the campaign registry
APPROVEDBrand has been approved by the campaign registry
DELETEDBrand has been deleted

Brand Vetting

vettingClass

ValueDescription
STANDARDStandard vetting

vettingProviderId

ValueDescription
AEGISVetting provider AEGIS

vettingStatus

ValueDescription
PENDINGThe vetting request is pending
REJECTEDThis vetting request has been rejected
FAILEDThe vetting request has failed
APPROVEDThe vetting request has been approved
EXPIREDThe vetting has expired and a new vetting must be requested

Campaigns

useCases

GET
/numbers-tcr/usecases
Retrieve list of available use cases in TCR
Payload respons
results
array of object
wajib
Tampilkan atribut turunan
results.name
string
wajib
results.accountingName
string
wajib
results.classification
string
wajib
results.displayName
string
wajib
results.description
string
wajib
results.maxSubUsecases
integer
wajib
results.minSubUsecases
integer
wajib
results.validSubUsecase
boolean
wajib
Contoh kode
curl -X GET 'https://api.bird.com/numbers-tcr/usecases' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'

campaignStatus

ValueDescription
FAILEDCampaign was submitted to MBCR but rejected by TCR
PENDINGCampaign is pending with TCR
REJECTEDCampaign is rejected by AT&T and no way to re submit
APPROVEDCampaign is approved
DECLINEDCampaign is rejected and can be edited and re submitted again.
SUSPENDEDCampaign is suspended
DELETEDCampaign has been deleted
EXPIREDCampaign has expired