New api feautres + bugs

This commit is contained in:
4026 2019-04-08 08:32:42 +00:00
parent dea884ea74
commit 24bb702698
1 changed files with 50 additions and 5 deletions

View File

@ -90,7 +90,7 @@ Sikeres kérés: -tömb-
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>`
`POST: http://example.org/a/newsletter?key=<kulcs>`
`DATA: new&subject=<Levél tárgya>&message=<Levél HTML tartalma>&message_text=<Levél TEXT tartalma>`
#### Várható válaszok
@ -103,7 +103,7 @@ Túl rövid üzenet: `message_too_short`
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>`
`POST: http://example.org/a/newsletter?key=<kulcs>`
`DATA: send&id=<Levél ID>&start=<Unix timestamp vagy 0 azonnal>`
#### Várható válaszok
@ -114,18 +114,63 @@ Sikeres kérés: `success`, Már várólistán: `already_queued`, Sikertelen ké
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>`
`POST: http://example.org/a/newsletter?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`
Sikeres kérés: -tömb-
### Kampány létrehozása
Kampányok létrehozására alkalmas.
A leveleket kezelő gyár: campaign
A kérés a következőképpen alakul:
`POST: http://example.org/a/campaign?key=<kulcs>`
`DATA: new&name=<Kampány neve>`
#### Várható válaszok
Sikeres kérés: `success`, `id`, Sikertelen kérés: `failed`
### Kampány törlése
Kampányok törlésére alkalmas.
A leveleket kezelő gyár: campaign
A kérés a következőképpen alakul:
`POST: http://example.org/a/campaign?key=<kulcs>`
`DATA: remove&id=<Kampány ID>`
#### Várható válaszok
Sikeres kérés: `success`, Sikertelen kérés: `failed`
### Kampány frissítése (csatolás)
Kampányok listához történő csatolására alkalmas.
A leveleket kezelő gyár: campaign
A kérés a következőképpen alakul:
`POST: http://example.org/a/campaign?key=<kulcs>`
`DATA: update&id=<Kampány ID>&lists=<Array of ListIDs>`
#### Várható válaszok
Sikeres kérés: `success`, Sikertelen kérés: `failed`
### Kampány csatolása levélhez
Kampányok levélhez történő csatolására alkalmas.
A leveleket kezelő gyár: campaign
A kérés a következőképpen alakul:
`POST: http://example.org/a/campaign?key=<kulcs>`
`DATA: relations&campaign=<Kampány ID>&newsletter=<Levél ID>`
#### Várható válaszok
Sikeres kérés: `success`, 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
üres, a HTML formátumú levél tartalmával minusz HTML tag-ek lesz azonos. Az üzenet
csak a HTML body részét tartalmazza!
csak a HTML body részét tartalmazza! Nagy mennyiségű üzenet küldésére használja a
newsletter, list és campaigns gyárakat!
A küldést és ellenőrzést végző gyár: send
A kérés a következőképpen alakul:
`POST: http://example.org/a/send?key=<kulcs>`