Cambiar el estado de una campaña
curl --request POST \
--url https://admintest.inceptia.ai/api/v2/campaigns/{campaign_id}/{action}/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://admintest.inceptia.ai/api/v2/campaigns/{campaign_id}/{action}/"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://admintest.inceptia.ai/api/v2/campaigns/{campaign_id}/{action}/', 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://admintest.inceptia.ai/api/v2/campaigns/{campaign_id}/{action}/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://admintest.inceptia.ai/api/v2/campaigns/{campaign_id}/{action}/"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://admintest.inceptia.ai/api/v2/campaigns/{campaign_id}/{action}/")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://admintest.inceptia.ai/api/v2/campaigns/{campaign_id}/{action}/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": 12345,
"name": "Campaña Test Octubre",
"description": "Campaña de prueba automatizada",
"bot": 116,
"conversation_type": "OUTBOUND_VOICE",
"closes_eod": false,
"params": {
"call_from": "09:00:00",
"call_to": "21:00:00",
"max_calls_per_case": 3,
"dialing_type": "HORIZONTAL_VERTICAL",
"workers": 120,
"max_phone_priority": 1,
"min_phone_priority": 0,
"start_date": "2024-10-10"
},
"case_stats": {
"q_loaded_cases": 10,
"q_filtered_cases": 0,
"q_resting_cases": 0,
"q_final_cases": 0
},
"metrics": {
"status": "ONGOING",
"percentage_completed": 0,
"percentage_called": 0,
"success_rate": "0%",
"contactability_rate": 0,
"bot_duration": null,
"hours": 0
},
"created_at": "2024-10-10T10:00:00Z"
}Campañas
Cambiar estado de campaña
Permite modificar el estado operativo de una campaña existente mediante una acción específica. Las acciones disponibles son:
- start: inicia una campaña pausada o programada. - stop: pausa una campaña en ejecución. - end: finaliza una campaña. El endpoint devuelve los datos actualizados de la campaña tras aplicar la acción.
POST
/
api
/
v2
/
campaigns
/
{campaign_id}
/
{action}
/
Cambiar el estado de una campaña
curl --request POST \
--url https://admintest.inceptia.ai/api/v2/campaigns/{campaign_id}/{action}/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://admintest.inceptia.ai/api/v2/campaigns/{campaign_id}/{action}/"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://admintest.inceptia.ai/api/v2/campaigns/{campaign_id}/{action}/', 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://admintest.inceptia.ai/api/v2/campaigns/{campaign_id}/{action}/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://admintest.inceptia.ai/api/v2/campaigns/{campaign_id}/{action}/"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://admintest.inceptia.ai/api/v2/campaigns/{campaign_id}/{action}/")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://admintest.inceptia.ai/api/v2/campaigns/{campaign_id}/{action}/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": 12345,
"name": "Campaña Test Octubre",
"description": "Campaña de prueba automatizada",
"bot": 116,
"conversation_type": "OUTBOUND_VOICE",
"closes_eod": false,
"params": {
"call_from": "09:00:00",
"call_to": "21:00:00",
"max_calls_per_case": 3,
"dialing_type": "HORIZONTAL_VERTICAL",
"workers": 120,
"max_phone_priority": 1,
"min_phone_priority": 0,
"start_date": "2024-10-10"
},
"case_stats": {
"q_loaded_cases": 10,
"q_filtered_cases": 0,
"q_resting_cases": 0,
"q_final_cases": 0
},
"metrics": {
"status": "ONGOING",
"percentage_completed": 0,
"percentage_called": 0,
"success_rate": "0%",
"contactability_rate": 0,
"bot_duration": null,
"hours": 0
},
"created_at": "2024-10-10T10:00:00Z"
}Autorizaciones
Token de acceso JWT. Debe ser enviado como 'Bearer {token}'.
Parámetros de ruta
ID de la campaña sobre la cual ejecutar la acción.
Acción a realizar sobre la campaña.
Opciones disponibles:
start, stop, end Respuesta
Acción ejecutada exitosamente. Devuelve la campaña actualizada.