Válassza ki az országot és a számtípust
Válassza ki a regisztráció országát, majd használja az alábbi hívás által visszaadott nevek egyikét: get_document_number_types. Ezt a nevet a következő paraméter értékeként küldje el: number_type, ne típusazonosítót vagy általános számkeresési kategóriát adjon meg.
Olvassa el a visszaadott utasításokat
Őrizze meg a követelmény- és kapcsolatazonosítókat a megfelelő személyazonosság- vagy dokumentumkezelési munkafolyamathoz. Ez a hívás követelményeket ad vissza; nem ellenőrzi és nem nyújtja be a fájljait. Kövesse a visszaadott utasításokat és a kiválasztott számra vonatkozó további követelményeket.
Ne értelmezze a hibát mentességként
Az érvénytelen országra vagy az ország regisztrációs dokumentumainak szükségtelenségére utaló hiba két feltételt von össze. Ez nem bizonyítja, hogy nincs szükség regisztrációra. A sikertelen lekérdezés vagy az üres eredmény sem jelenti az ügyfél vagy a szám jóváhagyását. Ha az eredmény nem egyértelmű, forduljon az ügyfélszolgálathoz.
Kérés
Használja az engedélyezett API-fiókjának hitelesítő adatait HTTPS-kapcsolaton keresztül. A Basic hitelesítés és az engedélyezett API-fiókok bearer tokenjei támogatottak; a fiókra vonatkozó korlátozások érvényesek.
POST kérés application/json vagy application/x-www-form-urlencoded tartalomtípussal.
curl --fail-with-body --silent --show-error \
--user "$API_USER:$API_PASSWORD" \
--request POST \
--header "Content-Type: application/json" \
--data '{"country":"US","number_type":"Local"}' \
"https://api.multitel.net/v3/get_requirements"| Név | Típus | Kötelező | Leírás |
|---|---|---|---|
country | szöveges karakterlánc | Igen | A get_document_countries által visszaadott ISO-országkód. |
number_type | szöveges karakterlánc | Igen | A get_document_number_types által visszaadott típusnév, például Local; az egyeztetés nem különbözteti meg a kis- és nagybetűket. A nevet adja meg, ne az azonosítóját. |
Válasz
A HTTP-állapot mellett ellenőrizze a JSON-törzsben a status.code értékét is. A response egyetlen követelmény-erőforrás, amely tartalmazza az id, type és attributes mezőket, valamint a relationships mezőt, ha az is szerepel a válaszban. Az erőforrás és a kapcsolatok adataiban szereplő azonosítókból nem következtethet azok jelentésére. Az opcionális restriction_message szövegéből a HTML-címkék el vannak távolítva; a megmaradt tartalmat szövegként kezelje, ne megbízható HTML-ként. A kezelő az első követelmény-erőforrást adja vissza, ezért ne feltételezze, hogy a válasz teljes körű lista. Az attribútumok és kapcsolatok elérhetősége az országtól és a típustól függ; a példa nem teljes, rögzített séma.
Szemléltető válaszstruktúra; nem élő fiókadat és nem aktuális árajánlat.
{
"status": {
"code": 200,
"msg": ""
},
"response": {
"id": "REQUIREMENT_ID_FROM_RESPONSE",
"type": "RESOURCE_TYPE_FROM_RESPONSE",
"attributes": {
"restriction_message": "Example country-specific instructions."
}
}
}Hibák
- 400: Az ország és a number_type ellenőrzése sikertelen: adja meg mindkét kötelező értéket. Az ellenőrzés szövege formázást is tartalmazhat.
- 400: Invalid country ISO or No country registration documents required.: ez a kétértelmű üzenet önmagában nem bizonyítja a regisztráció alóli mentességet.
- 400: Invalid number type: a visszaadott típusnevek egyikét használja. A régi hibaüzenet a következőket sorolja fel: Global, Local, Mobile, National, Shared Cost és Toll Free.
- 500: Unable to load registration requirements for the specified country and number type.: a követelményeket nem sikerült visszaadni. Próbálja újra később, vagy forduljon az ügyfélszolgálathoz.
Elérhetőség és mellékhatások
- Ez a katalógus- és követelménylekérdezés nem hoz létre személyazonossági rekordot, nem tölt fel igazoló dokumentumot, nem regisztrál számot és nem ad le megrendelést.
- A sikeres katalógusválasz nem jelenti a dokumentumai jóváhagyását, és nem erősíti meg, hogy a kiválasztott szám aktiválható.