Zhvilluesit

POST/v3/number_identity/{number}

Dërgoni një profil regjistrimi për një numër

Lidhni profilin tuaj të ruajtur të regjistrimit me një numër të blerë dhe, kur mbështetet, kërkoni shqyrtimin nga operatori.

Në këtë faqe
  1. Përgatitni profilin e ruajtur dhe numrin
  2. Dërgoni lidhjen
  3. Dalloni lidhjen nga miratimi
  4. Trajtoni gabimet pa krijuar detyra të dyfishta
  5. Kufizimi për dokumentet për një përdorim
  6. Mbroni informacionin e regjistrimit

Përgatitni profilin e ruajtur dhe numrin

Përdoreni këtë rrjedhë pune për të lidhur një profil të ruajtur regjistrimi me një numër të blerë dhe, për numrat e mbështetur që menaxhohen përmes operatorit, për të kërkuar shqyrtimin e regjistrimit. Ky nuk është një API i përgjithshëm aktivizimi për çdo ofrues numrash. Një kërkesë e suksesshme nuk provon se dokumentet janë miratuar ose se numri është aktiv.

Përdorni një llogari të aktivizuar të API-së MultiTEL përmes HTTPS, me kredencialet dhe kufizimet IP të konfiguruara për të. Si profili që nuk është fshirë, ashtu edhe numri i blerë që nuk është anuluar duhet t'i përkasin llogarisë suaj.

  1. Krijoni një profil regjistrimi ose zgjidhni një ekzistues. Ruani identifikuesin uuid të profilit lokal nga create_document; get_document kthen të njëjtën referencë lokale si id.
  2. Për dërgimin përmes operatorit, profili duhet të ketë referencat e ruajtura të identitetit dhe adresës. Bashkëngjitni materialet e kërkuara: prova dhe dokumente mbështetëse, përmes rrjedhave përkatëse të punës, përpara dërgimit.
  3. Kontrolloni që numri dhe profili përmbushin kërkesat e zbatueshme për shtetin dhe numrin përkatës. Mos supozoni se një profil i ruajtur është i miratuar për çdo numër.

Dërgoni lidhjen

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

Shtegu përmban numrin e telefonit të blerë, jo UUID-në e tij, një numër të brendshëm PBX apo një ID identiteti. Përpunuesi heq nga numri karakteret që nuk janë shifra. Përdorni numrin e plotë ndërkombëtar me kodin e shtetit. Shembulli është i trilluar dhe duhet zëvendësuar me numrin tuaj dhe referencën e ruajtur të profilit lokal.

Fushat për dërgimin e regjistrimit
FushaE detyrueshmeKuptimi
document_uuidPoIdentifikuesi i saktë uuid i profilit lokal të ruajtur. Mos e zëvendësoni me identifikuesit e maskuar në distancë identity_id, address_id, me një ID ngarkimi ose me një vlerë të kthyer registration_details_id.
service_descriptionJoNjë përshkrim i shërbimit të synuar, që i përcillet operatorit për verifikim. Hapësirat në fillim dhe në fund hiqen.
onetime_filesVaret nga rrjedha e punësNjë varg i pranuar për dokumentet e operatorit për një përdorim. Përpunuesi aktual heq hapësirat në fillim dhe në fund të teksteve të vargut dhe i përcjell ato pa gjetur skedarët që u korrespondojnë referencave lokale të ngarkimit. Përputhshmëria me ID-të e maskuara të kthyera nga create_encrypt_files nuk është vërtetuar; shihni më poshtë kufizimin për dokumentet për një përdorim, përpara se ta përdorni këtë fushë.

Për kërkesat me shumë pjesë, një varg përdor fusha të përsëritura onetime_files[]. Pranohet edhe një kërkesë JSON me Content-Type: application/json; vetitë e saj bashkohen me të dhënat e formularit. Fusha number mund të jepet në trupin e kërkesës kur numri mungon në shteg. Preferoni shtegun e shprehur qartë më sipër për të shmangur paqartësinë.

Dalloni lidhjen nga miratimi

Lexoni si rezultatin HTTP, ashtu edhe fushën JSON status.code. Gabimet JSON mund të mbërrijnë me HTTP 200. Një veprim i suksesshëm përmes operatorit raporton Address verification task created; awaiting carrier review. Ky shembull përdor referenca të trilluara.

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

