Programeri

POST/v3/number_identity/{number}

Pošaljite registracijski profil za broj

Povežite spremljeni registracijski profil s kupljenim brojem i, gdje je podržano, zatražite pregled operatera.

Na ovoj stranici
  1. Pripremite spremljeni profil i broj
  2. Pošaljite zahtjev za povezivanje
  3. Razlikujte povezivanje od odobrenja
  4. Obradite pogreške bez stvaranja dvostrukih zadataka
  5. Ograničenje za jednokratne dokumente
  6. Zaštitite podatke o registraciji

Pripremite spremljeni profil i broj

Ovim postupkom povežite spremljeni registracijski profil s kupljenim brojem i, za podržane brojeve koji se obrađuju putem operatera, zatražite pregled registracije. Ovo nije opći API za aktivaciju kod svih pružatelja brojeva. Uspješan zahtjev ne dokazuje da su dokumenti odobreni ili da je broj aktivan.

Upotrebljavajte omogućen MultiTEL API račun putem HTTPS-a s konfiguriranim vjerodajnicama i IP ograničenjima. I profil koji nije izbrisan i kupljeni broj koji nije poništen moraju pripadati vašem računu.

  1. Izradite registracijski profil ili odaberite postojeći. Sačuvajte uuid lokalnog profila iz funkcije create_document; get_document vraća istu lokalnu referencu kao id.
  2. Za slanje putem operatera profil mora sadržavati spremljene reference identiteta i adrese. Priložite potrebne dokaze i popratne dokumente putem odgovarajućih postupaka prije slanja.
  3. Provjerite ispunjavaju li broj i profil primjenjive zahtjeve za državu i broj. Nemojte pretpostaviti da je spremljeni profil odobren za svaki broj.

Pošaljite zahtjev za povezivanje

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/12125550123

Putanja sadrži kupljeni telefonski broj, a ne njegov UUID, PBX kućni broj ili ID identiteta. Funkcija za obradu uklanja iz broja sve znakove koji nisu znamenke. Upotrijebite puni međunarodni broj s pozivnim brojem države. Primjer je izmišljen i morate ga zamijeniti vlastitim brojem i spremljenom referencom lokalnog profila.

Polja za slanje registracije
PoljeObveznoZnačenje
document_uuidDaTočan spremljeni uuid lokalnog profila. Nemojte ga zamijeniti maskiranim udaljenim identifikatorima identity_id ili address_id, ID-jem učitavanja ili vraćenom vrijednošću registration_details_id.
service_descriptionNeOpis predviđene usluge koji se prosljeđuje operateru radi provjere. Uklanjaju se početni i završni razmaci.
onetime_filesOvisi o postupkuNiz koji se prihvaća za jednokratne dokumente operatera. Trenutačna funkcija za obradu uklanja početne i završne razmake iz njegovih znakovnih nizova te ih prosljeđuje bez razrješavanja lokalnih referenci učitavanja. Kompatibilnost s maskiranim ID-jevima koje vraća create_encrypt_files nije utvrđena; prije upotrebe ovog polja pogledajte ograničenje za jednokratne dokumente u nastavku.

U višedijelnim zahtjevima niz se navodi ponavljanjem polja onetime_files[]. Prihvaća se i JSON zahtjev sa zaglavljem Content-Type: application/json; njegova se svojstva spajaju s podacima obrasca. Polje number može se navesti u tijelu zahtjeva kada je broj izostavljen iz putanje. Radi izbjegavanja dvosmislenosti radije upotrijebite izričitu putanju prikazanu iznad.

Razlikujte povezivanje od odobrenja

Pročitajte i HTTP rezultat i status.code u JSON odgovoru. JSON pogreške mogu stići uz HTTP 200. Uspjeh pri obradi putem operatera prijavljuje se porukom Address verification task created; awaiting carrier review. U ovom se primjeru upotrebljavaju izmišljene reference.

{
  "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"
  }
}

