Engage Your Customers On Chat

Introduction
POST Image
POST Text Message
POST URL Link
POST Video
POST Document

Flock Connect Contact API

APIs to create campaigns with individual WhatsApp users. Each API is used to create a campaing for different message types (Image, text, video, URL and documents).

Overview

Parameters 'token','message','title' and 'number_details' are mandatory parameters.

- token: Unique access token provided to the user at sign-up.
- message: Raw text intended to send.
- title: Title of the Flock Connect campaign.
- number_details: List of numbers with the user’s name to send the campaign to.

Optional parameters

- file: image/video/any file type to be sent.
- metadata content: image and title with URLs.

Response Status Code

- 200: Success
- 400: Failure. (Missing parameters/wrong file formats)

POST Image

https://aiyolabs.com/api/create-campaign/contact/image

An API to send images to users in a particular campaign.

BODY

{
	"token": "5bebaee99cf858690b41dc74",
	"message": "Sample text message.",
	"title": "Sample Campaign Title"
“number_details”:
[{"name":"Arjun","phone":"919534785974"},
 {"name":"Nishant","phone":"918892043629"}],
"image": "ImageFile.jpg"
}

POST Text Message

https://aiyolabs.com/api/create-campaign/contact/text

An API to send text message to users in a particular campaign.

BODY

{
	"token": "5bebaee99cf858690b41dc74",
	"message": "Sample text message.",
	"title": "Sample Campaign Title"
“number_details”:
[{"name":"Arjun","phone":"919534785974"},
 	{"name":"Nishant","phone":"918892043629"}]
}

POST URL Link

https://aiyolabs.com/api/create-campaign/contact/link

An API to send URL links to users in a particular campaign.

BODY

{
	"token": "5bebaee99cf858690b41dc74",
	"message": "Sample text message.",
	"title": "Sample Campaign Title"
“number_details”:
[{"name":"Arjun","phone":"919534785974"},
 	{"name":"Nishant","phone":"918892043629"}],
"image": "ImageFile.jpg"
            "link": "www.someurllink.com"
"link_title": "Sample Website"

}

POST Video

https://aiyolabs.com/api/create-campaign/contact/video

An API to send videos to users in a particular campaign

BODY

{
	"token": "5bebaee99cf858690b41dc74",
	"message": "Sample text message.",
	"title": "Sample Campaign Title"
“number_details”:
[{"name":"Arjun","phone":"919534785974"},
 	{"name":"Nishant","phone":"918892043629"}],
"video": "VideoFile.mp4"
}

POST Document

https://aiyolabs.com/api/create-campaign/contact/file

An API to send files to users in a particular campaign.

BODY

{
	"token": "5bebaee99cf858690b41dc74",
	"message": "Sample Text Message",
	"title": "Sample Campaign Title"
“number_details”:
[{"name":"Arjun","phone":"919534785974"},
 	{"name":"Nishant","phone":"918892043629"}],
"file": "File.pdf"
}

Language

Example Request

Default

curl --request POST \
  --url https://aiyolabs.com/api/create-campaign/contact/image \
  --data '{
	"token": "5bebaee99cf858690b41dc74",
	"message": "Sample text message.",
	"title": "Sample Campaign Title"
“number_details”:
[{"name":"Arjun","phone":"919534785974"},
 {"name":"Nishant","phone":"918892043629"}],
"image": "ImageFile.jpg"
}
'

Example Response

200

{
  "success": 1
}

Example Request

Default

curl --request POST \
  --url https://aiyolabs.com/api/create-campaign/contact/text \
  --data '{
	"token": "5bebaee99cf858690b41dc74",
	"message": "Sample text message.",
	"title": "Sample Campaign Title"
“number_details”:
[{"name":"Arjun","phone":"919534785974"},
 	{"name":"Nishant","phone":"918892043629"}]
}
'

Example Response

200

{
  "success": 1
}

Example Request

Default

curl --request POST \
  --url https://aiyolabs.com/api/create-campaign/contact/link \
  --data '{
	"token": "5bebaee99cf858690b41dc74",
	"message": "Sample text message.",
	"title": "Sample Campaign Title"
“number_details”:
[{"name":"Arjun","phone":"919534785974"},
 	{"name":"Nishant","phone":"918892043629"}],
"image": "ImageFile.jpg"
            "link": "www.someurllink.com"
"link_title": "Sample Website"

}
'

Example Response

200

{
  "success": 1
}

Example Request

Default

curl --request POST \
  --url https://aiyolabs.com/api/create-campaign/contact/video \
  --data '{
	"token": "5bebaee99cf858690b41dc74",
	"message": "Sample text message.",
	"title": "Sample Campaign Title"
“number_details”:
[{"name":"Arjun","phone":"919534785974"},
 	{"name":"Nishant","phone":"918892043629"}],
"video": "VideoFile.mp4"
}
'

Example Response

200

{
  "success": 1
}

Example Request

Default

curl --request POST \
  --url https://aiyolabs.com/api/create-campaign/contact/file \
  --data '{
	"token": "5bebaee99cf858690b41dc74",
	"message": "Sample Text Message",
	"title": "Sample Campaign Title"
“number_details”:
[{"name":"Arjun","phone":"919534785974"},
 	{"name":"Nishant","phone":"918892043629"}],
"file": "File.pdf"
}
'

Example Response

200

{
  "success": 1
}

Example Request

Default

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://aiyolabs.com/api/create-campaign/contact/image",
  "method": "POST",
  "headers": {},
  "data": "{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample text message.\",\n\t\"title\": \"Sample Campaign Title\"\n“number_details”:\n[{\"name\":\"Arjun\",\"phone\":\"919534785974\"},\n {\"name\":\"Nishant\",\"phone\":\"918892043629\"}],\n\"image\": \"ImageFile.jpg\"\n}\n"
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

Example Response

200

{
  "success": 1
}

Example Request

