Consultar campanha
curl --request GET \
--url https://api.notifique.dev/v1/campaigns/{campaignId} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.notifique.dev/v1/campaigns/{campaignId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.notifique.dev/v1/campaigns/{campaignId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.notifique.dev/v1/campaigns/{campaignId}"
req, _ := http.NewRequest("GET", 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))
}{
"success": true,
"data": {
"id": "clxx...",
"name": "Exemplo",
"status": "DRAFT",
"templateId": "clxx...",
"channels": [
"whatsapp"
],
"segmentId": "clxx...",
"audienceContactIds": [
"clxx..."
],
"scheduledFor": "2025-02-10T14:00:00.000Z",
"instanceId": "clxx...",
"telegramInstanceId": "clxx...",
"fromEmail": "string",
"channelFailureMode": "STRICT",
"variables": {},
"startedAt": "2025-02-10T14:00:00.000Z",
"completedAt": "2025-02-10T14:00:00.000Z",
"errorMessage": "string",
"createdAt": "2025-02-10T14:00:00.000Z",
"updatedAt": "2025-02-10T14:00:00.000Z",
"audienceCount": 1,
"lastRunAt": "2025-02-10T14:00:00.000Z",
"sendingPoolId": "clxx..."
}
}{
"success": false,
"error": "Bad Request",
"code": "VALIDATION_ERROR",
"message": "Campo inválido ou ausente."
}{
"success": false,
"error": "Bad Request",
"code": "VALIDATION_ERROR",
"message": "Campo inválido ou ausente."
}{
"success": false,
"error": "Bad Request",
"code": "VALIDATION_ERROR",
"message": "Campo inválido ou ausente."
}{
"success": false,
"error": "Bad Request",
"code": "VALIDATION_ERROR",
"message": "Campo inválido ou ausente."
}Campanhas
Consultar campanha
Consulta um campanha.
GET
/
v1
/
campaigns
/
{campaignId}
Consultar campanha
curl --request GET \
--url https://api.notifique.dev/v1/campaigns/{campaignId} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.notifique.dev/v1/campaigns/{campaignId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.notifique.dev/v1/campaigns/{campaignId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.notifique.dev/v1/campaigns/{campaignId}"
req, _ := http.NewRequest("GET", 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))
}{
"success": true,
"data": {
"id": "clxx...",
"name": "Exemplo",
"status": "DRAFT",
"templateId": "clxx...",
"channels": [
"whatsapp"
],
"segmentId": "clxx...",
"audienceContactIds": [
"clxx..."
],
"scheduledFor": "2025-02-10T14:00:00.000Z",
"instanceId": "clxx...",
"telegramInstanceId": "clxx...",
"fromEmail": "string",
"channelFailureMode": "STRICT",
"variables": {},
"startedAt": "2025-02-10T14:00:00.000Z",
"completedAt": "2025-02-10T14:00:00.000Z",
"errorMessage": "string",
"createdAt": "2025-02-10T14:00:00.000Z",
"updatedAt": "2025-02-10T14:00:00.000Z",
"audienceCount": 1,
"lastRunAt": "2025-02-10T14:00:00.000Z",
"sendingPoolId": "clxx..."
}
}{
"success": false,
"error": "Bad Request",
"code": "VALIDATION_ERROR",
"message": "Campo inválido ou ausente."
}{
"success": false,
"error": "Bad Request",
"code": "VALIDATION_ERROR",
"message": "Campo inválido ou ausente."
}{
"success": false,
"error": "Bad Request",
"code": "VALIDATION_ERROR",
"message": "Campo inválido ou ausente."
}{
"success": false,
"error": "Bad Request",
"code": "VALIDATION_ERROR",
"message": "Campo inválido ou ausente."
}Autorizações
ntfContactBearerAuthntfContactApiKeyHeader
Authorization: Bearer sk_live_xxxxx
Parâmetros de caminho
Resposta
OK.
Campanha multicanal. channels ⊆ canais habilitados do template (whatsapp|sms|email|telegram). Status: DRAFT, SCHEDULED, RUNNING, COMPLETED, FAILED, CANCELLED.
Show child attributes
Show child attributes
Exemplo:
{
"id": "clxx...",
"name": "Exemplo",
"status": "DRAFT",
"templateId": "clxx...",
"channels": ["whatsapp"],
"segmentId": "clxx...",
"audienceContactIds": ["clxx..."],
"scheduledFor": "2025-02-10T14:00:00.000Z",
"instanceId": "clxx...",
"telegramInstanceId": "clxx...",
"fromEmail": "string",
"channelFailureMode": "STRICT",
"variables": {},
"startedAt": "2025-02-10T14:00:00.000Z",
"completedAt": "2025-02-10T14:00:00.000Z",
"errorMessage": "string",
"createdAt": "2025-02-10T14:00:00.000Z",
"updatedAt": "2025-02-10T14:00:00.000Z",
"audienceCount": 1,
"lastRunAt": "2025-02-10T14:00:00.000Z",
"sendingPoolId": "clxx..."
}
Esta página foi útil?

