> ## Documentation Index
> Fetch the complete documentation index at: https://docs.notifique.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Destinatários da campanha

> Lista os contatos que receberam ou receberão a campanha.



## OpenAPI

````yaml /contacts-api/api-reference/openapi-contacts.json get /v1/campaigns/{campaignId}/recipients
openapi: 3.0.3
info:
  title: Notifique API Contatos, tags e audiência
  description: >-
    API para **CRUD de contatos**, **tags**, **tópicos**, **segmentos** e
    **campanhas** (template + audiência + canais).


    **Contato:** pelo menos um de **phone** ou **email** (únicos por workspace).
    **Idiomas:** `languages` é um array de códigos BCP-47 permitidos (lista em
    **`GET /v1/meta/contact-locales`**); ordem = prioridade. **Telegram:** use
    **`telegramLinks`** (`instanceId` + `peer`) para várias instâncias Telegram
    no mesmo workspace; **`telegramPeer`** permanece como atalho legado
    (preenche a ligação na **instância Telegram padrão** do workspace). Na
    campanha, o peer usado é o da **`telegramInstanceId`** da campanha (ou
    default), com *fallback* para `telegramPeer`.


    **Campanhas:** `channels` pode incluir `whatsapp`, `sms`, `email`,
    `telegram`. Cada canal listado deve estar **habilitado no template**.
    **`instanceId`** = WhatsApp; **`telegramInstanceId`** = Telegram.


    **WhatsApp cartão:** `POST /v1/whatsapp/messages` com `type: "contact"` e
    `payload.contactId`.


    **Autenticação:** `Authorization: Bearer sk_live_xxxxx` ou `x-api-key`.


    **Escopos:** `contacts:*`, `tags:*`, `topics:*`, `segments:*`, `campaigns:*`
    (inclui `campaigns:run`).


    **Campanhas (extras):** `POST .../cancel` (DRAFT/SCHEDULED), `GET .../stats`
    e `GET .../recipients` (escopos update/read). Run devolve `runId`. Sending
    Pool WhatsApp: painel.
  version: 1.0.0
servers:
  - url: https://api.notifique.dev
    description: Produção
security:
  - ntfContactBearerAuth: []
  - ntfContactApiKeyHeader: []
tags:
  - name: Contatos
    description: CRUD de contatos do workspace (phone ou email; tags)
  - name: Tags
    description: Tags (rótulos) para vincular a contatos
  - name: Tópicos
    description: Tópicos de comunicação (marketing / opt-in por tema)
  - name: Segmentos
    description: >-
      Segmentos de audiencia (DSL v1). Regras: tag, property, contactField,
      topic, receiveMarketing. Escopos segments:read|create|update|delete.
  - name: Campanhas
    description: Campanhas multicanal com template; execução via POST .../run
paths:
  /v1/campaigns/{campaignId}/recipients:
    get:
      tags:
        - Campanhas
      summary: Destinatários da campanha
      description: Lista os contatos que receberam ou receberão a campanha.
      operationId: ntfContact_getV1CampaignRecipients
      parameters:
        - name: campaignId
          in: path
          required: true
          schema:
            type: string
        - name: channel
          in: query
          required: false
          schema:
            type: string
            enum:
              - whatsapp
              - sms
              - email
              - telegram
        - name: status
          in: query
          required: false
          schema:
            type: string
        - name: runId
          in: query
          required: false
          schema:
            type: string
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
        - name: pageSize
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 200
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfContact_CampaignRecipientsResponse'
        '401':
          description: Erro
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfContact_ErrorResponse'
        '402':
          description: Erro
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfContact_ErrorResponse'
        '403':
          description: Erro
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfContact_ErrorResponse'
        '404':
          description: Erro
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfContact_ErrorResponse'
components:
  schemas:
    NtfContact_CampaignRecipientsResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          type: object
          properties:
            rows:
              type: array
              items:
                $ref: '#/components/schemas/NtfContact_CampaignRecipient'
            total:
              type: integer
            page:
              type: integer
            pageSize:
              type: integer
    NtfContact_ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: string
          description: 'Rótulo HTTP do erro (ex.: Unauthorized, Bad Request, Not Found).'
        message:
          type: string
          description: >-
            Mensagem legível para exibir ao usuário (localizada via
            Accept-Language / x-locale quando aplicável).
        code:
          type: string
          description: >-
            Código estável da API v1 (enum). Sempre presente em erros. Use com o
            status HTTP para decidir retry ou correção. Ver [Respostas de
            erro](/guides/conceitos/resposta-de-erros).
      required:
        - success
        - error
        - message
        - code
    NtfContact_CampaignRecipient:
      type: object
      properties:
        id:
          type: string
        channel:
          $ref: '#/components/schemas/NtfContact_CampaignChannel'
        recipient:
          type: string
        contactId:
          type: string
          nullable: true
        status:
          type: string
        sentAt:
          type: string
          format: date-time
          nullable: true
        deliveredAt:
          type: string
          format: date-time
          nullable: true
        readAt:
          type: string
          format: date-time
          nullable: true
        clickedAt:
          type: string
          format: date-time
          nullable: true
        failedAt:
          type: string
          format: date-time
          nullable: true
        errorMessage:
          type: string
          nullable: true
        errorLabel:
          type: string
          nullable: true
        createdAt:
          type: string
          format: date-time
    NtfContact_CampaignChannel:
      type: string
      description: >-
        Canal na campanha (create/update): `whatsapp`, `sms`, `email`,
        `telegram`. Deve ser subconjunto dos canais habilitados no template.
        Templates podem habilitar RCS/Push/voz; a campanha via API/painel usa
        estes quatro.
      enum:
        - whatsapp
        - sms
        - email
        - telegram
  securitySchemes:
    ntfContactBearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: 'Authorization: Bearer sk_live_xxxxx'
    ntfContactApiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key
      description: 'x-api-key: sk_live_xxxxx'

````