Fejlesztők

POST/v3/directory/{number}

Telefonszám telefonkönyvi bejegyzésének beküldése

Küldje be a jóváhagyott telefonkönyvi adatokat a szolgáltatónak, ismerje meg a rendszerben alkalmazott díjat, és az újrapróbálkozás előtt tisztázza a bizonytalan eredményeket.

Ezen az oldalon
  1. Telefonkönyvi bejegyzés beküldése a szolgáltatónak
  2. A fiókra és a telefonszámra vonatkozó követelmények
  3. Űrlapos POST kérés
  4. Díjterhelés és újrapróbálkozás
  5. Válasz
  6. A régi rendszer hibái
  7. Ellenőrzés az újrapróbálkozás előtt

Telefonkönyvi bejegyzés beküldése a szolgáltatónak

Küldje be a MultiTEL rendszerében az Ön tulajdonában lévő, erre jogosult telefonszám telefonkönyvi bejegyzéséhez használandó nevet és címet. Ez díjköteles szolgáltatói frissítés, nem hívónév-lekérdezés, nem privát címjegyzékbejegyzés, és nem a portál nyilvántartásában szereplő LIDB mező általános frissítése.

Csak olyan adatokat küldjön be, amelyek telefonkönyvi közzétételét az ügyfél engedélyezte. A régi végpont használata előtt ellenőrizze, hogy a szolgáltató támogatja-e az adott számot. Az áttekintett kezelő nem ellenőrzi a szolgáltatói jogosultságot vagy a nemzetközi számformátumot; a szolgáltatónak küldött kérelme észak-amerikai számot feltételez, és eltávolítja az első tárolt számjegyet.

A fiókra és a telefonszámra vonatkozó követelmények

Engedélyezett forrás-IP-címről, HTTPS kapcsolaton keresztül használjon egy engedélyezett API-fiókot. A pontos számnak az adott fiókhoz tartozó, megvásárolt számok egyik nem érvénytelenített rekordjában kell szerepelnie. A nyilvántartásában szereplő teljes nemzetközi számsort használja, például támogatott észak-amerikai szám esetén az 1 országkódot tartalmazó formátumot. Ne használjon díjcsomag-azonosítót, a szám UUID-azonosítóját vagy másik fiókhoz tartozó számot.

Űrlapos POST kérés

Állítsa a NUMBER értékét az Ön tulajdonában lévő számra. A kitalált példa helyére a jóváhagyott telefonkönyvi adatokat írja. Ez a végpont a POST kérés űrlapmezőit olvassa be; az application/json formátumú kéréstörzset nem dolgozza fel.

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"
A telefonkönyvi bejegyzés űrlapmezői
MezőKötelező ennél az API-nálJelentés
lastnameIgenA bejegyzésben szereplő vezetéknév vagy a megfelelő bejegyzésnév-mező.
cityIgenA bejegyzésben szereplő település.
postalcodeIgenA bejegyzésben szereplő irányítószám.
stateIgenA bejegyzésben szereplő állam vagy régió, amelyet a támogatott szolgáltató elfogad.
streetnameIgenAz utca neve.
streetnumIgenHázszám.
firstnameNemKiegészítő keresztnév-összetevő.
streetpredir, streetpostdirNemAz utcanév előtti és utáni égtájjelölések, ha alkalmazhatók.
streettype, locationNemA közterület típusa vagy kiegészítő helymegjelölés, ha alkalmazható.

A példában szereplő égtájjelölések és cím helykitöltők, nem ajánlott postai cím. Ne adjon kitalált égtájjelölést valódi ügyféladatokhoz. Az API kötelező mezőkre vonatkozó ellenőrzései felületesek: nem igazolják, hogy a cím érvényes, vagy hogy a szolgáltató elfogadja, a régi webhely pedig eltérő űrlapkövetelményeket alkalmazott.

