SignalWire WhatsApp Businesses API

openapi: 3.2.0
info:
  title: SignalWire REST WhatsApp Businesses API
  version: 1.0.0
  contact:
    name: SignalWire
    url: https://support.signalwire.com/portal/en/newticket?departmentId=1029313000000006907&layoutId=1029313000000074011
    email: support@signalwire.com
  license:
    name: MIT
    url: https://github.com/signalwire/docs/blob/main/LICENSE
  termsOfService: https://signalwire.com/legal/signalwire-cloud-agreement
  description: List the WhatsApp Business Accounts connected to your Space.
servers:
- url: https://{space_name}.signalwire.com
  description: SignalWire API
  variables:
    space_name:
      default: '{Your_Space_Name}'
      description: Your SignalWire Space name
security:
- SignalWireBasicAuth: []
tags:
- name: WhatsApp Businesses
  description: List the WhatsApp Business Accounts connected to your Space.
  externalDocs:
    url: https://signalwire.com/docs/apis
    description: Developer documentation on Message API endpoints
paths:
  /api/messaging/whatsapp/businesses:
    get:
      operationId: list_whatsapp_businesses
      summary: List WhatsApp Business Accounts
      description: 'Returns the WhatsApp Business Accounts (WABAs) connected to your SignalWire Space. Each account can have its own set of phone numbers and message templates. Use a `whatsapp_business_id` from this list when creating or filtering [message templates](/docs/platform/messaging/whatsapp/message-templates).


        #### Permissions


        The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Numbers_.


        [Learn more about API scopes](/docs/platform/your-signalwire-api-space).'
      parameters: []
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WhatsAppBusinessListResponse'
        '401':
          description: Access is unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode401'
        '500':
          description: An internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode500'
      tags:
      - WhatsApp Businesses
components:
  schemas:
    WhatsAppBusinessListResponse:
      type: object
      required:
      - data
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/WhatsAppBusiness'
          description: List of WhatsApp Business Accounts connected to the Space.
      unevaluatedProperties:
        not: {}
      description: Response containing a list of WhatsApp Business Accounts.
    Types.StatusCodes.StatusCode401:
      type: object
      required:
      - error
      properties:
        error:
          type: string
          enum:
          - Unauthorized
      unevaluatedProperties:
        not: {}
      description: Access is unauthorized.
    uuid:
      type: string
      format: uuid
      description: Universal Unique Identifier.
    Types.StatusCodes.StatusCode500:
      type: object
      required:
      - error
      properties:
        error:
          type: string
          enum:
          - Internal Server Error
      unevaluatedProperties:
        not: {}
      description: An internal server error occurred.
    WhatsAppBusiness:
      type: object
      required:
      - whatsapp_business_id
      - business_name
      - business_portfolio_id
      - waba_id
      - created_at
      - updated_at
      properties:
        whatsapp_business_id:
          allOf:
          - $ref: '#/components/schemas/uuid'
          description: The SignalWire identifier for the WhatsApp Business Account. Use this value as `whatsapp_business_id` when creating or listing templates.
          examples:
          - 3fa85f64-5717-4562-b3fc-2c963f66afa6
        business_name:
          anyOf:
          - type: string
          - type: 'null'
          description: The business name as registered with Meta.
          examples:
          - Acme, Inc.
        business_portfolio_id:
          anyOf:
          - type: string
          - type: 'null'
          description: The Meta business portfolio ID associated with the account.
          examples:
          - '1234567890'
        waba_id:
          type: string
          description: The WhatsApp Business Account ID (WABA ID) assigned by Meta.
          examples:
          - '109876543210987'
        created_at:
          type: string
          description: The date and time when the record was created.
          examples:
          - '2024-01-15T10:30:00Z'
        updated_at:
          type: string
          description: The date and time when the record was last updated.
          examples:
          - '2024-01-15T10:30:00Z'
      unevaluatedProperties:
        not: {}
      description: A WhatsApp Business Account (WABA) connected to your SignalWire Space. Each business account can have its own set of phone numbers and message templates.
  securitySchemes:
    SignalWireBasicAuth:
      type: http
      scheme: Basic
      description: 'SignalWire Basic Authentication using Project ID and API Token.


        The client sends HTTP requests with the Authorization header containing

        the word Basic followed by a space and a base64-encoded string of project_id:token.

        The project ID will be used as the username and the API token as the password.


        Example:

        ```

        Authorization: Basic base64(project_id:token)

        ```'
      x-fern-basic:
        username:
          name: project_id
          env: SIGNALWIRE_PROJECT_ID
        password:
          name: api_token
          env: SIGNALWIRE_API_TOKEN
    SignalWireBearerAuth:
      type: http
      scheme: Bearer
      description: 'SignalWire Bearer Token Authentication for subscriber endpoints.

        The client sends HTTP requests with the Authorization header containing

        the word Bearer followed by a space and the subscriber token.


        Example:

        ```

        Authorization: Bearer <subscriber_token>

        ```'