Identifikuesit që lidhen me ofruesin janë referenca të maskuara, jo ID profilesh lokale që mund të përdoren në vend të njëra-tjetrës. document_uuid mbetet referenca e profilit lokal që dërguat. Në degën e përpunimit përmes operatorit të këtij përpunuesi, registration_details_id është një vlerë tjetër hash e llogaritur nga ajo referencë lokale; mos e zëvendësoni document_uuid me të në kërkesat e mëvonshme për profilin ose dërgimin.

Disa numra të caktuar përdorin lidhjen lokale të identitetit në vend të krijimit të një verifikimi te operatori. Rezultati i tyre i suksesshëm është Identity associated. me një varg bosh response. Ky rezultat nuk krijon një detyrë shqyrtimi te operatori dhe as nuk konfirmon miratimin. Portali ka një rrjedhë më të re pune për lidhjen, ku trajtimi i ofruesve dhe kontrollet për dërgimet e përsëritura ndryshojnë nga ato të kësaj pike fundore të API-së.

Trajtoni gabimet pa krijuar detyra të dyfishta

Kodi API 400 tregon mungesën e numrit ose të referencës së profilit. Kodi 404 tregon një profil ose numër të padisponueshëm për llogarinë ose një numër që mungon në inventarin e operatorit. Kodi 422 mund të raportojë mungesë të referencave të identitetit ose adresës, kërkesa të shitësit ose refuzim gjatë validimit nga operatori. Mungesa e konfigurimit të thirrjes së kthimit mund të prodhojë 503, ndërsa një dështim i transportit gjatë krijimit mund të prodhojë 502. Lexoni mesazhin dhe çdo informacion në requirement_diagnostics, në vend që t'i trajtoni të gjitha dështimet njësoj.

Dega e përpunimit përmes operatorit mund të përditësojë treguesit lokalë të regjistrimit në pritje përpara se të përfundojnë validimi i kërkesave, kontrollet e konfigurimit të thirrjes së kthimit ose krijimi i detyrës. Prandaj, një gabim nuk nënkupton se gjendja lokale ka mbetur e pandryshuar, dhe një tregues pritjeje, i vetëm, nuk provon se ekziston një detyrë. Mos i përdorni këta tregues si konfirmim të miratimit ose të dorëzimit të kërkesës.

Ofruesi mund ta pranojë një detyrë edhe nëse një veprim i mëvonshëm në bazën lokale të të dhënave dështon, dhe ky funksion ndihmës nuk kontrollon rezultatin e çdo shkrimi lokal përpara se të raportojë sukses. Ky përpunues nuk ka parametër idempotence për klientin apo mbrojtje kundër dërgimeve të dyfishta. Pas skadimit të afatit të pritjes, një gabimi ose një rezultati të pasigurt, kontrolloni historikun e regjistrimit të numrit në portal ose kontaktoni mbështetjen përpara se ta dërgoni sërish. Mungesa e një regjistrimi lokal nuk provon vetvetiu se ofruesi nuk ka marrë asgjë.

Kufizimi për dokumentet për një përdorim

Përpunuesi pranon onetime_files dhe përcjell çdo tekst jo bosh në marrëdhënien e skedarëve të enkriptuar të operatorit. Ai nuk kërkon regjistrimet e ngarkimeve të llogarisë pronare dhe nuk i shndërron ID-të e jashtme të maskuara të ngarkimeve në ID skedarësh të ofruesit. Auditimi pa lidhje me sistemet aktive verifikoi sjelljen e përcjelljes, jo bashkëngjitjen e suksesshme te operatori.

Mos supozoni se një ID skedari nga create_encrypt_files mund të kopjohet në këtë fushë për të përfunduar një rrjedhë pune për një marrëveshje për një përdorim. Përdorni portalin ose konfirmoni me MultiTEL rrjedhën e mbështetur të punës për identifikuesit kur një numër kërkon këto dokumente. Kjo mbetet një pjesë e pazgjidhur e shqyrtimit të API-së, jo një shembull i verifikuar nga fillimi në fund.

Mbroni informacionin e regjistrimit

Dërgoni vetëm informacion dhe dokumente që jeni të autorizuar t'i përdorni për numrin. Mbajini referencat e profilit dhe verifikimit të lidhura me llogarinë e duhur dhe shmangni ruajtjen në regjistrat e sistemit të përmbajtjes së plotë të kërkesave të regjistrimit. Kjo kërkesë nuk fshin ose zëvendëson çdo provë apo verifikim të mëparshëm. Shqyrtimi nga operatori, aktivizimi dhe ruajtja e të dhënave janë procese të veçanta.