Default

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://aiyolabs.com/api/create-campaign/contact/text",
  "method": "POST",
  "headers": {},
  "data": "{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample text message.\",\n\t\"title\": \"Sample Campaign Title\"\n“number_details”:\n[{\"name\":\"Arjun\",\"phone\":\"919534785974\"},\n \t{\"name\":\"Nishant\",\"phone\":\"918892043629\"}]\n}\n"
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

Example Response

200

{
  "success": 1
}

Example Request

Default

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://aiyolabs.com/api/create-campaign/contact/link",
  "method": "POST",
  "headers": {},
  "data": "{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample text message.\",\n\t\"title\": \"Sample Campaign Title\"\n“number_details”:\n[{\"name\":\"Arjun\",\"phone\":\"919534785974\"},\n \t{\"name\":\"Nishant\",\"phone\":\"918892043629\"}],\n\"image\": \"ImageFile.jpg\"\n            \"link\": \"www.someurllink.com\"\n\"link_title\": \"Sample Website\"\n\n}\n"
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

Example Response

200

{
  "success": 1
}

Example Request

Default

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://aiyolabs.com/api/create-campaign/contact/video",
  "method": "POST",
  "headers": {},
  "data": "{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample text message.\",\n\t\"title\": \"Sample Campaign Title\"\n“number_details”:\n[{\"name\":\"Arjun\",\"phone\":\"919534785974\"},\n \t{\"name\":\"Nishant\",\"phone\":\"918892043629\"}],\n\"video\": \"VideoFile.mp4\"\n}\n"
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

Example Response

200

{
  "success": 1
}

Example Request

Default

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://aiyolabs.com/api/create-campaign/contact/file",
  "method": "POST",
  "headers": {},
  "data": "{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample Text Message\",\n\t\"title\": \"Sample Campaign Title\"\n“number_details”:\n[{\"name\":\"Arjun\",\"phone\":\"919534785974\"},\n \t{\"name\":\"Nishant\",\"phone\":\"918892043629\"}],\n\"file\": \"File.pdf\"\n}\n"
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

Example Response

200

{
  "success": 1
}

Example Request

Default

require 'uri'
require 'net/http'

url = URI("https://aiyolabs.com/api/create-campaign/contact/image")

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

request = Net::HTTP::Post.new(url)
request.body = "{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample text message.\",\n\t\"title\": \"Sample Campaign Title\"\n“number_details”:\n[{\"name\":\"Arjun\",\"phone\":\"919534785974\"},\n {\"name\":\"Nishant\",\"phone\":\"918892043629\"}],\n\"image\": \"ImageFile.jpg\"\n}\n"

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

Example Response

200

{
  "success": 1
}

Example Request

Default

 require 'uri'
require 'net/http'

url = URI("https://aiyolabs.com/api/create-campaign/contact/text")

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

request = Net::HTTP::Post.new(url)
request.body = "{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample text message.\",\n\t\"title\": \"Sample Campaign Title\"\n“number_details”:\n[{\"name\":\"Arjun\",\"phone\":\"919534785974\"},\n \t{\"name\":\"Nishant\",\"phone\":\"918892043629\"}]\n}\n"

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

Example Response

200

{
  "success": 1
}

Example Request

Default

require 'uri'
require 'net/http'

url = URI("https://aiyolabs.com/api/create-campaign/contact/link")

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

request = Net::HTTP::Post.new(url)
request.body = "{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample text message.\",\n\t\"title\": \"Sample Campaign Title\"\n“number_details”:\n[{\"name\":\"Arjun\",\"phone\":\"919534785974\"},\n \t{\"name\":\"Nishant\",\"phone\":\"918892043629\"}],\n\"image\": \"ImageFile.jpg\"\n            \"link\": \"www.someurllink.com\"\n\"link_title\": \"Sample Website\"\n\n}\n"

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

Example Response

200

{
  "success": 1
}

Example Request

Default

require 'uri'
require 'net/http'

url = URI("https://aiyolabs.com/api/create-campaign/contact/video")

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

request = Net::HTTP::Post.new(url)
request.body = "{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample text message.\",\n\t\"title\": \"Sample Campaign Title\"\n“number_details”:\n[{\"name\":\"Arjun\",\"phone\":\"919534785974\"},\n \t{\"name\":\"Nishant\",\"phone\":\"918892043629\"}],\n\"video\": \"VideoFile.mp4\"\n}\n"

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

Example Response

200

{
  "success": 1
}

Example Request

Default

require 'uri'
require 'net/http'

url = URI("https://aiyolabs.com/api/create-campaign/contact/file")

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

request = Net::HTTP::Post.new(url)
request.body = "{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample Text Message\",\n\t\"title\": \"Sample Campaign Title\"\n“number_details”:\n[{\"name\":\"Arjun\",\"phone\":\"919534785974\"},\n \t{\"name\":\"Nishant\",\"phone\":\"918892043629\"}],\n\"file\": \"File.pdf\"\n}\n"

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

Example Response

200

{
  "success": 1
}

Example Request

Default

import requests

url = "https://aiyolabs.com/api/create-campaign/contact/image"

payload = "{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample text message.\",\n\t\"title\": \"Sample Campaign Title\"\n“number_details”:\n[{\"name\":\"Arjun\",\"phone\":\"919534785974\"},\n {\"name\":\"Nishant\",\"phone\":\"918892043629\"}],\n\"image\": \"ImageFile.jpg\"\n}\n"
response = requests.request("POST", url, data=payload)

print(response.text)

Example Response

200

{
  "success": 1
}

Example Request

Default

import requests

url = "https://aiyolabs.com/api/create-campaign/contact/text"

payload = "{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample text message.\",\n\t\"title\": \"Sample Campaign Title\"\n“number_details”:\n[{\"name\":\"Arjun\",\"phone\":\"919534785974\"},\n \t{\"name\":\"Nishant\",\"phone\":\"918892043629\"}]\n}\n"
response = requests.request("POST", url, data=payload)

