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

# Get campaign receipts

> Provider receipts of the messages a campaign sent: how many were accepted,
delivered, read or failed. The counts are cumulative (a read message is also
delivered and sent) and are recomputed every few minutes, so they trail the
dispatch progress, which is live. `campaignReceipts` is null until the
campaign has sent a message and the counts have been recomputed since.



## OpenAPI

````yaml /api/services-api.yaml get /v1/tenants/{tenantID}/campaigns/{campaignID}/receipts
openapi: 3.0.3
info:
  description: >-
    Talqui is an omnichannel customer service platform that unifies
    conversations from WhatsApp, Instagram, Telegram, and many other channels
    into a single attendant panel, alongside a broader ecosystem of plugins and
    integrations. This API gives developers programmatic access to Talqui's
    services layer, exposing the operations needed to read and manage tenants,
    conversations, plugins, and related resources that power that platform.


    Authentication is available on behalf of an Operator (the default for this
    API), a Plugin Connection, or a Plugin — see the [Talqui authentication
    guide](https://docs.talqui.chat/guides/introduction/authentication/) for how
    each token is obtained and when to use it.


    Need help or have questions not covered here? Reach out to
    support@talqui.com.
  license:
    name: ISC
    url: https://opensource.org/license/isc-license-txt
  title: Talqui - Services API
  version: 0.111.0
servers:
  - description: Production
    url: https://services-api.talqui.chat
security: []
tags:
  - name: Tenants
  - name: Settings
  - name: Analytics/Reports
  - name: Analytics
  - name: Campaigns
  - name: Campaigns/Models
  - name: Contacts
  - name: Contacts/Imports
  - name: Handoff links
  - name: Inboxes
  - name: Messages
  - name: Notifications
  - name: Sessions
  - name: Operators/Shortcuts
  - name: Operators
  - name: Plugins
  - name: Milestones
  - name: Invites
paths:
  /v1/tenants/{tenantID}/campaigns/{campaignID}/receipts:
    get:
      tags:
        - Campaigns
      summary: Get campaign receipts
      description: >-
        Provider receipts of the messages a campaign sent: how many were
        accepted,

        delivered, read or failed. The counts are cumulative (a read message is
        also

        delivered and sent) and are recomputed every few minutes, so they trail
        the

        dispatch progress, which is live. `campaignReceipts` is null until the

        campaign has sent a message and the counts have been recomputed since.
      operationId: GetCampaignReceiptsController
      parameters:
        - in: path
          name: tenantID
          required: true
          schema:
            description: The tenant the campaign belongs to.
            format: uuid
            pattern: >-
              ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
            type: string
        - in: path
          name: campaignID
          required: true
          schema:
            description: The campaign to read the receipts of.
            format: uuid
            pattern: >-
              ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  campaignReceipts:
                    additionalProperties: false
                    description: The receipts, or null while there is nothing to count yet.
                    nullable: true
                    properties:
                      campaignID:
                        description: The campaign these receipts belong to.
                        type: string
                      campaignMessagesCount:
                        description: Messages produced by the campaign dispatches so far.
                        type: number
                      campaignMessagesDeliveredCount:
                        description: >-
                          Messages delivered to the recipient, including the
                          ones already read. Cumulative.
                        type: number
                      campaignMessagesFailedCount:
                        description: Messages the provider refused or could not deliver.
                        type: number
                      campaignMessagesReadCount:
                        description: Messages read by the recipient.
                        type: number
                      campaignMessagesSentCount:
                        description: >-
                          Messages accepted by the provider: sent, delivered or
                          read. Cumulative.
                        type: number
                      tenantID:
                        description: The tenant this campaign belongs to.
                        type: string
                      updatedAt:
                        description: >-
                          When these counts were last recomputed. They trail the
                          dispatch by a few minutes.
                        format: date-time
                        type: string
                    required:
                      - tenantID
                      - campaignID
                      - campaignMessagesCount
                      - campaignMessagesSentCount
                      - campaignMessagesDeliveredCount
                      - campaignMessagesReadCount
                      - campaignMessagesFailedCount
                      - updatedAt
                    type: object
                required:
                  - campaignReceipts
                type: object
          description: Response for status 200.
        '400':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      oneOf:
                        - $ref: '#/components/schemas/MissingTenantIDError'
                        - $ref: '#/components/schemas/MissingCampaignIDError'
                        - $ref: '#/components/schemas/RequestValidationError'
                    maxItems: 1
                    minItems: 1
                    type: array
                required:
                  - errors
                type: object
          description: >-
            MissingTenantIDError (error_code 1001): tenantID absent from the
            URL. | MissingCampaignIDError (error_code 1741): campaignID absent
            from the URL. | RequestValidationError (error_code 1002): tenantID
            or campaignID is not a UUID.
        '401':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      $ref: '#/components/schemas/UnauthorizedError'
                    maxItems: 1
                    minItems: 1
                    type: array
                required:
                  - errors
                type: object
          description: 'UnauthorizedError (error_code 1003): missing/invalid operator token.'
        '403':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      $ref: '#/components/schemas/ForbiddenError'
                    maxItems: 1
                    minItems: 1
                    type: array
                required:
                  - errors
                type: object
          description: 'ForbiddenError (error_code 1004): operator token rejected upstream.'
        '500':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      $ref: '#/components/schemas/UnknownError'
                    maxItems: 1
                    minItems: 1
                    type: array
                required:
                  - errors
                type: object
          description: >-
            UnknownError (error_code 5999): Unexpected internal error not
            otherwise documented for this endpoint.
      security:
        - operatorAuth: []
components:
  schemas:
    MissingTenantIDError:
      additionalProperties: false
      properties:
        error:
          enum:
            - MissingTenantIDError
          type: string
        error_code:
          enum:
            - 1001
          type: number
        message:
          example: tenantID is required.
          type: string
        statusCode:
          enum:
            - 400
          type: number
      required:
        - statusCode
        - error
        - error_code
        - message
      type: object
    MissingCampaignIDError:
      additionalProperties: false
      properties:
        error:
          enum:
            - MissingCampaignIDError
          type: string
        error_code:
          enum:
            - 1741
          type: number
        message:
          example: campaignID is required.
          type: string
        statusCode:
          enum:
            - 400
          type: number
      required:
        - statusCode
        - error
        - error_code
        - message
      type: object
    RequestValidationError:
      additionalProperties: false
      properties:
        error:
          enum:
            - RequestValidationError
          type: string
        error_code:
          enum:
            - 1002
          type: number
        fields:
          items:
            additionalProperties: false
            properties:
              allowed:
                type: string
              field:
                type: string
              received:
                type: string
            required:
              - field
              - received
              - allowed
            type: object
          type: array
        message:
          example: Invalid request data.
          type: string
        statusCode:
          enum:
            - 400
          type: number
      required:
        - statusCode
        - error
        - error_code
        - message
        - fields
      type: object
    UnauthorizedError:
      additionalProperties: false
      properties:
        error:
          enum:
            - UnauthorizedError
          type: string
        error_code:
          enum:
            - 1003
          type: number
        message:
          example: You are not authorized to perform this request.
          type: string
        statusCode:
          enum:
            - 401
          type: number
      required:
        - statusCode
        - error
        - error_code
        - message
      type: object
    ForbiddenError:
      additionalProperties: false
      properties:
        error:
          enum:
            - ForbiddenError
          type: string
        error_code:
          enum:
            - 1004
          type: number
        message:
          example: You do not have access to this resource.
          type: string
        statusCode:
          enum:
            - 403
          type: number
      required:
        - statusCode
        - error
        - error_code
        - message
      type: object
    UnknownError:
      additionalProperties: false
      properties:
        error:
          enum:
            - UnknownError
          type: string
        error_code:
          enum:
            - 5999
          type: number
        message:
          example: For some unknown reason your request has not succeeded.
          type: string
        statusCode:
          enum:
            - 500
          type: number
      required:
        - statusCode
        - error
        - error_code
        - message
      type: object
  securitySchemes:
    operatorAuth:
      bearerFormat: JWT
      description: >-
        Behalf of an Operator (default). A JWT issued by Talqui Core when an
        operator signs in, scoped to every tenant that operator belongs to. Send
        as `Authorization: Bearer <jwt-token>`.
      scheme: bearer
      type: http

````

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