Udviklere

POST/v3/directory/{number}

Indsend en telefonbogsregistrering for et telefonnummer

Indsend en autoriseret telefonbogsregistrering til operatøren, forstå den implementerede opkrævning, og få afklaret usikre resultater, før du prøver igen.

På denne side
  1. Indsend en telefonbogsregistrering til operatøren
  2. Krav til konto og nummer
  3. POST-anmodning med formulardata
  4. Opkrævning og gentagne forsøg
  5. Svar
  6. Fejl i den ældre løsning
  7. Kontrollér, før du prøver igen

Indsend en telefonbogsregistrering til operatøren

Indsend det navn og den adresse, der skal bruges til en telefonbogsregistrering for et understøttet telefonnummer, som du ejer i MultiTEL. Dette er en betalt opdatering hos operatøren, ikke et opslag af opkalderens navn, en post i en privat adressebog eller en generel opdatering af portalens LIDB-felt i nummeroversigten.

Indsend kun oplysninger, som kunden har godkendt til en telefonbogsregistrering. Bekræft, at operatøren understøtter nummeret, før du bruger dette ældre endepunkt. Den gennemgåede behandlingskode validerer hverken, om udbyderen understøttes, eller det internationale nummerformat; anmodningen til operatøren forudsætter et nordamerikansk nummer og fjerner det første lagrede ciffer.

Krav til konto og nummer

Brug en aktiveret API-konto via HTTPS fra en tilladt kilde-IP-adresse. Det præcise nummer skal være registreret som et købt nummer, der ikke er annulleret, og som tilhører kontoen. Brug alle cifrene i det internationale nummer fra din nummeroversigt, eksempelvis formatet med landekode 1 for et understøttet nordamerikansk nummer. Brug ikke et prisplans-ID, nummerets UUID eller et nummer, der tilhører en anden konto.

POST-anmodning med formulardata

Angiv NUMBER som det nummer, du ejer. Erstat det fiktive eksempel med de godkendte registreringsoplysninger. Dette endepunkt læser formularfelter fra POST; det fortolker ikke en anmodningstekst i formatet application/json.

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"
Formularfelter til telefonbogsregistrering
FeltPåkrævet af dette APIBetydning
lastnameJaEfternavn til registreringen eller det relevante felt til registreringens navn.
cityJaBy til registreringen.
postalcodeJaPostnummer til registreringen.
stateJaDelstat eller region til registreringen, som den understøttede operatør accepterer.
streetnameJaVejnavn.
streetnumJaHusnummer.
firstnameNejSupplerende fornavnsdel.
streetpredir, streetpostdirNejRetningsangivelser før og efter vejnavnet, når det er relevant.
streettype, locationNejVejtype eller supplerende stedangivelse, når det er relevant.

Retningsangivelserne og adressen i eksemplet er pladsholdere, ikke en anbefalet postadresse. Tilføj ikke en fiktiv retningsangivelse til faktiske kundeoplysninger. Kontrollen af obligatoriske felter i API er overfladisk: den fastslår ikke, om en adresse er gyldig eller accepteres af operatøren, og det ældre websted anvendte andre formularkrav.

Implementeringen kan udsende en advarsel om en manglende nøgle i et array, når en valgfri retningsangivelse mangler eller er tom. Hvis svaret er fejlformateret, eller operatøren afviser adressen, skal du gemme anmodningsreferencen og bede support om at bekræfte registreringen i stedet for gentagne gange at indsende ændrede adressegæt.

Opkrævning og gentagne forsøg

Den gennemgåede behandlingskode kontrollerer, at saldoen er på mindst 10.00 saldoenheder før operatøren kontaktes. Når både operatøren og den lokale nummeropdatering har meldt om succes, trækker den 10.00 fra kontosaldoen og registrerer en transaktion for oprettelse af telefonbogsregistreringen. Dette er de aktuelt implementerede beløb, ikke et nyt prisforslag; kontrollér den gældende faktureringsvaluta og den understøttede tjeneste i dine kontovilkår, før du indsender.

Handlingen har ingen idempotensnøgle, beskyttelse mod dublerede ordrer eller samlet transaktion omkring indsendelsen til operatøren, den lokale opdatering og faktureringen. En vellykket gentaget anmodning kan medføre endnu en indsendelse til operatøren og endnu en opkrævning. En timeout eller en fejl i API beviser ikke, at operatøren afviste den tidligere anmodning: udbyderen kan have accepteret den, før en lokal opdatering mislykkedes.

Svar

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

Det normale svar ved succes indeholder en tom streng i feltet response og returnerer hverken et registrerings-ID eller oplysninger om færdiggørelse. Det betyder, at både operatørforløbet og den lokale opdatering meldte om succes; det beviser ikke offentliggørelse i alle eksterne telefonbøger, øjeblikkelig udbredelse eller fremtidig visning ved opkaldsidentifikation.

Fejl i den ældre løsning

Resultatkoder fra API til telefonbogsregistrering
API-kodeBetydning
404Nummeret blev ikke fundet på kontoen, eller et af de obligatoriske formularfelter var tomt.
400Kontosaldoen er lavere end den implementerede opkrævning.
500Anmodningen til operatøren mislykkedes, eller den lokale opdatering mislykkedes, efter at operatøren muligvis allerede havde accepteret anmodningen.
200Der blev meldt om succes; svaret indeholder ingen bekræftelse på offentliggørelse.

Læs både HTTP-status og følgende felter i JSON: status.code/status.msg. Godkendelse og begrænsninger for kilde-IP-adresser kan også forhindre et brugbart svar. Brug ikke GET eller forespørgselsparametre til at anmode om en opdatering, blot fordi den ældre behandlingskode ikke har en udtrykkelig kontrol af HTTP-metoden.

Kontrollér, før du prøver igen

  1. Bekræft det nummer, du ejer, operatørens understøttelse, de godkendte registreringsoplysninger og opkrævningen, før du sender anmodningen.
  2. Indsend én gang, og gem resultatet på kontosiden uden at eksponere kundens adresse i offentlige logfiler eller analysedata.
  3. Kontrollér den gemte registrering og transaktionshistorikken via den understøttede arbejdsgang for kontoen eller gennem support. Afsæt den behandlingstid, operatøren har bekræftet; dette API fastsætter ingen garanteret frist for udbredelse.
  4. Hvis resultatet er usikkert, skal du få support til at afstemme operatørordren og den lokale fakturering, før du prøver igen. En gentaget anmodning er ikke en idempotent statuskontrol.