Konstanty

Chybové konstanty

Obecné

OK = 0

Požadavek proběhl v pořádku, žádná chyba nenastala.

GENERIC_ERROR = 1

Obecná, nespecifikovaná chyba (konstanta by se v API neměla vyskytovat).

UNKNOWN_CURRENCY = 2

Neznámá měna.

UNKNOWN_LANGUAGE = 3

Neznámý jazyk.

UNKNOWN_SERVICE = 4

Neznámá služba. Služba neexistuje, nebo ji uživatel nemá povolenou, nebo požadavek není pro danou službu platný.

Konstanty pro účetní operace

BA_NOT_TARIFF = 10

Neplatný tarif.

BA_NOT_IN_ACCOUNT = 11

Neplatný účet pro natížení.

BA_NOT_PRODUCT = 12

Produkt neexistuje.

BA_CURRENCY_DIFF = 13

Účty nemají shodnou měnu.

BA_NOT_BPRODUCT = 14

Produkt v tarifu neexistuje.

BA_NOT_PEER = 15

Neplatný účet pro provedení operace.

BA_NOT_ACCOUNT = 16

Účet neexistuje.

BA_NOT_BATPRODUCT = 17

Produkt tarifu neexistuje.

BA_NOT_BATARIFF = 18

Účetní tarif neexistuje.

BA_NOT_PRICE = 19

Není definovaná cena.

BA_LOW_CREDIT = 20

Na účtu není dostatek prostředků pro provedení operace.

BA_NOT_FROM_ACCOUNT = 20

Neplatný účet pro odečtení prostředků.

Konstanty spojené s uživateli

USER_MISSING = 50

Neplatný uživatel. Uživatel nebyl zadán.

USER_NOT_ADDRESS_TYPE = 51

Neplatný typ uživatelské adresy.

USER_NOT_CONTACT_TYPE = 52

Neplatný typ uživatelského kontaktu.

USER_UNKNOWN_TYPE = 53

Neplatný typ uživatele.

USER_PASSWORD = 55

Chyba při ukládání/změně hesla.

USER_UNKNOWN_VALUE = 56

Chyba při vlastnosti uživatele (vlastnost neexistuje, nebo ji upravit).

USER_CANNOT_CREATE = 57

Přihlášený uživatel nemůže vytvářet nové uživatele. Přihlášený uživatel nesmí přiřazovat nového uživatele jiným.

USER_LOGIN = 58

Nový uživatel nemá zadané přihlašovací jméno, nebo je toto jméno již použito.

Konstanty spojené s API

API_SIGNATURE_ERROR = 100

Chybějící identifikátor volání API, nebo duplicitní identifikátor volání API, nebo se nepodařilo přihlásit uživatele.

API_INCORRECT_SERVICE = 101

Požadovaná akce (volání API) nepatří dané službě.

Konstanty spojené s WapPlatbami

WP_NOT_PARENT = 150

Chybná identifikace služby nebo obchodníka.

WP_NOT_MERCHANT = 151

Chybná identifikace obchodníka.

Konstanty spojené se SMS

SMSOUTSMS_UNKNOWN_TYPE = 200

Chybný typ SMS.

SMSOUTSMS_UNKNOWN_STATE = 201

Chybný stav SMS.

SMSOUTSMS_MISSING_MSISDN = 202

Chybí příjemce SMS.

SMSOUT_UNKNOWN_STATE = 203

Chybný stav části SMS.

SMSOUT_UNKNOWN_ENCODING = 204

Chybné kódování části SMS.

SMSOUTSMSE_UNKNOWN_SPLIT = 205

Chybný typ dělení SMS.

SMSOUTSMS_CANNOTSAVEANDSEND = 206

SMS již byla uložena a odeslána.

SMSOUTSMS_UNKNOWN_DSTATE = 207

Chybný stav doručení SMS.

SMSOUT_UNKNOWN_DSTATE = 208

Chybný stav doručení části SMS.

INVALID_SMS_SOURCE = 209