print(response.text)

Example Response

200

{
  "success": 1
}

Example Request

Default

import requests

url = "https://aiyolabs.com/api/create-campaign/contact/link"

payload = "{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample text message.\",\n\t\"title\": \"Sample Campaign Title\"\n“number_details”:\n[{\"name\":\"Arjun\",\"phone\":\"919534785974\"},\n \t{\"name\":\"Nishant\",\"phone\":\"918892043629\"}],\n\"image\": \"ImageFile.jpg\"\n            \"link\": \"www.someurllink.com\"\n\"link_title\": \"Sample Website\"\n\n}\n"
response = requests.request("POST", url, data=payload)

print(response.text)

Example Response

200

{
  "success": 1
}

Example Request

Default

import requests

url = "https://aiyolabs.com/api/create-campaign/contact/video"

payload = "{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample text message.\",\n\t\"title\": \"Sample Campaign Title\"\n“number_details”:\n[{\"name\":\"Arjun\",\"phone\":\"919534785974\"},\n \t{\"name\":\"Nishant\",\"phone\":\"918892043629\"}],\n\"video\": \"VideoFile.mp4\"\n}\n"
response = requests.request("POST", url, data=payload)

print(response.text)

Example Response

200

{
  "success": 1
}

Example Request

Default

import requests

url = "https://aiyolabs.com/api/create-campaign/contact/file"

payload = "{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample Text Message\",\n\t\"title\": \"Sample Campaign Title\"\n“number_details”:\n[{\"name\":\"Arjun\",\"phone\":\"919534785974\"},\n \t{\"name\":\"Nishant\",\"phone\":\"918892043629\"}],\n\"file\": \"File.pdf\"\n}\n"
response = requests.request("POST", url, data=payload)

print(response.text)

Example Response

200

{
  "success": 1
}

Example Request

Default

var http = require("https");

var options = {
  "method": "POST",
  "hostname": [
    "aiyolabs",
    "com"
  ],
  "path": [
    "api",
    "create-campaign",
    "contact",
    "image"
  ],
  "headers": {}
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write("{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample text message.\",\n\t\"title\": \"Sample Campaign Title\"\n“number_details”:\n[{\"name\":\"Arjun\",\"phone\":\"919534785974\"},\n {\"name\":\"Nishant\",\"phone\":\"918892043629\"}],\n\"image\": \"ImageFile.jpg\"\n}\n");
req.end();

Example Response

200

{
  "success": 1
}

Example Request

Default

var http = require("https");

var options = {
  "method": "POST",
  "hostname": [
    "aiyolabs",
    "com"
  ],
  "path": [
    "api",
    "create-campaign",
    "contact",
    "text"
  ],
  "headers": {}
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write("{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample text message.\",\n\t\"title\": \"Sample Campaign Title\"\n“number_details”:\n[{\"name\":\"Arjun\",\"phone\":\"919534785974\"},\n \t{\"name\":\"Nishant\",\"phone\":\"918892043629\"}]\n}\n");
req.end();

Example Response

200

{
  "success": 1
}

Example Request

Default

var http = require("https");

var options = {
  "method": "POST",
  "hostname": [
    "aiyolabs",
    "com"
  ],
  "path": [
    "api",
    "create-campaign",
    "contact",
    "link"
  ],
  "headers": {}
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write("{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample text message.\",\n\t\"title\": \"Sample Campaign Title\"\n“number_details”:\n[{\"name\":\"Arjun\",\"phone\":\"919534785974\"},\n \t{\"name\":\"Nishant\",\"phone\":\"918892043629\"}],\n\"image\": \"ImageFile.jpg\"\n            \"link\": \"www.someurllink.com\"\n\"link_title\": \"Sample Website\"\n\n}\n");
req.end();

Example Response

200

{
  "success": 1
}

Example Request

Default

var http = require("https");

var options = {
  "method": "POST",
  "hostname": [
    "aiyolabs",
    "com"
  ],
  "path": [
    "api",
    "create-campaign",
    "contact",
    "video"
  ],
  "headers": {}
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write("{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample text message.\",\n\t\"title\": \"Sample Campaign Title\"\n“number_details”:\n[{\"name\":\"Arjun\",\"phone\":\"919534785974\"},\n \t{\"name\":\"Nishant\",\"phone\":\"918892043629\"}],\n\"video\": \"VideoFile.mp4\"\n}\n");
req.end();

Example Response

200

{
  "success": 1
}

Example Request

Default

var http = require("https");

var options = {
  "method": "POST",
  "hostname": [
    "aiyolabs",
    "com"
  ],
  "path": [
    "api",
    "create-campaign",
    "contact",
    "file"
  ],
  "headers": {}
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write("{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample Text Message\",\n\t\"title\": \"Sample Campaign Title\"\n“number_details”:\n[{\"name\":\"Arjun\",\"phone\":\"919534785974\"},\n \t{\"name\":\"Nishant\",\"phone\":\"918892043629\"}],\n\"file\": \"File.pdf\"\n}\n");
req.end();

Example Response

200

{
  "success": 1
}

Example Request

Default

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://aiyolabs.com/api/create-campaign/contact/image",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample text message.\",\n\t\"title\": \"Sample Campaign Title\"\n“number_details”:\n[{\"name\":\"Arjun\",\"phone\":\"919534785974\"},\n {\"name\":\"Nishant\",\"phone\":\"918892043629\"}],\n\"image\": \"ImageFile.jpg\"\n}\n",
));

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

curl_close($curl);

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

Example Response

200

{
  "success": 1
}

Example Request

Default

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://aiyolabs.com/api/create-campaign/contact/text",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample text message.\",\n\t\"title\": \"Sample Campaign Title\"\n“number_details”:\n[{\"name\":\"Arjun\",\"phone\":\"919534785974\"},\n \t{\"name\":\"Nishant\",\"phone\":\"918892043629\"}]\n}\n",
));

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

curl_close($curl);

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

Example Response

200

{
  "success": 1
}

Example Request

Default

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://aiyolabs.com/api/create-campaign/contact/link",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample text message.\",\n\t\"title\": \"Sample Campaign Title\"\n“number_details”:\n[{\"name\":\"Arjun\",\"phone\":\"919534785974\"},\n \t{\"name\":\"Nishant\",\"phone\":\"918892043629\"}],\n\"image\": \"ImageFile.jpg\"\n            \"link\": \"www.someurllink.com\"\n\"link_title\": \"Sample Website\"\n\n}\n",
));

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

