Send an Agent Event
curl --request POST \
--url https://app.adsera.in/api/pub/wa/business-agent/events \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--header 'x-api-secret: <api-key>' \
--data '
{
"phoneId": "123456789012345",
"to": "919876543210",
"type": "order_shipped",
"description": "Order #1042 has shipped with BlueDart, AWB 1234567890.",
"payload": {
"order_id": "1042",
"tracking_url": "https://track.example.com/1234567890"
},
"contactId": "<string>"
}
'import requests
url = "https://app.adsera.in/api/pub/wa/business-agent/events"
payload = {
"phoneId": "123456789012345",
"to": "919876543210",
"type": "order_shipped",
"description": "Order #1042 has shipped with BlueDart, AWB 1234567890.",
"payload": {
"order_id": "1042",
"tracking_url": "https://track.example.com/1234567890"
},
"contactId": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"x-api-secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-api-key': '<api-key>',
'x-api-secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
phoneId: '123456789012345',
to: '919876543210',
type: 'order_shipped',
description: 'Order #1042 has shipped with BlueDart, AWB 1234567890.',
payload: {order_id: '1042', tracking_url: 'https://track.example.com/1234567890'},
contactId: '<string>'
})
};
fetch('https://app.adsera.in/api/pub/wa/business-agent/events', 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://app.adsera.in/api/pub/wa/business-agent/events",
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([
'phoneId' => '123456789012345',
'to' => '919876543210',
'type' => 'order_shipped',
'description' => 'Order #1042 has shipped with BlueDart, AWB 1234567890.',
'payload' => [
'order_id' => '1042',
'tracking_url' => 'https://track.example.com/1234567890'
],
'contactId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>",
"x-api-secret: <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://app.adsera.in/api/pub/wa/business-agent/events"
payload := strings.NewReader("{\n \"phoneId\": \"123456789012345\",\n \"to\": \"919876543210\",\n \"type\": \"order_shipped\",\n \"description\": \"Order #1042 has shipped with BlueDart, AWB 1234567890.\",\n \"payload\": {\n \"order_id\": \"1042\",\n \"tracking_url\": \"https://track.example.com/1234567890\"\n },\n \"contactId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-api-secret", "<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://app.adsera.in/api/pub/wa/business-agent/events")
.header("x-api-key", "<api-key>")
.header("x-api-secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"phoneId\": \"123456789012345\",\n \"to\": \"919876543210\",\n \"type\": \"order_shipped\",\n \"description\": \"Order #1042 has shipped with BlueDart, AWB 1234567890.\",\n \"payload\": {\n \"order_id\": \"1042\",\n \"tracking_url\": \"https://track.example.com/1234567890\"\n },\n \"contactId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.adsera.in/api/pub/wa/business-agent/events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["x-api-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"phoneId\": \"123456789012345\",\n \"to\": \"919876543210\",\n \"type\": \"order_shipped\",\n \"description\": \"Order #1042 has shipped with BlueDart, AWB 1234567890.\",\n \"payload\": {\n \"order_id\": \"1042\",\n \"tracking_url\": \"https://track.example.com/1234567890\"\n },\n \"contactId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"_id": "<string>",
"phoneId": "<string>",
"to": "<string>",
"type": "<string>",
"description": "<string>",
"payload": "<string>",
"metaEventId": "<string>",
"status": "<string>",
"errorMessage": "<string>",
"skippedReason": "<string>",
"source": "api",
"createdAt": "2023-11-07T05:31:56Z"
}
}{
"success": false,
"code": "FEATURE_DISABLED",
"message": "<string>"
}{
"status": 401,
"success": false,
"error": "Unauthorized: Please provide valid API credentials."
}{
"success": false,
"code": "FEATURE_DISABLED",
"message": "<string>"
}{
"success": false,
"code": "FEATURE_DISABLED",
"message": "<string>"
}{
"success": false,
"code": "FEATURE_DISABLED",
"message": "<string>"
}{
"success": false,
"code": "FEATURE_DISABLED",
"message": "<string>"
}Meta AI Agent
Send an Agent Event
Tells the Meta AI Agent on your number about something that happened in your systems (an order shipped, a payment received…), so it can tell the customer in the chat. Requires the Meta AI Agent to be enabled for your account and set up on the number.
POST
/
api
/
pub
/
wa
/
business-agent
/
events
Send an Agent Event
curl --request POST \
--url https://app.adsera.in/api/pub/wa/business-agent/events \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--header 'x-api-secret: <api-key>' \
--data '
{
"phoneId": "123456789012345",
"to": "919876543210",
"type": "order_shipped",
"description": "Order #1042 has shipped with BlueDart, AWB 1234567890.",
"payload": {
"order_id": "1042",
"tracking_url": "https://track.example.com/1234567890"
},
"contactId": "<string>"
}
'import requests
url = "https://app.adsera.in/api/pub/wa/business-agent/events"
payload = {
"phoneId": "123456789012345",
"to": "919876543210",
"type": "order_shipped",
"description": "Order #1042 has shipped with BlueDart, AWB 1234567890.",
"payload": {
"order_id": "1042",
"tracking_url": "https://track.example.com/1234567890"
},
"contactId": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"x-api-secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-api-key': '<api-key>',
'x-api-secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
phoneId: '123456789012345',
to: '919876543210',
type: 'order_shipped',
description: 'Order #1042 has shipped with BlueDart, AWB 1234567890.',
payload: {order_id: '1042', tracking_url: 'https://track.example.com/1234567890'},
contactId: '<string>'
})
};
fetch('https://app.adsera.in/api/pub/wa/business-agent/events', 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://app.adsera.in/api/pub/wa/business-agent/events",
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([
'phoneId' => '123456789012345',
'to' => '919876543210',
'type' => 'order_shipped',
'description' => 'Order #1042 has shipped with BlueDart, AWB 1234567890.',
'payload' => [
'order_id' => '1042',
'tracking_url' => 'https://track.example.com/1234567890'
],
'contactId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>",
"x-api-secret: <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://app.adsera.in/api/pub/wa/business-agent/events"
payload := strings.NewReader("{\n \"phoneId\": \"123456789012345\",\n \"to\": \"919876543210\",\n \"type\": \"order_shipped\",\n \"description\": \"Order #1042 has shipped with BlueDart, AWB 1234567890.\",\n \"payload\": {\n \"order_id\": \"1042\",\n \"tracking_url\": \"https://track.example.com/1234567890\"\n },\n \"contactId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-api-secret", "<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://app.adsera.in/api/pub/wa/business-agent/events")
.header("x-api-key", "<api-key>")
.header("x-api-secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"phoneId\": \"123456789012345\",\n \"to\": \"919876543210\",\n \"type\": \"order_shipped\",\n \"description\": \"Order #1042 has shipped with BlueDart, AWB 1234567890.\",\n \"payload\": {\n \"order_id\": \"1042\",\n \"tracking_url\": \"https://track.example.com/1234567890\"\n },\n \"contactId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.adsera.in/api/pub/wa/business-agent/events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["x-api-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"phoneId\": \"123456789012345\",\n \"to\": \"919876543210\",\n \"type\": \"order_shipped\",\n \"description\": \"Order #1042 has shipped with BlueDart, AWB 1234567890.\",\n \"payload\": {\n \"order_id\": \"1042\",\n \"tracking_url\": \"https://track.example.com/1234567890\"\n },\n \"contactId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"_id": "<string>",
"phoneId": "<string>",
"to": "<string>",
"type": "<string>",
"description": "<string>",
"payload": "<string>",
"metaEventId": "<string>",
"status": "<string>",
"errorMessage": "<string>",
"skippedReason": "<string>",
"source": "api",
"createdAt": "2023-11-07T05:31:56Z"
}
}{
"success": false,
"code": "FEATURE_DISABLED",
"message": "<string>"
}{
"status": 401,
"success": false,
"error": "Unauthorized: Please provide valid API credentials."
}{
"success": false,
"code": "FEATURE_DISABLED",
"message": "<string>"
}{
"success": false,
"code": "FEATURE_DISABLED",
"message": "<string>"
}{
"success": false,
"code": "FEATURE_DISABLED",
"message": "<string>"
}{
"success": false,
"code": "FEATURE_DISABLED",
"message": "<string>"
}Authorizations
Body
application/json
Was this page helpful?