Chybný odesilatel.

Konstanty spojené se Viberem

VIBER_NOT_ALLOWED = 300

Viber není povolen.

VIBER_UNKNOWN_STATE = 301

Chybný stav zprávy.

VIBER_UNKNOWN_DSTATE = 302

Chybný stav doručení zprávy.

VIBER_UNKNOWN_STATEV = 303

Chybný stav Viberu.

VIBER_UNKNOWN_STATES = 304

Chybný stav SMS.

VIBER_UNKNOWN_DSTATEV = 305

Chybný stav doručení Viberu.

VIBER_UNKNOWN_DSTATES = 306

Chybný stav doručení SMS.

VIBER_MISSING_MSISDN = 307

Chybí příjemce zprávy.

VIBER_DATA_ERROR = 308

Špatně zadaná data k odeslání.

VIBER_UNKNOWN_TYPE = 309

Neznámy typ zprávy.

VIBER_PROMO_NOT_ALLOWED = 310

Na zadané číslo nelze zaslat promo zprávu.

VIBER_WELCOME_ALREADY_SENT = 311

Na zadané číslo již byla zaslaná uvítací zpráva.

Konstanty spojené se ProfiSend

PROFI_NOT_ALLOWED = 400

ProfiSend není povolen.

PROFI_UNKNOWN_STATE = 401

Chybný stav zprávy.

PROFI_UNKNOWN_DSTATE = 402

Chybný stav doručení zprávy.

PROFI_UNKNOWN_PROTOCOL = 403

Neznámý protokol.

PROFI_PROTOCOL_NOT_ALLOWED = 404

Protokol nepovolen.

Konstanty spojené se ProfiCode

CODE_NOT_EXISTS = 500

Kód neexistuje.

CODE_NAME_NOT_EXISTS = 501

Služba s tímto názvem neexistuje.

CODE_ALREADY_USED = 502

Kód již byl použit.

CODE_VALIDITY_EXPIRED = 503

Platnost kódu vypršela.

CODE_NOT_ALLOWED = 504

Nelze použít službu ProfiCode.

Konstanty spojené s MSISDN API (vyhledání telefonního čísla)

MSISDN_REQUEST_ERROR = 600

Chyba při dotazu (nebylo možné provést dotaz na operátora).

MSISDN_OK = 601

Číslo je přihlášené do sítě.

MSISDN_ABSENT_SUSCRIBER = 602

Číslo není přihlášené do sítě.

MSISDN_UNKNOWN_SUBSCRIBER = 603

Neznámé telefonní číslo.

MSISDN_ERROR = 604

Jiná chyba telefonního čísla.

Nezařazené chybové konstanty

PHONE_CANNOT_FIX = 100000

Řetězec nelze převést na mezinárodní telefonní číslo.

Typové konstanty

Měna

Currency::CZK = 'CZK'

Česká koruna.

Currency::EUR = 'EUR'

Euro.

Currency::KRD = 'KRD'

Kredit (virtuální měna).

Jazyk

Language::CS = 'cs'

Český jazyk.

Language::EN = 'en'

Anglický jazyk.

Language::SK = 'sk'

Slovenský jazyk.

Část SMS

Některé SMS, jako zprávy z hlediska systému (a API), nejde fyzicky zaslat jako jednu zprávu (např. pokud má text délku 250 znaků). V takovém případě je zpráva rozdělena na několik částí, které se zašlou zvlášť. Část SMS jako objekt existuje vždy, bez ohledu na to, zda lze zprávu zaslat najednou, nebo ne (potom k SMS existuje právě jedna část SMS).

Stavy odesílání části SMS

Smsout::STATE_NONE = 'none'

Část SMS je v nedefinovatelném stavu. Tento stav by se neměl objevit.

Smsout::STATE_WAITING = 'waiting'

Část SMS byla zařazena a čeká na odeslání.

Smsout::STATE_SENDING = 'sending'

Část SMS se právě odesílá.

Smsout::STATE_SENT = 'sent'

