Ontwikkelaars

POST/v3/directory/{number}

Een telefoongidsvermelding voor een telefoonnummer indienen

Dien een geautoriseerde gidsvermelding bij de telecomaanbieder in, begrijp de geïmplementeerde kosten en laat onzekere resultaten uitzoeken voordat u het opnieuw probeert.

Op deze pagina
  1. Een gidsvermelding bij de telecomaanbieder indienen
  2. Vereisten voor account en nummer
  3. POST-verzoek met formuliergegevens
  4. Kosten en herhaalde verzoeken
  5. Antwoord
  6. Fouten van de verouderde functionaliteit
  7. Controleren voordat u het opnieuw probeert

Een gidsvermelding bij de telecomaanbieder indienen

Dien de naam en het adres in voor een gidsvermelding bij een geschikt telefoonnummer dat u in MultiTEL bezit. Dit is een betaalde wijziging bij de telecomaanbieder, geen zoekopdracht naar de naam van een beller, vermelding in een persoonlijk adresboek of algemene wijziging van het LIDB-veld in de nummerinventaris van het portaal.

Dien alleen gegevens in waarvoor de klant toestemming heeft gegeven om ze in een gidsvermelding te gebruiken. Controleer of de telecomaanbieder het nummer ondersteunt voordat u deze verouderde route gebruikt. De beoordeelde handler controleert niet of de provider in aanmerking komt en valideert ook het internationale nummerformaat niet; de aanvraag aan de telecomaanbieder gaat uit van een Noord-Amerikaans nummer en verwijdert het eerste opgeslagen cijfer.

Vereisten voor account en nummer

Gebruik een ingeschakeld API-account via HTTPS vanaf een toegestaan bron-IP-adres. Het exacte nummer moet als niet-geannuleerd aangekocht nummer bij dat account geregistreerd staan. Gebruik alle cijfers van het internationale nummer in uw nummerinventaris, bijvoorbeeld het formaat met landcode 1 voor een ondersteund Noord-Amerikaans nummer. Gebruik geen tariefplan-ID, UUID van een nummer of nummer dat bij een ander account hoort.

POST-verzoek met formuliergegevens

Stel NUMBER in op het nummer dat u bezit. Vervang het fictieve voorbeeld door de geautoriseerde gegevens voor de gidsvermelding. Deze route leest formuliervelden uit POST; een verzoekinhoud van het type application/json wordt niet verwerkt.

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --data-urlencode "lastname=EXAMPLE" \
  --data-urlencode "firstname=EXAMPLE" \
  --data-urlencode "streetnum=1" \
  --data-urlencode "streetname=Example" \
  --data-urlencode "streetpredir=N" \
  --data-urlencode "streetpostdir=W" \
  --data-urlencode "city=Example City" \
  --data-urlencode "state=NY" \
  --data-urlencode "postalcode=10001" \
  "https://api.multitel.net/v3/directory/$NUMBER"
Formuliervelden voor een gidsvermelding
VeldVerplicht voor deze APIBetekenis
lastnameJaAchternaam voor de gidsvermelding of het toepasselijke naamveld van de vermelding.
cityJaPlaats voor de gidsvermelding.
postalcodeJaPostcode voor de gidsvermelding.
stateJaStaat of regio voor de gidsvermelding, zoals geaccepteerd door de ondersteunde telecomaanbieder.
streetnameJaStraatnaam.
streetnumJaHuisnummer.
firstnameNeeAanvullend voornaamonderdeel.
streetpredir, streetpostdirNeeWindrichtingaanduidingen vóór en na de straatnaam, indien van toepassing.
streettype, locationNeeStraattype of aanvullende locatiegegevens, indien van toepassing.

De windrichtingaanduidingen en het adres in het voorbeeld zijn fictieve invulwaarden, geen aanbevolen postadres. Voeg geen fictieve windrichtingaanduiding toe aan echte klantgegevens. De controles op verplichte velden van de API zijn oppervlakkig: ze stellen niet vast of een adres geldig is of door de telecomaanbieder wordt geaccepteerd, en de oude website hanteerde andere formuliervereisten.

