InfiVoice Contacts API

openapi: 3.2.0
info:
  title: InfiVoice REST Contacts API
  description: Welcome to the InfiVoice REST API documentation. This API enables you to programmatically automate AI-powered voice communications at scale.
  version: 1.0.0
servers:
- url: /api/v1
  description: API v1
security:
- ApiKeyAuth: []
- BearerAuth: []
tags:
- name: Contacts
  description: 'Manage your leads and contacts with full CRUD operations. Contacts can be enriched with AI-generated summaries and sentiment analysis after calls.


    **Features:**

    - Store custom fields for personalization

    - Tag contacts for segmentation

    - Track lead stages through your funnel

    - Bulk import up to 10,000 contacts at once


    **AI Enrichment:** After a call, contacts are automatically updated with:

    - Conversation summary

    - Sentiment analysis

    - Lead score adjustments'
paths:
  /contacts:
    get:
      summary: List Contacts
      description: 'Retrieve all contacts from your CRM. Contacts are enriched with AI-generated data after calls.


        **Contact Data Includes:**

        - Basic info (name, phone, email, company)

        - Custom fields for personalization

        - Tags for segmentation

        - Lead stage and score

        - AI summary and sentiment (post-call)


        **Required Scope:** `contacts:read`'
      operationId: listContacts
      tags:
      - Contacts
      parameters:
      - $ref: '#/components/parameters/PageParam'
      - $ref: '#/components/parameters/PageSizeParam'
      responses:
        '200':
          description: List of contacts with enriched data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContactListResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
    post:
      summary: Create Contact
      description: 'Add a new contact to your CRM. The phone number is required; all other fields are optional.


        **Best Practices:**

        - Use E.164 format for phone numbers (+1234567890)

        - Add custom fields that your agents can reference

        - Use tags for easy filtering and segmentation


        **Required Scope:** `contacts:write`'
      operationId: createContact
      tags:
      - Contacts
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateContactRequest'
            examples:
              basic:
                summary: Basic contact
                value:
                  phone: '+14155551234'
                  firstName: John
                  lastName: Doe
                  email: john@example.com
              withCustomFields:
                summary: Contact with custom fields
                value:
                  phone: '+14155551234'
                  firstName: John
                  company: Acme Corp
                  tags:
                  - lead
                  - enterprise
                  customFields:
                    accountId: ACC-12345
                    preferredTime: morning
      responses:
        '201':
          description: Contact created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContactResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '409':
          $ref: '#/components/responses/Conflict'
  /contacts/{id}:
    get:
      summary: Get Contact Details
      description: 'Retrieve complete information about a contact including call history and AI enrichment.


        **AI Enrichment (after calls):**

        - `aiSummary` — AI-generated summary of conversations

        - `sentiment` — Detected sentiment (positive, neutral, negative)

        - `leadScore` — Automatically calculated lead score


        **Required Scope:** `contacts:read`'
      operationId: getContact
      tags:
      - Contacts
      parameters:
      - $ref: '#/components/parameters/IdParam'
      responses:
        '200':
          description: Complete contact details with AI enrichment
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContactResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    put:
      summary: Update Contact
      description: 'Update contact information. Only include fields you want to change.


        **Tip:** Update the `stage` field to move contacts through your sales funnel.


        **Required Scope:** `contacts:write`'
      operationId: updateContact
      tags:
      - Contacts
      parameters:
      - $ref: '#/components/parameters/IdParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateContactRequest'
      responses:
        '200':
          description: Contact updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContactResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    delete:
      summary: Delete Contact
      description: 'Permanently delete a contact and all associated data.


        **Warning:** This action cannot be undone. Call history remains but will no longer be linked to this contact.


        **Required Scope:** `contacts:write`'
      operationId: deleteContact
      tags:
      - Contacts
      parameters:
      - $ref: '#/components/parameters/IdParam'
      responses:
        '200':
          description: Contact permanently deleted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /contacts/bulk-import:
    post:
      summary: Bulk Import Contacts
      description: 'Import up to 10,000 contacts in a single request. Ideal for syncing from external CRMs or uploading lists.


        **Behavior:**

        - Duplicate phone numbers are skipped

        - Invalid records are counted in `failed` response field

        - Import is atomic — all succeed or detailed errors returned


        **Performance Tip:** For very large imports, batch into multiple requests of 5,000 contacts each.


        **Required Scope:** `contacts:write`'
      operationId: bulkImportContacts
      tags:
      - Contacts
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImportRequest'
      responses:
        '201':
          description: Import completed with success/failure counts
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkImportResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    CreateContactRequest:
      type: object
      required:
      - phone
      properties:
        phone:
          type: string
          minLength: 10
        firstName:
          type: string
        lastName:
          type: string
        email:
          type: string
          format: email
        company:
          type: string
        tags:
          type: array
          items:
            type: string
        customFields:
          type: object
          additionalProperties: true
    Contact:
      type: object
      properties:
        id:
          type: string
          format: uuid
        phone:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        email:
          type: string
        company:
          type: string
        tags:
          type: array
          items:
            type: string
        customFields:
          type: object
        stage:
          type: string
        leadScore:
          type: integer
        aiSummary:
          type: string
        sentiment:
          type: string
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    ContactResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          $ref: '#/components/schemas/Contact'
        meta:
          $ref: '#/components/schemas/Meta'
    Meta:
      type: object
      properties:
        requestId:
          type: string
          format: uuid
        timestamp:
          type: string
          format: date-time
    UpdateContactRequest:
      type: object
      properties:
        phone:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        email:
          type: string
          format: email
        company:
          type: string
        tags:
          type: array
          items:
            type: string
        customFields:
          type: object
        stage:
          type: string
    PaginationMeta:
      allOf:
      - $ref: '#/components/schemas/Meta'
      - type: object
        properties:
          pagination:
            type: object
            properties:
              page:
                type: integer
              pageSize:
                type: integer
              totalItems:
                type: integer
              totalPages:
                type: integer
              hasNext:
                type: boolean
              hasPrev:
                type: boolean
    ContactListResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          type: array
          items:
            $ref: '#/components/schemas/Contact'
        meta:
          $ref: '#/components/schemas/PaginationMeta'
    DeleteResponse:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          type: object
          properties:
            deleted:
              type: boolean
              example: true
        meta:
          $ref: '#/components/schemas/Meta'
    BulkImportRequest:
      type: object
      required:
      - contacts
      properties:
        contacts:
          type: array
          minItems: 1
          maxItems: 10000
          items:
            $ref: '#/components/schemas/CreateContactRequest'
        skipDuplicates:
          type: boolean
          default: true
    ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: object
          properties:
            code:
              type: string
              example: VALIDATION_ERROR
            message:
              type: string
              example: Invalid request parameters
            details:
              type: object
        meta:
          $ref: '#/components/schemas/Meta'
    BulkImportResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          type: object
          properties:
            imported:
              type: integer
            skipped:
              type: integer
            errors:
              type: array
              items:
                type: object
                properties:
                  row:
                    type: integer
                  phoneNumber:
                    type: string
                  error:
                    type: string
        meta:
          $ref: '#/components/schemas/Meta'
  responses:
    Conflict:
      description: Resource conflict
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    BadRequest:
      description: Invalid request parameters
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Authentication required or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  parameters:
    PageSizeParam:
      name: pageSize
      in: query
      description: Items per page (max 100)
      schema:
        type: integer
        default: 20
        minimum: 1
        maximum: 100
    PageParam:
      name: page
      in: query
      description: Page number (1-indexed)
      schema:
        type: integer
        default: 1
        minimum: 1
    IdParam:
      name: id
      in: path
      required: true
      description: Resource UUID
      schema:
        type: string
        format: uuid
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key for authentication
    BearerAuth:
      type: http
      scheme: bearer
      description: Bearer token (API key)