Recipient

List email campaign recipients

Use this method to get all recipients from the email campaign. You can filter recipients who have got bounce states as well.

GEThttps://api.messageflow.com/v2.1/campaign/email/report/recipient

Query parameters

Response

200401404500

Request was successfully processed

Body

application/json

metaMetaObject (object)

Additional data

dataarray of EmailCampaignsRecipient (object)

Request

var client = new RestClient("https://api.messageflow.com/v2.1/campaign/email/report/recipient?campaignId=SOME_STRING_VALUE&bouncesOnly=SOME_BOOL_VALUE&dateTo=SOME_STRING_VALUE&dateFrom=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE");
var request = new RestRequest(Method.GET);
request.AddHeader("authorization", "REPLACE_KEY_VALUE");
request.AddHeader("application-key", "REPLACE_KEY_VALUE");
IRestResponse response = client.Execute(request);

Response

{
  "meta": {
    "numberOfData": 1,
    "status": 200,
    "uniqId": "00d928f759"
  },
  "data": [
    {
      "email": "text"
    }
  ]
}

C#

var client = new RestClient("https://api.messageflow.com/v2.1/campaign/email/report/recipient?campaignId=SOME_STRING_VALUE&bouncesOnly=SOME_BOOL_VALUE&dateTo=SOME_STRING_VALUE&dateFrom=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE");
var request = new RestRequest(Method.GET);
request.AddHeader("authorization", "REPLACE_KEY_VALUE");
IRestResponse response = client.Execute(request);

Go

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://api.messageflow.com/v2.1/campaign/email/report/recipient?campaignId=SOME_STRING_VALUE&bouncesOnly=SOME_BOOL_VALUE&dateTo=SOME_STRING_VALUE&dateFrom=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("authorization", "REPLACE_KEY_VALUE")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Java

HttpResponse<String> response = Unirest.get("https://api.messageflow.com/v2.1/campaign/email/report/recipient?campaignId=SOME_STRING_VALUE&bouncesOnly=SOME_BOOL_VALUE&dateTo=SOME_STRING_VALUE&dateFrom=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE")
  .header("authorization", "REPLACE_KEY_VALUE")
  .asString();

Node

var request = require("request");

var options = {
  method: 'GET',
  url: 'https://api.messageflow.com/v2.1/campaign/email/report/recipient',
  qs: {
    campaignId: 'SOME_STRING_VALUE',
    bouncesOnly: 'SOME_BOOL_VALUE',
    dateTo: 'SOME_STRING_VALUE',
    dateFrom: 'SOME_STRING_VALUE',
    limit: 'SOME_INTEGER_VALUE',
    offset: 'SOME_INTEGER_VALUE'
  },
  headers: {authorization: 'REPLACE_KEY_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

Php

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.messageflow.com/v2.1/campaign/email/report/recipient?campaignId=SOME_STRING_VALUE&bouncesOnly=SOME_BOOL_VALUE&dateTo=SOME_STRING_VALUE&dateFrom=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "authorization: REPLACE_KEY_VALUE"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Python

import requests

url = "https://api.messageflow.com/v2.1/campaign/email/report/recipient"

querystring = {"campaignId":"SOME_STRING_VALUE","bouncesOnly":"SOME_BOOL_VALUE","dateTo":"SOME_STRING_VALUE","dateFrom":"SOME_STRING_VALUE","limit":"SOME_INTEGER_VALUE","offset":"SOME_INTEGER_VALUE"}

headers = {'authorization': 'REPLACE_KEY_VALUE'}

response = requests.request("GET", url, headers=headers, params=querystring)

print(response.text)

Ruby

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.messageflow.com/v2.1/campaign/email/report/recipient?campaignId=SOME_STRING_VALUE&bouncesOnly=SOME_BOOL_VALUE&dateTo=SOME_STRING_VALUE&dateFrom=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["authorization"] = 'REPLACE_KEY_VALUE'

response = http.request(request)
puts response.read_body

Shell

http GET 'https://api.messageflow.com/v2.1/campaign/email/report/recipient?campaignId=SOME_STRING_VALUE&bouncesOnly=SOME_BOOL_VALUE&dateTo=SOME_STRING_VALUE&dateFrom=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE' \
  authorization:REPLACE_KEY_VALUEuthorization: REPLACE_KEY_VALUE'