Postup objednávky
1
Najděte službu v katalogu
GET /credit/services vrací katalog služeb, které si můžete objednat.cURL
Odpověď
services.sender.<platform>.<calling_code>.<variant>. platform je kanál (například sms), calling_code je telefonní předvolba země (například 420) a variant je druh služby (například alnum).Z těchto tří částí sestavíte ploché service_id, které potřebujete pro objednávku: sender_<platform>_<calling_code>_<variant>. Textový odesílatel pro Česko má tedy service_id sender_sms_420_alnum.Každá varianta obsahuje tato pole:Pole
subject určuje, odkud se vezme předmět služby, tedy text odesílatele nebo telefonní číslo:2
Ověřte cenu nanečisto
Před skutečnou objednávkou pošlete na
POST /credit/order stejný požadavek s dryrun: true. API objednávku jen ověří, zkontroluje kredit i dostupnost služby a vrátí celkový poplatek. Nic se nezmění.cURL
Odpověď
Celkový poplatek se počítá jako
setup + monthly × počet měsíců. Počet měsíců vyplývá z minimálního intervalu služby: year znamená 12, quarter 3 a cokoli jiného 1.3
Objednejte službu
Pokud vám poplatek vyhovuje, pošlete stejný požadavek bez U služby se
dryrun. Celkový poplatek se odečte z kreditu.cURL
Odpověď
subject: order číslo ještě neexistuje. Objednávka se přesto přijme hned:Odpověď – číslo přidělí operátor později
4
Zkontrolujte své objednávky
GET /credit/orders vrací služby, které tento API klíč skutečně objednal. Katalog GET /credit/services naopak ukazuje, co si objednat můžete.cURL
Odpověď
Seznam objednávek použijete ke dvěma věcem:
- Dohledání přesného
subject— zrušení služby vyžaduje přesně stejnou hodnotu, se kterou byla objednaná. - Sledování čekající objednávky — jakmile
pendingpřejde nafalse, najdete vsubjectpřidělené číslo. Přidělení trvá několik dní, takže stačí seznam kontrolovat například jednou denně.
Zrušení služby
POST /credit/cancel označí službu ke zrušení na konci zaplaceného období. Předejte service_id a přesný subject z GET /credit/orders.
cURL
Odpověď
active_until a teprve potom skončí. V GET /credit/orders má do té doby cancel_at_period_end: true.
Volání je idempotentní, takže opakované zrušení už nic nezmění. API v takovém případě vrátí chybu Service already cancelled.
Chyby
Použití objednané služby
Jakmile je služba aktivní (status: active), můžete ji používat ve zprávách:
- Textového odesílatele nebo číslo nastavíte jako
senderve zprávě nebo jako výchozí odesílatele API klíče. Postup popisuje koncept Odesílatelé, aliasy a výchozí odesílatel. - Zprávy z vyhrazeného čísla odcházejí přes bránu
direct, zprávy přes SIM hosting přes bránucustom. Podrobnosti najdete v přehledu Kanály. - Číslo pro WhatsApp musí být zaregistrované ve WhatsApp Business účtu. Registraci přes WhatsApp Partner API popisuje tutoriál Registrace WhatsApp Business účtu.
Další kroky
Odesílatelé
Jak SmsManager vybírá odesílatele, jak fungují aliasy a výchozí odesílatel.
Kanály
Brány
high, direct a custom a pole odesílatele pro jednotlivé kanály.Kredit a účtování
Kdy se kredit odečítá a co se stane, když nestačí.
Dobíjení kreditu
Bankovní převod, platební karta, automatické dobíjení a měsíční fakturace.
Registrace WhatsApp Business účtu
Krok za krokem zaregistrujete WhatsApp Business účet přes Partner API.
REST API reference
Úplný popis endpointů
/credit/services, /credit/order, /credit/orders a /credit/cancel.