Programiści

POST/v3/number_identity/{number}

Prześlij profil rejestracyjny numeru

Powiąż zapisany profil rejestracyjny z zakupionym numerem i, jeśli ta funkcja jest obsługiwana, zleć sprawdzenie przez operatora.

Na tej stronie
  1. Przygotuj zapisany profil i numer
  2. Prześlij powiązanie
  3. Odróżniaj powiązanie od zatwierdzenia
  4. Obsługuj błędy bez tworzenia zduplikowanych zadań
  5. Ograniczenie dotyczące dokumentów do jednorazowego przedłożenia
  6. Chroń informacje rejestracyjne

Przygotuj zapisany profil i numer

Użyj tej procedury, aby powiązać zapisany profil rejestracyjny z zakupionym numerem oraz, w przypadku obsługiwanych numerów dostarczanych przez operatora, zlecić sprawdzenie rejestracji. Nie jest to uniwersalne API aktywacji dla wszystkich dostawców numerów. Pomyślne wykonanie żądania nie dowodzi, że dokumenty zostały zatwierdzone ani że numer jest aktywny.

Korzystaj z włączonego konta API MultiTEL przez HTTPS, używając skonfigurowanych dla niego danych uwierzytelniających i ograniczeń adresów IP. Zarówno nieusunięty profil, jak i zakupiony, nieunieważniony numer muszą należeć do Twojego konta.

  1. Utwórz profil rejestracyjny lub wybierz istniejący. Zachowaj lokalny identyfikator profilu uuid z create_document; get_document zwraca tę samą lokalną referencję jako id.
  2. Do przesłania zgłoszenia do operatora profil potrzebuje zapisanych referencji tożsamości i adresu. Dołącz wymagane dowody i dokumenty uzupełniające za pomocą odpowiednich procedur przed przesłaniem zgłoszenia.
  3. Sprawdź, czy numer i profil spełniają obowiązujące wymagania dotyczące kraju i numeru. Nie zakładaj, że zapisany profil jest zatwierdzony dla każdego numeru.

Prześlij powiązanie

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

Ścieżka zawiera zakupiony numer telefonu, a nie jego UUID, numer wewnętrzny centrali PBX ani identyfikator tożsamości. Procedura obsługi usuwa z numeru znaki inne niż cyfry. Użyj pełnego numeru międzynarodowego z kodem kraju. Przykład jest fikcyjny i należy zastąpić go własnym numerem oraz zapisaną lokalną referencją profilu.

Pola zgłoszenia rejestracji
PoleWymaganeZnaczenie
document_uuidTakDokładny zapisany lokalny identyfikator profilu uuid. Nie zastępuj go zamaskowanym zdalnym identyfikatorem identity_id, address_id, identyfikatorem przesłanego pliku ani zwróconą wartością registration_details_id.
service_descriptionNieOpis planowanej usługi, przekazywany do weryfikacji przez operatora. Spacje na początku i na końcu są usuwane.
onetime_filesZależnie od proceduryTablica przyjmowana dla dokumentów do jednorazowego przedłożenia operatorowi. Obecna procedura obsługi usuwa spacje z początku i końca jej ciągów znaków i przekazuje je dalej bez rozwiązywania lokalnych referencji do przesłanych plików. Nie potwierdzono zgodności z zamaskowanymi identyfikatorami zwracanymi przez create_encrypt_files; przed użyciem tego pola zapoznaj się z poniższym ograniczeniem dotyczącym dokumentów do jednorazowego przedłożenia.

W żądaniach wieloczęściowych tablica korzysta z powtarzanych pól onetime_files[]. Akceptowane jest również żądanie JSON z Content-Type: application/json; jego właściwości są scalane z danymi formularza. Pole number można podać w danych żądania, jeśli numer został pominięty w ścieżce. Aby uniknąć niejednoznaczności, używaj wyraźnie określonej ścieżki pokazanej powyżej.

Odróżniaj powiązanie od zatwierdzenia

Sprawdzaj zarówno wynik HTTP, jak i status.code w odpowiedzi JSON. Błędy JSON mogą zostać zwrócone z HTTP 200. Powodzenie zgłoszenia do operatora jest sygnalizowane komunikatem: Address verification task created; awaiting carrier review. W tym przykładzie użyto fikcyjnych referencji.

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