Část SMS byla odeslána.

Smsout::STATE_ERROR = 'error'

Část SMS nelze odeslat.

Stavy doručení části SMS

Smsout::DELIVERY_NOSTATE = 'nostate'

K části SMS nejsou informace o doručení.

Smsout::DELIVERY_DELIVERED = 'delivered'

Část SMS byla doručena.

Smsout::DELIVERY_EXPIRED = 'expired'

Část SMS nebyla doručena, vypršela platnost.

Smsout::DELIVERY_DELETED = 'deleted'

Část SMS nebyla doručena, byla smazána.

Smsout::DELIVERY_UNDELIVERABLE = 'undeliverable'

Část SMS nebyla doručena, nelze doručit.

Může odpovídat situaci, kdy bylo možné identifikovat zemi i operátora, ale neexistuje číslo příjemce. Zpráva byla předána operátorovi, který ji odmítl.

Smsout::DELIVERY_ACCEPTED = 'accepted'

Část SMS nebyla doručena, operátor SMS ale přijal.

Smsout::DELIVERY_UNKNOWN = 'unknown'

Část SMS nebyla doručena, neznámá chyba.

Smsout::DELIVERY_REJECTED = 'rejected'

Část SMS nebyla doručena, byla odmítnuta.

Smsout::DELIVERY_DESTERROR = 'destaddrerror'

Část SMS nebyla doručena, chybné číslo příjemce.

Smsout::DELIVERY_SRCERROR = 'sourceaddrerror'

Část SMS nebyla doručena, chybné číslo odesilatele.

Kódování části SMS

Smsout::ENCODING_7BITS = 7

7bitové kódování. SMS neobsahuje žádné znaky mimo ASCII7.

Smsout::ENCODING_8BITS = 8

8bitové kódování. SMS není textová (např. wappush).

Smsout::ENCODING_16BITS = 16

16bitové kódování. SMS obsahuje znaky mimo ASCII7 (například českou diakritiku).

SMS

Celá SMS, jako zpráva z hlediska systému (a API), i když může být před odesláním rozdělena na více menších zpráv.

Typy SMS

SmsoutSms::TYPE_TEXT = 'text'

Textová zpráva.

SmsoutSms::TYPE_WAPPUSH = 'wappush'

Wappush zpráva.

SmsoutSms::TYPE_PDU = 'pdu'

Zpráva zadána pomocí PDU (UDH + PDU).

Stavy SMS

SmsoutSms::STATE_INSERTED = 'inserted'

SMS je uložena. SMS v tomto tvaru je zpožděná SMS. K takové SMS ještě neexistují části SMS.

SmsoutSms::STATE_QUEUED = 'queued'

SMS čeká na odeslání. Pro danou SMS již byly vytvořené části a čekají na odeslání.

SmsoutSms::STATE_SENT = 'sent'

Všechny části této SMS již byly odeslány.

SmsoutSms::STATE_SENDING = 'sending'

Části této SMS jsou právě zařazovány do fronty.

SmsoutSms::STATE_NOCREDIT = 'nocredit'

Tento stav může nastat pouze v případě, kdy byla SMS zpožděná a ve chvíli odesílání nebylo na účtu dostatek prostředků. SMS nebude odeslána.

SmsoutSms::STATE_UNKNOWN = 'unknown'

SMS vkládá do systému.

Stavy doručení SMS

SmsoutSms::DELIVERY_NOSTATE = 'nostate'

K SMS nejsou informace o doručení.

SmsoutSms::DELIVERY_DELIVERED = 'delivered'

Všechni část SMS byly doručeny.

SmsoutSms::DELIVERY_EXPIRED = 'expired'

Alespoň jedna část SMS se nachází ve stavu Smsout::DELIVERY_EXPIRED.

SmsoutSms::DELIVERY_DELETED = 'deleted'

Alespoň jedna část SMS se nachází ve stavu Smsout::DELIVERY_DELETED.

SmsoutSms::DELIVERY_UNDELIVERABLE = 'undeliverable'