curl_close($curl);

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

Example Response

200

{
  "success": 1
}

Example Request

Default

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://aiyolabs.com/api/create-campaign/contact/video",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample text message.\",\n\t\"title\": \"Sample Campaign Title\"\n“number_details”:\n[{\"name\":\"Arjun\",\"phone\":\"919534785974\"},\n \t{\"name\":\"Nishant\",\"phone\":\"918892043629\"}],\n\"video\": \"VideoFile.mp4\"\n}\n",
));

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

curl_close($curl);

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

Example Response

200

{
  "success": 1
}

Example Request

Default

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://aiyolabs.com/api/create-campaign/contact/file",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample Text Message\",\n\t\"title\": \"Sample Campaign Title\"\n“number_details”:\n[{\"name\":\"Arjun\",\"phone\":\"919534785974\"},\n \t{\"name\":\"Nishant\",\"phone\":\"918892043629\"}],\n\"file\": \"File.pdf\"\n}\n",
));

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

curl_close($curl);

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

Example Response

200

{
  "success": 1
}

Example Request

Default

package main

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

func main() {

	url := "https://aiyolabs.com/api/create-campaign/contact/image"

	payload := strings.NewReader("{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample text message.\",\n\t\"title\": \"Sample Campaign Title\"\n“number_details”:\n[{\"name\":\"Arjun\",\"phone\":\"919534785974\"},\n {\"name\":\"Nishant\",\"phone\":\"918892043629\"}],\n\"image\": \"ImageFile.jpg\"\n}\n")

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

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

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

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

}

Example Response

200

{
  "success": 1
}

Example Request

Default

package main

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

func main() {

	url := "https://aiyolabs.com/api/create-campaign/contact/text"

	payload := strings.NewReader("{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample text message.\",\n\t\"title\": \"Sample Campaign Title\"\n“number_details”:\n[{\"name\":\"Arjun\",\"phone\":\"919534785974\"},\n \t{\"name\":\"Nishant\",\"phone\":\"918892043629\"}]\n}\n")

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

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

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

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

}

Example Response

200

{
  "success": 1
}

Example Request

Default

package main

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

func main() {

	url := "https://aiyolabs.com/api/create-campaign/contact/link"

	payload := strings.NewReader("{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample text message.\",\n\t\"title\": \"Sample Campaign Title\"\n“number_details”:\n[{\"name\":\"Arjun\",\"phone\":\"919534785974\"},\n \t{\"name\":\"Nishant\",\"phone\":\"918892043629\"}],\n\"image\": \"ImageFile.jpg\"\n            \"link\": \"www.someurllink.com\"\n\"link_title\": \"Sample Website\"\n\n}\n")

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

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

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

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

}

Example Response

200

{
  "success": 1
}

Example Request

Default

package main

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

func main() {

	url := "https://aiyolabs.com/api/create-campaign/contact/video"

	payload := strings.NewReader("{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample text message.\",\n\t\"title\": \"Sample Campaign Title\"\n“number_details”:\n[{\"name\":\"Arjun\",\"phone\":\"919534785974\"},\n \t{\"name\":\"Nishant\",\"phone\":\"918892043629\"}],\n\"video\": \"VideoFile.mp4\"\n}\n")

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

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

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

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

}

Example Response

200

{
  "success": 1
}

Example Request

Default

package main

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

func main() {

	url := "https://aiyolabs.com/api/create-campaign/contact/file"

	payload := strings.NewReader("{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample Text Message\",\n\t\"title\": \"Sample Campaign Title\"\n“number_details”:\n[{\"name\":\"Arjun\",\"phone\":\"919534785974\"},\n \t{\"name\":\"Nishant\",\"phone\":\"918892043629\"}],\n\"file\": \"File.pdf\"\n}\n")

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

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

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

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

}

Example Response

200

{
  "success": 1
}

Flock Connect Group API

Set of APIs to add campaign with different message inputs - text, file, video, image and URL links.

Every API authenticates and validates user by their access token.

Response Status Codes

- 200: Success
- 400: Failure (Missing parameters or incorrect file format)

POST Image

https://aiyolabs.com/api/create-campaign/group/image

An API to send images to WhatsApp group chats.

BODY

{
	"token": "5bebaee99cf858690b41dc74",
	"message": "Sample text message.",
	"title": "Sample Campaign Title"
            "group_id": "917097197955-1539171951"
"image": "ImageFile.jpg"
}

POST Text Message

https://aiyolabs.com/api/create-campaign/group/text

An API to send text to WhatsApp group chats.

BODY

{
	"token": "5bebaee99cf858690b41dc74",
	"message": "Sample text message.",
	"title": "Sample Campaign Title"
            "group_id": "917097197955-1539171951"
}

POST URL Link

https://aiyolabs.com/api/create-campaign/group/link

An API to send a URL link to WhatsApp group chats.

BODY

{
	"token": "5bebaee99cf858690b41dc74",
	"message": "Sample text message.",
	"title": "Sample Campaign Title"
            "group_id": "917097197955-1539171951"
"image": "ImageFile.jpg"
            "link": "www.someurllink.com"
"link_title": "Sample Website"

}

POST Video