A megvalósítás hiányzó tömbkulcsra figyelmeztető üzenetet adhat, ha egy nem kötelező égtájjelölés hiányzik vagy üres. Ha a válasz hibás formátumú, vagy a szolgáltató elutasítja a címet, őrizze meg a kérelem hivatkozását, és kérje az ügyfélszolgálattól a bejegyzés megerősítését ahelyett, hogy találgatás alapján módosított címeket küldene be ismételten.

Díjterhelés és újrapróbálkozás

Az áttekintett kezelő ellenőrzi, hogy rendelkezésre áll-e legalább 10.00 egyenlegegység a szolgáltató megkeresése előtt. Miután a szolgáltató és a helyi számfrissítés is sikert jelzett, levon 10.00 összeget a fiók egyenlegéből, és rögzít egy telefonkönyvi beállítási tranzakciót. Ezek a rendszerben jelenleg alkalmazott összegek, nem új árazási javaslatok; beküldés előtt a fiókfeltételek alapján ellenőrizze az alkalmazandó számlázási pénznemet és a támogatott szolgáltatást.

A művelethez nem tartozik idempotenciakulcs, az ismételt megrendelést megakadályozó védelem, illetve a szolgáltatói beküldést, a helyi frissítést és a számlázást összefogó tranzakció. Egy sikeres ismételt kérés újabb szolgáltatói beküldést és újabb díjterhelést eredményezhet. Az időtúllépés vagy az API hibája nem bizonyítja, hogy a szolgáltató elutasította a korábbi kérelmet: előfordulhat, hogy a szolgáltató már elfogadta azt, mielőtt a helyi frissítés meghiúsult.

Válasz

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

A szokásos sikeres válaszban üres karakterlánc a response mező értéke, és nem érkezik vissza bejegyzésazonosító vagy a teljesítésre vonatkozó részlet. Ez azt jelenti, hogy a szolgáltatói és a helyi frissítési útvonal sikert jelzett; nem bizonyítja a közzétételt minden külső telefonkönyvben, az azonnali elterjedést vagy a későbbi hívóazonosító-kijelzést.

A régi rendszer hibái

A telefonkönyvi bejegyzés API-eredménykódjai
API-kódJelentés
404A szám nem található a fiókban, vagy az egyik kötelező űrlapmező üres volt.
400A fiók egyenlege alacsonyabb a rendszerben alkalmazott díjnál.
500A szolgáltatói kérelem meghiúsult, vagy a helyi frissítés akkor hiúsult meg, amikor a szolgáltató esetleg már elfogadta a kérelmet.
200Siker jelzése; a válasz nem tartalmazza a közzététel megerősítését.

Olvassa el a HTTP-állapotot és a JSON következő mezőit is: status.code/status.msg. A hitelesítés és a forrás-IP-címre vonatkozó korlátozások szintén megakadályozhatják a használható válasz érkezését. Ne kérjen frissítést GET használatával vagy lekérdezési paraméterekkel pusztán azért, mert a régi kezelő nem ellenőrzi kifejezetten a HTTP-metódust.

Ellenőrzés az újrapróbálkozás előtt

  1. A kérés elküldése előtt ellenőrizze a saját tulajdonú számot, a szolgáltatói jogosultságot, a jóváhagyott telefonkönyvi adatokat és a díjat.
  2. Egyszer küldje be a kérelmet, és őrizze meg a fiókoldali eredményt anélkül, hogy az ügyfél címét nyilvános naplókban vagy analitikai rendszerekben felfedné.
  3. Ellenőrizze a mentett bejegyzést és a tranzakciós előzményeket a támogatott fiókkezelési folyamatban vagy az ügyfélszolgálaton keresztül. Várja meg a szolgáltató által megerősített feldolgozási időt; ez az API nem határoz meg garantált határidőt az adatok elterjedésére.
  4. Ha az eredmény bizonytalan, az újrapróbálkozás előtt kérje az ügyfélszolgálattól a szolgáltatói megrendelés és a helyi számlázás egyeztetését. Az ismételt kérés nem idempotens állapotellenőrzés.