Odeslání zápisu do telefonního seznamu operátora
Odešlete jméno a adresu pro zápis do telefonního seznamu u podporovaného telefonního čísla, které vlastníte v MultiTEL. Jde o placenou aktualizaci u operátora, nikoli o vyhledání jména volajícího, soukromý záznam v adresáři nebo obecnou aktualizaci pole LIDB v evidenci portálu.
Odesílejte pouze údaje, jejichž zařazení do telefonního seznamu zákazník schválil. Před použitím této starší cesty ověřte, že operátor dané číslo podporuje. Prověřená obslužná rutina neověřuje, zda je poskytovatel podporován, ani mezinárodní formát čísla; její požadavek operátorovi předpokládá severoamerické číslo a odstraňuje první uloženou číslici.
Požadavky na účet a číslo
Použijte aktivovaný účet API přes HTTPS z povolené zdrojové IP adresy. Přesně toto číslo musí být vedeno v nezneplatněném záznamu zakoupeného čísla, který patří danému účtu. Použijte všechny číslice mezinárodního čísla z vaší evidence, například formát s předvolbou země 1 u podporovaného severoamerického čísla. Nepoužívejte ID cenového plánu, UUID čísla ani číslo patřící jinému účtu.
Formulářový požadavek POST
Nastavte NUMBER na číslo, které vlastníte. Smyšlené údaje v příkladu nahraďte schválenými údaji pro zápis. Tato cesta čte formulářová pole z požadavku POST; nezpracovává tělo ve formátu 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"| Pole | Vyžadováno tímto API | Význam |
|---|---|---|
| lastname | Ano | Příjmení pro zápis nebo odpovídající pole názvu zápisu. |
| city | Ano | Město pro zápis. |
| postalcode | Ano | Poštovní směrovací číslo pro zápis. |
| state | Ano | Stát nebo oblast pro zápis, které podporovaný operátor přijímá. |
| streetname | Ano | Název ulice. |
| streetnum | Ano | Číslo domu. |
| firstname | Ne | Doplňující složka křestního jména. |
| streetpredir, streetpostdir | Ne | Označení světové strany před názvem ulice a za ním, pokud se používají. |
| streettype, location | Ne | Typ ulice nebo doplňující text k umístění, pokud se používá. |
Označení světových stran a adresa v příkladu jsou zástupné údaje, nikoli doporučená poštovní adresa. Ke skutečným údajům zákazníka nepřidávejte smyšlené označení světové strany. Kontroly povinných polí v API jsou jen povrchní: nepotvrzují platnost adresy ani její přijetí operátorem a starší web používal jiné požadavky na formulář.
Pokud nepovinné označení světové strany chybí nebo je prázdné, může implementace vypsat varování o chybějícím klíči pole. Je-li odpověď chybně utvořená nebo operátor adresu odmítne, uchovejte referenci požadavku a požádejte podporu o potvrzení zápisu místo opakovaného odesílání odhadovaných úprav adresy.
Účtování poplatku a opakování požadavků
Prověřená obslužná rutina kontroluje, zda je zůstatek alespoň 10.00 jednotek zůstatku před kontaktováním operátora. Jakmile operátor i místní aktualizace čísla ohlásí úspěch, odečte 10.00 ze zůstatku účtu a zaznamená transakci za zřízení zápisu do telefonního seznamu. Jde o částky, které jsou nyní v implementaci, nikoli o nový návrh cen; před odesláním ověřte příslušnou fakturační měnu a podporovanou službu podle podmínek svého účtu.
Operace nemá klíč idempotence, ochranu proti duplicitním objednávkám ani transakci zahrnující odeslání operátorovi, místní aktualizaci a účtování. Úspěšně zopakovaný požadavek může vést k dalšímu odeslání operátorovi a dalšímu poplatku. Vypršení časového limitu ani chyba API nedokazují, že operátor předchozí požadavek odmítl: poskytovatel jej mohl přijmout ještě před selháním místní aktualizace.
Odpověď
{
"status": {
"code": 200,
"msg": "Success"
},
"response": ""
}Běžná odpověď při úspěchu obsahuje prázdný řetězec v poli response a nevrací ID zápisu ani podrobnosti o dokončení. Znamená to, že zpracování u operátora i místní aktualizace ohlásily úspěch; nedokazuje to zveřejnění ve všech externích seznamech, okamžité rozšíření změny ani budoucí zobrazení identifikace volajícího.
Chyby starší implementace
| Kód API | Význam |
|---|---|
| 404 | Číslo nebylo na účtu nalezeno nebo bylo některé z povinných formulářových polí prázdné. |
| 400 | Zůstatek účtu je nižší než poplatek nastavený v implementaci. |
| 500 | Požadavek operátorovi selhal nebo selhala místní aktualizace poté, co operátor již mohl požadavek přijmout. |
| 200 | Byl ohlášen úspěch; odpověď neobsahuje potvrzení zveřejnění. |
Zkontrolujte stav HTTP i následující pole v JSON: status.code/status.msg. Použitelné odpovědi může zabránit také ověřování přístupu a omezení zdrojových IP adres. K vyžádání aktualizace nepoužívejte GET ani parametry dotazu jen proto, že starší obslužná rutina nemá výslovnou kontrolu metody HTTP.
Před opakováním ověřte výsledek
- Před odesláním požadavku ověřte vlastnictví čísla, podporu u operátora, schválené údaje pro zápis a poplatek.
- Odešlete požadavek jednou a uchovejte výsledek na straně účtu, aniž byste adresu zákazníka zveřejnili ve veřejných protokolech nebo analytických systémech.
- Zkontrolujte uložený zápis a historii transakcí prostřednictvím podporovaného postupu v účtu nebo podpory. Vyčkejte po dobu zpracování potvrzenou operátorem; toto API nestanovuje žádnou zaručenou lhůtu pro rozšíření změny.
- Pokud je výsledek nejistý, nechte podporu před dalším pokusem porovnat a vyjasnit objednávku u operátora a místní účtování. Opakovaný požadavek není idempotentní kontrolou stavu.