add public documentation for WA outbound metrics api

Author: akashbdj

descriptions/0/api.intercom.io.yaml

@@ -8960,6 +8960,188 @@ paths:
                     id: 6762f23b1bb69f9f2193bc1d
                   message_type: sms
                   body: heyy https://picsum.photos/200/300
+  "/messages/status":
+    get:
+      summary: Get WhatsApp message status
+      parameters:
+      - name: Intercom-Version
+        in: header
+        schema:
+          "$ref": "#/components/schemas/intercom_version"
+      - name: ruleset_id
+        in: query
+        required: true
+        description: The unique identifier for the set of WhatsApp messages to check status for
+        schema:
+          type: string
+      - name: per_page
+        in: query
+        required: false
+        description: Number of results per page (default 50, max 100)
+        schema:
+          type: integer
+          default: 50
+          maximum: 100
+      - name: starting_after
+        in: query
+        required: false
+        description: Cursor for pagination, used to fetch the next page of results
+        schema:
+          type: string
+      tags:
+      - Messages
+      - WhatsApp
+      operationId: getWhatsAppMessageStatus
+      description: |
+        Retrieves the status of outbound WhatsApp messages based on a ruleset ID.
+        
+        This endpoint returns paginated status events for WhatsApp messages, providing
+        information about delivery state and related message details.
+        
+        > 🚧 Feature Flag Required
+        >
+        > This endpoint requires the "team-channels-whatsapp-outbound-api" feature to be enabled.
+      responses:
+        '200':
+          description: Successful response
+          content:
+            application/json:
+              examples:
+                Successful response:
+                  value:
+                    type: "list"
+                    ruleset_id: "12345"
+                    pages:
+                      type: "pages"
+                      per_page: 50
+                      total_pages: 3
+                      next:
+                        starting_after: "abc123"
+                    total_count: 125
+                    events:
+                      - id: "event_1"
+                        conversation_id: "conv_123"
+                        status: "delivered"
+                        type: "broadcast_outbound"
+                        created_at: 1734537980
+                        updated_at: 1734538000
+                        whatsapp_message_id: "wamid_123"
+                        template_name: "appointment_reminder"
+                      - id: "event_2"
+                        conversation_id: "conv_456"
+                        status: "sent"
+                        type: "broadcast_outbound"
+                        created_at: 1734537970
+                        updated_at: 1734538010
+                        whatsapp_message_id: "wamid_456"
+                        template_name: "order_update"
+              schema:
+                type: object
+                required:
+                  - type
+                  - ruleset_id
+                  - pages
+                  - total_count
+                  - events
+                properties:
+                  type:
+                    type: string
+                    enum: ["list"]
+                  ruleset_id:
+                    type: string
+                    description: The provided ruleset ID
+                  pages:
+                    type: object
+                    required:
+                      - type
+                      - per_page
+                      - total_pages
+                    properties:
+                      type:
+                        type: string
+                        enum: ["pages"]
+                      per_page:
+                        type: integer
+                        description: Number of results per page
+                      total_pages:
+                        type: integer
+                        description: Total number of pages
+                      next:
+                        type: object
+                        nullable: true
+                        description: Information for fetching next page (null if no more pages)
+                        properties:
+                          starting_after:
+                            type: string
+                            description: Cursor for the next page
+                  total_count:
+                    type: integer
+                    description: Total number of events
+                  events:
+                    type: array
+                    items:
+                      type: object
+                      required:
+                        - id
+                        - conversation_id
+                        - status
+                        - type
+                        - created_at
+                        - updated_at
+                        - whatsapp_message_id
+                      properties:
+                        id:
+                          type: string
+                          description: Event ID
+                        conversation_id:
+                          type: string
+                          description: ID of the conversation
+                        status:
+                          type: string
+                          description: Current status of the message
+                          enum: ["queued", "sent", "delivered", "read", "failed"]
+                        type:
+                          type: string
+                          description: Event type
+                          enum: ["broadcast_outbound"]
+                        created_at:
+                          type: integer
+                          description: Creation timestamp
+                        updated_at:
+                          type: integer
+                          description: Last update timestamp
+                        whatsapp_message_id:
+                          type: string
+                          description: WhatsApp's message identifier
+                        template_name:
+                          type: string
+                          description: Name of the WhatsApp template used
+        '400':
+          description: Bad request - missing required parameters
+          content:
+            application/json:
+              examples:
+                missing ruleset_id:
+                  value:
+                    type: error
+                    request_id: "req_123"
+                    message: "Missing required parameter: ruleset_id"
+        '401':
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/authentication_error"
+        '403':
+          description: Forbidden - feature flag not enabled
+          content:
+            application/json:
+              examples:
+                feature not enabled:
+                  value:
+                    type: error
+                    request_id: "req_456"
+                    message: "Feature 'team-channels-whatsapp-outbound-api' is not enabled for this workspace"
   "/news/news_items":
     get:
       summary: List all news items