> ## Documentation Index > Fetch the complete documentation index at: https://messenger-docs.cogfy.com/llms.txt > Use this file to discover all available pages before exploring further. # List messages of a broadcast > Returns a paginated list of messages for a specific broadcast. Use the `status` query parameter to filter by message status. ## OpenAPI ````yaml GET /broadcasts/{broadcastId}/messages openapi: 3.1.0 info: title: Cogfy Messenger Public API version: 1.0.0 description: API for interacting with the Cogfy Messenger platform servers: - url: https://messenger-public-api.cogfy.com description: Production server - url: http://localhost:3100 description: Local server security: - ApiKeyAuth: [] paths: /broadcasts/{broadcastId}/messages: get: tags: - Broadcasts summary: List messages of a broadcast description: >- Returns a paginated list of messages for a specific broadcast. Use the `status` query parameter to filter by message status. parameters: - in: path name: broadcastId schema: type: string 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)$ required: true - in: query name: cursor schema: description: >- Opaque cursor returned by a previous call, used to fetch the next page type: string description: >- Opaque cursor returned by a previous call, used to fetch the next page - in: query name: status schema: description: >- Filter by broadcast message status. Possible values: - `pending` — Message queued, not yet sent to WhatsApp. - `sent` — Message sent to WhatsApp, awaiting delivery confirmation. - `delivered` — WhatsApp confirmed the message was delivered to the recipient. - `read` — WhatsApp confirmed the recipient read the message. - `failed` — The send attempt or WhatsApp delivery failed. - `skipped` — The recipient was skipped (e.g., marketing opt-out). type: string description: >- Filter by broadcast message status. Possible values: - `pending` — Message queued, not yet sent to WhatsApp. - `sent` — Message sent to WhatsApp, awaiting delivery confirmation. - `delivered` — WhatsApp confirmed the message was delivered to the recipient. - `read` — WhatsApp confirmed the recipient read the message. - `failed` — The send attempt or WhatsApp delivery failed. - `skipped` — The recipient was skipped (e.g., marketing opt-out). responses: '200': description: A paginated list of broadcast messages content: application/json: schema: type: object properties: data: type: array items: type: object properties: id: type: string 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)$ contactPhoneNumber: anyOf: - type: string - type: 'null' status: anyOf: - type: string - type: 'null' description: >- Status of the broadcast message. Possible values: - `pending` — Message queued, not yet sent to WhatsApp. - `sent` — Message sent to WhatsApp, awaiting delivery confirmation. - `delivered` — WhatsApp confirmed the message was delivered to the recipient. - `read` — WhatsApp confirmed the recipient read the message. - `failed` — The send attempt or WhatsApp delivery failed. - `skipped` — The recipient was skipped (e.g., marketing opt-out). batchNumber: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' messageId: anyOf: - type: string 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: 'null' content: anyOf: - type: string - type: 'null' type: anyOf: - type: string - type: 'null' from: anyOf: - type: string - type: 'null' to: anyOf: - type: string - type: 'null' sendDate: anyOf: - type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ - type: 'null' deliverDate: anyOf: - type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ - type: 'null' readDate: anyOf: - type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ - type: 'null' createDate: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ required: - id - contactPhoneNumber - status - batchNumber - messageId - content - type - from - to - sendDate - deliverDate - readDate - createDate additionalProperties: false cursors: type: object properties: next: description: >- Opaque cursor to fetch the next page. Absent when there are no more results type: string additionalProperties: false required: - data additionalProperties: false '404': description: Broadcast not found components: securitySchemes: ApiKeyAuth: type: apiKey in: header name: api-key ````