Dokumentace REST API
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.
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řipravte požadavek SMS
Použijte schválené odesílací číslo s povolenou SMS vlastněné účtem a příjemce, který souhlasil s přijetím zprávy. Dokončete požadovanou registraci Brand/Campaign nebo ověření toll-free čísla. Níže uvedený příklad po vyplnění funkčními přihlašovacími údaji a čísly odešle skutečnou zprávu; nejedná se o sandbox.
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
--request POST \
--header "Content-Type: application/json" \
--data '{"from":"YOUR_APPROVED_NUMBER","to":"YOUR_CONSENTED_RECIPIENT","text":"Your requested update is ready."}' \
"https://api.multitel.net/v3/sendsms"Nahraďte zástupné symboly odesílatele a příjemce telefonními čísly v mezinárodním formátu, pouze číslicemi včetně kódu země. U MMS zadejte podporovanou veřejně dostupnou mediální URL v media a nejprve ověřte způsobilost MMS a ceny.
Přijetí není doručení
Zkontrolujte vnější aplikační stav i vrácený výsledek zprávy. Zaznamenejte identifikátor zprávy poskytnutý službou a sledujte stav doručení a události webhooku. Úspěšné odeslání nemůže prokázat, že telefon příjemce zprávu obdržel.
Účtování SMS probíhá za segment. Kódování a délka zprávy mohou vytvořit několik segmentů; poplatky za média a poplatky související s operátorem se mohou od SMS lišit. Před odesláním si přečtěte aktuální prodejní cenu účtu. Nikdy slepě neopakujte odeslání s vypršeným časovým limitem: nejprve zkontrolujte jeho zaznamenaný výsledek.
Ř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.