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 PARAMETRU | HODNOTA | POVINNÉ | VÝCHOZÍ HODNOTA |
---|---|---|---|
application_id | Application ID | Ano | - |
application_token | Application token | Ano | - |
number | Telefonní číslo, na které bude kód odeslán | Ano | - |
country | Kód země daného telefonního čísla | ne | Hodnota je brána z profilu. |
language | Jazyk odeslané zprávy | ne | en |
code_type | Typ odeslaného kódu (string , int , or combined ) | ne | int |
code_length | Délka verifikačního kódu (4-100) | ne | 6 |
request_quota_number | Počet požadavků za minutu pro identifikaci request_quota_identification | ne | 1 |
request_quota_identification | Identifikace "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_resend | Limit počtu přeposlání | ne | null - neomezené |
trials_available_verification | Limit počtu oveření | ne | null - neomezené |
expiration | Expirace OTP požadavku v sekundách, po uplynutí této doby není možné ověřit požadavek. | ne | 604800 - 7 dní |
channel | Alternativní 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. | ne | SMS objekt a/nebo Viber objekt |
Tabulka parametrů SMS objektu
JMÉNO PARAMETRU | HODNOTA | POVINNÉ | VÝCHOZÍ HODNOTA |
---|---|---|---|
sender_id | ID odesílatele, viz sender ID type | ne | gSystem |
sender_id_value | Hodnota odesílatele - gOwn (např. "420 777 777 777"), gText (např. "BulkGate"), gProfile (např. "423"), gMobile or gPush (KEY) | ne | null |
Tabulka parametrů Viber objektu
JMÉNO PARAMETRU | HODNOTA | POVINNÉ | VÝCHOZÍ HODNOTA |
---|---|---|---|
sender | Váš zaregistrovaný odesilatel pro Viber | Ano | - |
expiration | Doba v sekundách po které bude zpráva odeslána dalším kanálem v pořadí v případě nedoručení. | ne | 120 |
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
}