Dokumentace REST API

REST API pro telefonní čísla

Zjistěte dostupné země a čísla, prohlédněte si kompletní nabídku a spravujte čísla, která vlastníte.

Otevřít referenční dokumentaci specifickou pro účet Vývojáři a automatizace

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.

Přečtěte si dostupný katalog zemí

curl --fail-with-body \
  --user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
  --header "Accept: application/json" \
  "https://api.multitel.net/v3/getcountries"

Odpověď v3 obsahuje status a pole response. Položky zemí zahrnují isocode, name, countrycode, informace o schopnostech a next_function. Dostupnost závisí na účtu a inventáři; země není příslibem, že každá předvolba nebo typ čísla je skladem.

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

Od vyhledání po aktivaci

Pomocí příslušných geografických operací vyberte zemi, případně požadovaný nižší územní celek, oblast a typ čísla.
Přečtěte si zřizovací, měsíční a provozní ceny vybraného čísla, kanály, zahrnutý objem a registrační požadavky.
Odešlete požadované dokumenty koncového uživatele a zkontrolujte jejich stav. Číslo může zůstat ve stavu čekání až do schválení.
Objednejte jednou s přesným výběrem z inventáře a ceny. Je-li odpověď nejistá, před odesláním další objednávky zkontrolujte svůj inventář.
Nakonfigurujte směrování hlasu a doručování zpráv nezávisle a poté otestujte úplnou zamýšlenou trasu.

Návod na nákup čísla Registrační požadavky jednotlivých zemí Kanály a zahrnuté minuty

Ř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.

Katalog koncových bodů specifický pro účet Konzole REST pro komunikační služby Veřejný dokument OpenAPI pro komunikační služby Průvodce integrací OAuth