Kūrėjams

POST/v3/number_identity/{number}

Pateikite numerio registracijos profilį

Susiekite išsaugotą registracijos profilį su įsigytu numeriu ir, jei palaikoma, paprašykite operatoriaus peržiūros.

Šiame puslapyje
  1. Paruoškite išsaugotą profilį ir numerį
  2. Pateikite susiejimo užklausą
  3. Atskirkite susiejimą nuo patvirtinimo
  4. Tvarkykite klaidas nesukurdami pasikartojančių užduočių
  5. Vienkartinių dokumentų apribojimas
  6. Apsaugokite registracijos informaciją

Paruoškite išsaugotą profilį ir numerį

Naudokite šią eigą išsaugotam registracijos profiliui susieti su įsigytu numeriu ir, jei numerį aptarnaujantis operatorius tai palaiko, registracijos peržiūrai užsakyti. Tai nėra universali visų numerių teikėjų aktyvinimo API. Sėkminga užklausa nepatvirtina, kad dokumentai patvirtinti ar numeris aktyvus.

Naudokite įjungtą MultiTEL API paskyrą per HTTPS su jai nustatytais prisijungimo duomenimis ir IP apribojimais. Ir neištrintas profilis, ir įsigytas, neanuliuotas numeris turi priklausyti jūsų paskyrai.

  1. Sukurkite registracijos profilį arba pasirinkite esamą. Išsaugokite vietinio profilio uuid, gautą iš create_document; get_document grąžina tą pačią vietinę nuorodą lauke id.
  2. Pateikiant operatoriui, profilyje turi būti išsaugotos tapatybės ir adreso nuorodos. Pridėkite reikiamus įrodymus ir papildomus dokumentus prieš pateikdami, naudodamiesi atitinkamomis jų pridėjimo procedūromis.
  3. Patikrinkite, ar numeris ir profilis atitinka taikomus šalies ir numerio reikalavimus. Nemanykite, kad išsaugotas profilis yra patvirtintas kiekvienam numeriui.

Pateikite susiejimo užklausą

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

Kelyje nurodomas įsigytas telefono numeris, o ne jo UUID, PBX vidinis numeris ar tapatybės ID. Apdorojimo funkcija iš numerio pašalina visus simbolius, kurie nėra skaitmenys. Naudokite visą tarptautinį numerį su šalies kodu. Pavyzdys išgalvotas; jame pateiktus duomenis būtina pakeisti savo numeriu ir išsaugota vietinio profilio nuoroda.

Registracijos pateikimo laukai
LaukasPrivalomasReikšmė
document_uuidTaipTikslus išsaugoto vietinio profilio uuid. Vietoj jo nenaudokite užmaskuotų nuotolinių identity_id, address_id, įkelto failo ID ar grąžintos registration_details_id reikšmės.
service_descriptionNeNumatomos paslaugos aprašas, perduodamas operatoriui patikrinti. Tarpai pradžioje ir pabaigoje pašalinami.
onetime_filesPriklauso nuo procedūrosMasyvas, priimamas operatoriui skirtiems vienkartiniams dokumentams. Dabartinė apdorojimo funkcija pašalina tarpus jo eilučių pradžioje ir pabaigoje bei perduoda eilutes, neieškodama vietines įkeltų failų nuorodas atitinkančių identifikatorių. Suderinamumas su užmaskuotais ID, kuriuos grąžina create_encrypt_files, nenustatytas; prieš naudodami šį lauką perskaitykite toliau aprašytą vienkartinių dokumentų apribojimą.

Kelių dalių užklausose masyvui naudojami pasikartojantys onetime_files[] laukai. Taip pat priimama JSON užklausa su Content-Type: application/json; jos savybės sujungiamos su formos duomenimis. Lauką number galima pateikti užklausos duomenyse, jei numeris nenurodytas kelyje. Kad išvengtumėte dviprasmybių, rinkitės pirmiau parodytą aiškiai nurodytą kelią.

Atskirkite susiejimą nuo patvirtinimo

Perskaitykite ir HTTP rezultatą, ir JSON status.code. JSON klaidos gali būti grąžinamos su HTTP 200. Sėkmingai pateikus operatoriui, grąžinamas pranešimas Address verification task created; awaiting carrier review. Šiame pavyzdyje naudojamos išgalvotos nuorodos.

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

