Trigger

Triggering scenario

Action allows to trigger scenario previously created in redlink panel.

POSThttps://api.messageflow.com/v2.1/scenario/trigger

Body

application/json

TriggerScenarioBody (one of)

objectobject

Response

200401404500

Request was successfully processed

Body

application/json

metaMetaObject (object)

Additional data

Request

var client = new RestClient("https://api.messageflow.com/v2.1/scenario/trigger");
var request = new RestRequest(Method.POST);
request.AddHeader("content-type", "application/json");
request.AddHeader("authorization", "REPLACE_KEY_VALUE");
request.AddHeader("application-key", "REPLACE_KEY_VALUE");
request.AddParameter("application/json", "{\"scenarioId\":\"XXXXXX-XXXXX-XXXXX-XXXXX\",\"recipientEmail\":\"[e-mail]\",\"recipientMobileNumber\":\"string\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Response

{
  "meta": {
    "numberOfData": 1,
    "status": 200,
    "uniqId": "00d928f759"
  }
}

C#

var client = new RestClient("https://api.messageflow.com/v2.1/scenario/trigger");
var request = new RestRequest(Method.POST);
request.AddHeader("content-type", "application/json");
request.AddHeader("authorization", "REPLACE_KEY_VALUE");
request.AddParameter("application/json", "{\"scenarioId\":\"XXXXXX-XXXXX-XXXXX-XXXXX\",\"recipientEmail\":\"[e-mail]\",\"recipientMobileNumber\":\"string\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Go

package main

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

func main() {

	url := "https://api.messageflow.com/v2.1/scenario/trigger"

	payload := strings.NewReader("{\"scenarioId\":\"XXXXXX-XXXXX-XXXXX-XXXXX\",\"recipientEmail\":\"[e-mail]\",\"recipientMobileNumber\":\"string\"}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("content-type", "application/json")
	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.post("https://api.messageflow.com/v2.1/scenario/trigger")
  .header("content-type", "application/json")
  .header("authorization", "REPLACE_KEY_VALUE")
  .body("{\"scenarioId\":\"XXXXXX-XXXXX-XXXXX-XXXXX\",\"recipientEmail\":\"[e-mail]\",\"recipientMobileNumber\":\"string\"}")
  .asString();

Node

var request = require("request");

var options = {
  method: 'POST',
  url: 'https://api.messageflow.com/v2.1/scenario/trigger',
  headers: {'content-type': 'application/json', authorization: 'REPLACE_KEY_VALUE'},
  body: {
    scenarioId: 'XXXXXX-XXXXX-XXXXX-XXXXX',
    recipientEmail: '[e-mail]',
    recipientMobileNumber: 'string'
  },
  json: true
};

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/scenario/trigger",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\"scenarioId\":\"XXXXXX-XXXXX-XXXXX-XXXXX\",\"recipientEmail\":\"[e-mail]\",\"recipientMobileNumber\":\"string\"}",
  CURLOPT_HTTPHEADER => array(
    "authorization: REPLACE_KEY_VALUE",
    "content-type: application/json"
  ),
));

$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/scenario/trigger"

payload = "{\"scenarioId\":\"XXXXXX-XXXXX-XXXXX-XXXXX\",\"recipientEmail\":\"[e-mail]\",\"recipientMobileNumber\":\"string\"}"
headers = {
    'content-type': "application/json",
    'authorization': "REPLACE_KEY_VALUE"
    }

response = requests.request("POST", url, data=payload, headers=headers)

print(response.text)

Ruby

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

url = URI("https://api.messageflow.com/v2.1/scenario/trigger")

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

request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request["authorization"] = 'REPLACE_KEY_VALUE'
request.body = "{\"scenarioId\":\"XXXXXX-XXXXX-XXXXX-XXXXX\",\"recipientEmail\":\"[e-mail]\",\"recipientMobileNumber\":\"string\"}"

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

Shell

echo '{"scenarioId":"XXXXXX-XXXXX-XXXXX-XXXXX","recipientEmail":"[e-mail]","recipientMobileNumber":"string"}' |  \
  http POST https://api.messageflow.com/v2.1/scenario/trigger \
  authorization:REPLACE_KEY_VALUE \
  content-type:application/jsontest.pl","recipientMobileNumber":"string"}'