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

# Programar llamada saliente con cuestionario externo

> Crea una llamada outbound en estado `pending`, vinculada a un `questionnaireId`. Usa `schedulingWindow` si quieres acotar fecha u horario.



## OpenAPI

````yaml /openapi/openapi-maria.yaml post /api/v1/calls/external-questionnaire
openapi: 3.1.0
info:
  title: marIA API
  version: 1.0.0
  description: >
    marIA es el agente de voz de Omniloy que atiende llamadas entrantes de
    pacientes en hospitales y clínicas.

    - Voice / Telefonía: el paciente llama y marIA responde, gestiona citas con
    el EHR/HIS, responde FAQs y escala a humano cuando es necesario.

    - Notificaciones WhatsApp: confirmaciones y recordatorios de cita por
    plantilla aprobada.

    - Centros y servicios: consulta y gestión de centros, especialidades y
    coberturas configuradas en marIA.

    - Base de conocimiento FAQ: documentos que alimentan el conocimiento del
    agente sobre centros y servicios.

    - Llamadas salientes y cuestionarios: programación outbound y cuestionarios
    de seguimiento.

    - Integración EHR/HIS mediante webhooks: marIA ⇄ Hospital para beneficios,
    huecos y citas.

    - Gestión de webhooks: registro y configuración de endpoints para recibir
    eventos de marIA.

    Los webhooks top‑level notifican eventos (p. ej. estado de llamadas, citas)
    firmados con `webhookHmac`.
servers:
  - url: https://{your-prod-endpoint}
    description: Producción
    variables:
      your-prod-endpoint:
        default: your-prod-endpoint
        description: Sustituye este valor por el host real antes de probar la petición.
  - url: https://{your-dev-endpoint}
    description: Staging
    variables:
      your-dev-endpoint:
        default: your-dev-endpoint
        description: Sustituye este valor por el host de staging o desarrollo.
security: []
tags:
  - name: Health
    description: Estado y disponibilidad del servicio.
  - name: Centers
    description: Centros médicos con sus servicios y coberturas configurados en marIA.
  - name: WhatsApp Notifications
    description: Envío de confirmaciones y recordatorios de cita por plantilla de WhatsApp.
  - name: FAQ
    description: >-
      Documentos FAQ para que el agente pueda responder preguntas sobre centros
      y servicios.
  - name: Webhooks - Appointments
    description: Eventos de citas integradas con el EHR/HIS.
  - name: Webhooks - Voice
    description: >-
      Eventos de telefonía (estado de llamada, escalado, respuestas y
      transcripciones).
  - name: Voice Calls
    description: Gestión de llamadas entrantes y salientes registradas en MarIA Core.
  - name: Voice Answers
    description: Acceso y filtrado de respuestas capturadas durante llamadas.
  - name: Voice Transcripts
    description: Acceso a transcripciones y enlaces de grabación.
  - name: Content - Questionnaires
    description: Definición de cuestionarios para llamadas salientes.
  - name: Questionnaire Instances
    description: Estado, revisión y resultados de instancias de cuestionario.
  - name: Scheduling - Time Ranges
    description: Rangos horarios reutilizables para programar llamadas.
  - name: Gestión de webhooks
    description: Configuración y gestión de webhooks; endpoints para integradores.
paths:
  /api/v1/calls/external-questionnaire:
    post:
      tags:
        - Voice Calls
      summary: Programar llamada saliente con cuestionario externo
      description: >-
        Crea una llamada outbound en estado `pending`, vinculada a un
        `questionnaireId`. Usa `schedulingWindow` si quieres acotar fecha u
        horario.
      operationId: schedule-external-questionnaire-call
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalQuestionnaireCallInputDto'
            example:
              name: Ana
              surname1: García
              phone: '+34612345678'
              questionnaireId: 550e8400-e29b-41d4-a716-446655440000
              externalId: case-123
              schedulingWindow:
                date: '2026-05-12'
                startTime: '10:00'
                endTime: '12:00'
              metadata:
                source: ehr
      responses:
        '201':
          description: Creada
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCallEnvelopeDto'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDto'
        '404':
          description: Cuestionario no encontrado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDto'
      security:
        - apiKeyAuth: []
components:
  schemas:
    ExternalQuestionnaireCallInputDto:
      type: object
      properties:
        name:
          type: string
        surname1:
          type: string
        surname2:
          type: string
        phone:
          type: string
          example: '+34612345678'
        questionnaireId:
          type: string
          format: uuid
        externalId:
          type: string
        schedulingWindow:
          $ref: '#/components/schemas/SchedulingWindowDto'
        metadata:
          type: object
          additionalProperties: true
      required:
        - name
        - phone
        - questionnaireId
    CreateCallEnvelopeDto:
      type: object
      properties:
        success:
          type: boolean
        data:
          type: object
          properties:
            callId:
              type: string
              format: uuid
            call:
              $ref: '#/components/schemas/CallCoreDto'
    ErrorDto:
      type: object
      properties:
        status:
          type: string
          enum:
            - error
        code:
          type: integer
        error_code:
          type: string
        message:
          type: string
      required:
        - status
        - code
        - error_code
        - message
    SchedulingWindowDto:
      type: object
      properties:
        date:
          type: string
          pattern: ^\d{4}-\d{2}-\d{2}$
        startTime:
          type: string
          pattern: ^\d{2}:\d{2}$
        endTime:
          type: string
          pattern: ^\d{2}:\d{2}$
        allowedDaysOfWeek:
          type: array
          items:
            type: integer
            minimum: 0
            maximum: 6
    CallCoreDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
        apiKeyId:
          type: string
        endUserId:
          type: string
        questionnaireInstanceId:
          type: string
        callDirection:
          type: string
          enum:
            - inbound
            - outbound
        status:
          type: string
          enum:
            - pending
            - dialing
            - failure
            - no_answer
            - in_progress
            - rejected
            - success
            - transferred
            - canceled
            - service_off
        scheduledAt:
          type: string
          format: date-time
        startedAt:
          type: string
          format: date-time
        endedAt:
          type: string
          format: date-time
        schedulingWindow:
          $ref: '#/components/schemas/SchedulingWindowDto'
        transcription:
          type: array
          items:
            type: object
            properties:
              speaker:
                type: string
                enum:
                  - patient
                  - operator
              content:
                type: string
              time:
                type: string
                format: date-time
        summary:
          type: string
        transferReason:
          type: string
        userIntent:
          type: string
        callResult:
          type: string
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
      description: >-
        API Key proporcionada por Omniloy. La misma key se usa para llamadas
        entrantes y salientes.

````