Lookup API FAQ
Wat is Bird Lookup?
Lookup beantwoordt vragen over een ontvanger voordat u naar hen verzendt. Geef het een telefoonnummer en het vertelt u wat het nummer is: het netwerk dat het bedient, het land, of het van netwerk is gewisseld, en wat voor type lijn het is. Geef het een e-mailadres en het vertelt u of het adres het waard is om naartoe te sturen.
Wat kan ik opzoeken?
Twee dingen, elk één operatie. Een telefoonnummer-lookup retourneert het land, het netwerk dat het nummer bedient, het netwerk dat het heeft uitgegeven, of het tussen beide is verplaatst, en het lijntype, plus elke eigenschap waar u om vraagt. Een e-mailadres-lookup retourneert één oordeel, een betrouwbaarheidsscore en de flags erachter.
Hoeveel werk kost de integratie?
Elke lookup is één verzoek en één antwoord. Er is niets om aan te maken, niets om te pollen, en niets om achteraf op te ruimen. Getypte methoden worden meegeleverd in de Go, TypeScript, Python en PHP SDK's, en bird lookup phone-number en bird lookup email doen hetzelfde vanuit de CLI.
Kan ik een lookup uitvoeren zonder code te schrijven?
Ja. De Lookup-pagina in het dashboard voert dezelfde twee operaties één voor één uit, wat de snelste manier is om te zien hoe een antwoord eruitziet voordat u erop verder bouwt.
Wat heb ik nodig vóór mijn eerste lookup?
Een API-sleutel met het lookup-bereik, en een organisatiewallet die de kosten kan dekken. De prijs is per query zonder licentiekosten, dus er is geen abonnement om eerst te kiezen.
Wanneer moet ik Lookup gebruiken in plaats van gewoon te versturen?
Gebruik het wanneer u wilt beslissen voordat u zich vastlegt: een aanmelding screenen, een lead beoordelen voordat u erop handelt, of een bericht anders routeren afhankelijk van wat het lijntype blijkt te zijn. U krijgt een antwoord waar u naar kunt handelen zonder eerst iets te versturen.
Hoe wordt Lookup geprijsd?
Per query. Elke lookup wordt in rekening gebracht bij de wallet van uw organisatie. Een telefoonnummer-lookup brengt eenmalig kosten in rekening voor de basislookup, plus één bedrag voor elke eigenschap die beantwoord wordt geretourneerd. Een e-mailadres-lookup brengt eenmalig kosten in rekening per beantwoord adres. Er zijn geen licentiekosten.
Waar vind ik de tarieven?
De Lookup-prijspagina toont het tarief voor de basislookup, voor elke eigenschap en voor een e-mailadres-lookup. Tarieven variëren per eigenschap, omdat elke eigenschap uit een andere databron komt.
Betaal ik voor een eigenschap die leeg terugkomt?
Nee. Een eigenschap wordt alleen gefactureerd wanneer deze wordt geleverd. Een eigenschap die niet beantwoord kon worden, komt terug met een status die dat aangeeft en kost u niets, en de basislookup wordt gewoon daarnaast geleverd.
Wat gebeurt er met mijn factuur als een lookup mislukt?
Er wordt niets in rekening gebracht. Een onjuist geformateerd nummer, een adres dat we weigeren en een databron die niet bereikbaar is, kosten allemaal niets.
Word ik gefactureerd voor een adres dat onbezorgbaar blijkt te zijn?
Ja. Elk beantwoord adres wordt gefactureerd, inclusief onbezorgbare. Dat is het antwoord waar u om vroeg, en het is het antwoord dat u een bounce bespaart.
Kan een retry mij dubbel factureren?
Niet als u een Idempotency-Key meestuurt. Een herhaling van hetzelfde verzoek speelt het opgeslagen antwoord opnieuw af in plaats van een nieuwe lookup uit te voeren. De GET-varianten, die het nummer of het adres in de URL plaatsen, kunnen geen idempotency key bevatten, dus gebruik POST voor alles wat geautomatiseerd is.
Hoeveel lookups kan ik per minuut uitvoeren?
De lookup-snelheidslimiet begint op 10 verzoeken per minuut, geteld per actieve credential, zodat één drukke sleutel een andere niet kan uithongeren. Elke lookup bereikt een externe databron en brengt kosten in rekening op uw wallet voor het antwoord, daarom begint het waar de verzendlimieten beginnen.
Is er een batch- of bulklookup?
Op dit moment niet. Geen van beide operaties heeft een batchvorm, dus het controleren van een hele lijst is niet waar dit voor bedoeld is. Vraag ons de limiet te verhogen als dat is wat u nodig heeft, in plaats van eromheen te werken.
Welk bereik heeft een lookup nodig?
Het lookup-bereik op schrijfniveau. Er is geen leesniveau: elk lookup-endpoint vereist schrijftoegang, inclusief het ophalen van een resultaat waarvoor u al heeft betaald. Eigenaren en beheerders hebben het standaard, en leden niet.
Welke fouten kan een lookup retourneren?
Vier die ertoe doen. E22000 wanneer het nummer niet geldig is in internationaal formaat, E22003 wanneer het adres geen geldig e-mailadres is, E22001 wanneer de wallet van de organisatie de lookup niet kan dekken, en E22002 wanneer Lookup tijdelijk niet beschikbaar is. Geen ervan brengt kosten in rekening.
Faalt mijn verzoek als een eigenschap niet beantwoord kan worden?
Nee. Een falende eigenschap komt terug als een status in zijn eigen blok, terwijl de basislookup ernaast wordt geleverd. Alleen als de basislookup zelf faalt, faalt het verzoek, en dan faalt het volledig in plaats van een half leeg antwoord te retourneren dat u zou moeten inspecteren om te ontdekken dat het leeg was.
Wat geeft een telefoonnummer-lookup als antwoord?
De basislookup geeft het land van het nummer, het netwerk dat het momenteel bedient, het netwerk dat het nummerbereik heeft uitgegeven, of het ooit van netwerk is gewisseld, en een globaal lijntype. De basislookup wordt altijd uitgevoerd, en als er geen antwoord kan worden gegeven, mislukt het hele verzoek in plaats van een half leeg antwoord te retourneren.
Hoe moet ik het nummer schrijven?
Eerst het landnummer, dan het nationale nummer. De plus aan het begin is optioneel en 00 werkt als vervanging, dus +31612345678, 31612345678 en 0031612345678 zijn allemaal hetzelfde nummer.
Waarom is mijn nummer afgewezen?
Een nummer dat is geschreven voor binnenlands bellen, zonder landcode, retourneert E22000 in plaats van te worden geraden. Een landcode vóór 0612345678 plakken zou een bestaand nummer ergens anders aanduiden en u kosten in rekening brengen voor het opzoeken van dát nummer.
Welke lijntypen kan het retourneren?
mobile, fixed_line, voip, toll_free, premium_rate, satellite, pager, payphone, m2m, service, other of unknown. unknown betekent dat het carrierplatform geen classificatie heeft voor het bereik, en other betekent dat het er wel een heeft zonder equivalent hier. Vraag de classification-eigenschap op voor de toegewezen dienst met hogere precisie.
Hoe kan ik zien of een nummer is geporteerd?
network_info is het netwerk dat het nummer momenteel bedient en original_network_info is het netwerk dat het bereik heeft uitgegeven. Die twee verschillen zodra een nummer is geporteerd, en flags bevat dan ported. Vraag de porting-eigenschap op als u ook de datum en het volledige record nodig hebt.
Waarom ontbreekt country_code in mijn antwoord?
Omdat het nummer niet tot één enkel land behoort, zoals bij een niet-geografisch bereik. Velden zonder waarde worden weggelaten in plaats van als null geretourneerd, dus elk veld dat in het antwoord aanwezig is, is daadwerkelijk opgelost.
Belt of berichtt een lookup het nummer?
Nee. Een lookup neemt nooit contact op met het nummer zelf. Het leest carrier- en nummerintelligentiegegevens, en de presence- en roaming-eigenschappen bevragen het netwerk waarop het nummer is geregistreerd, dus er gaat niets over en er komt niets aan op het toestel.
Welke eigenschappen kan ik toevoegen aan een telefoonnummer-lookup?
Zes, benoemd in type. classification voor de exacte toegewezen dienst van het bereik, porting voor wanneer het nummer voor het laatst van netwerk is gewisseld en elke eerdere wisseling, presence voor of het op dit moment actief is op het netwerk, roaming voor of het roamt en op welk netwerk, sim_swap voor wanneer de SIM voor het laatst is gewisseld, en score voor een geloofwaardigheidsscore van 0 tot 100.
Zijn sommige eigenschappen trager dan andere?
Ja. classification, porting en score lezen opgeslagen gegevens en retourneren snel. presence, roaming en sim_swap bevragen het live netwerk, dus die zijn trager en hun dekking varieert per operator. Verwacht voor die drie vaker unavailable of inconclusive dan voor de opgeslagen eigenschappen.
Wat betekenen de statussen van eigenschappen?
ok betekent dat de eigenschap is beantwoord, de waarde staat in het antwoord en er is gefactureerd. unavailable betekent dat er geen antwoord is ontvangen en er niet is gefactureerd. inconclusive betekent dat er een antwoord is ontvangen maar dat het de eigenschap niet oplost, wat een echte bevinding is, en ook hiervoor is niet gefactureerd.
Kunnen er later nieuwe statussen bijkomen?
Ja, status is een open vocabulaire. Vertrek vanuit ok en behandel al het andere als niet-beantwoord, dan blijft uw code correct hoe het vocabulaire ook groeit.
Wat voegen porting en classification toe ten opzichte van het basisantwoord?
porting geeft u de datum en de volledige geschiedenis, terwijl de ported-vlag van de basislookup alleen aangeeft of er ooit een wisseling heeft plaatsgevonden. classification lost line_type op naar de exacte toegewezen dienst, uit een andere bron met een breder vocabulaire, en wordt apart gerapporteerd zodat u de twee altijd kunt onderscheiden.
Waarom retourneerde sim_swap een bereik in plaats van een datum?
Omdat het netwerk geen exact getal wilde vrijgeven. sim_swap retourneert min_days en max_days in plaats van last_swapped_at wanneer alleen een recentheidsbereik bekend is. porting doet iets vergelijkbaars: het zet last_ported_at_is_approximate wanneer een register de periode van een wisseling vastlegt maar niet de dag.
Betekent porting.ported ingesteld op false dat de controle is mislukt?
Nee. Het betekent dat het register is geraadpleegd en geen wisseling voor dit nummer bevat, wat een bevinding over het nummer is en geen gat in het antwoord. De status op het blok vertelt u of de controle überhaupt is uitgevoerd.
Hoe moet ik de score interpreteren?
Als één signaal van meerdere. De score loopt van 0 voor lage betrouwbaarheid tot 100 voor hoge betrouwbaarheid. Het is een samengestelde waarde die u niet kunt afleiden uit de andere eigenschappen. Weeg de score af tegen de rest van het antwoord in plaats van er uitsluitend op te filteren.
Wat vertelt een e-mailadres-lookup?
Of het adres e-mail accepteert. Eén aanroep retourneert een oordeel in result, een delivery_confidence-score, de flags die het type adres beschrijven, en een correctie wanneer het adres op een typfout lijkt.
Wat zijn de vijf oordelen?
valid betekent dat het adres bestaat en e-mail accepteert — verstuur gerust. neutral betekent dat het niet bevestigd kon worden, meestal omdat het ontvangende domein elke ontvanger hetzelfde beantwoordt. risky betekent dat het waarschijnlijk e-mail accepteert, maar een grotere kans heeft op een bounce of klacht. undeliverable betekent dat het geen e-mail accepteert. typo betekent dat het adres verkeerd gespeld lijkt.
Waarom is een adres onbestelbaar?
reason geeft aan welk van drie dingen fout is: invalid_syntax voor een onjuist gevormd adres, invalid_domain wanneer het domein helemaal geen e-mail accepteert, en invalid_recipient wanneer het domein e-mail accepteert maar deze mailbox niet bestaat.
Wat moet ik doen met een typo-oordeel?
Bied did_you_mean aan aan degene die het oorspronkelijke adres heeft ingetypt, in plaats van er ongevraagd naartoe te sturen. De correctie is een schatting, en het bedoelde adres kan geen van beide zijn.
Hoe verschilt delivery_confidence van result?
De score loopt van 0 (zeker niet bezorgd) tot 100 (zeker wel bezorgd). Dezelfde score kan om verschillende redenen onder verschillende oordelen vallen, dus lees deze naast result in plaats van in plaats daarvan. Het is het veld om op te steunen wanneer u één drempelwaarde wilt over alle oordelen heen, inclusief oordelen die later worden toegevoegd.
Er is ook een valid-veld. Is dat het valid-oordeel?
Nee, en het verschil is belangrijk. Het valid-veld is beperkter: het geeft aan of het adres correct gevormd is en of het domein is ingesteld om e-mail te ontvangen. Het zegt niets over de mailbox, dus een adres met een werkend domein maar een niet-bestaande mailbox is daar true en undeliverable in result.
Wat betekenen de flags?
role betekent dat het adres een functie benoemt in plaats van een persoon, zoals support@ of info@, waardoor antwoorden en toestemming dubbelzinnig zijn en klachten waarschijnlijker. disposable betekent een wegwerpadresprovider, dus het adres zal doorgaans ophouden te bestaan. free_provider betekent een consumentenmailboxprovider zoals Gmail of Outlook.com, wat alleen een signaal is wanneer u een zakelijk adres verwachtte.
Hoe moet ik het adres schrijven?
Stuur een kaal adres, precies zoals u het heeft. Een display-name-vorm, met een naam ervoor en het adres tussen punthaken, wordt geweigerd in plaats van uitgepakt, omdat het uitpakken een adres zou opzoeken dat u niet heeft verstuurd. Het deel vóór het apenstaartje wordt doorgegeven zoals geschreven, en het wijzigen van hoofdletters kan de delivery_confidence die u terugkrijgt veranderen.
Heb ik Lookup nodig om te stoppen met verzenden naar adressen die al gebounced zijn?
Nee. Suppressions doen dat automatisch en gratis, voor adressen die al gebounced zijn of een klacht hebben ingediend. Gebruik Lookup voor adressen waar u nog niet naartoe heeft gestuurd, bij aanmelding of voordat u actie onderneemt op een lead.
Breng het in de praktijk.
Ga verder met de documentatie, gidsen en voorbeelden voor dit onderwerp. De bronnen zijn in het Engels.
Lees de volledige beschrijving van de functionaliteit
Elke bewerking heeft een eigen pagina, met de antwoordvelden overzichtelijk weergegeven.
Telefoonnummer-lookupLand, beide providers, de porteringsvlag, het lijntype en vijf eigenschappen.E-mailadres-lookupDe vijf beoordelingen, de vlaggen, de betrouwbaarheidsscore en de typocorrectie.PrijzenHet tarief per query voor de standaard lookup en voor elke eigenschap die antwoord geeft.De Lookup APIBeide bewerkingen, de eigenschapsstatussen en hoe de facturering werkt.