Teostatakse POST päringuga, kõik parameetrid annakse üle query string sisse.
https://api.quantumtec.eu/v1/viber/bulk| Parameeter | Tähendus |
|---|---|
| Content-Type | application/json |
| Accept | application/json |
| X-ApiKey | API võti autoriseerimiseks |
Parameetrid saadetakse JSON formaadis.
| Parameeter | Formaat | Rakendamine | Kirjeldus |
|---|---|---|---|
| bulkId | string | Ei ole kohustuslik | Postituse ID. Kui mitte märkida siis määratakse automaatselt. |
| from | string | Kohustuslik | Saatja nimi (number) |
| text | string | Kohustuslik | Sõnumi tekst |
| recipients | array | Kohustuslik | Sõnumite saajate numbrite loend |
| recipients(to) | string | Kohustuslik | Saaja number |
| recipients(messageId) | string | Ei ole kohustuslik | Märgitakse kliendi poolt juhul kui tekib vajadus kasutada enda sõnumite ID. Kui mitte märkida siis määratakse automaatselt. |
| buttonText | string | Ei ole kohustuslik | Nuputekst üleminekuks |
| buttonUrl | string | Ei ole kohustuslik | Link, mille kaudu toimub üleminek nupule klõpsamisel |
| pictureUrl | string | Ei ole kohustuslik | Link sõnumis kuvatava pildi juurde |
| startTime | string | Ei ole kohustuslik | Postituse algusaeg. Märgitakse formaadis "2018-01-01T00:10:20.000Z", ajavöönd peab olema UTC. Kui mitte märkida siis postitus algab koheselt. |
Vastuseks päringule saadetakse andmekogum JSON formaadis.
| Parameeter | Kirjeldus |
|---|---|
| bulkId | Viber kampaania identifikaator |