Klargjør den lagrede profilen og nummeret
Bruk denne arbeidsflyten til å knytte en lagret registreringsprofil til et kjøpt nummer og, for støttede numre som håndteres av en operatør, be om vurdering av registreringen. Dette er ikke et generelt aktiverings-API for alle nummerleverandører. En vellykket forespørsel beviser ikke at dokumentene er godkjent eller at nummeret er aktivt.
Bruk en aktivert MultiTEL API-konto over HTTPS med de konfigurerte påloggingsopplysningene og IP-begrensningene. Både profilen, som ikke må være slettet, og det kjøpte nummeret, som ikke må være annullert, må tilhøre kontoen din.
- Opprett en registreringsprofil eller velg en eksisterende. Ta vare på profilens lokale uuid fra create_document; get_document returnerer den samme lokale referansen som id.
- Ved innsending til operatøren må profilen ha lagrede referanser til identitet og adresse. Legg ved nødvendige bevis og støttedokumenter gjennom de respektive arbeidsflytene før innsending.
- Kontroller at nummeret og profilen oppfyller gjeldende krav for landet og nummeret. Ikke anta at en lagret profil er godkjent for alle numre.
Send inn tilknytningen
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/12125550123Stien inneholder det kjøpte telefonnummeret, ikke nummerets UUID, et internnummer i en PBX eller en identitets-ID. Behandlingsfunksjonen fjerner alle tegn som ikke er sifre, fra nummeret. Bruk hele det internasjonale nummeret med landskode. Eksemplet er oppdiktet og må erstattes med ditt eget nummer og den lagrede lokale profilreferansen.
| Felt | Påkrevd | Betydning |
|---|---|---|
document_uuid | Ja | Den nøyaktige lagrede lokale uuid for profilen. Ikke erstatt den med den maskerte eksterne identity_id, address_id, en opplastings-ID eller en returnert registration_details_id-verdi. |
service_description | Nei | En beskrivelse av den tiltenkte tjenesten, som videresendes for verifisering hos operatøren. Innledende og avsluttende mellomrom fjernes. |
onetime_files | Avhenger av arbeidsflyten | En liste som godtas for operatørens engangsdokumenter. Den nåværende behandlingsfunksjonen fjerner innledende og avsluttende mellomrom fra strengene og videresender dem uten å slå opp lokale opplastingsreferanser. Kompatibilitet med de maskerte ID-ene som returneres av create_encrypt_files, er ikke fastslått; se begrensningen for engangsdokumenter nedenfor før du bruker dette feltet. |
I flerdelte forespørsler angis en liste med gjentatte onetime_files[]-felter. En JSON-forespørsel godtas også med Content-Type: application/json; egenskapene flettes inn i skjemadataene. number kan oppgis i forespørselsdataene når nummeret utelates fra stien. Bruk helst den eksplisitte stien vist ovenfor for å unngå tvetydighet.
Skill mellom tilknytning og godkjenning
Les både HTTP-resultatet og status.code i JSON. JSON-feil kan komme med HTTP 200. Ved vellykket behandling hos operatøren meldes Address verification task created; awaiting carrier review. Dette eksemplet bruker oppdiktede referanser.
{
"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"
}
}Identifikatorene knyttet til leverandøren er maskerte referanser, ikke lokale profil-ID-er som kan brukes om hverandre. document_uuid forblir den lokale profilreferansen du sendte inn. I denne behandlingsfunksjonens operatørgren er registration_details_id en ytterligere hash av den lokale referansen; ikke erstatt document_uuid med den i senere profil- eller innsendingsforespørsler.
Noen tildelte numre bruker lokal identitetstilknytning i stedet for å opprette en verifisering hos operatøren. Det vellykkede resultatet for disse er Identity associated. med en tom response-liste. Dette oppretter ingen vurderingsoppgave hos operatøren og bekrefter heller ingen godkjenning. Portalen har en nyere arbeidsflyt for tilknytning der leverandørhåndteringen og kontrollene for gjentatt innsending er annerledes enn ved dette endepunktet.
Håndter feil uten å opprette dupliserte oppgaver
API-kode 400 omfatter manglende nummer eller profilreferanse. Kode 404 omfatter en profil eller et nummer som ikke er tilgjengelig for kontoen, eller et nummer som mangler i operatørens nummerbeholdning. Kode 422 kan melde om manglende identitets- eller adressereferanser, selgerkrav eller avvisning ved operatørens validering. Manglende konfigurasjon av tilbakekall kan gi 503, og en transportfeil under oppretting kan gi 502. Les meldingen og eventuelle requirement_diagnostics i stedet for å behandle alle feil på samme måte.
Operatørgrenen kan oppdatere lokale flagg for ventende registrering før kravvalideringen, kontrollene av tilbakekallskonfigurasjonen eller opprettingen av oppgaven er ferdig. En feil betyr derfor ikke at den lokale tilstanden er uendret, og et venteflagg alene beviser ikke at det finnes en oppgave. Ikke bruk disse flaggene som bekreftelse på godkjenning eller at forespørselen er levert.
Leverandøren kan godta en oppgave selv om en senere lokal databaseoperasjon mislykkes, og denne hjelpefunksjonen kontrollerer ikke resultatet av hver lokal skriveoperasjon før den melder om suksess. Denne behandlingsfunksjonen har ingen idempotensparameter for klienten eller beskyttelse mot duplisert innsending. Etter et tidsavbrudd, en feil eller et usikkert resultat bør du kontrollere nummerets registreringshistorikk i portalen eller kontakte kundestøtte før du sender inn på nytt. En manglende lokal oppføring beviser ikke i seg selv at leverandøren ikke mottok noe.
Begrensning for engangsdokumenter
Behandlingsfunksjonen godtar onetime_files og videresender hver ikke-tomme streng til operatørens relasjon for krypterte filer. Den slår ikke opp opplastingsradene til kontoen som eier dem, og oversetter heller ikke eksterne maskerte opplastings-ID-er til leverandørens fil-ID-er. Gjennomgangen uten nettilkobling bekreftet videresendingsatferden, ikke at filene ble vedlagt hos operatøren.
Ikke anta at en fil-ID fra create_encrypt_files kan kopieres til dette feltet for å fullføre en arbeidsflyt for en engangsavtale. Bruk portalen eller få MultiTEL til å bekrefte den støttede arbeidsflyten for identifikatorer når et nummer krever disse dokumentene. Dette er fortsatt en uavklart del av API-gjennomgangen, ikke et eksempel som er verifisert fra start til slutt.
Beskytt registreringsopplysningene
Send bare inn opplysninger og dokumenter du har tillatelse til å bruke for nummeret. Sørg for at profil- og verifiseringsreferanser er knyttet til riktig konto, og unngå å loggføre fullstendige registreringsdata fra forespørsler. Denne forespørselen sletter eller erstatter ikke alle tidligere bevis eller verifiseringer. Operatørens vurdering, aktivering og oppbevaring er separate prosesser.