Skip to main content
POST
/
messages
/
interactive
/
flow
Send interactive Flow message
curl --request POST \
  --url https://messenger-public-api.cogfy.com/messages/interactive/flow \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "from": "<string>",
  "to": "<string>",
  "interactive": {
    "type": "flow",
    "header": {},
    "body": {
      "text": "<string>"
    },
    "footer": {
      "text": "<string>"
    },
    "action": {
      "name": "flow",
      "parameters": {
        "flow_cta": "<string>",
        "flow_name": "<string>",
        "flow_message_version": 3,
        "flow_action": "navigate",
        "flow_action_payload": "<string>"
      }
    }
  }
}
'
import requests

url = "https://messenger-public-api.cogfy.com/messages/interactive/flow"

payload = {
"from": "<string>",
"to": "<string>",
"interactive": {
"type": "flow",
"header": {},
"body": { "text": "<string>" },
"footer": { "text": "<string>" },
"action": {
"name": "flow",
"parameters": {
"flow_cta": "<string>",
"flow_name": "<string>",
"flow_message_version": 3,
"flow_action": "navigate",
"flow_action_payload": "<string>"
}
}
}
}
headers = {
"api-key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
from: '<string>',
to: '<string>',
interactive: {
type: 'flow',
header: {},
body: JSON.stringify({text: '<string>'}),
footer: {text: '<string>'},
action: {
name: 'flow',
parameters: {
flow_cta: '<string>',
flow_name: '<string>',
flow_message_version: 3,
flow_action: 'navigate',
flow_action_payload: '<string>'
}
}
}
})
};

fetch('https://messenger-public-api.cogfy.com/messages/interactive/flow', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://messenger-public-api.cogfy.com/messages/interactive/flow",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'from' => '<string>',
'to' => '<string>',
'interactive' => [
'type' => 'flow',
'header' => [

],
'body' => [
'text' => '<string>'
],
'footer' => [
'text' => '<string>'
],
'action' => [
'name' => 'flow',
'parameters' => [
'flow_cta' => '<string>',
'flow_name' => '<string>',
'flow_message_version' => 3,
'flow_action' => 'navigate',
'flow_action_payload' => '<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api-key: <api-key>"
],
]);

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

curl_close($curl);

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

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

func main() {

url := "https://messenger-public-api.cogfy.com/messages/interactive/flow"

payload := strings.NewReader("{\n \"from\": \"<string>\",\n \"to\": \"<string>\",\n \"interactive\": {\n \"type\": \"flow\",\n \"header\": {},\n \"body\": {\n \"text\": \"<string>\"\n },\n \"footer\": {\n \"text\": \"<string>\"\n },\n \"action\": {\n \"name\": \"flow\",\n \"parameters\": {\n \"flow_cta\": \"<string>\",\n \"flow_name\": \"<string>\",\n \"flow_message_version\": 3,\n \"flow_action\": \"navigate\",\n \"flow_action_payload\": \"<string>\"\n }\n }\n }\n}")

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

req.Header.Add("api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://messenger-public-api.cogfy.com/messages/interactive/flow")
.header("api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"from\": \"<string>\",\n \"to\": \"<string>\",\n \"interactive\": {\n \"type\": \"flow\",\n \"header\": {},\n \"body\": {\n \"text\": \"<string>\"\n },\n \"footer\": {\n \"text\": \"<string>\"\n },\n \"action\": {\n \"name\": \"flow\",\n \"parameters\": {\n \"flow_cta\": \"<string>\",\n \"flow_name\": \"<string>\",\n \"flow_message_version\": 3,\n \"flow_action\": \"navigate\",\n \"flow_action_payload\": \"<string>\"\n }\n }\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://messenger-public-api.cogfy.com/messages/interactive/flow")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"from\": \"<string>\",\n \"to\": \"<string>\",\n \"interactive\": {\n \"type\": \"flow\",\n \"header\": {},\n \"body\": {\n \"text\": \"<string>\"\n },\n \"footer\": {\n \"text\": \"<string>\"\n },\n \"action\": {\n \"name\": \"flow\",\n \"parameters\": {\n \"flow_cta\": \"<string>\",\n \"flow_name\": \"<string>\",\n \"flow_message_version\": 3,\n \"flow_action\": \"navigate\",\n \"flow_action_payload\": \"<string>\"\n }\n }\n }\n}"

response = http.request(request)
puts response.read_body
{
  "id": "<string>"
}

Authorizations

api-key
string
header
required

Body

application/json
from
string
to
string
interactive
object

Response

200 - application/json

Interactive Flow message sent successfully

id
string