Valmistele tallennettu profiili ja numero
Tällä työnkululla voit liittää tallennetun rekisteröintiprofiilin ostettuun numeroon ja pyytää rekisteröinnin tarkistusta tuetuille operaattoriin kytketyille numeroille. Tämä ei ole yleinen aktivointirajapinta kaikkien numerontarjoajien numeroille. Onnistunut pyyntö ei osoita, että asiakirjat on hyväksytty tai numero on aktiivinen.
Käytä käytössä olevaa MultiTEL API -tiliä HTTPS-yhteyden kautta ja noudata tilille määritettyjä tunnistetietoja ja IP-rajoituksia. Sekä profiilin, jota ei ole poistettu, että ostetun numeron, jota ei ole mitätöity, on kuuluttava tilillesi.
- Luo rekisteröintiprofiili tai valitse olemassa oleva. Säilytä paikallisen profiilin uuid, jonka create_document palauttaa; get_document palauttaa saman paikallisen viitteen kentässä id.
- Operaattorille lähetettäessä profiilissa on oltava tallennetut henkilöllisyys- ja osoiteviitteet. Liitä vaaditut todisteet ja täydentävät asiakirjat niiden omien työnkulkujen kautta ennen lähettämistä.
- Tarkista, että numero ja profiili täyttävät sovellettavat maa- ja numerokohtaiset vaatimukset. Älä oleta, että tallennettu profiili on hyväksytty kaikille numeroille.
Lähetä liittämispyyntö
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/12125550123Polku sisältää ostetun puhelinnumeron, ei sen UUID-tunnistetta, puhelinvaihteen alanumeroa tai henkilöllisyystunnistetta. Käsittelijä poistaa numerosta kaikki muut merkit paitsi numeromerkit. Käytä koko kansainvälistä numeroa maatunnuksineen. Esimerkki on kuvitteellinen, ja sen tilalle on vaihdettava oma numerosi ja tallennettu paikallinen profiiliviitteesi.
| Kenttä | Pakollinen | Merkitys |
|---|---|---|
document_uuid | Kyllä | Tallennetun paikallisen profiilin täsmällinen uuid. Älä käytä sen sijaan peitettyä etäjärjestelmän identity_id- tai address_id-tunnistetta, lataustunnistetta tai palautettua registration_details_id-arvoa. |
service_description | Ei | Kuvaus aiotusta palvelusta. Se välitetään operaattorin varmennusta varten. Alussa ja lopussa olevat välilyönnit poistetaan. |
onetime_files | Riippuu työnkulusta | Taulukko, joka hyväksytään operaattorin kertaluonteisia asiakirjoja varten. Nykyinen käsittelijä poistaa merkkijonojen alussa ja lopussa olevat välilyönnit ja välittää merkkijonot ratkaisematta paikallisia latausviitteitä. Yhteensopivuutta create_encrypt_files-toiminnon palauttamien peitettyjen tunnisteiden kanssa ei ole vahvistettu; lue jäljempänä kuvattu kertaluonteisia asiakirjoja koskeva rajoitus ennen tämän kentän käyttöä. |
Moniosaisissa pyynnöissä taulukko annetaan toistuvina onetime_files[]-kenttinä. Myös JSON-pyyntö hyväksytään otsakkeella Content-Type: application/json; sen ominaisuudet yhdistetään lomakkeen tietosisältöön. number voidaan antaa tietosisällössä, kun numero jätetään pois polusta. Käytä mieluiten yllä esitettyä täsmällistä polkua epäselvyyksien välttämiseksi.
Erota liittäminen hyväksynnästä
Lue sekä HTTP-tulos että JSON-vastauksen status.code. JSON-virheitä voi saapua HTTP 200 -vastauksen mukana. Onnistunut operaattorille tehty pyyntö palauttaa ilmoituksen Address verification task created; awaiting carrier review. Tässä esimerkissä käytetään kuvitteellisia viitteitä.
{
"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"
}
}Palveluntarjoajaan liittyvät tunnisteet ovat peitettyjä viitteitä, eivät keskenään vaihdettavia paikallisia profiilitunnisteita. document_uuid pysyy lähettämänäsi paikallisena profiiliviitteenä. Tämän käsittelijän operaattoriin kytketyssä suorituspolussa registration_details_id on kyseisestä paikallisesta viitteestä edelleen laskettu tiiviste; älä korvaa sillä document_uuid-arvoa myöhemmissä profiili- tai lähetyspyynnöissä.
Joissakin allokoiduissa numeroissa käytetään paikallista henkilöllisyyden liittämistä operaattorin varmennuksen luomisen sijaan. Niiden onnistunut tulos on Identity associated. ja tyhjä response-taulukko. Tämä ei luo operaattorin tarkistustehtävää eikä osoita hyväksyntää. Portaalissa on uudempi liittämistyönkulku, jonka palveluntarjoajien käsittely ja toistuvien lähetysten tarkistukset eroavat tästä päätepisteestä.
Käsittele virheet luomatta päällekkäisiä tehtäviä
API-koodi 400 koskee puuttuvaa numeroa tai profiiliviitettä. Koodi 404 koskee profiilia tai numeroa, joka ei ole tilin käytettävissä, tai numeroa, jota ei ole operaattorin numerovalikoimassa. Koodi 422 voi ilmoittaa puuttuvista henkilöllisyys- tai osoiteviitteistä, myyjän vaatimuksista tai operaattorin validoinnin hylkäyksestä. Puuttuva takaisinkutsun määritys voi tuottaa koodin 503, ja luontipyynnön tiedonsiirtovirhe voi tuottaa koodin 502. Lue viesti ja mahdolliset requirement_diagnostics-tiedot sen sijaan, että käsittelisit kaikkia virheitä samalla tavalla.
Operaattoriin kytketty suorituspolku voi päivittää paikalliset odottavan rekisteröinnin tilaliput ennen kuin vaatimusten validointi, takaisinkutsun määritysten tarkistukset tai tehtävän luonti valmistuvat. Virhe ei siksi tarkoita, että paikallinen tila olisi ennallaan, eikä odotusta ilmaiseva lippu yksin osoita, että tehtävä on olemassa. Älä käytä näitä lippuja vahvistuksena hyväksynnästä tai pyynnön perillemenosta.
Palveluntarjoaja voi hyväksyä tehtävän, vaikka myöhempi paikallinen tietokantatoiminto epäonnistuisi, eikä tämä apufunktio tarkista jokaisen paikallisen kirjoituksen tulosta ennen onnistumisesta ilmoittamista. Tässä käsittelijässä ei ole asiakkaan idempotenssiparametria eikä suojausta päällekkäisiltä lähetyksiltä. Tarkista aikakatkaisun, virheen tai epävarman tuloksen jälkeen numeron rekisteröintihistoria portaalista tai ota yhteyttä tukeen ennen uutta lähetystä. Paikallisen tietueen puuttuminen ei yksin osoita, ettei palveluntarjoaja vastaanottanut mitään.
Kertaluonteisia asiakirjoja koskeva rajoitus
Käsittelijä hyväksyy onetime_files-kentän ja välittää jokaisen ei-tyhjän merkkijonon operaattorin salattujen tiedostojen relaatioon. Se ei hae omistavan tilin latausrivejä eikä muunna ulkoisia peitettyjä lataustunnisteita palveluntarjoajan tiedostotunnisteiksi. Ilman verkkoyhteyttä tehty tarkastus varmisti välitystoiminnan, ei tiedostojen onnistunutta liittämistä operaattorin järjestelmässä.
Älä oleta, että create_encrypt_files-toiminnon palauttaman tiedostotunnisteen voi kopioida tähän kenttään kertaluonteisen sopimustyönkulun viimeistelemiseksi. Käytä portaalia tai varmista MultiTELiltä tuettu tunnisteiden työnkulku, kun numero edellyttää näitä asiakirjoja. Tämä on edelleen ratkaisematon osa API-tarkastusta, ei alusta loppuun varmennettu esimerkki.
Suojaa rekisteröintitiedot
Lähetä vain tietoja ja asiakirjoja, joita sinulla on oikeus käyttää kyseistä numeroa varten. Pidä profiili- ja varmennusviitteet liitettyinä oikeaan tiliin ja vältä rekisteröintipyyntöjen koko tietosisällön kirjaamista lokiin. Tämä pyyntö ei poista tai korvaa kaikkia aiempia todisteita tai varmennuksia. Operaattorin tarkistus, aktivointi ja tietojen säilyttäminen ovat erillisiä prosesseja.