https://aiyolabs.com/api/create-campaign/group/video

An API to send videos to WhatsApp group chats.

BODY

{
	"token": "5bebaee99cf858690b41dc74",
	"message": "Sample text message.",
	"title": "Sample Campaign Title"
            "group_id": "917097197955-1539171951"
"video": "VideoFile.mp4"
}

POST Document

https://aiyolabs.com/api/create-campaign/group/file

An API to send a file to WhatsApp group chats.

BODY

{
	"token": "5bebaee99cf858690b41dc74",
	"message": "Sample Text Message",
	"title": "Sample Campaign Title"
            "group_id": "917097197955-1539171951"
"file": "File.pdf"
}

Language

Example Request

Default

curl --request POST \
  --url https://aiyolabs.com/api/create-campaign/group/image \
  --data '{
	"token": "5bebaee99cf858690b41dc74",
	"message": "Sample text message.",
	"title": "Sample Campaign Title"
            "group_id": "917097197955-1539171951"
"image": "ImageFile.jpg"
}'

Example Response

200

{
  "success": 1
}

Example Request

Default

curl --request POST \
  --url https://aiyolabs.com/api/create-campaign/group/text \
  --data '{
	"token": "5bebaee99cf858690b41dc74",
	"message": "Sample text message.",
	"title": "Sample Campaign Title"
            "group_id": "917097197955-1539171951"
}
'

Example Response

200

{
  "success": 1
}

Example Request

Default

curl --request POST \
  --url https://aiyolabs.com/api/create-campaign/group/link \
  --data '{
	"token": "5bebaee99cf858690b41dc74",
	"message": "Sample text message.",
	"title": "Sample Campaign Title"
            "group_id": "917097197955-1539171951"
"image": "ImageFile.jpg"
            "link": "www.someurllink.com"
"link_title": "Sample Website"

}
'

Example Response

200

{
  "success": 1
}

Example Request

Default

curl --request POST \
  --url https://aiyolabs.com/api/create-campaign/group/video \
  --data '{
	"token": "5bebaee99cf858690b41dc74",
	"message": "Sample text message.",
	"title": "Sample Campaign Title"
            "group_id": "917097197955-1539171951"
"video": "VideoFile.mp4"
}'

Example Response

200

{
  "success": 1
}

Example Request

Default

curl --request POST \
  --url https://aiyolabs.com/api/create-campaign/group/file \
  --data '{
	"token": "5bebaee99cf858690b41dc74",
	"message": "Sample Text Message",
	"title": "Sample Campaign Title"
            "group_id": "917097197955-1539171951"
"file": "File.pdf"
}'

Example Response

200

{
  "success": 1
}

Example Request

Default

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://aiyolabs.com/api/create-campaign/group/image",
  "method": "POST",
  "headers": {},
  "data": "{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample text message.\",\n\t\"title\": \"Sample Campaign Title\"\n            \"group_id\": \"917097197955-1539171951\"\n\"image\": \"ImageFile.jpg\"\n}\n"
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

Example Response

200

{
  "success": 1
}

Example Request

Default

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://aiyolabs.com/api/create-campaign/group/text",
  "method": "POST",
  "headers": {},
  "data": "{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample text message.\",\n\t\"title\": \"Sample Campaign Title\"\n            \"group_id\": \"917097197955-1539171951\"\n}\n"
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

Example Response

200

{
  "success": 1
}

Example Request

Default

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://aiyolabs.com/api/create-campaign/group/link",
  "method": "POST",
  "headers": {},
  "data": "{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample text message.\",\n\t\"title\": \"Sample Campaign Title\"\n            \"group_id\": \"917097197955-1539171951\"\n\"image\": \"ImageFile.jpg\"\n            \"link\": \"www.someurllink.com\"\n\"link_title\": \"Sample Website\"\n\n}\n"
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

Example Response

200

{
  "success": 1
}

Example Request

Default

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://aiyolabs.com/api/create-campaign/group/video",
  "method": "POST",
  "headers": {},
  "data": "{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample text message.\",\n\t\"title\": \"Sample Campaign Title\"\n            \"group_id\": \"917097197955-1539171951\"\n\"video\": \"VideoFile.mp4\"\n}\n"
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

Example Response

200

{
  "success": 1
}

Example Request

Default

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://aiyolabs.com/api/create-campaign/group/file",
  "method": "POST",
  "headers": {},
  "data": "{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample Text Message\",\n\t\"title\": \"Sample Campaign Title\"\n            \"group_id\": \"917097197955-1539171951\"\n\"file\": \"File.pdf\"\n}\n"
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

Example Response

200

{
  "success": 1
}

Example Request

Default

require 'uri'
require 'net/http'

url = URI("https://aiyolabs.com/api/create-campaign/group/image")

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

request = Net::HTTP::Post.new(url)
request.body = "{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample text message.\",\n\t\"title\": \"Sample Campaign Title\"\n            \"group_id\": \"917097197955-1539171951\"\n\"image\": \"ImageFile.jpg\"\n}\n"

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

Example Response

200

{
  "success": 1
}

Example Request

Default

require 'uri'
require 'net/http'

url = URI("https://aiyolabs.com/api/create-campaign/group/text")

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

request = Net::HTTP::Post.new(url)
request.body = "{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample text message.\",\n\t\"title\": \"Sample Campaign Title\"\n            \"group_id\": \"917097197955-1539171951\"\n}\n"

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

Example Response

200

{
  "success": 1
}

Example Request

Default

require 'uri'
require 'net/http'

url = URI("https://aiyolabs.com/api/create-campaign/group/link")

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

request = Net::HTTP::Post.new(url)
request.body = "{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample text message.\",\n\t\"title\": \"Sample Campaign Title\"\n            \"group_id\": \"917097197955-1539171951\"\n\"image\": \"ImageFile.jpg\"\n            \"link\": \"www.someurllink.com\"\n\"link_title\": \"Sample Website\"\n\n}\n"

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

