Fejlesztők

POST/v3/number_identity/{number}

Számregisztrációs profil beküldése

Kapcsolja össze mentett regisztrációs profilját egy megvásárolt számmal, és ahol ez támogatott, kérjen távközlési szolgáltatói felülvizsgálatot.

Ezen az oldalon
  1. A mentett profil és a szám előkészítése
  2. Az összerendelés beküldése
  3. Az összerendelés és a jóváhagyás megkülönböztetése
  4. Hibakezelés ismétlődő feladatok létrehozása nélkül
  5. Az egyszeri dokumentumokra vonatkozó korlátozás
  6. A regisztrációs adatok védelme

A mentett profil és a szám előkészítése

Ezzel a munkafolyamattal egy mentett regisztrációs profilt kapcsolhat össze egy megvásárolt számmal, és a támogatott, távközlési szolgáltatói háttérrel rendelkező számoknál kérheti a regisztráció felülvizsgálatát. Ez nem az összes számszolgáltatóhoz használható általános aktiválási API. A sikeres kérés nem bizonyítja a dokumentumok jóváhagyását vagy a szám aktív állapotát.

Használjon engedélyezett MultiTEL API-fiókot HTTPS-kapcsolaton keresztül, a beállított hitelesítő adatokkal és IP-korlátozásokkal. A nem törölt profilnak és a megvásárolt, nem érvénytelenített számnak egyaránt az Ön fiókjához kell tartoznia.

  1. Hozzon létre egy regisztrációs profilt vagy válasszon egy meglévőt. Őrizze meg a helyi profil uuid értékét a create_document válaszából; a get_document ugyanazt a helyi hivatkozást adja vissza id néven.
  2. A távközlési szolgáltatónak történő beküldéshez a profilnak rendelkeznie kell a mentett személyazonossági és címhivatkozásokkal. Csatolja a szükséges igazolásokat és alátámasztó dokumentumokat a megfelelő munkafolyamatokkal, még a beküldés előtt.
  3. Ellenőrizze, hogy a szám és a profil megfelel-e az adott országra és számra vonatkozó követelményeknek. Ne feltételezze, hogy egy mentett profil minden számhoz jóvá van hagyva.

Az összerendelés beküldése

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

Az útvonal a megvásárolt telefonszámot tartalmazza, nem annak UUID-jét, egy PBX-melléket vagy egy személyazonossági azonosítót. A kéréskezelő eltávolítja a számból a nem számjegy karaktereket. A teljes nemzetközi számot használja az országhívóval együtt. A példa kitalált adatokat tartalmaz; ezeket a saját számára és a mentett helyi profil hivatkozására kell cserélnie.

A regisztráció beküldési mezői
MezőKötelezőJelentés
document_uuidIgenA mentett helyi profil pontos uuid értéke. Ne helyettesítse a maszkolt távoli identity_id vagy address_id értékkel, feltöltési azonosítóval vagy egy visszaadott registration_details_id értékkel.
service_descriptionNemA tervezett szolgáltatás leírása, amelyet továbbítanak a távközlési szolgáltatói ellenőrzéshez. Az elején és a végén található szóközöket eltávolítják.
onetime_filesMunkafolyamattól függA távközlési szolgáltató egyszeri dokumentumaihoz elfogadott tömb. A jelenlegi kéréskezelő eltávolítja a karakterláncok elején és végén található szóközöket, majd továbbítja őket a helyi feltöltési hivatkozások feloldása nélkül. A create_encrypt_files által visszaadott maszkolt azonosítókkal való kompatibilitás nem igazolt; a mező használata előtt olvassa el alább az egyszeri dokumentumokra vonatkozó korlátozást.

Többrészes kéréseknél a tömb ismétlődő onetime_files[] mezőket használ. JSON-kérés is elfogadott Content-Type: application/json fejléccel; a tulajdonságait beolvasztják az űrlap adataiba. A number megadható a kérés törzsében, ha a szám hiányzik az útvonalból. A félreértések elkerülése érdekében a fent bemutatott, számot is tartalmazó útvonalat részesítse előnyben.

Az összerendelés és a jóváhagyás megkülönböztetése

Olvassa el a HTTP-eredményt és a JSON status.code értékét is. JSON-hibák HTTP 200 mellett is érkezhetnek. A távközlési szolgáltatói feldolgozás sikere esetén ez az üzenet jelenik meg: Address verification task created; awaiting carrier review. A példa kitalált hivatkozásokat használ.

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

