Links
Comment on page

Messages

Odeslání zprávy e-mailové kampaně

Odeslání nebo naplánování odeslání zprávy e-mailové kampaně všem kontaktům, kterým zpráva zatím nebyla odeslána.
POST /distributions/{distribution_id}/messages/{message_id}/send

Parametry:

Jméno parametru
Popis
Typ
distribution_id
Identifikátor distribučního kanálu / e-mailové kampaně, ve které je odesílaná zpráva
integer
message_id
Identifikátor odesílané zprávy
integer

Data:

Jméno pole
Popis
Typ
scheduled_date
Datum a čas odeslání zprávy. Pokud není hodnota specifikována, zpráva je odeslána okamžitě.
date string, optional
Příklad
curl --request POST \
--url https://api.click4survey.com/v1/distributions/{distribution_id}/messages/{message_id}/send \
--header 'Accept: application/json' \
--header 'X-API-TOKEN: {api-token}' \
--header 'User-Agent: app-name ([email protected])' \
--header 'Content-Type: application/json' \
--data '{"scheduled_date":"2022-10-10T10:00:00.000Z"}'
Příklad dat požadavku
{
"scheduled_date": "2022-10-10T10:00:00.000Z"
}
Úspěšně zpracovaný požadavek vrací stavový kód 200 OK a v poli result jsou data se souhrnem počtu kontaktů k odeslání e-mailové zprávy. V případě vrácení jiného kódu došlo při plánování odesílání zprávy k chybě. Zde je přehled chybových stavů.

Struktura vrácených dat:

Jméno pole
Popis
Typ
contacts_count
Přehled počtu kontaktů pro odesílanou zprávu
object
↳ pending
Počet kontaktů k odeslání
integer
↳ sent
Počet kontaktů, kterým již byla zpráva odeslána
integer
↳ bounces
Počet kontaktů, kterým se nepodařilo zprávu odeslat
integer
Příklad odpovědi
{
"result": {
"contacts_count": {
"pending": 1250,
"sent": 48545,
"bounces": 124
}
},
"meta": {
"request_id": "0c5e22e7-f3a2-4f68-8939-dcf7dce06c77",
"http_status": 200
}
}
Last modified 1yr ago