Identyfikatory związane z dostawcą są zamaskowanymi referencjami, a nie wymiennymi lokalnymi identyfikatorami profili. document_uuid pozostaje przesłaną przez Ciebie lokalną referencją profilu. W ścieżce tej procedury obsługi korzystającej z operatora registration_details_id jest kolejnym skrótem tej lokalnej referencji; nie zastępuj nim document_uuid w późniejszych żądaniach dotyczących profilu lub przesyłania zgłoszeń.

W przypadku niektórych przydzielonych numerów tożsamość jest powiązywana lokalnie zamiast tworzenia weryfikacji u operatora. Wynikiem powodzenia jest Identity associated. z pustą tablicą response. Nie tworzy to zadania sprawdzenia przez operatora ani nie potwierdza zatwierdzenia. Portal udostępnia nowszą procedurę powiązania, której obsługa dostawców i kontrole ponownych zgłoszeń różnią się od tego punktu końcowego.

Obsługuj błędy bez tworzenia zduplikowanych zadań

Kod API 400 oznacza brak numeru lub referencji profilu. Kod 404 oznacza profil lub numer niedostępny dla konta albo brak numeru w zasobach operatora. Kod 422 może wskazywać brak referencji tożsamości lub adresu, wymagania sprzedawcy albo odrzucenie podczas walidacji przez operatora. Brak konfiguracji wywołania zwrotnego może spowodować 503, a błąd transportu podczas tworzenia może spowodować 502. Czytaj komunikat i ewentualne requirement_diagnostics, zamiast traktować wszystkie błędy jednakowo.

Ścieżka korzystająca z operatora może zaktualizować lokalne flagi oczekującej rejestracji przed zakończeniem walidacji wymagań, sprawdzania konfiguracji wywołania zwrotnego lub tworzenia zadania. Błąd nie oznacza więc, że stan lokalny pozostał niezmieniony, a sama flaga oczekiwania nie dowodzi istnienia zadania. Nie traktuj tych flag jako potwierdzenia zatwierdzenia ani dostarczenia żądania.

Dostawca może przyjąć zadanie nawet wtedy, gdy późniejsza operacja w lokalnej bazie danych zakończy się niepowodzeniem, a ta funkcja pomocnicza nie sprawdza wyniku każdego lokalnego zapisu przed zgłoszeniem powodzenia. Ta procedura obsługi nie udostępnia parametru idempotencji klienta ani zabezpieczenia przed zduplikowanymi zgłoszeniami. Po przekroczeniu limitu czasu, błędzie lub niepewnym wyniku sprawdź historię rejestracji numeru w portalu lub skontaktuj się z pomocą techniczną przed ponownym przesłaniem zgłoszenia. Sam brak lokalnego rekordu nie dowodzi, że dostawca niczego nie otrzymał.

Ograniczenie dotyczące dokumentów do jednorazowego przedłożenia

Procedura obsługi przyjmuje onetime_files i przekazuje każdy niepusty ciąg znaków do relacji zaszyfrowanych plików operatora. Nie wyszukuje rekordów przesłanych plików należących do konta właściciela ani nie przekształca zewnętrznych zamaskowanych identyfikatorów przesłanych plików w identyfikatory plików dostawcy. Audyt offline potwierdził sposób przekazywania danych, a nie pomyślne dołączenie plików u operatora.

Nie zakładaj, że można skopiować identyfikator pliku z create_encrypt_files do tego pola, aby ukończyć procedurę jednorazowej umowy. Jeśli numer wymaga tych dokumentów, skorzystaj z portalu lub potwierdź z MultiTEL obsługiwaną procedurę użycia identyfikatorów. Ten element przeglądu API pozostaje nierozstrzygnięty i nie jest przykładem zweryfikowanym od początku do końca.

Chroń informacje rejestracyjne

Przesyłaj wyłącznie informacje i dokumenty, których masz prawo używać dla danego numeru. Zachowuj powiązanie referencji profilu i weryfikacji z właściwym kontem i unikaj zapisywania pełnych danych żądań rejestracyjnych w dziennikach. To żądanie nie usuwa ani nie zastępuje wszystkich wcześniejszych dowodów lub weryfikacji. Sprawdzenie przez operatora, aktywacja i przechowywanie danych to odrębne procesy.