Indsend en registreringsprofil til et nummer

Klargør den gemte profil og nummeret

Brug denne arbejdsgang til at knytte en gemt registreringsprofil til et købt nummer og anmode om gennemgang af registreringen for understøttede numre, der håndteres via en operatør. Det er ikke en generel aktiverings-API til alle nummerudbydere. En vellykket anmodning beviser ikke, at dokumenterne er godkendt, eller at nummeret er aktivt.

Brug en aktiveret MultiTEL API-konto via HTTPS med de konfigurerede legitimationsoplysninger og IP-begrænsninger. Både profilen, som ikke må være slettet, og det købte nummer, som ikke må være annulleret, skal tilhøre din konto.

1. Opret en registreringsprofil eller vælg en eksisterende. Gem den lokale profils uuid fra create_document; get_document returnerer den samme lokale reference som id.
2. Ved indsendelse via en operatør skal profilen have sine gemte identitets- og adressereferencer. Vedhæft de påkrævede beviser og supplerende dokumenter via de respektive arbejdsgange inden indsendelse.
3. Kontrollér, at nummeret og profilen opfylder de gældende krav for landet og nummeret. Antag ikke, at en gemt profil er godkendt til alle numre.

Indsend 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/12125550123

Stien indeholder det købte telefonnummer, ikke dets UUID, et PBX-lokalnummer eller et identitets-ID. Behandlingsfunktionen fjerner alle tegn, der ikke er cifre, fra nummeret. Brug det fulde internationale nummer med landekode. Eksemplet er fiktivt og skal erstattes med dit eget nummer og den gemte lokale profilreference.

Ved multipart-anmodninger angives et array med gentagne onetime_files[]-felter. En JSON-anmodning accepteres også med Content-Type: application/json; dens egenskaber flettes ind i formularens nyttedata. Feltet number kan angives i nyttedataene, når nummeret er udeladt fra stien. Brug helst den eksplicitte sti vist ovenfor for at undgå tvetydighed.

Skeln mellem tilknytning og godkendelse

Læs både HTTP-resultatet og status.code i JSON-svaret. JSON-fejl kan modtages med HTTP 200. Ved succes via en operatør rapporteres Address verification task created; awaiting carrier review. Dette eksempel bruger fiktive referencer.

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

De udbyderrelaterede identifikatorer er maskerede referencer og kan ikke bruges som indbyrdes udskiftelige lokale profil-ID'er. document_uuid forbliver den lokale profilreference, du indsendte. I denne behandlingsfunktions forløb via en operatør er registration_details_id en yderligere hash af denne lokale reference; erstat ikke document_uuid med den i senere profil- eller indsendelsesanmodninger.

Nogle tildelte numre bruger lokal identitetstilknytning i stedet for at oprette en verifikation hos operatøren. Deres succesresultat er Identity associated. med et tomt response-array. Det opretter ikke en gennemgangsopgave hos operatøren og dokumenterer ikke en godkendelse. Portalen har en nyere arbejdsgang til tilknytning, hvor håndteringen af udbydere og kontrollen af gentagne indsendelser adskiller sig fra dette endepunkt.

Håndtér fejl uden at oprette dublerede opgaver

API-kode 400 dækker et manglende nummer eller en manglende profilreference. Kode 404 dækker en profil eller et nummer, der ikke er tilgængeligt for kontoen, eller et nummer, der mangler i operatørens nummerbeholdning. Kode 422 kan angive manglende identitets-/adressereferencer, sælgerkrav eller afvisning ved operatørens validering. Manglende konfiguration af tilbagekald kan medføre 503, og en transportfejl under oprettelsen kan medføre 502. Læs meddelelsen og eventuelle requirement_diagnostics i stedet for at behandle alle fejl ens.

Forløbet via en operatør kan opdatere lokale flag for afventende registrering, før validering af krav, kontrol af konfigurationen af tilbagekald eller oprettelse af opgaven er afsluttet. En fejl betyder derfor ikke, at den lokale tilstand er uændret, og et afventningsflag alene beviser ikke, at der findes en opgave. Brug ikke disse flag som bekræftelse på godkendelse eller levering af anmodningen.

Udbyderen kan acceptere en opgave, selv om en senere lokal databaseoperation mislykkes, og denne hjælpefunktion kontrollerer ikke resultatet af alle lokale skrivninger, før den rapporterer succes. Denne behandlingsfunktion har ingen parameter til klientstyret idempotens og ingen beskyttelse mod dublerede indsendelser. Efter en timeout, en fejl eller et usikkert resultat skal du kontrollere nummerets registreringshistorik i portalen eller kontakte support, før du indsender igen. En manglende lokal post beviser ikke i sig selv, at udbyderen ikke har modtaget noget.

Begrænsning for dokumenter til engangsbrug

Behandlingsfunktionen accepterer onetime_files og videresender hver ikke-tom streng til operatørens relation for krypterede filer. Den slår ikke den ejende kontos uploadposter op og omsætter ikke eksterne maskerede upload-ID'er til udbyderens fil-ID'er. Offlinegennemgangen bekræftede videresendelsesadfærden, ikke at filerne blev vedhæftet korrekt hos operatøren.

Antag ikke, at et fil-ID fra create_encrypt_files kan kopieres til dette felt for at fuldføre en arbejdsgang for en engangsaftale. Brug portalen, eller få MultiTEL til at bekræfte den understøttede arbejdsgang for identifikatorer, når et nummer kræver disse dokumenter. Dette er fortsat en uafklaret del af API-gennemgangen, ikke et verificeret eksempel fra start til slut.

Beskyt registreringsoplysninger

Indsend kun oplysninger og dokumenter, som du har tilladelse til at bruge til nummeret. Sørg for, at profil- og verifikationsreferencer er knyttet til den korrekte konto, og undgå at logge komplette registreringsnyttedata. Denne anmodning sletter eller erstatter ikke alle tidligere beviser eller verifikationer. Operatørens gennemgang, aktivering og opbevaring er separate processer.