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

# Get WhatsApp campaign

> A campaign with counts by status, what it has cost so far, and the latest failures.

Scope: `whatsapp:send`.



## OpenAPI

````yaml /openapi.json get /whatsapp/campaigns/{id}
openapi: 3.1.0
info:
  title: Messaly API
  version: 1.0.0
  description: >-
    SMS, WhatsApp, email, contacts and CRM for your business. Amounts are in
    KES. Authenticate with an API key (Settings → API keys). A key can be
    limited to scopes and to IP addresses; a key with no scopes can call every
    endpoint here.
servers:
  - url: https://app.telaven.com/api/v1
    description: Production
security:
  - bearerAuth: []
  - apiKeyHeader: []
tags:
  - name: Account
    description: Wallet balance and SMS pricing.
  - name: SMS
    description: Send SMS and read messages and analytics.
  - name: SMS campaigns
    description: Create, schedule and send SMS campaigns to lists and tags.
  - name: Contacts
    description: Contacts and contact lists.
  - name: WhatsApp
    description: Send approved WhatsApp templates.
  - name: Email
    description: Email campaigns and unsubscribes.
  - name: CRM
    description: Deals, companies and pipelines.
paths:
  /whatsapp/campaigns/{id}:
    get:
      tags:
        - WhatsApp
      summary: Get WhatsApp campaign
      description: >-
        A campaign with counts by status, what it has cost so far, and the
        latest failures.


        Scope: `whatsapp:send`.
      operationId: getWhatsappCampaign
      parameters:
        - name: id
          in: path
          required: true
          description: The campaign ID.
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                data:
                  id: c51a…
                  name: November offer
                  status: processing
                  totalRecipients: 1200
                  totalSent: 640
                  totalFailed: 3
                counts:
                  - status: sent
                    'n': 640
                    cost: 96000
                  - status: failed
                    'n': 3
                    cost: 0
                  - status: queued
                    'n': 557
                    cost: 0
                spentCents: 96000
                failures:
                  - phone: '+254700000001'
                    name: Ali
                    error: Recipient phone number not in allowed list
        '401':
          description: No API key, or the key is wrong, disabled or expired.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: >-
            The key doesn't have the scope this endpoint needs, or it's used
            from an address its IP allowlist doesn't include.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No campaign with that ID in your account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: >-
            More than 120 requests in a minute with this key. Wait for the
            number of seconds in Retry-After.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: >-
            Something went wrong on our side. Retry with backoff. A POST sent
            with an Idempotency-Key replays this same error for that key,
            because the request may have partly run: check the result before
            trying again with a new key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
        code:
          type: string
          description: Machine-readable code where one exists, e.g. INSUFFICIENT_BALANCE.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Authorization: Bearer tlv_…'
    apiKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.