Identifikatori povezani s pružateljem usluge maskirane su reference, a ne međusobno zamjenjivi ID-jevi lokalnih profila. document_uuid ostaje referenca lokalnog profila koju ste poslali. U grani ove funkcije za obradu koja se izvršava putem operatera, registration_details_id dodatni je sažetak dobiven raspršivanjem te lokalne reference; nemojte njime zamijeniti document_uuid u kasnijim zahtjevima za profil ili slanje.

Neki dodijeljeni brojevi upotrebljavaju lokalno povezivanje identiteta umjesto stvaranja provjere kod operatera. Njihov uspješan rezultat glasi Identity associated. uz prazan niz response. Time se ne stvara zadatak pregleda kod operatera niti se potvrđuje odobrenje. Portal ima noviji postupak povezivanja čija se obrada pružatelja usluga i provjere ponovljenog slanja razlikuju od ove krajnje točke.

Obradite pogreške bez stvaranja dvostrukih zadataka

API kod 400 obuhvaća nedostajući broj ili referencu profila. Kod 404 obuhvaća profil ili broj koji nije dostupan računu ili broj koji nedostaje u inventaru operatera. Kod 422 može prijaviti nedostajuće reference identiteta/adrese, zahtjeve prodavatelja ili odbijanje pri validaciji operatera. Nedostajuća konfiguracija povratnog poziva može proizvesti 503, a pogreška u prijenosu pri stvaranju može proizvesti 502. Pročitajte poruku i eventualne podatke requirement_diagnostics umjesto da sve pogreške obrađujete jednako.

Grana obrade putem operatera može ažurirati lokalne oznake registracije na čekanju prije nego što završe validacija zahtjeva, provjere konfiguracije povratnog poziva ili stvaranje zadatka. Pogreška stoga ne znači da je lokalno stanje nepromijenjeno, a sama oznaka čekanja ne dokazuje da zadatak postoji. Te oznake nemojte upotrebljavati kao potvrdu odobrenja ili dostave zahtjeva.

Pružatelj usluge može prihvatiti zadatak čak i ako kasnija lokalna operacija baze podataka ne uspije, a ova pomoćna funkcija ne provjerava rezultat svakog lokalnog upisa prije prijave uspjeha. Ova funkcija za obradu nema parametar za idempotentnost klijenta ni zaštitu od dvostrukog slanja. Nakon isteka vremena čekanja, pogreške ili neizvjesnog rezultata provjerite povijest registracije broja na portalu ili se obratite podršci prije ponovnog slanja. Nedostatak lokalnog zapisa sam po sebi ne dokazuje da pružatelj usluge nije ništa primio.

Ograničenje za jednokratne dokumente

Funkcija za obradu prihvaća onetime_files i prosljeđuje svaki neprazan znakovni niz u relaciju operatera za šifrirane datoteke. Ne pretražuje zapise učitavanja računa kojem pripadaju niti pretvara vanjske maskirane ID-jeve učitavanja u ID-jeve datoteka pružatelja usluge. Revizijom izvan mreže potvrđeno je ponašanje pri prosljeđivanju, a ne uspješno prilaganje kod operatera.

Nemojte pretpostaviti da se ID datoteke iz funkcije create_encrypt_files može kopirati u ovo polje kako bi se dovršio postupak jednokratnog ugovora. Kada broj zahtijeva te dokumente, upotrijebite portal ili s MultiTEL-om potvrdite podržani postupak upotrebe identifikatora. To ostaje neriješen dio pregleda API-ja, a ne provjeren primjer cjelokupnog postupka od početka do kraja.

Zaštitite podatke o registraciji

Šaljite samo podatke i dokumente koje ste ovlašteni upotrebljavati za taj broj. Reference profila i provjere moraju ostati povezane s odgovarajućim računom te izbjegavajte zapisivanje cjelovitih sadržaja registracijskih zahtjeva u zapisnike. Ovaj zahtjev ne briše niti zamjenjuje sve prethodne dokaze ili provjere. Pregled operatera, aktivacija i čuvanje podataka zasebni su procesi.