Su teikėju susiję identifikatoriai yra užmaskuotos nuorodos, o ne vietinių profilių ID, kuriuos būtų galima naudoti vietoj jų. document_uuid išlieka jūsų pateikta vietinio profilio nuoroda. Šios apdorojimo funkcijos operatoriui skirtoje vykdymo šakoje registration_details_id yra papildoma tos vietinės nuorodos maišos reikšmė; vėlesnėse profilio ar pateikimo užklausose nekeiskite document_uuid šia reikšme.

Kai kuriems paskirtiems numeriams naudojamas vietinis tapatybės susiejimas, o operatoriaus patikra nesukuriama. Jų sėkmingas rezultatas yra Identity associated. su tuščiu response masyvu. Tai nesukuria operatoriaus peržiūros užduoties ir nepatvirtina patvirtinimo fakto. Portale veikia naujesnė susiejimo eiga, kurios darbas su teikėjais ir pakartotinio pateikimo patikros skiriasi nuo šio galinio taško.

Tvarkykite klaidas nesukurdami pasikartojančių užduočių

API kodas 400 nurodo, kad trūksta numerio arba profilio nuorodos. Kodas 404 nurodo, kad profilis ar numeris paskyrai neprieinamas arba numerio nėra operatoriaus numerių sąraše. Kodas 422 gali pranešti apie trūkstamas tapatybės ar adreso nuorodas, pardavėjo reikalavimus arba operatoriaus patikros atmetimą. Nesant atgalinio iškvietimo konfigūracijos, gali būti grąžintas 503, o įvykus perdavimo klaidai kuriant užduotį – 502. Perskaitykite pranešimą ir visus pateiktus requirement_diagnostics duomenis, užuot visas nesėkmes vertinę vienodai.

Operatoriui skirta vykdymo šaka gali atnaujinti vietines laukiančios registracijos žymas dar nebaigus tikrinti reikalavimų, atgalinio iškvietimo konfigūracijos ar kurti užduoties. Todėl klaida nereiškia, kad vietinė būsena nepasikeitė, o vien laukimo žyma neįrodo, kad užduotis egzistuoja. Nenaudokite šių žymų kaip patvirtinimo ar užklausos pristatymo įrodymo.

Teikėjas gali priimti užduotį net jei vėlesnė vietinės duomenų bazės operacija nepavyksta, o ši pagalbinė funkcija prieš pranešdama apie sėkmę patikrina ne kiekvieno vietinio įrašymo rezultatą. Šioje apdorojimo funkcijoje nėra kliento idempotentiškumo parametro ar apsaugos nuo pakartotinio pateikimo. Pasibaigus laukimo laikui, įvykus klaidai ar gavus neaiškų rezultatą, patikrinkite numerio registracijos istoriją portale arba prieš pateikdami dar kartą kreipkitės į pagalbos tarnybą. Vien tai, kad nėra vietinio įrašo, neįrodo, jog teikėjas nieko negavo.

Vienkartinių dokumentų apribojimas

Apdorojimo funkcija priima onetime_files ir kiekvieną netuščią eilutę perduoda į operatoriaus šifruotų failų sąsają. Ji neieško savininko paskyros įkeltų failų įrašų ir nekeičia išorinių užmaskuotų įkėlimo ID į teikėjo failų ID. Neprisijungus atliktas auditas patvirtino perdavimo veikimą, bet ne sėkmingą failų pridėjimą operatoriaus sistemoje.

Nemanykite, kad iš create_encrypt_files gautą failo ID galima nukopijuoti į šį lauką ir taip užbaigti vienkartinio susitarimo procedūrą. Kai numeriui reikia šių dokumentų, naudokitės portalu arba su MultiTEL išsiaiškinkite palaikomą identifikatorių naudojimo eigą. Tai tebėra neišspręsta API peržiūros dalis, o ne nuo pradžios iki pabaigos patikrintas pavyzdys.

Apsaugokite registracijos informaciją

Pateikite tik tą informaciją ir dokumentus, kuriuos turite teisę naudoti šiam numeriui. Užtikrinkite, kad profilio ir patikros nuorodos būtų susietos su tinkama paskyra, ir venkite žurnaluose įrašyti visus registracijos užklausų duomenis. Ši užklausa neištrina ir nepakeičia visų ankstesnių įrodymų ar patikrų. Operatoriaus peržiūra, aktyvinimas ir duomenų saugojimas yra atskiri procesai.