New api features

This commit is contained in:
4026 2019-04-08 08:25:53 +00:00
parent e25c7ae010
commit dea884ea74
1 changed files with 69 additions and 0 deletions

View File

@ -52,6 +52,75 @@ Sikeres leiratkozás: `success`, Sikertelen leiratkozás: `unsub_error`,
Ismeretlen E-mail cím: `unknown_email`, Hiányzó paraméterek: `missing_parameters`
### Lista létrehozás
Levelezőlista létrehozására alkalmas.
A listát kezelő gyár: list
A kérés a következőképpen alakul:
`POST: http://example.org/a/list?key=<kulcs>`
`DATA: new&name=<Lista neve>`
#### Várható válaszok
Sikeres kérés: `success`, Sikertelen kérés: `failed`,
Nem megfelelő név: `bad_name`
### Lista törlése
Levelezőlista törlésére alkalmas.
A listát kezelő gyár: list
A kérés a következőképpen alakul:
`POST: http://example.org/a/list?key=<kulcs>`
`DATA: remove&id=<Lista ID>`
#### Várható válaszok
Sikeres kérés: `success`, Sikertelen kérés: `failed`
### Listák lekérdezése
Levelezőlisták lekérdezésére alkalmas.
A listát kezelő gyár: list
A kérés a következőképpen alakul:
`POST: http://example.org/a/list?key=<kulcs>`
`DATA: get`
#### Várható válaszok
Sikeres kérés: -tömb-
### Levél létrehozás
Levelek létrehozására alkalmas.
A leveleket kezelő gyár: newsletter
A kérés a következőképpen alakul:
`POST: http://example.org/a/list?key=<kulcs>`
`DATA: new&subject=<Levél tárgya>&message=<Levél HTML tartalma>&message_text=<Levél TEXT tartalma>`
#### Várható válaszok
Sikeres kérés: `success`, `id`, Sikertelen kérés: `failed`,
Nem megfelelő tárgy: `bad_subject`, Túl hosszú üzenet: `message_too_powerful`,
Túl rövid üzenet: `message_too_short`
### Levél küldése
Levelek küldésére alkalmas.
A leveleket kezelő gyár: newsletter
A kérés a következőképpen alakul:
`POST: http://example.org/a/list?key=<kulcs>`
`DATA: send&id=<Levél ID>&start=<Unix timestamp vagy 0 azonnal>`
#### Várható válaszok
Sikeres kérés: `success`, Már várólistán: `already_queued`, Sikertelen kérés: `failed`
### Levelek listázása
Levelek listázására alkalmas.
A leveleket kezelő gyár: newsletter
A kérés a következőképpen alakul:
`POST: http://example.org/a/list?key=<kulcs>`
`DATA: get`
#### Várható válaszok
Sikeres kérés: `success`, Már várólistán: `already_queued`, Sikertelen kérés: `failed`
### E-mail küldése
Egyéni e-mail küldését, valamint annak sikerességének vizsgálatát teszi lehetővé.
Az üzenet HTML és Plain text formában kerül kiküldésre. Ha a `message_text` értéke