Skicka in en registreringsprofil för ett nummer

Förbered den sparade profilen och numret

Använd det här arbetsflödet för att koppla en sparad registreringsprofil till ett köpt nummer och begära registreringsgranskning för operatörsanknutna nummer som stöds. Det är inte ett allmänt aktiverings-API för alla nummerleverantörer. En lyckad begäran bevisar inte att dokumenten är godkända eller att numret är aktivt.

Använd ett aktiverat MultiTEL API-konto via HTTPS med kontots konfigurerade inloggningsuppgifter och IP-begränsningar. Både profilen, som inte får vara raderad, och det köpta numret, som inte får vara makulerat, måste tillhöra ditt konto.

1. Skapa en registreringsprofil eller välj en befintlig. Spara den lokala profilens uuid från create_document; get_document returnerar samma lokala referens som id.
2. För inskickning till operatören behöver profilen sina sparade identitets- och adressreferenser. Bifoga de obligatoriska intygen och kompletterande dokumenten via respektive arbetsflöde innan du skickar in begäran.
3. Kontrollera att numret och profilen uppfyller de tillämpliga kraven för landet och numret. Utgå inte från att en sparad profil är godkänd för alla nummer.

Skicka in kopplingen

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

Sökvägen innehåller det köpta telefonnumret, inte dess UUID, en anknytning i en telefonväxel eller ett identitets-ID. Hanteraren tar bort alla tecken som inte är siffror från numret. Använd hela det internationella numret med landskod. Exemplet är fiktivt och måste ersättas med ditt eget nummer och din sparade lokala profilreferens.

För multipart-begäranden anges en array genom upprepade onetime_files[]-fält. En JSON-begäran accepteras också med Content-Type: application/json; dess egenskaper slås samman med formulärets nyttolast. Ett number-värde kan anges i nyttolasten när numret utelämnas ur sökvägen. Använd helst den uttryckliga sökvägen ovan för att undvika tvetydighet.

Skilj på koppling och godkännande

Läs både HTTP-resultatet och status.code i JSON-svaret. JSON-fel kan komma med HTTP 200. Vid en lyckad begäran till operatören rapporteras Address verification task created; awaiting carrier review. Det här exemplet använder fiktiva referenser.

{
  "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 leverantörsrelaterade identifierarna är maskerade referenser, inte lokala profil-ID:n som kan användas omväxlande. document_uuid förblir den lokala profilreferens som du skickade in. I den här hanterarens operatörsanknutna kodväg är registration_details_id ett ytterligare hashvärde av den lokala referensen; ersätt inte document_uuid med det i senare profil- eller inskickningsbegäranden.

Vissa tilldelade nummer använder lokal identitetskoppling i stället för att skapa en verifiering hos operatören. Deras lyckade resultat är Identity associated. med en tom response-array. Det skapar ingen granskningsuppgift hos operatören och innebär inget godkännande. Portalen har ett nyare arbetsflöde för koppling där leverantörshanteringen och kontrollerna vid upprepad inskickning skiljer sig från den här ändpunkten.

Hantera fel utan att skapa dubbla uppgifter

API-kod 400 gäller när ett nummer eller en profilreferens saknas. Kod 404 gäller när en profil eller ett nummer inte är tillgängligt för kontot eller när ett nummer saknas i operatörens nummerbestånd. Kod 422 kan ange saknade identitets- eller adressreferenser, säljarens krav eller avslag vid operatörens validering. Saknad konfiguration för återanrop kan ge 503, och ett transportfel vid skapandet kan ge 502. Läs meddelandet och eventuell requirement_diagnostics i stället för att behandla alla fel på samma sätt.

Den operatörsanknutna kodvägen kan uppdatera lokala flaggor för väntande registrering innan kravvalideringen, kontrollerna av återanropskonfigurationen eller skapandet av uppgiften har slutförts. Ett fel innebär därför inte att det lokala tillståndet är oförändrat, och en väntandeflagga bevisar inte ensam att en uppgift finns. Använd inte dessa flaggor som bekräftelse på godkännande eller på att begäran har levererats.

Leverantören kan acceptera en uppgift även om en senare lokal databasoperation misslyckas, och den här hjälpfunktionen kontrollerar inte resultatet av varje lokal skrivning innan den rapporterar att åtgärden lyckades. Den här hanteraren saknar både idempotensparameter för klienten och skydd mot dubbla inskickningar. Efter en timeout, ett fel eller ett osäkert resultat ska du kontrollera numrets registreringshistorik i portalen eller kontakta supporten innan du skickar in igen. Att en lokal post saknas bevisar inte i sig att leverantören inte tog emot något.

Begränsning för engångsdokument

Hanteraren accepterar onetime_files och vidarebefordrar varje icke-tom sträng till operatörens relation för krypterade filer. Den slår inte upp uppladdningsraderna för det konto som äger dem och omvandlar inte externa maskerade uppladdnings-ID:n till leverantörens fil-ID:n. Offlinegranskningen verifierade vidarebefordringsbeteendet, inte att filer faktiskt bifogades hos operatören.

Utgå inte från att ett fil-ID från create_encrypt_files kan kopieras till det här fältet för att slutföra ett arbetsflöde för engångsavtal. Använd portalen eller be MultiTEL bekräfta vilket arbetsflöde för identifierare som stöds när ett nummer kräver dessa dokument. Detta är fortfarande en olöst del av API-granskningen, inte ett verifierat exempel från början till slut.

Skydda registreringsuppgifterna

Skicka endast in uppgifter och dokument som du har behörighet att använda för numret. Håll profil- och verifieringsreferenser kopplade till rätt konto och undvik att logga fullständiga registreringsnyttolaster. Den här begäran raderar eller ersätter inte alla tidigare intyg eller verifieringar. Operatörsgranskning, aktivering och lagring är separata processer.