Bereid het opgeslagen profiel en het nummer voor
Gebruik deze werkwijze om een opgeslagen registratieprofiel aan een gekocht nummer te koppelen en, voor ondersteunde nummers die via een telecomaanbieder worden afgehandeld, een registratiebeoordeling aan te vragen. Dit is geen algemene activerings-API voor elke nummerleverancier. Een geslaagd verzoek bewijst niet dat documenten zijn goedgekeurd of dat het nummer actief is.
Gebruik een ingeschakeld MultiTEL API-account via HTTPS met de daarvoor ingestelde inloggegevens en IP-beperkingen. Zowel het niet-verwijderde profiel als het gekochte, niet-ongeldig verklaarde nummer moet bij uw account horen.
- Maak een registratieprofiel of selecteer een bestaand profiel. Bewaar de uuid van het lokale profiel uit create_document; get_document retourneert dezelfde lokale verwijzing als id.
- Voor indiening bij de telecomaanbieder moet het profiel opgeslagen verwijzingen naar de identiteit en het adres bevatten. Voeg de vereiste bewijsstukken en aanvullende documenten vóór indiening toe via de bijbehorende procedures.
- Controleer of het nummer en het profiel voldoen aan de toepasselijke vereisten voor het land en het nummer. Ga er niet van uit dat een opgeslagen profiel voor elk nummer is goedgekeurd.
Dien de 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/12125550123Het pad bevat het gekochte telefoonnummer, niet de UUID ervan, een toestelnummer van een telefooncentrale of een identiteits-ID. De verwerkingsfunctie verwijdert alle tekens die geen cijfers zijn uit het nummer. Gebruik het volledige internationale nummer met landcode. Het voorbeeld is fictief en moet worden vervangen door uw eigen nummer en de opgeslagen verwijzing naar uw lokale profiel.
| Veld | Verplicht | Betekenis |
|---|---|---|
document_uuid | Ja | De exacte opgeslagen uuid van het lokale profiel. Gebruik hiervoor niet de gemaskeerde externe identity_id, address_id, een upload-ID of een geretourneerde waarde van registration_details_id. |
service_description | Nee | Een beschrijving van de beoogde dienst, die wordt doorgestuurd voor verificatie door de telecomaanbieder. Spaties aan het begin en einde worden verwijderd. |
onetime_files | Afhankelijk van de procedure | Een array voor eenmalige documenten voor de telecomaanbieder. De huidige verwerkingsfunctie verwijdert spaties aan het begin en einde van de tekenreeksen en stuurt ze door zonder lokale uploadverwijzingen om te zetten. Compatibiliteit met de gemaskeerde ID's die create_encrypt_files retourneert, is niet vastgesteld; lees de onderstaande beperking voor eenmalige documenten voordat u dit veld gebruikt. |
Bij multipartverzoeken gebruikt een array herhaalde velden onetime_files[]. Een JSON-verzoek met Content-Type: application/json wordt ook geaccepteerd; de eigenschappen ervan worden samengevoegd met de formuliergegevens. Het veld number kan in de verzoekgegevens worden opgegeven wanneer het nummer in het pad ontbreekt. Gebruik bij voorkeur het hierboven getoonde expliciete pad om onduidelijkheid te voorkomen.
Maak onderscheid tussen koppeling en goedkeuring
Lees zowel het HTTP-resultaat als status.code in de JSON. JSON-fouten kunnen met HTTP 200 worden ontvangen. Bij een geslaagde indiening bij de telecomaanbieder wordt de melding Address verification task created; awaiting carrier review. geretourneerd. Dit voorbeeld gebruikt fictieve verwijzingen.
{
"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 identificatoren die betrekking hebben op de leverancier zijn gemaskeerde verwijzingen en zijn niet uitwisselbaar met lokale profiel-ID's. document_uuid blijft de verwijzing naar het lokale profiel die u hebt ingediend. In de verwerkingsroute voor de telecomaanbieder is registration_details_id een verdere hash van die lokale verwijzing; vervang document_uuid daar niet door in latere profiel- of indieningsverzoeken.
Bij sommige toegewezen nummers wordt de identiteit lokaal gekoppeld in plaats van dat er een verificatie bij de telecomaanbieder wordt aangemaakt. Bij succes wordt de melding Identity associated. geretourneerd met een lege array response. Dit maakt geen beoordelingstaak bij de telecomaanbieder aan en bevestigt geen goedkeuring. Het portaal heeft een nieuwere koppelingsprocedure waarvan de afhandeling van leveranciers en de controles op herhaalde indiening verschillen van dit eindpunt.
Handel fouten af zonder dubbele taken aan te maken
API-code 400 geeft aan dat een nummer of profielverwijzing ontbreekt. Code 404 geeft aan dat een profiel of nummer niet beschikbaar is voor het account of dat een nummer ontbreekt in de voorraad van de telecomaanbieder. Code 422 kan wijzen op ontbrekende identiteits- of adresverwijzingen, vereisten van de verkoper of afwijzing bij validatie door de telecomaanbieder. Ontbrekende configuratie voor terugmeldingen kan 503 opleveren en een transportfout bij het aanmaken kan 502 opleveren. Lees de melding en eventuele requirement_diagnostics in plaats van elke fout op dezelfde manier te behandelen.
De verwerkingsroute voor de telecomaanbieder kan lokale markeringen voor een registratie in behandeling bijwerken voordat de validatie van vereisten, de controle van de configuratie voor terugmeldingen of het aanmaken van de taak is voltooid. Een fout betekent daarom niet dat de lokale toestand ongewijzigd is, en een markering voor een registratie in behandeling bewijst op zichzelf niet dat er een taak bestaat. Gebruik deze markeringen niet als bevestiging van goedkeuring of aflevering van het verzoek.
De leverancier kan een taak accepteren, ook als een latere bewerking in de lokale database mislukt, en deze hulpfunctie controleert niet elk resultaat van een lokale schrijfbewerking voordat zij succes meldt. Deze verwerkingsfunctie heeft geen idempotentieparameter voor de client of beveiliging tegen dubbele indiening. Controleer na een time-out, fout of onzekere uitkomst de registratiegeschiedenis van het nummer in het portaal of neem contact op met de ondersteuning voordat u opnieuw indient. Een ontbrekende lokale registratie bewijst op zichzelf niet dat de leverancier niets heeft ontvangen.
Beperking voor eenmalige documenten
De verwerkingsfunctie accepteert onetime_files en stuurt elke niet-lege tekenreeks door naar de relatie voor versleutelde bestanden bij de telecomaanbieder. Zij zoekt geen uploadrecords van het account van de eigenaar op en zet externe gemaskeerde upload-ID's niet om in bestands-ID's van de leverancier. De offlinecontrole heeft het doorstuurgedrag bevestigd, maar niet het succesvol koppelen van bestanden bij de telecomaanbieder.
Ga er niet van uit dat een bestands-ID uit create_encrypt_files naar dit veld kan worden gekopieerd om de procedure voor een eenmalige overeenkomst af te ronden. Gebruik het portaal of bevestig bij MultiTEL welke procedure voor identificatoren wordt ondersteund wanneer een nummer deze documenten vereist. Dit blijft een onopgelost onderdeel van de API-beoordeling en is geen voorbeeld dat van begin tot eind is geverifieerd.
Bescherm registratiegegevens
Dien alleen informatie en documenten in die u voor het nummer mag gebruiken. Houd profiel- en verificatieverwijzingen gekoppeld aan het juiste account en vermijd het loggen van volledige registratiegegevens uit verzoeken. Dit verzoek verwijdert of vervangt niet alle eerdere bewijsstukken of verificaties. Beoordeling door de telecomaanbieder, activering en het bewaren van gegevens zijn afzonderlijke processen.