BulkGate Helpdesk
  • Languages iconCzech
    • English

›Specifikace

Specifikace

  • Odeslání One Time Password (OTP)
  • Oveření One Time Password (OTP)
  • Přeposlání One Time Password (OTP)

Odeslání One Time Password (OTP)

API URL

Adresa URL používaná k odeslání požadavků HTTP:

https://portal.bulkgate.com/api/1.0/otp/send
POST /api/1.0/otp/send HTTP/1.1
Host: portal.bulkgate.com
Content-Type: application/json
Cache-Control: no-cache

Tabulka parametrů

JMÉNO PARAMETRUHODNOTAPOVINNÉVÝCHOZÍ HODNOTA
application_idApplication IDAno-
application_tokenApplication tokenAno-
numberTelefonní číslo, na které bude kód odeslánAno-
countryKód země daného telefonního číslaneHodnota je brána z profilu.
languageJazyk odeslané zprávyneen
code_typeTyp odeslaného kódu (string, int, or combined)neint
code_lengthDélka verifikačního kódu (4-100)ne6
request_quota_numberPočet požadavků za minutu pro identifikaci request_quota_identificationne1
request_quota_identificationIdentifikace "uživatele/žadatele OTP", na kterého se bude uplatňovat kvóta request_quota_number za minutu. Doporučujeme pro tuto identifikaci používat IP adresu.Ano-
trials_available_resendLimit počtu přeposlánínenull - neomezené
trials_available_verificationLimit počtu oveřenínenull - neomezené
expirationExpirace OTP požadavku v sekundách, po uplynutí této doby není možné ověřit požadavek.ne604800 - 7 dní
channelAlternativní kanály. Kanály jsou seřazeny v kaskádě, pokud tedy není možné doručit zprávu skrze prioritní kanál, budou použity kanály níže v kaskádě. Pokud ani jeden z alternativních kanálu nedokáže doručit zprávu bude použita SMS.neSMS objekt a/nebo Viber objekt

Tabulka parametrů SMS objektu

JMÉNO PARAMETRUHODNOTAPOVINNÉVÝCHOZÍ HODNOTA
sender_idID odesílatele, viz sender ID typenegSystem
sender_id_valueHodnota odesílatele - gOwn (např. "420 777 777 777"), gText (např. "BulkGate"), gProfile (např. "423"), gMobile or gPush (KEY)nenull

Tabulka parametrů Viber objektu

JMÉNO PARAMETRUHODNOTAPOVINNÉVÝCHOZÍ HODNOTA
senderVáš zaregistrovaný odesilatel pro ViberAno-
expirationDoba v sekundách po které bude zpráva odeslána dalším kanálem v pořadí v případě nedoručení.ne120

Příklad úplného požadavku

POST /api/1.0/otp/send HTTP/1.1
Host: portal.bulkgate.com
Content-Type: application/json
Cache-Control: no-cache

{
  "application_id": "APPLICATION_ID",
  "application_token": "APPLICATION_TOKEN",
  "number": "420777777777",
  "country": "cz",
  "language": "cs",
  "code_type": "string",
  "code_length": 7,
  "request_quota_number": 1,
  "request_quota_identification": "127.0.0.1",
  "trials_available_resend": 2,
  "trials_available_verification": 5,
  "expiration": 3600,
  "channel": {
    "viber": {
      "sender": "Lt. Hagan",
      "expiration": 100
    },
    "sms": {
      "sender_id": "gText",
      "sender_id_value": "Lt-Hagan",
      "unicode": true
    }
  }
}

Odpověď na tento příkaz může být:

V případě úspěchu:

{
    "data": {
        "id": "otp-id"
    }
}

V případě chyby:

{
    "type": "unknown_identity",
    "code": 400,
    "error": "Unknown identity",
    "detail": null
}
{
    "type": "invalid_input_parameters",
    "code": 400,
    "error": "Invalid input parameters",
    "detail": null
}
Další →
  • API URL
    • Tabulka parametrů
    • Tabulka parametrů SMS objektu
    • Tabulka parametrů Viber objektu
    • Příklad úplného požadavku
  • Odpověď na tento příkaz může být:
ŘešeníSMS BránaViber BusinessBroadcastHromadné SMSSMS notifikace2 way SMSSmart SMSMobile ConnectWeb Portál
Partneři a vývojářiSMS APIIntegraceAffiliate programWhite label
ZdrojeBlogYouTubeFacebookLinkedInTwitterGitHubPackagist
SpolečnostKontaktZásady ochrany osobních údajůObchodní podmínky
CeníkyCeník SMSCeník ViberCeník Mobile Connect
SMS BránaTOPefekt s.r.o. © 2023