De implementatie kan een waarschuwing over een ontbrekende arraysleutel geven wanneer een optionele windrichtingaanduiding ontbreekt of leeg is. Als het antwoord een onjuist formaat heeft of de telecomaanbieder het adres afwijst, bewaar dan de aanvraagreferentie en vraag de ondersteuning om de gidsvermelding te bevestigen in plaats van herhaaldelijk aangepaste adresvarianten op basis van vermoedens in te dienen.

Kosten en herhaalde verzoeken

De beoordeelde handler controleert of het saldo ten minste 10.00 saldo-eenheden bedraagt voordat deze contact opneemt met de telecomaanbieder. Nadat zowel de telecomaanbieder als de lokale nummerwijziging succes hebben gemeld, schrijft de handler 10.00 af van het accountsaldo en registreert een transactie voor het instellen van de gidsvermelding. Dit zijn de momenteel geïmplementeerde bedragen, geen voorstel voor nieuwe prijzen; controleer vóór indiening de toepasselijke factureringsvaluta en de ondersteunde dienst aan de hand van uw accountvoorwaarden.

De bewerking heeft geen idempotentiesleutel, beveiliging tegen dubbele opdrachten of transactie die de indiening bij de telecomaanbieder, de lokale wijziging en de facturering omvat. Een geslaagd herhaald verzoek kan tot een nieuwe indiening bij de telecomaanbieder en een nieuwe afschrijving leiden. Een time-out of API-fout bewijst niet dat de telecomaanbieder het eerdere verzoek heeft afgewezen: de provider kan het al hebben geaccepteerd voordat een lokale wijziging mislukte.

Antwoord

{
  "status": {
    "code": 200,
    "msg": "Success"
  },
  "response": ""
}

Het normale antwoord bij succes bevat een lege tekenreeks in het veld response en geeft geen ID van de gidsvermelding of details over de voltooiing terug. Dit betekent dat zowel de verwerking bij de telecomaanbieder als de lokale wijziging succes heeft gemeld; het bewijst niet dat de vermelding in elke externe gids is gepubliceerd, dat wijzigingen direct zijn verspreid of dat de belleridentificatie in de toekomst wordt weergegeven.

Fouten van de verouderde functionaliteit

Resultaatcodes van de API voor gidsvermeldingen
API-codeBetekenis
404Het nummer is niet gevonden bij het account, of een van de verplichte formuliervelden was leeg.
400Het accountsaldo is lager dan het bedrag dat de implementatie in rekening brengt.
500Het verzoek aan de telecomaanbieder is mislukt, of de lokale wijziging is mislukt nadat de telecomaanbieder het verzoek mogelijk al had geaccepteerd.
200Succes gemeld; het antwoord bevat geen bevestiging van publicatie.

Controleer zowel de HTTP-status als de JSON-velden status.code/status.msg. Authenticatie en beperkingen op bron-IP-adressen kunnen eveneens verhinderen dat u een bruikbaar antwoord ontvangt. Gebruik geen GET of queryparameters om een wijziging aan te vragen alleen omdat de verouderde handler geen expliciete controle op de HTTP-methode heeft.

Controleren voordat u het opnieuw probeert

  1. Controleer vóór verzending van het verzoek of u het nummer bezit, of het bij de telecomaanbieder in aanmerking komt, of de gegevens voor de gidsvermelding zijn geautoriseerd en welke kosten gelden.
  2. Dien het verzoek eenmaal in en bewaar het resultaat aan de accountzijde zonder het adres van de klant openbaar te maken in openbare logboeken of analysegegevens.
  3. Controleer de opgeslagen gidsvermelding en de transactiegeschiedenis via de ondersteunde accountprocedure of de ondersteuning. Wacht de door de telecomaanbieder bevestigde verwerkingstijd af; deze API stelt geen gegarandeerde termijn voor de verspreiding van wijzigingen vast.
  4. Laat de ondersteuning bij een onzeker resultaat eerst de opdracht bij de telecomaanbieder en de lokale facturering met elkaar afstemmen voordat u het opnieuw probeert. Een herhaald verzoek is geen idempotente statuscontrole.