Example Response

200

{
  "success": 1
}

Example Request

Default

require 'uri'
require 'net/http'

url = URI("https://aiyolabs.com/api/create-campaign/group/video")

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

request = Net::HTTP::Post.new(url)
request.body = "{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample text message.\",\n\t\"title\": \"Sample Campaign Title\"\n            \"group_id\": \"917097197955-1539171951\"\n\"video\": \"VideoFile.mp4\"\n}\n"

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

Example Response

200

{
  "success": 1
}

Example Request

Default

require 'uri'
require 'net/http'

url = URI("https://aiyolabs.com/api/create-campaign/group/file")

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

request = Net::HTTP::Post.new(url)
request.body = "{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample Text Message\",\n\t\"title\": \"Sample Campaign Title\"\n            \"group_id\": \"917097197955-1539171951\"\n\"file\": \"File.pdf\"\n}\n"

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

Example Response

200

{
  "success": 1
}

Example Request

Default

import requests

url = "https://aiyolabs.com/api/create-campaign/group/image"

payload = "{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample text message.\",\n\t\"title\": \"Sample Campaign Title\"\n            \"group_id\": \"917097197955-1539171951\"\n\"image\": \"ImageFile.jpg\"\n}\n"
response = requests.request("POST", url, data=payload)

print(response.text)

Example Response

200

{
  "success": 1
}

Example Request

Default

import requests

url = "https://aiyolabs.com/api/create-campaign/group/text"

payload = "{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample text message.\",\n\t\"title\": \"Sample Campaign Title\"\n            \"group_id\": \"917097197955-1539171951\"\n}\n"
response = requests.request("POST", url, data=payload)

print(response.text)

Example Response

200

{
  "success": 1
}

Example Request

Default

import requests

url = "https://aiyolabs.com/api/create-campaign/group/link"

payload = "{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample text message.\",\n\t\"title\": \"Sample Campaign Title\"\n            \"group_id\": \"917097197955-1539171951\"\n\"image\": \"ImageFile.jpg\"\n            \"link\": \"www.someurllink.com\"\n\"link_title\": \"Sample Website\"\n\n}\n"
response = requests.request("POST", url, data=payload)

print(response.text)

Example Response

200

{
  "success": 1
}

Example Request

Default

import requests

url = "https://aiyolabs.com/api/create-campaign/group/video"

payload = "{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample text message.\",\n\t\"title\": \"Sample Campaign Title\"\n            \"group_id\": \"917097197955-1539171951\"\n\"video\": \"VideoFile.mp4\"\n}\n"
response = requests.request("POST", url, data=payload)

print(response.text)

Example Response

200

{
  "success": 1
}

Example Request

Default

import requests

url = "https://aiyolabs.com/api/create-campaign/group/file"

payload = "{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample Text Message\",\n\t\"title\": \"Sample Campaign Title\"\n            \"group_id\": \"917097197955-1539171951\"\n\"file\": \"File.pdf\"\n}\n"
response = requests.request("POST", url, data=payload)

print(response.text)

Example Response

200

{
  "success": 1
}

Example Request

Default

var http = require("https");

var options = {
  "method": "POST",
  "hostname": [
    "aiyolabs",
    "com"
  ],
  "path": [
    "api",
    "create-campaign",
    "group",
    "image"
  ],
  "headers": {}
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write("{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample text message.\",\n\t\"title\": \"Sample Campaign Title\"\n            \"group_id\": \"917097197955-1539171951\"\n\"image\": \"ImageFile.jpg\"\n}\n");
req.end();

Example Response

200

{
  "success": 1
}

Example Request

Default

var http = require("https");

var options = {
  "method": "POST",
  "hostname": [
    "aiyolabs",
    "com"
  ],
  "path": [
    "api",
    "create-campaign",
    "group",
    "text"
  ],
  "headers": {}
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write("{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample text message.\",\n\t\"title\": \"Sample Campaign Title\"\n            \"group_id\": \"917097197955-1539171951\"\n}\n");
req.end();

Example Response

200

{
  "success": 1
}

Example Request

Default

var http = require("https");

var options = {
  "method": "POST",
  "hostname": [
    "aiyolabs",
    "com"
  ],
  "path": [
    "api",
    "create-campaign",
    "group",
    "link"
  ],
  "headers": {}
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write("{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample text message.\",\n\t\"title\": \"Sample Campaign Title\"\n            \"group_id\": \"917097197955-1539171951\"\n\"image\": \"ImageFile.jpg\"\n            \"link\": \"www.someurllink.com\"\n\"link_title\": \"Sample Website\"\n\n}\n");
req.end();

Example Response

200

{
  "success": 1
}

Example Request

Default

var http = require("https");

var options = {
  "method": "POST",
  "hostname": [
    "aiyolabs",
    "com"
  ],
  "path": [
    "api",
    "create-campaign",
    "group",
    "video"
  ],
  "headers": {}
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write("{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample text message.\",\n\t\"title\": \"Sample Campaign Title\"\n            \"group_id\": \"917097197955-1539171951\"\n\"video\": \"VideoFile.mp4\"\n}\n");
req.end();

Example Response

200

{
  "success": 1
}

Example Request

Default

var http = require("https");

var options = {
  "method": "POST",
  "hostname": [
    "aiyolabs",
    "com"
  ],
  "path": [
    "api",
    "create-campaign",
    "group",
    "file"
  ],
  "headers": {}
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write("{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample Text Message\",\n\t\"title\": \"Sample Campaign Title\"\n            \"group_id\": \"917097197955-1539171951\"\n\"file\": \"File.pdf\"\n}\n");
req.end();

Example Response

200

{
  "success": 1
}

Example Request

Default

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://aiyolabs.com/api/create-campaign/group/image",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample text message.\",\n\t\"title\": \"Sample Campaign Title\"\n            \"group_id\": \"917097197955-1539171951\"\n\"image\": \"ImageFile.jpg\"\n}\n",
));

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

curl_close($curl);

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

Example Response

200

{
  "success": 1
}

Example Request

Default

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://aiyolabs.com/api/create-campaign/group/text",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample text message.\",\n\t\"title\": \"Sample Campaign Title\"\n            \"group_id\": \"917097197955-1539171951\"\n}\n",
));

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

curl_close($curl);

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

Example Response

200

{
  "success": 1
}

Example Request

Default

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://aiyolabs.com/api/create-campaign/group/link",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample text message.\",\n\t\"title\": \"Sample Campaign Title\"\n            \"group_id\": \"917097197955-1539171951\"\n\"image\": \"ImageFile.jpg\"\n            \"link\": \"www.someurllink.com\"\n\"link_title\": \"Sample Website\"\n\n}\n",
));

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

