Připravte uložený profil a číslo
Tento postup použijte k přiřazení uloženého registračního profilu k zakoupenému číslu a u podporovaných čísel spravovaných operátorem také k vyžádání posouzení registrace. Nejde o obecné aktivační API pro všechny poskytovatele čísel. Úspěšný požadavek nedokazuje, že byly dokumenty schváleny nebo že je číslo aktivní.
Použijte povolený účet MultiTEL API přes HTTPS s nakonfigurovanými přihlašovacími údaji a omezeními IP adres. Nesmazaný profil i zakoupené, nezrušené číslo musí patřit k vašemu účtu.
- Vytvořte registrační profil nebo vyberte existující. Uchovejte si místní identifikátor profilu uuid z create_document; get_document vrací stejný místní odkaz jako id.
- Pro odeslání operátorovi musí profil obsahovat uložené odkazy na identitu a adresu. Před odesláním připojte požadované doklady a podpůrné dokumenty prostřednictvím příslušných postupů.
- Ověřte, že číslo i profil splňují příslušné požadavky pro danou zemi a číslo. Nepředpokládejte, že je uložený profil schválen pro každé číslo.
Odešlete přiřazení
curl --silent --show-error --request POST \
--user "$API_USER:$API_PASSWORD" \
--form-string document_uuid="$PROFILE_UUID" \
--form-string service_description="Example customer support line" \
https://api.multitel.net/v3/number_identity/12125550123Cesta obsahuje zakoupené telefonní číslo, nikoli jeho UUID, pobočku ústředny PBX nebo ID identity. Obslužná funkce z čísla odstraní všechny znaky kromě číslic. Použijte úplné mezinárodní číslo včetně předvolby země. Příklad je smyšlený a je nutné jej nahradit vlastním číslem a uloženým místním odkazem na profil.
| Pole | Povinné | Význam |
|---|---|---|
document_uuid | Ano | Přesný uložený místní identifikátor profilu uuid. Nenahrazujte jej maskovanými vzdálenými identifikátory identity_id, address_id, ID nahraného souboru ani vrácenou hodnotou registration_details_id. |
service_description | Ne | Popis zamýšlené služby, který se předává k ověření operátorem. Mezery na začátku a na konci se odstraní. |
onetime_files | Závisí na postupu | Pole přijímané pro jednorázové dokumenty operátora. Aktuální obslužná funkce odstraní mezery na začátku a na konci jeho řetězců a předá je dál, aniž by dohledávala místní odkazy na nahrané soubory. Kompatibilita s maskovanými ID vrácenými funkcí create_encrypt_files nebyla prokázána; před použitím tohoto pole si níže přečtěte omezení jednorázových dokumentů. |
U vícedílných požadavků se pro pole používají opakovaná pole onetime_files[]. Přijímá se také požadavek JSON s hlavičkou Content-Type: application/json; jeho vlastnosti se sloučí s daty formuláře. Pokud je číslo v cestě vynecháno, lze v datech požadavku uvést number. Abyste předešli nejednoznačnosti, upřednostněte výše uvedenou explicitní cestu.
Rozlišujte mezi přiřazením a schválením
Čtěte výsledek HTTP i hodnotu status.code v JSON. Chyby v JSON mohou přijít i s HTTP 200. Úspěch při zpracování operátorem je oznámen zprávou Address verification task created; awaiting carrier review. Tento příklad používá smyšlené odkazy.
{
"status": {
"code": 200,
"msg": "Address verification task created; awaiting carrier review."
},
"response": {
"number": "+12125550123",
"did_id": "11111111111111111111111111111111",
"document_uuid": "0123456789abcdef0123456789abcdef",
"identity_id": "22222222222222222222222222222222",
"address_id": "33333333333333333333333333333333",
"address_verification_id": "44444444444444444444444444444444",
"verification_status": "pending",
"verification_reference": null,
"requirement_id": "55555555555555555555555555555555",
"registration_details_id": "8516ac99dc60603295de7bdb6a153530"
}
}Identifikátory související s poskytovatelem jsou maskované odkazy, nikoli zaměnitelná místní ID profilů. document_uuid zůstává místním odkazem na profil, který jste odeslali. Ve větvi této obslužné funkce pro zpracování operátorem je registration_details_id dalším hashem tohoto místního odkazu; v pozdějších požadavcích týkajících se profilu nebo odeslání jím nenahrazujte document_uuid.
U některých přidělených čísel se místo vytvoření ověření u operátora používá místní přiřazení identity. Jejich úspěšným výsledkem je Identity associated. s prázdným polem response. Tím se nevytváří úloha posouzení operátorem ani nepotvrzuje schválení. Portál nabízí novější postup přiřazení, jehož zpracování poskytovatelů a kontroly opakovaného odeslání se od tohoto koncového bodu liší.
Řešte chyby bez vytváření duplicitních úloh
Kód API 400 označuje chybějící číslo nebo odkaz na profil. Kód 404 označuje profil či číslo nedostupné pro daný účet nebo číslo chybějící v evidenci operátora. Kód 422 může hlásit chybějící odkazy na identitu či adresu, požadavky prodejce nebo zamítnutí při ověřování operátorem. Chybějící konfigurace zpětného volání může vyvolat kód 503 a chyba přenosu při vytváření může vyvolat kód 502. Přečtěte si zprávu a případné requirement_diagnostics a neřešte všechna selhání stejným způsobem.
Větev pro zpracování operátorem může aktualizovat místní příznaky čekající registrace ještě před dokončením ověření požadavků, kontrol konfigurace zpětného volání nebo vytvoření úlohy. Chyba tedy neznamená, že místní stav zůstal beze změny, a samotný příznak čekání nedokazuje, že úloha existuje. Nepoužívejte tyto příznaky jako potvrzení schválení nebo doručení požadavku.
Poskytovatel může přijmout úlohu i v případě, že pozdější operace v místní databázi selže, a tato pomocná funkce před oznámením úspěchu nekontroluje výsledek každého místního zápisu. Tato obslužná funkce nemá parametr idempotence pro klienta ani ochranu před duplicitním odesláním. Po vypršení časového limitu, chybě nebo nejistém výsledku zkontrolujte historii registrace čísla na portálu nebo se před opětovným odesláním obraťte na podporu. Chybějící místní záznam sám o sobě nedokazuje, že poskytovatel nic neobdržel.
Omezení jednorázových dokumentů
Obslužná funkce přijímá onetime_files a každý neprázdný řetězec předává do vazby operátora na šifrované soubory. Nedohledává záznamy nahraných souborů účtu vlastníka ani nepřevádí externí maskovaná ID nahraných souborů na ID souborů poskytovatele. Offline audit ověřil chování při předávání, nikoli úspěšné připojení u operátora.
Nepředpokládejte, že lze do tohoto pole zkopírovat ID souboru z create_encrypt_files a dokončit tak postup jednorázového souhlasu. Pokud číslo tyto dokumenty vyžaduje, použijte portál nebo si u MultiTEL ověřte podporovaný postup práce s identifikátory. Tato část kontroly API zůstává nevyřešena; nejde o příklad ověřený od začátku do konce.
Chraňte registrační údaje
Odesílejte pouze údaje a dokumenty, které jste oprávněni pro dané číslo použít. Udržujte odkazy na profily a ověření přiřazené ke správnému účtu a vyhněte se zaznamenávání úplných registračních dat požadavků do protokolů. Tento požadavek neodstraňuje ani nenahrazuje všechny předchozí doklady nebo ověření. Posouzení operátorem, aktivace a uchovávání údajů jsou samostatné procesy.