Danh mục thao tác

Xem trước đối tượng

campaigns.audience.previewMCP:campaigns_audience_previewBộ công cụ: Thiết lập tự chạy

Count and sample who the audience filter selects and who is excluded (do-not-contact, already enrolled). No side effects.

Chỉ đọc
Quyền: Đọc

Gọi bằng REST v2

curl -X POST https://zl.builera.app/api/public/v2/ops/campaigns.audience.preview \
  -H "Authorization: Bearer za_live_…" \
  -H "Content-Type: application/json" \
  -d '{"campaignId":"3f2b8c1e-5d4a-4e6b-9c7d-1a2b3c4d5e6f"}'

Mỗi khoá/kết nối tối đa 300 lệnh đọc và 60 lệnh ghi mỗi phút. Gọi lại cùng Idempotency-Key trả đúng kết quả cũ, không làm lại.

Gọi qua MCP

{
  "method": "tools/call",
  "params": {
    "name": "campaigns_audience_preview",
    "arguments": {
      "campaignId": "3f2b8c1e-5d4a-4e6b-9c7d-1a2b3c4d5e6f"
    }
  }
}

Thêm https://zl.builera.app/mcp vào ứng dụng AI rồi cho phép kết nối; AI chỉ thấy công cụ trong bộ bạn chọn.

Kết quả

HTTP 200
{ "status": "succeeded", "operationId": "…", "data": { … } }

Ví dụ đầu vào

{
  "campaignId": "3f2b8c1e-5d4a-4e6b-9c7d-1a2b3c4d5e6f"
}

Thay mã (id) mẫu bằng mã thật lấy từ các thao tác liệt kê/tìm kiếm.

Lược đồ đầu vào (JSON Schema)

{
  "type": "object",
  "properties": {
    "campaignId": {
      "type": "string",
      "format": "uuid",
      "description": "Campaign id."
    },
    "audience": {
      "type": "object",
      "properties": {
        "segmentId": {
          "type": "string",
          "format": "uuid",
          "nullable": true,
          "default": null
        },
        "listIds": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "uuid"
          },
          "maxItems": 20,
          "default": []
        },
        "filter": {
          "type": "object",
          "properties": {
            "search": {
              "type": "string",
              "maxLength": 100
            },
            "labelIds": {
              "type": "array",
              "items": {
                "type": "string",
                "format": "uuid"
              },
              "maxItems": 50
            },
            "labelMode": {
              "type": "string",
              "enum": [
                "any",
                "all"
              ],
              "default": "any"
            },
            "excludeLabelIds": {
              "type": "array",
              "items": {
                "type": "string",
                "format": "uuid"
              },
              "maxItems": 50
            },
            "stageIds": {
              "type": "array",
              "items": {
                "type": "string",
                "format": "uuid"
              },
              "maxItems": 50
            },
            "noStage": {
              "type": "boolean"
            },
            "ownerIds": {
              "type": "array",
              "items": {
                "type": "string",
                "format": "uuid"
              },
              "maxItems": 50
            },
            "sources": {
              "type": "array",
              "items": {
                "type": "string",
                "maxLength": 40
              },
              "maxItems": 20
            },
            "listIds": {
              "type": "array",
              "items": {
                "type": "string",
                "format": "uuid"
              },
              "maxItems": 20
            },
            "accountId": {
              "type": "string",
              "format": "uuid"
            },
            "relations": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "stranger",
                  "request_sent",
                  "request_received",
                  "friend",
                  "blocked"
                ]
              },
              "maxItems": 5
            },
            "hasPhone": {
              "type": "boolean"
            },
            "hasZalo": {
              "type": "boolean"
            },
            "dnc": {
              "type": "string",
              "enum": [
                "exclude",
                "only",
                "include"
              ],
              "default": "include"
            },
            "interactedWithinDays": {
              "type": "integer",
              "minimum": 1,
              "maximum": 3650
            },
            "notInteractedDays": {
              "type": "integer",
              "minimum": 1,
              "maximum": 3650
            }
          },
          "additionalProperties": false,
          "nullable": true,
          "default": null
        },
        "contactIds": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "uuid"
          },
          "maxItems": 5000,
          "default": []
        },
        "excludeLabelIds": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "uuid"
          },
          "maxItems": 20,
          "default": []
        },
        "allowOverlap": {
          "type": "boolean",
          "default": false
        }
      },
      "additionalProperties": false
    }
  },
  "required": [
    "campaignId"
  ],
  "additionalProperties": false
}

Cùng bộ công cụ