Macros
Create a new macro
Creates a new macro with the specified actions
POST
/
api
/
v1
/
macros
Create a new macro
curl --request POST \
--url https://api.evoai.app/api/v1/macros \
--header 'Content-Type: application/json' \
--header 'api_access_token: <api-key>' \
--data '
{
"name": "Resolver e agradecer cliente",
"actions": [
{
"action_name": "send_message",
"action_params": [
"Obrigado por entrar em contato!"
]
}
],
"visibility": "global"
}
'import requests
url = "https://api.evoai.app/api/v1/macros"
payload = {
"name": "Resolver e agradecer cliente",
"actions": [
{
"action_name": "send_message",
"action_params": ["Obrigado por entrar em contato!"]
}
],
"visibility": "global"
}
headers = {
"api_access_token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Resolver e agradecer cliente',
actions: [
{
action_name: 'send_message',
action_params: ['Obrigado por entrar em contato!']
}
],
visibility: 'global'
})
};
fetch('https://api.evoai.app/api/v1/macros', 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://api.evoai.app/api/v1/macros",
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([
'name' => 'Resolver e agradecer cliente',
'actions' => [
[
'action_name' => 'send_message',
'action_params' => [
'Obrigado por entrar em contato!'
]
]
],
'visibility' => 'global'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api_access_token: <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://api.evoai.app/api/v1/macros"
payload := strings.NewReader("{\n \"name\": \"Resolver e agradecer cliente\",\n \"actions\": [\n {\n \"action_name\": \"send_message\",\n \"action_params\": [\n \"Obrigado por entrar em contato!\"\n ]\n }\n ],\n \"visibility\": \"global\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api_access_token", "<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://api.evoai.app/api/v1/macros")
.header("api_access_token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Resolver e agradecer cliente\",\n \"actions\": [\n {\n \"action_name\": \"send_message\",\n \"action_params\": [\n \"Obrigado por entrar em contato!\"\n ]\n }\n ],\n \"visibility\": \"global\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.evoai.app/api/v1/macros")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_access_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Resolver e agradecer cliente\",\n \"actions\": [\n {\n \"action_name\": \"send_message\",\n \"action_params\": [\n \"Obrigado por entrar em contato!\"\n ]\n }\n ],\n \"visibility\": \"global\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Example Macro"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z"
},
"message": "Macro created successfully"
}{
"success": false,
"error": {
"code": "BAD_REQUEST",
"message": "Invalid request data"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/macros",
"method": "POST"
}
}{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Unauthorized"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/macros",
"method": "POST"
}
}{
"success": false,
"error": {
"code": "FORBIDDEN",
"message": "Forbidden"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/macros",
"method": "POST"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Validation error",
"details": {
"name": "Name is required"
}
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/macros",
"method": "POST"
}
}{
"success": false,
"error": {
"code": "INTERNAL_ERROR",
"message": "An internal server error occurred"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/macros",
"method": "POST"
}
}Autorizações
Corpo
application/json
Macro name
Required string length:
1 - 255Exemplo:
"Resolver e agradecer cliente"
List of actions that will be executed
Minimum array length:
1Show child attributes
Show child attributes
Macro visibility (agents can only create personal)
Opções disponíveis:
personal, global Exemplo:
"global"
⌘I
Create a new macro
curl --request POST \
--url https://api.evoai.app/api/v1/macros \
--header 'Content-Type: application/json' \
--header 'api_access_token: <api-key>' \
--data '
{
"name": "Resolver e agradecer cliente",
"actions": [
{
"action_name": "send_message",
"action_params": [
"Obrigado por entrar em contato!"
]
}
],
"visibility": "global"
}
'import requests
url = "https://api.evoai.app/api/v1/macros"
payload = {
"name": "Resolver e agradecer cliente",
"actions": [
{
"action_name": "send_message",
"action_params": ["Obrigado por entrar em contato!"]
}
],
"visibility": "global"
}
headers = {
"api_access_token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Resolver e agradecer cliente',
actions: [
{
action_name: 'send_message',
action_params: ['Obrigado por entrar em contato!']
}
],
visibility: 'global'
})
};
fetch('https://api.evoai.app/api/v1/macros', 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://api.evoai.app/api/v1/macros",
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([
'name' => 'Resolver e agradecer cliente',
'actions' => [
[
'action_name' => 'send_message',
'action_params' => [
'Obrigado por entrar em contato!'
]
]
],
'visibility' => 'global'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api_access_token: <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://api.evoai.app/api/v1/macros"
payload := strings.NewReader("{\n \"name\": \"Resolver e agradecer cliente\",\n \"actions\": [\n {\n \"action_name\": \"send_message\",\n \"action_params\": [\n \"Obrigado por entrar em contato!\"\n ]\n }\n ],\n \"visibility\": \"global\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api_access_token", "<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://api.evoai.app/api/v1/macros")
.header("api_access_token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Resolver e agradecer cliente\",\n \"actions\": [\n {\n \"action_name\": \"send_message\",\n \"action_params\": [\n \"Obrigado por entrar em contato!\"\n ]\n }\n ],\n \"visibility\": \"global\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.evoai.app/api/v1/macros")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_access_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Resolver e agradecer cliente\",\n \"actions\": [\n {\n \"action_name\": \"send_message\",\n \"action_params\": [\n \"Obrigado por entrar em contato!\"\n ]\n }\n ],\n \"visibility\": \"global\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Example Macro"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z"
},
"message": "Macro created successfully"
}{
"success": false,
"error": {
"code": "BAD_REQUEST",
"message": "Invalid request data"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/macros",
"method": "POST"
}
}{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Unauthorized"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/macros",
"method": "POST"
}
}{
"success": false,
"error": {
"code": "FORBIDDEN",
"message": "Forbidden"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/macros",
"method": "POST"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Validation error",
"details": {
"name": "Name is required"
}
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/macros",
"method": "POST"
}
}{
"success": false,
"error": {
"code": "INTERNAL_ERROR",
"message": "An internal server error occurred"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/macros",
"method": "POST"
}
}