Alespoň jedna část SMS se nachází ve stavu Smsout::DELIVERY_UNDELIVERABLE.

SmsoutSms::DELIVERY_ACCEPTED = 'accepted'

Alespoň jedna část SMS se nachází ve stavu Smsout::DELIVERY_ACCEPTED.

SmsoutSms::DELIVERY_UNKNOWN = 'unknown'

Alespoň jedna část SMS se nachází ve stavu Smsout::DELIVERY_UNKNOWN.

SmsoutSms::DELIVERY_REJECTED = 'rejected'

Alespoň jedna část SMS se nachází ve stavu Smsout::DELIVERY_REJECTED.

SmsoutSms::DELIVERY_DESTERROR = 'destaddrerror'

Alespoň jedna část SMS se nachází ve stavu Smsout::DELIVERY_DESTERROR.

SmsoutSms::DELIVERY_SRCERROR = 'sourceaddrerror'

Alespoň jedna část SMS se nachází ve stavu Smsout::DELIVERY_SRCERROR.

Celá SMS má jiný stav než SmsoutSms::DELIVERY_NOSTATE v případě, že existují informace o doručení pro všechny části SMS.

V případě, že je SMS rozdělena na více části může dojít k tomu, že různé části mají různé stavy doručení. Výše uvedený seznam stavů je řazený podle přednosti, SmsoutSms::DELIVERY_NOSTATE má nejnižší přednost, SmsoutSms::DELIVERY_SRCERROR nejvyšší. Celá SMS má potom stav, který odpovídá stavu s nejvyšší předností, který má alespoň jedna její část.

Další nastavení SMS

Způsob rozdělení SMS

Definice způsobu, jakým bude rozdělena textová SMS, pokud ji nelze zaslat jako najednou a musí být rozdělena na části.

SmsoutSmsExtra::SPLIT_PLATFORM = 'platform'

SMS bude rozdělena na mezerách (tak aby nedošlo k rozdělení slova mezi 2 části SMS) a každá část bude mít na začátku pořadové číslo části a počet všech částí (např. 2/5).

SmsoutSmsExtra::SPLIT_WORD = 'word'

SMS bude rozdělena na mezerách (tak aby nedošlo k rozdělení slova mezi 2 části SMS).

SmsoutSmsExtra::SPLIT_WORD = 'char'

SMS bude rozdělena tak, aby každá část obsahovala maximální možný počet znaků (může dojít k rozdělení slova mezi 2 části SMS).

SmsoutSmsExtra::SPLIT_CONCAT = 'concat'

SMS bude zaslána jako "dlouhá SMS". Jedná se o speciální způsob zaslání SMS, kde mobilní telefon je schopen jednotlivé části pospojovat a zobrazit jako jednu zprávu. Běžné telefony umí zpracovávat dlouhou SMS.

Viber

Stavy zprávy

Viber::STATE_QUEUED_VIBER = 'queued_viber'

Zpráva čeká na odeslání Viberem.

Viber::STATE_SENDING_VIBER = 'sending_viber'

Zpráva je odesílána Viberem.

Viber::STATE_SENT_VIBER = 'sent_viber'

Zpráva byla odeslána Viberem.

Viber::STATE_QUEUED_SMS = 'queued_sms'

Zpráva čeká na odeslání přes SMS.

Viber::STATE_SENDING_SMS = 'sending_sms'

Zpráva je odesílání přes SMS.

Viber::STATE_SENT_SMS = 'sent_sms'

Zpráva byla odeslána přes SMS.

Viber::STATE_ERROR = 'error'

Zpráva nebyla odeslána.

Stavy odesílání zprávy přes Viber

Viber::STATE_VIBER_NOSTATE = 'nostate'

Zpráva nebyla odeslána přes Viber.

Viber::STATE_VIBER_SENDING = 'sending'

Zpráva je odesílána Viberem.

Viber::STATE_VIBER_SENT = 'sent'

Zpráva byla odeslána Viberem.

