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

# Verify a WhatsApp connection

> Calls your provider with the stored credentials and records the outcome. A connection must be `ACTIVE` before `POST /messaging/send` will accept it. On failure the reason lands in `last_error_message`.



## OpenAPI

````yaml /openapi.json post /messaging/connections/{connectionId}/verify
openapi: 3.1.0
info:
  title: Vocobase API
  version: '2.0'
  description: >-
    API for managing voice AI agents, documents, and calls on the Vocobase
    platform.
servers:
  - url: https://api.vocobase.com/api/v2
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Config
    description: >-
      Read and update account configuration, webhook settings, and telephony
      credentials.
  - name: Agents
    description: Create, read, update, and delete voice AI agents.
  - name: Voices
    description: >-
      List voice tiers, available voices, and stream preview audio for agent
      configuration.
  - name: Documents
    description: Upload, manage, and delete knowledge base documents.
  - name: Agent Documents
    description: Link and unlink documents to agents for knowledge base integration.
  - name: Calls
    description: Initiate outbound calls and view call history.
  - name: Phone Numbers
    description: >-
      Import DIDs, assign agents for inbound routing, and re-sync carrier
      Application bindings.
  - name: Inbound Routing Policies
    description: >-
      Define pre-answer routing decisions for inbound calls before AI sessions
      are created.
  - name: Telephony Connections
    description: Create, list, rename, and disconnect named V2 telephony connections.
  - name: VoiceLink Management
    description: Manage VoiceLink reseller clients, DID mapping, and readiness sync.
  - name: Projects
    description: Organize agents into projects. Every agent belongs to exactly one project.
  - name: Dictionaries
    description: Speech-recognition dictionary CRUD and agent attachment.
  - name: Sessions
    description: Browser-initiated WebRTC voice sessions for in-app voice agents.
  - name: Campaigns
    description: Batch outbound calling.
  - name: Billing
    description: Balance, transactions, and usage summaries.
  - name: Custom Functions
    description: HTTP endpoints the agent can call mid-conversation.
  - name: Extraction Sets
    description: Reusable sets of post-call extraction fields.
  - name: Lifecycle Hooks
    description: Automatic pre-call and post-call integration steps.
  - name: Messaging
    description: Bring-your-own WhatsApp sending.
  - name: Integration Logs
    description: Audit trail for integration calls.
  - name: Connectors
    description: Catalog of tools an agent can be connected to.
  - name: Customers
    description: B2B2B sub-tenants and their tool connections.
  - name: Agent Tools
    description: Binding connectors and connections to an agent.
paths:
  /messaging/connections/{connectionId}/verify:
    post:
      tags:
        - Messaging
      summary: Verify a WhatsApp connection
      description: >-
        Calls your provider with the stored credentials and records the outcome.
        A connection must be `ACTIVE` before `POST /messaging/send` will accept
        it. On failure the reason lands in `last_error_message`.
      operationId: verifyMessagingConnection
      parameters:
        - name: connectionId
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: Connection ID.
      responses:
        '200':
          description: The connection with its refreshed status.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    const: true
                  data:
                    type: object
                    properties:
                      connection:
                        $ref: '#/components/schemas/MessagingConnection'
              example:
                success: true
                data:
                  connection:
                    id: mc_4d5e6f70-8192-a3b4-c5d6-e7f809122334
                    connection_id: mc_4d5e6f70-8192-a3b4-c5d6-e7f809122334
                    provider: aisensy
                    api_mode: campaign
                    channel: whatsapp
                    name: AiSensy — Sales
                    status: ACTIVE
                    is_default: true
                    credentials:
                      api_key: sk_l****9f2c
                    webhook_url: >-
                      https://api.vocobase.com/api/whatsapp/webhooks/aisensy/7c1f9a2b4d6e8013
                    webhook_secret_set: true
                    last_verified_at: '2026-08-22T10:05:00.000Z'
                    last_error_message: null
                    created_at: '2026-08-22T09:58:00.000Z'
                    updated_at: '2026-08-22T10:05:00.000Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimitExceeded'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  schemas:
    MessagingConnection:
      type: object
      properties:
        id:
          type: string
          format: uuid
        connection_id:
          type: string
          format: uuid
          description: Same value as `id`.
        provider:
          type: string
          enum:
            - aisensy
            - interakt
        api_mode:
          type: string
          enum:
            - campaign
            - project
          nullable: true
          description: AiSensy only. Decides which credentials and which send fields apply.
        channel:
          type: string
          enum:
            - whatsapp
        name:
          type: string
        status:
          type: string
          description: '`ACTIVE` once verified.'
        is_default:
          type: boolean
        credentials:
          type: object
          additionalProperties: true
          description: Masked. Secrets are encrypted at rest and never returned in full.
        webhook_url:
          type: string
          format: uri
          description: >-
            Paste this into your provider dashboard to receive delivery-status
            webhooks.
        webhook_secret_set:
          type: boolean
          description: >-
            Whether a signing secret is stored. The secret itself is never
            returned.
        last_verified_at:
          type: string
          format: date-time
          nullable: true
        last_error_message:
          type: string
          nullable: true
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          const: false
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
          required:
            - code
            - message
      required:
        - success
        - error
  responses:
    Unauthorized:
      description: Missing or invalid API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            error:
              code: UNAUTHORIZED
              message: Invalid or missing API key
    NotFound:
      description: Resource not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            error:
              code: NOT_FOUND
              message: Resource not found
    RateLimitExceeded:
      description: Per-account rate limit exceeded. Retry after a short backoff.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            error:
              code: RATE_LIMITED
              message: Rate limit exceeded. Retry after 60 seconds.
    InternalError:
      description: Unexpected server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            error:
              code: INTERNAL_ERROR
              message: An unexpected error occurred
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key in format: `rg_live_xxxx`. Pass as a Bearer token in the
        Authorization header.

````