curl_close($curl);

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

Example Response

200

{
  "success": 1
}

Example Request

Default

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://aiyolabs.com/api/create-campaign/group/video",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample text message.\",\n\t\"title\": \"Sample Campaign Title\"\n            \"group_id\": \"917097197955-1539171951\"\n\"video\": \"VideoFile.mp4\"\n}\n",
));

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

curl_close($curl);

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

Example Response

200

{
  "success": 1
}

Example Request

Default

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://aiyolabs.com/api/create-campaign/group/file",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample Text Message\",\n\t\"title\": \"Sample Campaign Title\"\n            \"group_id\": \"917097197955-1539171951\"\n\"file\": \"File.pdf\"\n}\n",
));

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

curl_close($curl);

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

Example Response

200

{
  "success": 1
}

Example Request

Default

package main

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

func main() {

	url := "https://aiyolabs.com/api/create-campaign/group/image"

	payload := strings.NewReader("{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample text message.\",\n\t\"title\": \"Sample Campaign Title\"\n            \"group_id\": \"917097197955-1539171951\"\n\"image\": \"ImageFile.jpg\"\n}\n")

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

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

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

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

}

Example Response

200

{
  "success": 1
}

Example Request

Default

package main

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

func main() {

	url := "https://aiyolabs.com/api/create-campaign/group/text"

	payload := strings.NewReader("{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample text message.\",\n\t\"title\": \"Sample Campaign Title\"\n            \"group_id\": \"917097197955-1539171951\"\n}\n")

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

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

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

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

}

Example Response

200

{
  "success": 1
}

Example Request

Default

package main

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

func main() {

	url := "https://aiyolabs.com/api/create-campaign/group/link"

	payload := strings.NewReader("{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample text message.\",\n\t\"title\": \"Sample Campaign Title\"\n            \"group_id\": \"917097197955-1539171951\"\n\"image\": \"ImageFile.jpg\"\n            \"link\": \"www.someurllink.com\"\n\"link_title\": \"Sample Website\"\n\n}\n")

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

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

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

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

}

Example Response

200

{
  "success": 1
}

Example Request

Default

package main

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

func main() {

	url := "https://aiyolabs.com/api/create-campaign/group/video"

	payload := strings.NewReader("{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample text message.\",\n\t\"title\": \"Sample Campaign Title\"\n            \"group_id\": \"917097197955-1539171951\"\n\"video\": \"VideoFile.mp4\"\n}\n")

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

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

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

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

}

Example Response

200

{
  "success": 1
}

Example Request

Default

package main

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

func main() {

	url := "https://aiyolabs.com/api/create-campaign/group/file"

	payload := strings.NewReader("{\n\t\"token\": \"5bebaee99cf858690b41dc74\",\n\t\"message\": \"Sample Text Message\",\n\t\"title\": \"Sample Campaign Title\"\n            \"group_id\": \"917097197955-1539171951\"\n\"file\": \"File.pdf\"\n}\n")

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

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

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

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

}

Example Response

200

{
  "success": 1
}

Flock Push API

The Flock Push set of APIs are built to send Push messages to subscriber WhatsApp users. Three variations differentiate if the Push is to be sent to individual user or category of '#' subscribers or to groups.

Two mandatory parameters are to be passed:

- Access Token of the user.
- Message desired to send.

The group ID and the category name is passed as third parameter if required.

Response Status Codes:
200: Successfully sent Push messages.
400: Failure due to missing parameters or unavailability of subscribed users.

POST Global Push

https://aiyolabs.com/api/send_global_push

An API to send Push WhatsApp to all the subscribed users.

BODY

{
            "access_token": "5b98adb037f7544a375ff2a2",
	"message": "Message to send to the subscribers.”
}

POST Hashtag Push

https://aiyolabs.com/api/send_hashtag_push

An API to send Push WhatsApp to subscribed users in a specific '#' category.

BODY

{
            "access_token": "5b98adb037f7544a375ff2a2",
	"message": "Message to send to the subscribers.”,
	“category”:”#bitcoin”
}

POST Group Push

https://aiyolabs.com/api/send_group_push

Sending a Push to a group is done using this API.

BODY

{
            "access_token": "5b98adb037f7544a375ff2a2",
	"message": "Message to send to the subscribers.”,
            “group_id”:“917097197955-1539171951”
}

Language

Example Request

Default

curl --request POST \
  --url https://aiyolabs.com/api/send_global_push \
  --data '{
            "access_token": "5b98adb037f7544a375ff2a2",
	"message": "Message to send to the subscribers.”
}
'

Example Response

200

{
"code":200,
"message":"successfully sent messages”
}

Example Request

Default

curl --request POST \
  --url https://aiyolabs.com/api/send_hashtag_push \
  --data '{
            "access_token": "5b98adb037f7544a375ff2a2",
	"message": "Message to send to the subscribers.”,
	“category”:”#bitcoin”
}
'

Example Response

200

{
"code":200,
"message":"successfully sent messages”
}

