Skicka enkäter

Endpoints

Bläddra en specifik enkäts utskick: GET surveys/{surveyId}/sendings
Läsa en specifik enkäts utskick: GET surveys/{surveyId}/sendings
Skicka en specifik enkät: POST surveys/{surveyId}/sendings

Anropsdata-typ

{
  "participants": [
    "5f806d30591746f32872e96e"
  ],
  "newParticipants": [
    {
      "phoneNumber": "46712345678",
      "emailAddress": "test@example.com",
      "properties": {
        "firstName": "John"
      }
    }
  ],
  "channels": [
    "Sms",
    "Email"
  ],
  "defaultProperties": {
    "firstName": ""
  },
  "deliveryWindows": [
    {
      "opens": "2021-11-12T11:57:12.2013982Z",
      "closes": "2021-11-19T11:57:12.2013982Z"
    }
  ],
  "sms": {
    "sender": "iP1",
    "body": "Survey time {firstName}"
  },
  "email": {
    "sender": "iP1",
    "subject": "Survey time",
    "message": "Here's the survey"
  }
}

participants

En samling ID:n för deltagare i sändningen. För förfrågningar är detta en lista över tidigare deltagare att påminna om.

newParticipants

En samling data för att skapa nya deltagare. Max 1000. Dessa konverteras och flyttas till deltagare under bearbetningen.

phoneNumber

Telefonnumret som ska användas vid sändning på sms-kanalen.

emailAddress

E-postadressen som ska användas när du skickar på e-postkanalen.

properties

En dictionary över ytterligare egenskaper som kan användas när du mallar meddelanden. Kan även användas för att kategorisera deltagare och mallfrågor.

channels

Vilka kanaler ska sändningen skickas på. Giltiga värden är Sms och E-post. Fler kan läggas till i framtiden. Minst en krävs, och endast deltagare som har tillämpliga målegenskaper kommer att skickas på specifika kanaler (t.ex. telefonnummer för sms).

defaultProperties

Som deltagaregenskaper men standardvärden som används när en deltagare saknar den specifika egenskapen.

deliveryWindows

Om det finns ett behov av att schemalägga en sändning i framtiden finns det möjlighet att göra det med våra leveranstidsfönster.

Du kan ha hur många fönster som helst. Detta gör att du kan skicka meddelanden vid specifika tidpunkter under flera dagar, t.ex. varje dag mellan 10:00 och 10:05 på vardagar.

Parsing

• null i fältet öppnas kommer att ersättas med aktuellt datum och tid.
• Om closes är null kommer fältet att ställas in på 7 dagar (168 timmar) efter att fältet öppnas

Begäran kommer att avvisas om fönster överlappar varandra.

Om inga fönster ges kommer vi att skapa ett fönster som kommer att tillämpa analysregeln ovan.

sms

Kanalspecifika detaljer för sms-kanalen.

email

Kanalspecifik information för e-postkanalen.

sender

Avsändarens namn/ID att använda för antingen SMS eller e-post.

body

SMS meddelandetext. Deltagaregenskaper kan skapas som mallar med hjälp av parenteser ({}). En speciell mall {url} kan läggas till för att placera länken till undersökningen på en specifik plats i meddelandet. Om {url} inte ingår kommer den att läggas till efter två radbrytningar i slutet av meddelandet.

subject

E-postämnet som ska användas i alla e-postmeddelanden.

message

Ett meddelande till deltagarna som kommer att inkluderas i mejlen tillsammans med länken till undersökningen.

Responsdata-typ

{
  "id": "600ade98a11bf89ac18b5d76",
  "surveyId": "5f9028d2d60d0f12d4db4e67",
  "status": "Delivered",
  "participants": [
    "5f806d30591746f32872e96e",
    "5f903a70490f3c2d48fea8d3"
  ],
  "newParticipants": [],
  "channels": [
    "Sms",
    "Email"
  ],
  "defaultProperties": {},
  "deliveryWindows": [
    {
      "opens": "2021-11-12T11:57:12.2013982Z",
      "closes": "2021-11-19T11:57:12.2013982Z"
    }
  ],
  "sms": {
    "sender": "iP1",
    "body": "Survey time {firstName}\n\n{url}",
    "batchId": "600ade99e66b6b1fc8aada38",
    "pendingParticipants": [],
    "deliveredParticipants": [
      "5f806d30591746f32872e96e",
      "5f903a70490f3c2d48fea8d3"
    ],
    "failedParticipants": [],
    "status": "Delivered"
  },
  "email": {
    "sender": "iP1",
    "subject": "Survey time",
    "message": "Here's the survey",
    "emailIds": [
      "2c2d2930b0254b8fb8a834670e7f31ef",
      "ec0814ff12074597b6fb73d85f5261c6"
    ],
    "pendingParticipants": [],
    "deliveredParticipants": [
      "5f806d30591746f32872e96e",
      "5f903a70490f3c2d48fea8d3"
    ],
    "failedParticipants": [],
    "status": "Delivered"
  }
}

id

Sändande ID, används för att referera till det.

surveyId

Undersöknings-ID för den undersökning som sändningen tillhör.

status

Aktuell status för sändningen eller en specifik kanal. Tillgängliga statusar inkluderar följande.

batchId

SMS-batch-ID som hänvisar till skickade eller schemalagda meddelanden på SMS-kanalen.

emailIds

E-post-ID:n som hänvisar till skickade eller schemalagda e-postmeddelanden på e-postkanalen.

pendingParticipants

ID för kanaldeltagare vars meddelande väntar på leverans.

deliveredParticipants

ID för kanaldeltagare vars meddelandeleverans har bekräftats eller schemalagts externt.

failedParticipants

ID för kanaldeltagare vars meddelande inte kunde levereras.