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

# Create web call

> Create an in-browser web call and return SIP WebRTC details for a browser softphone.



## OpenAPI

````yaml /openapi.yaml post /api/v1/create-web-call
openapi: 3.1.0
info:
  title: Voxworks API
  version: 1.0.0
  description: >-
    Public REST API for creating contacts, scheduling calls, retrieving call
    results, managing lists and objects, and receiving automation webhooks.
servers:
  - url: https://api.voxworks.ai
    description: Production
security:
  - BearerAuth: []
tags:
  - name: Health
  - name: Contacts
  - name: Calls
  - name: Lists
  - name: Objects
  - name: Webhooks
paths:
  /api/v1/create-web-call:
    post:
      tags:
        - Calls
      summary: Create web call
      description: >-
        Create an in-browser web call and return SIP WebRTC details for a
        browser softphone.
      operationId: createWebCall
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateWebCallRequest'
            example:
              script_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890
              contact_id: a1b2c3d4-5678-90ab-cdef-1234567890ab
      responses:
        '201':
          description: Web call created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateWebCallResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    CreateWebCallRequest:
      type: object
      required:
        - script_id
      properties:
        script_id:
          type: string
        contact_id:
          type: string
        did:
          type: string
          description: Optional SIP destination/user value. Defaults to `web`.
        participant_identity:
          type: string
        objects:
          type: object
          additionalProperties:
            type: object
            additionalProperties: true
    CreateWebCallResponse:
      allOf:
        - $ref: '#/components/schemas/CreateCallResponse'
        - type: object
          properties:
            script_id:
              type: string
            did:
              type:
                - string
                - 'null'
            ws_url:
              type: string
            sip_domain:
              type: string
            sip_username:
              type: string
            sip_password:
              type: string
            target:
              type: string
            headers:
              type: object
              additionalProperties:
                type: string
    CreateCallResponse:
      type: object
      required:
        - success
        - call_id
        - contact_id
        - status
      properties:
        success:
          type: boolean
          example: true
        call_id:
          type: string
        contact_id:
          type: string
        status:
          type: string
          example: scheduled
    ErrorResponse:
      type: object
      required:
        - success
        - message
      properties:
        success:
          type: boolean
          example: false
        message:
          type: string
  responses:
    BadRequest:
      description: Missing or invalid request data.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Missing, malformed, or invalid authorization.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            invalid:
              value:
                success: false
                message: Invalid API key
    NotFound:
      description: The requested resource was not found or does not belong to your team.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    RateLimited:
      description: Rate limit exceeded.
      headers:
        Retry-After:
          schema:
            type: string
        X-RateLimit-Limit:
          schema:
            type: string
        X-RateLimit-Remaining:
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            message: Rate limit exceeded
    InternalServerError:
      description: Internal server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            message: Internal server error
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: 'API key from Voxworks, sent as `Authorization: Bearer YOUR_API_KEY`.'

````