Esita numbri registreerimisprofiil

Valmista ette salvestatud profiil ja number

Kasuta seda töövoogu salvestatud registreerimisprofiili sidumiseks ostetud numbriga ja toetatud operaatoripõhiste numbrite registreerimise ülevaatuse taotlemiseks. See ei ole üldine aktiveerimise API kõigi numbripakkujate jaoks. Edukas päring ei tõenda, et dokumendid on heaks kiidetud või number on aktiivne.

Kasuta lubatud MultiTEL API kontot HTTPS-i kaudu koos sellele seadistatud autentimisandmete ja IP-piirangutega. Nii kustutamata profiil kui ka ostetud ja tühistamata number peavad kuuluma sinu kontole.

1. Loo registreerimisprofiil või vali olemasolev. Säilita kohaliku profiili uuid, mille tagastab create_document; get_document tagastab sama kohaliku viite väljal id.
2. Operaatorile esitamiseks peavad profiilil olema salvestatud identiteedi- ja aadressiviited. Lisa nõutavad tõendid ja lisadokumendid enne esitamist neile vastavate töövoogude kaudu.
3. Kontrolli, et number ja profiil vastaksid asjaomase riigi ja numbri nõuetele. Ära eelda, et salvestatud profiil on iga numbri jaoks heaks kiidetud.

Esita sidumistaotlus

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

Tee sisaldab ostetud telefoninumbrit, mitte selle UUID-d, PBX-i lühinumbrit ega identiteedi ID-d. Päringutöötleja eemaldab numbrist kõik märgid, mis ei ole numbrid. Kasuta täielikku rahvusvahelist numbrit koos riigikoodiga. Näide on väljamõeldud ning selles olevad andmed tuleb asendada sinu enda numbri ja salvestatud kohaliku profiili viitega.

Mitmeosalistes päringutes kasutatakse massiivi jaoks korduvaid onetime_files[] välju. Aktsepteeritakse ka JSON-päringut päisega Content-Type: application/json; selle omadused ühendatakse vormiandmetega. Kui number on teest välja jäetud, võib päringuandmetes esitada välja number. Mitmetimõistetavuse vältimiseks eelista ülal näidatud selgesõnalist teed.

Erista sidumist heakskiidust

Loe nii HTTP tulemust kui ka JSON-i välja status.code. JSON-i vead võivad saabuda koos HTTP koodiga 200. Operaatoripõhise töövoo õnnestumisel tagastatakse teade Address verification task created; awaiting carrier review. Selles näites kasutatakse väljamõeldud viiteid.

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

Teenusepakkujaga seotud identifikaatorid on maskeeritud viited, mitte omavahel asendatavad kohaliku profiili ID-d. document_uuid jääb sinu esitatud kohaliku profiili viiteks. Selle päringutöötleja operaatoripõhises täitmisharus on registration_details_id selle kohaliku viite täiendav räsi; ära asenda hilisemates profiili- või esitamispäringutes välja document_uuid selle väärtusega.

Mõne eraldatud numbri puhul kasutatakse operaatori kontrolli loomise asemel kohalikku identiteedi sidumist. Nende edukas tulemus on Identity associated. koos tühja response massiiviga. See ei loo operaatori ülevaatusülesannet ega kinnita heakskiitu. Portaalis on uuem sidumise töövoog, mille teenusepakkujate käsitlus ja korduva esitamise kontrollid erinevad selle lõpp-punkti omadest.

Käsitle vigu ülesannete duplikaate loomata

API kood 400 tähistab puuduvat numbrit või profiiliviidet. Kood 404 tähistab profiili või numbrit, mis pole kontole kättesaadav, või numbrit, mis puudub operaatori numbrivarust. Kood 422 võib teatada puuduvatest identiteedi- või aadressiviidetest, müüja nõuetest või operaatori valideerimisel tagasilükkamisest. Puuduv tagasikutse seadistus võib anda koodi 503 ja loomisel tekkiv andmeedastuse tõrge võib anda koodi 502. Loe teadet ja võimalikke requirement_diagnostics andmeid, selle asemel et käsitleda kõiki tõrkeid ühtemoodi.

Operaatoripõhine täitmisharu võib uuendada kohalikke ootel registreerimise tunnuseid enne nõuete valideerimise, tagasikutse seadistuse kontrollimise või ülesande loomise lõppu. Seega ei tähenda viga, et kohalik olek on muutumatu, ning ainuüksi ooteloleku tunnus ei tõenda ülesande olemasolu. Ära kasuta neid tunnuseid heakskiidu ega päringu kohaletoimetamise kinnitusena.

Teenusepakkuja võib ülesande vastu võtta ka siis, kui hilisem kohaliku andmebaasi toiming ebaõnnestub, ning see abifunktsioon ei kontrolli enne õnnestumisest teatamist iga kohaliku kirjutustoimingu tulemust. Selles päringutöötlejas ei ole kliendi idempotentsusparameetrit ega kaitset korduva esitamise vastu. Pärast ajalõppu, viga või ebakindlat tulemust kontrolli numbri registreerimisajalugu portaalis või võta enne uuesti esitamist ühendust klienditoega. Kohaliku kirje puudumine ei tõenda iseenesest, et teenusepakkuja ei saanud midagi.

Ühekordsete dokumentide piirang

Päringutöötleja aktsepteerib välja onetime_files ja edastab iga mittetühja stringi operaatori krüptitud failide seosesse. See ei otsi üleslaadimiste omanikkonto üleslaadimiskirjeid ega teisenda väliseid maskeeritud üleslaadimise ID-sid teenusepakkuja faili-ID-deks. Võrguühenduseta audit kinnitas edastamise toimimist, mitte failide edukat lisamist operaatori poolel.

Ära eelda, et funktsiooni create_encrypt_files tagastatud faili-ID saab ühekordse kokkuleppe töövoo lõpetamiseks sellesse välja kopeerida. Kui number nõuab neid dokumente, kasuta portaali või täpsusta MultiTEL-iga, millist identifikaatorite töövoogu toetatakse. See on endiselt API ülevaatuse lahendamata osa, mitte algusest lõpuni kontrollitud näide.

Kaitse registreerimisandmeid

Esita ainult teavet ja dokumente, mida sul on õigus selle numbri jaoks kasutada. Hoia profiili- ja kontrolliviited seotuna õige kontoga ning väldi täielike registreerimispäringu andmete logimist. See päring ei kustuta ega asenda kõiki varasemaid tõendeid või kontrolle. Operaatori ülevaatus, aktiveerimine ja andmete säilitamine on eraldi protsessid.