Dokumentace REST API
Odešlete svůj první požadavek na API MultiTEL
Začněte požadavkem pouze pro čtení, porozumějte odpovědi a poté zvolte referenci pro službu, kterou chcete vytvořit.
Vyberte API a přihlašovací údaje společně
Schválené účty v kategoriích Vývojáři a automatizace, Firemní a Poskytovatelé komunikačních služeb mohou integrovat povolené služby. Jednotlivý vývojář nemusí předstírat, že je firmou. Aplikační SMS/MMS vyžaduje příslušné schválení odesílání a registraci. Služba Pro jednotlivce a rodiny nemá žádné zákaznicky přístupné API pro zahájení odesílání zpráv.
| Rodina API | Základní URL | Ověření a výsledek |
|---|---|---|
| Komunikace v3 | https://api.multitel.net/v3 | Schválené přihlašovací údaje Basic; způsobilé poskytnuté tokeny pouze pro operace, které je podporují. JSON status a response. |
| Registrace tísňového volání | https://api.multi.tel/emergency | Schválené přihlašovací údaje Basic nebo specificky poskytnutý přístup bearer. JSON code, message a data. |
| Portálové integrace REST | Hostitel a operace jsou uvedeny ve vývojářské referenční dokumentaci vašeho účtu | Použijte zdokumentované přihlašovací údaje, rozsahy a schéma dané operace. Požadavky relace prohlížeče představují samostatné rozhraní. |
Před použitím příkladů nastavte MULTITEL_API_USERNAME a MULTITEL_API_PASSWORD prostřednictvím konfigurace tajných údajů vašeho serveru. Nikdy je nevkládejte do veřejného kódu JavaScript v prohlížeči, do adres URL ani do správy zdrojového kódu. Vyhrazené přihlašovací údaje se spravují v nastavení integrace API.
První požadavek: přečtení zůstatku
Toto čtení nezakoupí službu ani nezahájí hovor či zprávu.
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
"https://api.multitel.net/v3/getbalance"Rozhraní Communications v3 API vrací aplikační výsledek uvnitř těla JSON. Zkontrolujte stav HTTP a status.code před čtením response; zamítnutý požadavek nemusí mít žádný objekt odpovědi. Hodnoty kódů mohou být řetězce nebo čísla.
{
"status": {
"code": 200,
"msg": ""
},
"response": {
"balance": "25.0000",
"currency": "USD",
"terms": "Prepaid"
}
}Toto je fiktivní příklad, nikoli zůstatek účtu. Peněžní hodnoty považujte za desetinné částky. Při diagnostice zamítnutého požadavku uchovejte zprávu odpovědi serveru s odstraněnými přihlašovacími údaji.
Používejte fakturační údaje správně
Odpověď se zůstatkem obsahuje aktuální zůstatek, měnu a platební podmínky. Neuvádí cenu budoucího hovoru ani úplnou fakturu. Pro tyto dotazy použijte příslušné operace pro sazby a využití. Stávající čísla mohou mít jiné tarify než dnešní katalog.
Vyberte si další integraci
REST API pro vyhledání směrování LRN
Vyhledejte směrovací číslo a dostupné informace o operátorovi pro severoamerické telefonní číslo za jednotnou cenu za vyhledání.
Přečtěte si integračního průvodce →REST API pro telefonní čísla
Zjistěte dostupné země a čísla, prohlédněte si kompletní nabídku a spravujte čísla, která vlastníte.
Přečtěte si integračního průvodce →REST API pro SMS a MMS
Odesílejte schválené aplikační zprávy a zpracovávejte přijetí, události doručení, segmentaci a poplatky.
Přečtěte si integračního průvodce →REST API pro tísňová volání
Zaregistrujte číslo a adresu služby, sledujte stav jeho aktivace a udržujte záznam aktuální při změně polohy.
Přečtěte si integračního průvodce →REST API pro účet a fakturaci
Zjistěte zůstatek a fakturační informace dostupné vaší schválené integraci.
Přečtěte si integračního průvodce →Vyhledávání CNAM a informací o směrování
Zjistěte jména volajících, seznamte se s úrovněmi vyhledávání a používejte informace o směrování čísel.
Reference CNAM REST →Hostovaná PBX
Začněte dostupnými tarify služby a tenantem, který chcete konfigurovat.
API tarifů služby hostované PBX →Řešení chyb a opakovaných pokusů
- Selhání ověření nebo nedostatečná oprávnění
- Zkontrolujte stav povolení přihlašovacích údajů API, povolenou službu a omezení zdrojové IP adresy. Soubor cookie portálové relace není integračním přihlašovacím údajem.
- Nedostatečný kredit nebo nesplněné schválení
- Před opakováním operace vyřešte zůstatek účtu, schválení odesílání nebo požadavek na dokumenty.
- Žádný výsledek
- Prázdný inventář nebo chybějící jméno volajícího považujte za běžný výsledek. Nepředpokládejte, že syntakticky platné číslo má všechny služby.
- Vypršení síťového časového limitu nebo selhání služby
- Pro čtení používejte omezený počet opakovaných pokusů s prodlužováním čekací doby. U nákupu, odeslání nebo registrace nejprve zkontrolujte stav operace; opakování přijatého požadavku může duplikovat zpoplatněnou akci.
Podpora idempotence náleží každé rodině API. Rozhraní Emergency API podporuje klíče pro opakování; to však nečiní libovolné požadavky v3 idempotentními. Pro podporu uchovávejte časová razítka, vrácená ID a odpovědi po odstranění citlivých údajů.
Pokračujte referencí svého účtu
Referenční dokumentace po přihlášení filtruje operace podle vašich oprávnění a povolených služeb. Použijte v ní uvedeného přesného hostitele, typ přihlašovacích údajů, pole požadavku a schéma odpovědi. Konzole mohou provádět ostré operace, včetně nákupů a odesílání zpráv.