Berei die gestoorde profiel en nommer voor
Gebruik hierdie werkvloei om 'n gestoorde registrasieprofiel aan 'n gekoopte nommer te koppel en, vir ondersteunde nommers wat deur 'n netwerkoperateur verskaf word, registrasiehersiening aan te vra. Dit is nie 'n algemene aktiverings-API vir elke nommerverskaffer nie. 'n Suksesvolle versoek bewys nie dat dokumente goedgekeur is of dat die nommer aktief is nie.
Gebruik 'n geaktiveerde MultiTEL API-rekening oor HTTPS met die ingestelde aanmeldbesonderhede en IP-beperkings daarvan. Sowel die profiel wat nie uitgevee is nie as die gekoopte nommer wat nie nietig verklaar is nie, moet aan jou rekening behoort.
- Skep 'n registrasieprofiel of kies 'n bestaande een. Bewaar die plaaslike profiel se uuid uit create_document; get_document gee dieselfde plaaslike verwysing as id terug.
- Vir indiening by die netwerkoperateur benodig die profiel sy gestoorde identiteits- en adresverwysings. Heg die vereiste bewysstukke en stawende dokumente voor indiening deur hul toepaslike werkvloeie aan.
- Kontroleer dat die nommer en profiel aan die toepaslike land- en nommervereistes voldoen. Moenie aanvaar dat 'n gestoorde profiel vir elke nommer goedgekeur is nie.
Dien die koppeling in
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/12125550123Die pad bevat die gekoopte telefoonnommer, nie die UUID daarvan, 'n PBX-uitbreiding of 'n identiteits-ID nie. Die hanteerder verwyder alle tekens wat nie syfers is nie uit die nommer. Gebruik die volledige internasionale nommer met die landkode. Die voorbeeld is fiktief en moet met jou eie nommer en gestoorde plaaslike profielverwysing vervang word.
| Veld | Vereis | Betekenis |
|---|---|---|
document_uuid | Ja | Die presiese uuid van die gestoorde plaaslike profiel. Moenie die gemaskeerde afgeleë identity_id, address_id, oplaai-ID of 'n teruggestuurde registration_details_id-waarde in die plek daarvan gebruik nie. |
service_description | Nee | 'n Beskrywing van die beoogde diens wat vir verifikasie deur die netwerkoperateur aangestuur word. Spasies aan die begin en einde word verwyder. |
onetime_files | Hang van die werkvloei af | 'n Skikking wat vir die netwerkoperateur se eenmalige dokumente aanvaar word. Die huidige hanteerder verwyder spasies aan die begin en einde van die stringe en stuur dit aan sonder om plaaslike oplaaiverwysings na te slaan. Verenigbaarheid met die gemaskeerde ID's wat create_encrypt_files teruggee, is nie vasgestel nie; sien die beperking op eenmalige dokumente hieronder voordat jy hierdie veld gebruik. |
Vir meerdelige versoeke gebruik 'n skikking herhaalde onetime_files[]-velde. 'n JSON-versoek word ook aanvaar met Content-Type: application/json; die eienskappe daarvan word by die vorm se datalading ingesluit. 'n number kan in die datalading verskaf word wanneer die nommer in die pad weggelaat word. Gebruik verkieslik die uitdruklike pad hierbo om dubbelsinnigheid te vermy.
Onderskei tussen koppeling en goedkeuring
Lees sowel die HTTP-resultaat as die JSON se status.code. JSON-foute kan saam met HTTP 200 aankom. 'n Suksesvolle versoek aan die netwerkoperateur meld Address verification task created; awaiting carrier review. Hierdie voorbeeld gebruik fiktiewe verwysings.
{
"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"
}
}Die verskafferverwante identifiseerders is gemaskeerde verwysings en kan nie uitruilbaar as plaaslike profiel-ID's gebruik word nie. document_uuid bly die plaaslike profielverwysing wat jy ingedien het. In hierdie hanteerder se uitvoeringspad vir netwerkoperateurs is registration_details_id 'n verdere hutswaarde van daardie plaaslike verwysing; moenie document_uuid daarmee vervang in latere profiel- of indieningsversoeke nie.
Sommige toegekende nommers gebruik plaaslike identiteitskoppeling eerder as om 'n verifikasie by die netwerkoperateur te skep. Hul suksesvolle resultaat is Identity associated. met 'n leë response-skikking. Dit skep nie 'n hersieningstaak by die netwerkoperateur nie en bevestig ook nie goedkeuring nie. Die portaal het 'n nuwer koppelingswerkvloei waarvan die verskafferhantering en kontroles vir herhaalde indiening van hierdie eindpunt verskil.
Hanteer foute sonder om duplikaattake te skep
API-kode 400 dui op 'n ontbrekende nommer of profielverwysing. Kode 404 dui op 'n profiel of nommer wat nie vir die rekening beskikbaar is nie, of 'n nommer wat in die netwerkoperateur se voorraad ontbreek. Kode 422 kan ontbrekende identiteits-/adresverwysings, verkopervereistes of verwerping tydens validering deur die netwerkoperateur aandui. Ontbrekende terugroepkonfigurasie kan 503 veroorsaak, en 'n vervoerfout tydens skepping kan 502 veroorsaak. Lees die boodskap en enige requirement_diagnostics eerder as om elke mislukking op dieselfde manier te behandel.
Die uitvoeringspad vir netwerkoperateurs kan plaaslike merkers vir hangende registrasie bywerk voordat vereistevalidering, kontroles van terugroepkonfigurasie of taakskepping voltooi is. 'n Fout beteken dus nie dat die plaaslike toestand onveranderd is nie, en 'n merker vir 'n hangende registrasie alleen bewys nie dat 'n taak bestaan nie. Moenie daardie merkers as bevestiging van goedkeuring of aflewering van die versoek gebruik nie.
Die verskaffer kan 'n taak aanvaar selfs al misluk 'n latere plaaslike databasisbewerking, en hierdie hulpfunksie kontroleer nie elke plaaslike skryfresultaat voordat dit sukses meld nie. Hierdie hanteerder het geen kliëntparameter vir idempotensie of beskerming teen duplikaatindienings nie. Gaan ná 'n tydverstreking, fout of onsekere resultaat die nommer se registrasiegeskiedenis na in die portaal of kontak ondersteuning voordat jy weer indien. 'n Ontbrekende plaaslike rekord bewys op sigself nie dat die verskaffer niks ontvang het nie.
Beperking op eenmalige dokumente
Die hanteerder aanvaar onetime_files en stuur elke nieleë string na die netwerkoperateur se koppeling vir geënkripteerde lêers aan. Dit slaan nie die oplaairekords van die rekening waaraan dit behoort na nie en skakel ook nie eksterne gemaskeerde oplaai-ID's na verskafferlêer-ID's om nie. Die vanlyn oudit het die aanstuurgedrag bevestig, nie suksesvolle aanhegting by die netwerkoperateur nie.
Moenie aanvaar dat 'n lêer-ID uit create_encrypt_files na hierdie veld gekopieer kan word om 'n werkvloei vir 'n eenmalige ooreenkoms te voltooi nie. Gebruik die portaal of bevestig die ondersteunde werkvloei vir identifiseerders met MultiTEL wanneer 'n nommer hierdie dokumente vereis. Dit bly 'n onopgeloste deel van die API-hersiening en is nie 'n voorbeeld wat van begin tot einde geverifieer is nie.
Beskerm registrasie-inligting
Dien slegs inligting en dokumente in wat jy gemagtig is om vir die nommer te gebruik. Hou profiel- en verifikasieverwysings aan die korrekte rekening gekoppel en vermy dit om volledige registrasiedataladings in logboeke op te teken. Hierdie versoek vee nie elke vorige bewysstuk of verifikasie uit of vervang dit nie. Hersiening deur die netwerkoperateur, aktivering en bewaring is afsonderlike prosesse.