Dezvoltatori

POST/v3/number_identity/{number}

Trimiteți un profil de înregistrare pentru un număr

Asociați profilul de înregistrare salvat cu un număr achiziționat și, unde este disponibilă această opțiune, solicitați verificarea de către operator.

Pe această pagină
  1. Pregătiți profilul salvat și numărul
  2. Trimiteți asocierea
  3. Faceți distincția între asociere și aprobare
  4. Gestionați erorile fără a crea sarcini duplicate
  5. Limitare privind documentele de unică folosință
  6. Protejați informațiile de înregistrare

Pregătiți profilul salvat și numărul

Folosiți acest flux de lucru pentru a asocia un profil de înregistrare salvat cu un număr achiziționat și, pentru numerele gestionate de un operator pentru care există suport, pentru a solicita verificarea înregistrării. Acesta nu este un API general de activare pentru toți furnizorii de numere. O cerere reușită nu dovedește că documentele sunt aprobate sau că numărul este activ.

Folosiți un cont API MultiTEL activat, prin HTTPS, cu datele de autentificare și restricțiile IP configurate pentru acesta. Atât profilul neșters, cât și numărul achiziționat și neanulat trebuie să aparțină contului dumneavoastră.

  1. Creați un profil de înregistrare sau selectați unul existent. Păstrați identificatorul uuid al profilului local din create_document; get_document returnează aceeași referință locală ca id.
  2. Pentru trimiterea către operator, profilul trebuie să conțină referințele salvate la identitate și adresă. Atașați elementele necesare: dovezi și documente justificative, prin fluxurile de lucru corespunzătoare, înainte de trimitere.
  3. Verificați dacă numărul și profilul îndeplinesc cerințele aplicabile țării și numărului respectiv. Nu presupuneți că un profil salvat este aprobat pentru orice număr.

Trimiteți asocierea

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

Calea conține numărul de telefon achiziționat, nu UUID-ul acestuia, o extensie PBX sau un ID de identitate. Componenta de procesare elimină din număr caracterele care nu sunt cifre. Folosiți numărul internațional complet, cu prefixul de țară. Exemplul este fictiv și trebuie înlocuit cu propriul număr și cu referința salvată a profilului local.

Câmpuri pentru trimiterea înregistrării
CâmpObligatoriuSemnificație
document_uuidDaIdentificatorul uuid exact al profilului local salvat. Nu îl înlocuiți cu identificatorii la distanță mascați identity_id, address_id, cu un ID de încărcare sau cu o valoare registration_details_id returnată.
service_descriptionNuO descriere a serviciului preconizat, transmisă operatorului pentru verificare. Spațiile de la început și de la sfârșit sunt eliminate.
onetime_filesDepinde de fluxul de lucruUn tablou acceptat pentru documentele de unică folosință ale operatorului. Componenta actuală de procesare elimină spațiile de la începutul și sfârșitul șirurilor și le transmite mai departe fără a identifica fișierele corespunzătoare referințelor locale de încărcare. Compatibilitatea cu ID-urile mascate returnate de create_encrypt_files nu este stabilită; consultați mai jos limitarea privind documentele de unică folosință înainte de a utiliza acest câmp.

Pentru cererile multipart, un tablou folosește câmpuri onetime_files[] repetate. Este acceptată și o cerere JSON cu Content-Type: application/json; proprietățile acesteia sunt îmbinate cu datele formularului. Câmpul number poate fi furnizat în corpul cererii atunci când numărul este omis din cale. Preferați calea explicită prezentată mai sus pentru a evita ambiguitatea.

Faceți distincția între asociere și aprobare

Citiți atât rezultatul HTTP, cât și câmpul JSON status.code. Erorile JSON pot fi primite cu HTTP 200. O operațiune reușită realizată prin operator raportează Address verification task created; awaiting carrier review. Acest exemplu folosește referințe fictive.

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

Identificatorii legați de furnizor sunt referințe mascate, nu ID-uri de profil local care pot fi folosite interschimbabil. document_uuid rămâne referința profilului local pe care ați trimis-o. În ramura de procesare prin operator a acestei componente, registration_details_id este un hash suplimentar al acelei referințe locale; nu înlocuiți document_uuid cu acesta în cererile ulterioare privind profilul sau trimiterea.

Unele numere alocate folosesc asocierea locală a identității în locul creării unei verificări la operator. Rezultatul lor reușit este Identity associated. cu un tablou response gol. Acesta nu creează o sarcină de verificare la operator și nu confirmă aprobarea. Portalul are un flux de asociere mai nou, în care gestionarea furnizorilor și verificările pentru trimiterile repetate diferă de cele ale acestui punct de acces API.

Gestionați erorile fără a crea sarcini duplicate

Codul API 400 indică lipsa numărului sau a referinței profilului. Codul 404 indică un profil sau un număr indisponibil pentru cont ori un număr care lipsește din inventarul operatorului. Codul 422 poate raporta lipsa referințelor la identitate sau adresă, cerințe ale vânzătorului ori respingerea validării de către operator. Lipsa configurării apelului de revenire poate produce 503, iar o eroare de transport la creare poate produce 502. Citiți mesajul și eventualele informații din requirement_diagnostics, în loc să tratați toate erorile la fel.

Ramura de procesare prin operator poate actualiza indicatorii locali de înregistrare în așteptare înainte de finalizarea validării cerințelor, a verificărilor configurării apelului de revenire sau a creării sarcinii. Prin urmare, o eroare nu înseamnă că starea locală a rămas neschimbată, iar un indicator de așteptare nu dovedește singur existența unei sarcini. Nu folosiți acești indicatori drept confirmare a aprobării sau a livrării cererii.

Furnizorul poate accepta o sarcină chiar dacă o operațiune ulterioară în baza de date locală eșuează, iar această funcție auxiliară nu verifică rezultatul fiecărei scrieri locale înainte de a raporta succesul. Această componentă de procesare nu are un parametru de idempotență pentru client și nici protecție împotriva trimiterilor duplicate. După depășirea timpului de așteptare, o eroare sau un rezultat incert, verificați istoricul înregistrării numărului în portal sau contactați serviciul de asistență înainte de a trimite din nou. Absența unei înregistrări locale nu dovedește, prin ea însăși, că furnizorul nu a primit nimic.

Limitare privind documentele de unică folosință

Componenta de procesare acceptă onetime_files și transmite fiecare șir nevid către relația de fișiere criptate a operatorului. Aceasta nu caută înregistrările de încărcare ale contului proprietar și nu convertește ID-urile externe mascate ale încărcărilor în ID-uri de fișiere ale furnizorului. Auditul offline a verificat comportamentul de transmitere, nu atașarea reușită la operator.

Nu presupuneți că un ID de fișier din create_encrypt_files poate fi copiat în acest câmp pentru a finaliza un flux de lucru pentru un acord de unică folosință. Folosiți portalul sau confirmați cu MultiTEL fluxul de lucru acceptat pentru identificatori atunci când un număr necesită aceste documente. Acest aspect rămâne o parte nerezolvată a revizuirii API-ului, nu un exemplu verificat de la un capăt la altul.

Protejați informațiile de înregistrare

Trimiteți numai informații și documente pe care sunteți autorizat să le utilizați pentru numărul respectiv. Păstrați referințele profilului și ale verificării asociate contului corect și evitați înregistrarea în jurnale a conținutului integral al cererilor de înregistrare. Această cerere nu șterge și nu înlocuiește toate dovezile sau verificările anterioare. Verificarea de către operator, activarea și păstrarea datelor sunt procese separate.