Auth

Generate a resource-scoped JWT from a direct hash.

Changed on

Resolves a direct hash link and returns a resource-scoped JWT token. The token grants limited access to specific resource types associated with the direct hash (e.g., aicall for an AI direct hash). This endpoint is unauthenticated — the direct hash acts as the credential.

post/auth/boot

Request

  • Base URL
    https://api.voipbin.net/v1.0
  • URL
    https://api.voipbin.net/v1.0/auth/boot
  • Auth
    none declared

Request body

direct_hashstring required

The direct hash link (e.g., "direct.a1b2c3d4e5f6"). Obtained from resource direct hash endpoints such as POST /ais/{id}/direct_hash_regenerate.

Example request

{
  "direct_hash": "direct.a1b2c3d4e5f6"
}

Response

Resource-scoped JWT generated successfully.

tokenstring

JWT token string for API authentication. Pass as Bearer <token> in the Authorization header.

type'direct'

Token type. Always "direct" for boot tokens.

resource_typestring

The type of resource this token is scoped to (e.g., "ai").

resource_idstring uuid

The UUID of the resource this token is scoped to. Returned from the resource creation endpoint (e.g., POST /ais).

customer_idstring uuid

The UUID of the customer that owns the resource. Returned from the POST /auth/signup response.

expirestring date-time

Token expiry timestamp in ISO 8601 format.

allowed_resource_idstring uuid

The single resource this token may act on, assigned at boot before the resource exists. The resource created with this token takes this id, so two visitors of the same public link cannot reach each other's conversation. Clients do not need to send it anywhere; the server takes the target from the token.

scope_versioninteger

Version of the token's scope contract. Bumping it invalidates every outstanding token in one step; clients treat the resulting 401 as a signal to boot again.

Example response

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21lcl9pZCI6IjU1MGU4NDAwLWUyOWItNDFkNC1hNzE2LTQ0NjY1NTQ0MDAwMCJ9.abc123",
  "type": "direct",
  "resource_type": "ai",
  "resource_id": "550e8400-e29b-41d4-a716-446655440000",
  "customer_id": "660e8400-e29b-41d4-a716-446655440001",
  "expire": "2026-04-07T12:00:00Z",
  "allowed_resource_id": "770e8400-e29b-41d4-a716-446655440002",
  "scope_version": 2,
  "resource_data": {
    "public_display_config": {
      "primary_color": "#1a73e8",
      "secondary_color": "#f5f5f5",
      "header_background_color": "#1a73e8",
      "header_text_color": "#ffffff",
      "logo_url": "https://cdn.example.com/logo.png",
      "position": "bottom_right",
      "theme_mode": "light",
      "header_title": "Support",
      "header_subtitle": "We usually reply in a few minutes",
      "connecting_indicator_enabled": true,
      "connecting_indicator_text": "Connecting…",
      "typing_indicator_enabled": true,
      "border_radius": "rounded",
      "font_size": "default"
    }
  }
}

Changes

  • 7b9e8b2dd029Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 4357c568bf8cRevision changes
    • info

      added the optional property to the response with the status