İçeriğe geç
Geliştiriciler

Endpoint'ler

Campaigns

Broadcast campaigns created in the app: status, results and sending.

Yollar temel URL'ye göredir. Her kart, çağrının gerektirdiği izni ve her parametreyi türü ve sınırlarıyla listeler.

GET
/campaigns

List campaigns, newest first.

İzin: campaigns
Sayfalı

Sorgu parametreleri

  • statusisteğe bağlıenum

    Campaign status.

    İzin verilen değerler:draftscheduledsendingcompletedfailed

GET
/campaigns/:id

Retrieve a campaign with its delivery stats.

İzin: campaigns

Yol parametreleri

  • idzorunlustring

    Campaign ID.

POST
/campaigns/:id/send

Send a draft, scheduled or failed campaign now, or schedule it.

İzin: campaigns

Yol parametreleri

  • idzorunlustring

    Campaign ID.

JSON gövdesi

  • send_atisteğe bağlıstring (ISO 8601 date-time with offset) | null

    Schedule for this time. Omit or null to send now.

  • Sending now answers 202 and runs in the background; campaign.completed fires when it finishes. Scheduling answers 200.
  • 402 insufficient_credits when the workspace cannot pay for the send; 409 for a campaign that is already sending or completed.