---
title: "Create a recording"
method: POST
path: "/uc/{connection_id}/recording"
tags: ["uc", "recording"]
---

# Create a recording

`POST /uc/{connection_id}/recording`

## Request

- Base URL: `http://api.unified.to`
- URL: `http://api.unified.to/uc/{connection_id}/recording`
- Auth: API key in header `authorization`

## Path parameters

- `connection_id` string, required

## Query parameters

- `fields` string[]
- `raw` string

## Request body

- UcRecording
  - `id` string
  - `created_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `updated_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `start_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `end_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `expires_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `call_id` string
  - `web_url` string
  - `contacts` UcContact[]
    - `id` string: Unique identifier for this contact object
    - `created_at` string, date-time: The date that this contact object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
    - `updated_at` string, date-time: The last date that this contact object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
    - `name` string: The name of the contact
    - `first_name` string
    - `last_name` string
    - `title` string: The job title of the contact
    - `company` string: The company/organization name of the contact
    - `emails` UcEmail[]: An array of email addresses for this contact
      - `email` string, required
      - `type` 'WORK' | 'HOME' | 'OTHER'
    - `telephones` UcTelephone[]: An array of telephones for this contact
      - `telephone` string, required
      - `type` 'WORK' | 'HOME' | 'OTHER' | 'FAX' | 'MOBILE'
    - `metadata` UcMetadata[]
      - `id` string
      - `slug` string
      - `value` unknown
      - `namespace` string
      - `format` 'TEXT' | 'NUMBER' | 'DATE' | 'BOOLEAN' | 'FILE' | 'TEXTAREA' | 'SINGLE_SELECT' | 'MULTIPLE_SELECT' | 'MEASUREMENT' | 'PRICE' | 'YES_NO' | 'CURRENCY' | 'URL'
      - `extra_data` unknown
    - `raw` unknown
  - `user_id` string: reference to HrisEmployee (reference to HrisEmployee)
  - `media` UcRecordingMedia[]
    - `start_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
    - `end_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
    - `language` string: two digit ISO code
    - `transcripts` UcRecordingTranscript[]
      - `start_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
      - `end_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
      - `text` string, required
      - `contact_id` string: (reference to UcContact)
      - `user_id` string: reference to HrisEmployee (reference to HrisEmployee)
    - `transcript_download_url` string
    - `recording_download_url` string
  - `user_name` string
  - `user_phone` string
  - `type` 'INBOUND' | 'OUTBOUND'
  - `conversation_identifier` string: opaque identifier shared across legs of one interaction
  - `metadata` UcMetadata[]
    - `id` string
    - `slug` string
    - `value` unknown
    - `namespace` string
    - `format` 'TEXT' | 'NUMBER' | 'DATE' | 'BOOLEAN' | 'FILE' | 'TEXTAREA' | 'SINGLE_SELECT' | 'MULTIPLE_SELECT' | 'MEASUREMENT' | 'PRICE' | 'YES_NO' | 'CURRENCY' | 'URL'
    - `extra_data` unknown
  - `raw` unknown

## Response `200`

Successful

- UcRecording
  - `id` string
  - `created_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `updated_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `start_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `end_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `expires_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `call_id` string
  - `web_url` string
  - `contacts` UcContact[]
    - `id` string: Unique identifier for this contact object
    - `created_at` string, date-time: The date that this contact object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
    - `updated_at` string, date-time: The last date that this contact object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
    - `name` string: The name of the contact
    - `first_name` string
    - `last_name` string
    - `title` string: The job title of the contact
    - `company` string: The company/organization name of the contact
    - `emails` UcEmail[]: An array of email addresses for this contact
      - `email` string, required
      - `type` 'WORK' | 'HOME' | 'OTHER'
    - `telephones` UcTelephone[]: An array of telephones for this contact
      - `telephone` string, required
      - `type` 'WORK' | 'HOME' | 'OTHER' | 'FAX' | 'MOBILE'
    - `metadata` UcMetadata[]
      - `id` string
      - `slug` string
      - `value` unknown
      - `namespace` string
      - `format` 'TEXT' | 'NUMBER' | 'DATE' | 'BOOLEAN' | 'FILE' | 'TEXTAREA' | 'SINGLE_SELECT' | 'MULTIPLE_SELECT' | 'MEASUREMENT' | 'PRICE' | 'YES_NO' | 'CURRENCY' | 'URL'
      - `extra_data` unknown
    - `raw` unknown
  - `user_id` string: reference to HrisEmployee (reference to HrisEmployee)
  - `media` UcRecordingMedia[]
    - `start_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
    - `end_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
    - `language` string: two digit ISO code
    - `transcripts` UcRecordingTranscript[]
      - `start_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
      - `end_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
      - `text` string, required
      - `contact_id` string: (reference to UcContact)
      - `user_id` string: reference to HrisEmployee (reference to HrisEmployee)
    - `transcript_download_url` string
    - `recording_download_url` string
  - `user_name` string
  - `user_phone` string
  - `type` 'INBOUND' | 'OUTBOUND'
  - `conversation_identifier` string: opaque identifier shared across legs of one interaction
  - `metadata` UcMetadata[]
    - `id` string
    - `slug` string
    - `value` unknown
    - `namespace` string
    - `format` 'TEXT' | 'NUMBER' | 'DATE' | 'BOOLEAN' | 'FILE' | 'TEXTAREA' | 'SINGLE_SELECT' | 'MULTIPLE_SELECT' | 'MEASUREMENT' | 'PRICE' | 'YES_NO' | 'CURRENCY' | 'URL'
    - `extra_data` unknown
  - `raw` unknown

---

[API](https://skmtc.dev/unified/apis/unified-to-api-2.md) · [All operations](https://skmtc.dev/unified/apis/unified-to-api-2/llms.txt) · [OpenAPI document](https://skmtc.dev/unified/apis/unified-to-api-2/revisions/7a38bdd7f089?raw)