A szolgáltatóhoz kapcsolódó azonosítók maszkolt hivatkozások, nem felcserélhető helyi profilazonosítók. A document_uuid továbbra is az Ön által beküldött helyi profilhivatkozás. A kéréskezelő távközlési szolgáltatót használó feldolgozási ágában a registration_details_id ennek a helyi hivatkozásnak egy további kivonata; a későbbi profil- vagy beküldési kérésekben ne cserélje le vele a document_uuid értékét.

Egyes kiosztott számoknál szolgáltatói ellenőrzés létrehozása helyett helyi személyazonosság-összerendelés történik. Sikeres eredményük az Identity associated. üzenet, üres response tömbbel. Ez nem hoz létre szolgáltatói felülvizsgálati feladatot, és nem jelent jóváhagyást. A portálon újabb összerendelési munkafolyamat érhető el, amelynek szolgáltatókezelése és ismételt beküldéseket ellenőrző működése eltér ettől a végponttól.

Hibakezelés ismétlődő feladatok létrehozása nélkül

A 400 API-kód hiányzó számot vagy profilhivatkozást jelez. A 404 kód a fiók számára nem elérhető profilt vagy számot, illetve a távközlési szolgáltató nyilvántartásából hiányzó számot jelzi. A 422 kód hiányzó személyazonossági vagy címhivatkozásokat, értékesítői követelményeket vagy a szolgáltatói érvényesítés elutasítását jelezheti. A hiányzó visszahívási beállítás 503, a létrehozás közben fellépő adatátviteli hiba pedig 502 kódot eredményezhet. Olvassa el az üzenetet és az esetleges requirement_diagnostics adatokat ahelyett, hogy minden hibát ugyanúgy kezelne.

A távközlési szolgáltatót használó feldolgozási ág már a követelmények ellenőrzésének, a visszahívási beállítások vizsgálatának vagy a feladat létrehozásának befejezése előtt frissítheti a függőben lévő regisztrációt jelző helyi jelzőket. Egy hiba ezért nem jelenti azt, hogy a helyi állapot változatlan, és egy függő állapotot jelző érték önmagában nem bizonyítja feladat létezését. Ezeket a jelzőket ne tekintse a jóváhagyás vagy a kérés kézbesítése megerősítésének.

A szolgáltató akkor is elfogadhat egy feladatot, ha egy későbbi helyi adatbázis-művelet meghiúsul, és ez a segédfüggvény nem ellenőrzi minden helyi írás eredményét a siker jelzése előtt. Ebben a kéréskezelőben nincs kliensoldali idempotenciaparaméter vagy az ismételt beküldést megakadályozó védelem. Időtúllépés, hiba vagy bizonytalan eredmény után ellenőrizze a szám regisztrációs előzményeit a portálon vagy forduljon az ügyfélszolgálathoz az újbóli beküldés előtt. A helyi bejegyzés hiánya önmagában nem bizonyítja, hogy a szolgáltató semmit sem kapott.

Az egyszeri dokumentumokra vonatkozó korlátozás

A kéréskezelő elfogadja a onetime_files mezőt, és minden nem üres karakterláncot továbbít a távközlési szolgáltató titkosított fájlokhoz tartozó kapcsolatába. Nem keresi ki a tulajdonos fiók feltöltési sorait, és nem alakítja át a külső, maszkolt feltöltési azonosítókat szolgáltatói fájlazonosítókká. Az offline audit a továbbítás működését igazolta, a szolgáltatónál történő sikeres csatolást nem.

Ne feltételezze, hogy a create_encrypt_files által visszaadott fájlazonosító ebbe a mezőbe másolásával végrehajtható egy egyszeri megállapodás munkafolyamata. Ha egy számhoz ilyen dokumentumok szükségesek, használja a portált, vagy egyeztesse a MultiTEL-lel az azonosítók támogatott munkafolyamatát. Ez továbbra is az API felülvizsgálatának megoldatlan része, nem pedig teljes folyamatában ellenőrzött példa.

A regisztrációs adatok védelme

Csak olyan adatokat és dokumentumokat küldjön be, amelyek felhasználására az adott számhoz jogosult. A profil- és ellenőrzési hivatkozások maradjanak a megfelelő fiókhoz rendelve, és kerülje a teljes regisztrációs kérésadatok naplózását. Ez a kérés nem töröl vagy cserél le minden korábbi igazolást vagy ellenőrzést. A szolgáltatói felülvizsgálat, az aktiválás és az adatmegőrzés külön folyamatok.