Viber::STATE_VIBER_ERROR = 'error'

Odeslání přes Viber selhalo.

Stavy odesílání zprávy přes SMS

Viber::STATE_SMS_NOSTATE = 'nostate'

Zpráva nebyla odeslána přes SMS.

Viber::STATE_SMS_SENDING = 'sending'

Zpráva je odesílána přes SMS.

Viber::STATE_SMS_SENT = 'sent'

Zpráva byla odeslána přes SMS.

Viber::STATE_SMS_ERROR = 'error'

Odeslání přes SMS selhalo.

Stavy doručení zprávy

Viber::DELIVERY_NOSTATE = 'nostate'

K zprávě nejsou informace o doručení.

Viber::DELIVERY_DELIVERED = 'delivered'

Zpráva byla doručena.

Viber::DELIVERY_EXPIRED = 'expired'

Zpráva vypršela.

Viber::DELIVERY_DELETED = 'deleted'

Zpráva byla odstraněna.

Viber::DELIVERY_UNDELIVERABLE = 'undeliverable'

Zprávu nelze doručit.

Viber::DELIVERY_ACCEPTED = 'accepted'

Zpráva byla přijata operátorem.

Viber::DELIVERY_UNKNOWN = 'unknown'

Zprávu nelze doručit z neznámých důvodů.

Viber::DELIVERY_REJECTED = 'rejected'

Zpráva byla odmítnuta.

Viber::DELIVERY_DESTERROR = 'destaddrerror'

Chybná adresa příjemce.

Viber::DELIVERY_SRCERROR = 'sourceaddrerror'

Chybná adresa odesilatele.

Viber::DELIVERY_SEEN = 'seen'

Zpráva byla zobrazena.

Stavy doručení zprávy přes Viber

Viber::DELIVERY_VIBER_NOSTATE = 'nostate'

K zprávě nejsou informace o doručení.

Viber::DELIVERY_VIBER_DELIVERED = 'delivered'

Zpráva byla doručena.

Viber::DELIVERY_VIBER_SEEN = 'seen'

Zpráva byla zobrazena.

Viber::DELIVERY_VIBER_EXPIRED = 'expired'

Zpráva vypršela.

Viber::DELIVERY_VIBER_REJECTED = 'rejected'

Zpráva byla odmítnuta.

Viber::DELIVERY_VIBER_DELETED = 'deleted'

Zpráva byla odstraněna.

Viber::DELIVERY_VIBER_UNDELIVERABLE = 'undeliverable'

Zprávu nelze doručit.

Viber::DELIVERY_VIBER_UNKNOWN = 'unknown'

Zprávu nelze doručit z neznámých důvodů.

Stavy doručení zprávy přes SMS

Viber::DELIVERY_SMS_NOSTATE = 'nostate'

K zprávě nejsou informace o doručení.

Viber::DELIVERY_SMS_DELIVERED = 'delivered'

Zpráva byla doručena.

Viber::DELIVERY_SMS_EXPIRED = 'expired'

Zpráva vypršela.

Viber::DELIVERY_SMS_DELETED = 'deleted'

Zpráva byla odstraněna.

Viber::DELIVERY_SMS_UNDELIVERABLE = 'undeliverable'

Zprávu nelze doručit.

Viber::DELIVERY_SMS_ACCEPTED = 'accepted'

Zpráva byla přijata operátorem.

Viber::DELIVERY_SMS_UNKNOWN = 'unknown'

Zprávu nelze doručit z neznámých důvodů.

Viber::DELIVERY_SMS_REJECTED = 'rejected'

Zpráva byla odmítnuta.

Viber::DELIVERY_SMS_DESTERROR = 'destaddrerror'

Chybná adresa příjemce.

Viber::DELIVERY_SMS_SRCERROR = 'sourceaddrerror'

Chybná adresa odesilatele.

Typ doručované zprávy

Viber::TYPE_WELCOME = 'welcome'

Uvítací zpráva.

Viber::TYPE_PROMO = 'promo'

