REST API dokumentáció
Telefonszám REST API-k
Fedezze fel az elérhető országokat és számokat, tekintse meg a teljes ajánlatot, és kezelje a saját számait.
Az API-t és a hitelesítő adatot együtt válassza ki
A jóváhagyott Fejlesztők és automatizálás, Üzleti és Kommunikációs szolgáltatók profilú fiókok integrálhatják az engedélyezett szolgáltatásokat. Egy magánfejlesztőnek nem kell cégnek kiadnia magát. Az alkalmazásból küldött SMS/MMS-hez a megfelelő küldési jóváhagyás és regisztráció szükséges. A Magánszemélyek és családok szolgáltatáshoz nem tartozik ügyfelek számára elérhető üzenetküldő API.
| API-család | Alap-URL | Hitelesítés és eredmény |
|---|---|---|
| Kommunikációs v3 | https://api.multitel.net/v3 | Jóváhagyott Basic hitelesítő adatok; jogosult, kiosztott tokenek csak az azokat támogató műveleteknél. JSON status és response. |
| Segélyhívási regisztráció | https://api.multi.tel/emergency | Jóváhagyott Basic hitelesítő adatok vagy kifejezetten kiosztott bearer hozzáférés. JSON code, message és data. |
| Portál REST-integrációk | A fiókja fejlesztői referenciájában látható gazdagép és művelet | Használja az adott művelet dokumentált hitelesítő adatát, hatóköreit és sémáját. A böngészős munkamenetkérések külön felületet jelentenek. |
A példák használata előtt állítsa be az MULTITEL_API_USERNAME és az MULTITEL_API_PASSWORD értékét a szervere titokkezelő konfigurációjában. Soha ne helyezze ezeket nyilvános böngészős JavaScriptbe, URL-ekbe vagy a verziókezelőbe. A külön hitelesítő adatokat az API-integráció beállításaiban kezelheti.
Az elérhető országkatalógus olvasása
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
"https://api.multitel.net/v3/getcountries"A v3 válasz tartalmazza a status mezőt és egy response tömböt. Az országbejegyzések tartalmazzák az isocode, name, countrycode mezőket, a képességekre vonatkozó információkat és a next_function mezőt. Az elérhetőség fiók- és készletfüggő; egy ország szerepelése nem ígéret arra, hogy minden előhívó vagy számtípus raktáron van.
{
"status": {
"code": 200,
"msg": "Results: 1"
},
"response": [
{
"countrycode": "1",
"name": "United States",
"description": "United States",
"isocode": "US",
"is_mobile": 0,
"sms_coverage": 1,
"latitude": "37.0902",
"longitude": "-95.7129",
"next_function": "v3/getareas/US"
}
]
}A felderítéstől az aktiválásig
- A megfelelő földrajzi műveletekkel válassza ki az országot, szükség esetén annak közigazgatási egységét, a körzetet és a számtípust.
- Olvassa el a kiválasztott szám beállítási, havi és használati díjait, csatornáit, keretét és regisztrációs követelményeit.
- Nyújtsa be a szükséges végfelhasználói dokumentumokat, és ellenőrizze az állapotukat. Egy szám jóváhagyásig függőben maradhat.
- Egyszer rendeljen, a pontos készlet- és árválasztással. Ha a válasz bizonytalan, újabb rendelés beküldése előtt vizsgálja meg a készletét.
- A hangirányítást és az üzenetkézbesítést egymástól függetlenül konfigurálja, majd tesztelje a teljes tervezett útvonalat.
Hibák és újrapróbálkozások kezelése
- Hitelesítési vagy jogosultsági hiba
- Ellenőrizze az API-hitelesítő adat engedélyezett állapotát, az engedélyezett szolgáltatást és a forrás-IP-korlátozást. A portál munkamenet-sütije nem integrációs hitelesítő adat.
- Elégtelen egyenleg vagy hiányzó jóváhagyás
- A művelet megismétlése előtt rendezze a fiók egyenlegét, a küldési jóváhagyást vagy a dokumentumkövetelményt.
- Nincs eredmény
- Az üres készletet vagy a hiányzó hívónevet kezelje szokásos kimenetelként. Ne feltételezze, hogy egy szintaktikailag érvényes számhoz minden szolgáltatás elérhető.
- Hálózati időtúllépés vagy szolgáltatáshiba
- Olvasási műveleteknél korlátozza az újrapróbálkozások számát, és alkalmazzon várakozást a próbálkozások között (backoff). Vásárlás, küldés vagy regisztráció esetén először vizsgálja meg a művelet állapotát; egy már elfogadott kérés megismétlése megkettőzheti a díjköteles műveletet.
Az idempotencia támogatása API-családonként eltérő. Az Emergency API támogatja az újrapróbálási kulcsokat, de ettől a tetszőleges v3-kérések még nem lesznek idempotensek. Az ügyfélszolgálat számára őrizze meg az időbélyegeket, a visszaadott azonosítókat és a kitakart válaszokat.
Folytassa a fiókjához tartozó referenciával
A bejelentkezett állapotban elérhető referencia a műveleteket a jogosultságai és az engedélyezett szolgáltatások szerint szűri. Használja annak pontos hosztját, hitelesítő adat típusát, kérésmezőit és válaszsémáját. A konzolok éles műveleteket is végrehajthatnak, beleértve a vásárlásokat és az üzenetküldést.