Example Request

Default

curl --request POST \
  --url https://aiyolabs.com/api/send_group_push \
  --data '{
            "access_token": "5b98adb037f7544a375ff2a2",
	"message": "Message to send to the subscribers.”,
            “group_id”:“917097197955-1539171951”
}
'

Example Response

200

{
"code":200,
"message":"successfully sent messages”
}

Example Request

Default

var http = require("https");

var options = {
  "method": "POST",
  "hostname": [
    "aiyolabs",
    "com"
  ],
  "path": [
    "api",
    "send_global_push"
  ],
  "headers": {}
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write("{\n            \"access_token\": \"5b98adb037f7544a375ff2a2\",\n\t\"message\": \"Message to send to the subscribers.”\n}\n");
req.end();

Example Response

200

{
"code":200,
"message":"successfully sent messages”
}

Example Request

Default

var http = require("https");

var options = {
  "method": "POST",
  "hostname": [
    "aiyolabs",
    "com"
  ],
  "path": [
    "api",
    "send_hashtag_push"
  ],
  "headers": {}
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write("{\n            \"access_token\": \"5b98adb037f7544a375ff2a2\",\n\t\"message\": \"Message to send to the subscribers.”,\n\t“category”:”#bitcoin”\n}\n");
req.end();

Example Response

200

{
"code":200,
"message":"successfully sent messages”
}

Example Request

Default

var http = require("https");

var options = {
  "method": "POST",
  "hostname": [
    "aiyolabs",
    "com"
  ],
  "path": [
    "api",
    "send_group_push"
  ],
  "headers": {}
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write("{\n            \"access_token\": \"5b98adb037f7544a375ff2a2\",\n\t\"message\": \"Message to send to the subscribers.”,\n            “group_id”:“917097197955-1539171951”\n}\n");
req.end();

Example Response

200

{
"code":200,
"message":"successfully sent messages”
}

Example Request

Default

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://aiyolabs.com/api/send_global_push",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\n            \"access_token\": \"5b98adb037f7544a375ff2a2\",\n\t\"message\": \"Message to send to the subscribers.”\n}\n",
));

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

curl_close($curl);

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

Example Response

200

{
"code":200,
"message":"successfully sent messages”
}

Example Request

Default

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://aiyolabs.com/api/send_hashtag_push",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\n            \"access_token\": \"5b98adb037f7544a375ff2a2\",\n\t\"message\": \"Message to send to the subscribers.”,\n\t“category”:”#bitcoin”\n}\n",
));

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

curl_close($curl);

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

Example Response

200

{
"code":200,
"message":"successfully sent messages”
}

Example Request

Default

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://aiyolabs.com/api/send_group_push",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\n            \"access_token\": \"5b98adb037f7544a375ff2a2\",\n\t\"message\": \"Message to send to the subscribers.”,\n            “group_id”:“917097197955-1539171951”\n}\n",
));

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

curl_close($curl);

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

Example Response

200

{
"code":200,
"message":"successfully sent messages”
}

Flock Suite API

This set of APIs are used to automate exporting and importing tasks.

Export Chat API adds an exported WhatsApp chat to Flock Listen. The chat is exported as a .txt file and compressed.

Import Contact API imports a list of contacts (in .csv file) into the Flock Connect Contact Lists.

Web-View of Analytics Graph API responds with a HTML code. The response is executed in the browser to provide a graphical interface for the WhatsApp Analytics Graph.

Response Status Codes:
200: Successful execution
400: Failure. Missing parameters/file

POST Export Chat

https://aiyolabs.com/api/export-chat-message

An API to add the exported WhatsApp chat into Flock Listen.

BODY

{
	"user_id": "Api token",
	"chat_file": "WhatsApp chat.zip",
	"mobile_type": "2"
}

POST Import Contacts to List

https://aiyolabs.com/api/export-list-contact

An API to import a list of contacts to Flock Connect Contact lists.

BODY

{
	"user_id": "Api token",
	"list_name": "Contact List 1",
	"list_file": "contacts.csv"
}

GET Web-view Graph

https://aiyolabs.com/api/web-view-group-graph/<user_id>

An API to generate a user interface of the analytics graph of a specific user.

Language

Example Request

Default

curl --request POST \
  --url https://aiyolabs.com/api/export-chat-message \
  --data '{
	"user_id": "Api token",
	"chat_file": "WhatsApp chat.zip",
	"mobile_type": "2"
}
'

Example Response

200

{
  "code": 200,
  "message": "successfully exported and stored",
  "data": "347 messages has been stored."
}

Example Request

Default

curl --request POST \
  --url https://aiyolabs.com/api/export-list-contact \
  --data '{
	"user_id": "Api token",
	"list_name": "Contact List 1",
	"list_file": "contacts.csv"
}
'

Example Response

200

{
  "code": 200,
  "message": "successfully exported all contacts"
}

Example Request

Default

curl --request GET \
  --url https://aiyolabs.com/api/web-view-group-graph/%3Cuser_id%3E

Example Request

Default

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://aiyolabs.com/api/export-chat-message",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\n\t\"user_id\": \"Api token\",\n\t\"chat_file\": \"WhatsApp chat.zip\",\n\t\"mobile_type\": \"2\"\n}\n",
));

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

curl_close($curl);

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

Example Response

200

{
  "code": 200,
  "message": "successfully exported and stored",
  "data": "347 messages has been stored."
}

Example Request

Default

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://aiyolabs.com/api/export-list-contact",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\n\t\"user_id\": \"Api token\",\n\t\"list_name\": \"Contact List 1\",\n\t\"list_file\": \"contacts.csv\"\n}\n",
));

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

curl_close($curl);

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

Example Response

200

{
  "code": 200,
  "message": "successfully exported all contacts"
}

Example Request

Default

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://aiyolabs.com/api/web-view-group-graph/%3Cuser_id%3E",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
));

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

curl_close($curl);

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