Promo/reklamní zpráva.

ProfiSend

Stavy zprávy

ProfiMessage::STATE_INSERTED = 'inserted'

Zpráva byla vložena do systému.

ProfiMessage::STATE_QUEUED = 'queued'

Zpráva je připravena k odeslání.

ProfiMessage::STATE_SENT = 'sent'

Zpráva byla odeslána.

ProfiMessage::STATE_SENDING = 'sending'

Zpráva čeká na odeslání.

ProfiMessage::STATE_ERROR = 'error'

Chyba při odeslání.

Stavy doručení zprávy přes ProfiSend

ProfiMessage::DELIVERY_NOSTATE = 'nostate'

K zprávě nejsou informace o doručení.

ProfiMessage::DELIVERY_DELIVERED = 'delivered'

Zpráva byla doručena.

ProfiMessage::DELIVERY_EXPIRED = 'expired'

Zpráva vypršela.

ProfiMessage::DELIVERY_DELETED = 'deleted'

Zpráva byla odstraněna.

ProfiMessage::DELIVERY_UNDELIVERABLE = 'undeliverable'

Zprávu nelze doručit.

ProfiMessage::DELIVERY_ACCEPTED = 'accepted'

Zpráva byla přijata operátorem.

ProfiMessage::DELIVERY_UNKNOWN = 'unknown'

Zprávu nelze doručit z neznámých důvodů.

ProfiMessage::DELIVERY_REJECTED = 'rejected'

Zpráva byla odmítnuta.

ProfiMessage::DELIVERY_DESTERROR = 'destaddrerror'

Chybná adresa příjemce.

ProfiMessage::DELIVERY_SRCERROR = 'sourceaddrerror'

Chybná adresa odesilatele.

ProfiMessage::DELIVERY_SEEN = 'seen'

Zpráva byla zobrazena.

Objekty ProfiSms, ProfiViber a ProfiFacebook mají stejné konstanty pro stavy zprávy.

ProfiSend protokoly

ProfiMessage::PROTOCOL_SMS = 'sms'

SMS protokol.

ProfiMessage::PROTOCOL_VIBER = 'viber'

SMS protokol.

ProfiMessage::PROTOCOL_FACEBOOK = 'facebook'

SMS protokol.

Uživatel

Typ uživatele

User::TYPE_USER = 'user'

Běžný uživatel.

User::TYPE_CUSTOMER = 'customer'

Zákazník. Uživatel provozující vlastní službu používající ProfiSMS, může spravovat ("vlastnit") další uživatele.

User::TYPE_ADMIN = 'admin'

Administrátor systému.

User::TYPE_SYSTEM = 'system'

Systémový (interní) uživatel.

Typ uživatelské adresy

UserAddress::TYPE_INVOICE = 'invoice'

Fakturační adresa.

UserAddress::TYPE_POSTAL = 'postal'

Poštovní adresa.

Typ uživatelského kontaktu

UserContact::TYPE_EMAIL = 'email'

Emailová adresa.

UserContact::TYPE_CELL = 'cell'

Mobilní telefon.

Důvod přiřazení příchozí SMS

Gsm::RESEND_PHONE = 'phone'

SMS byla předána na základě registrovaného telefonního čísla, telefonní číslo, ze kterého byla SMS odeslána.

Gsm::RESEND_LOGIN = 'login'

SMS byla předána na základě přihlašovacího jména uživatele - první slovo v SMS je uživatelské jméno.

Gsm::RESEND_SESSION = 'session'

SMS byla předána na základě session. Při odeslání SMS je možné požádat o přiřazování příchozí odpovědí, pokud bude příchozí SMS zaslána z telefonního čísla, na které byla uživatelem platformy zaslána SMS a u dané SMS byla vyžádána session, příchozí SMS se přiřadí danému uživateli platformy. Délka session je jeden den.

Gsm::RESEND_KEYWORD = 'keyword'

SMS byla předána na základě klíčového slova - první slovo v SMS. Slovo je možné si registrovat.