> This page is for APIs.

> Fetch clean Markdown by appending `.md` to any page URL under https://signalwire.com/docs or requesting it with the HTTP header `Accept: text/markdown`. The root index at https://signalwire.com/docs/llms.txt lists the available documentation indexes.

# call.record

GET /

Receive call.record events

Reference: https://signalwire.com/docs/apis/relay/client/fabric/call-record

## AsyncAPI Specification

```yaml
asyncapi: 2.6.0
info:
  title: call.record
  version: subpackage_callRecord.call.record
  description: Receive call.record events
channels:
  /:
    description: Receive call.record events
    publish:
      operationId: subpackage_callRecord.call.record-publish
      summary: call.record
      message:
        name: onCallRecordCallRecordEvent
        title: call.record
        payload:
          $ref: '#/components/schemas/call.record_callRecordEvent'
servers:
  production:
    url: wss://relay.signalwire.com/
    protocol: wss
    x-default: true
components:
  schemas:
    ChannelsCallRecordMessagesCallRecordEventJsonrpc:
      type: string
      enum:
        - '2.0'
      description: JSON-RPC version. Always `2.0`.
      title: ChannelsCallRecordMessagesCallRecordEventJsonrpc
    ChannelsCallRecordMessagesCallRecordEventMethod:
      type: string
      enum:
        - signalwire.event
      description: Always `signalwire.event`.
      title: ChannelsCallRecordMessagesCallRecordEventMethod
    ChannelsCallRecordMessagesCallRecordEventParamsEventType:
      type: string
      enum:
        - call.record
      description: The event type — identifies which event this is.
      title: ChannelsCallRecordMessagesCallRecordEventParamsEventType
    Fabric.FabricCallRecordState:
      type: string
      enum:
        - recording
        - paused
        - finished
        - no_input
      title: Fabric.FabricCallRecordState
    FabricCallRecordParamsPauseBehavior:
      type: string
      enum:
        - silence
        - skip
      description: >-
        How paused time is handled in the recording: `silence` inserts silence
        for the paused span, while `skip` leaves it out entirely.
      title: FabricCallRecordParamsPauseBehavior
    Fabric.FabricRecordEventDirection:
      type: string
      enum:
        - listen
        - speak
        - both
      title: Fabric.FabricRecordEventDirection
    Fabric.FabricRecordEventAudio:
      type: object
      properties:
        format:
          type: string
          description: The file format of the recording (for example `mp3` or `wav`).
        stereo:
          type: boolean
          description: Whether the recording was captured in stereo.
        direction:
          $ref: '#/components/schemas/Fabric.FabricRecordEventDirection'
          description: Which side(s) of the conversation were captured.
      description: The audio settings the recording was captured with.
      title: Fabric.FabricRecordEventAudio
    Fabric.FabricRecordEventSpec:
      type: object
      properties:
        audio:
          $ref: '#/components/schemas/Fabric.FabricRecordEventAudio'
          description: The audio settings used for this recording.
      description: >-
        Describes how the recording was made. The `audio` field is present when
        audio was recorded.
      title: Fabric.FabricRecordEventSpec
    Fabric.CallRecordParams:
      type: object
      properties:
        call_id:
          type: string
          description: >-
            Unique identifier of the call this event is about. Always present on
            Fabric events.
        node_id:
          type: string
          description: The node the call leg lives on.
        room_session_id:
          type: string
          description: >-
            The room session this call leg belongs to. In a 1:1 call this equals
            the `call_id`.
        segment_id:
          type: string
          description: >-
            Identifier of the call segment this event belongs to, for
            correlating events within the same segment.
        tag:
          type: string
          description: >-
            The `tag` the leg was dialed with, when a server-side application
            set one on the dial. Absent otherwise.
        control_id:
          type: string
          description: >-
            The `control_id` of the recording this event refers to, from the
            request that started it.
        state:
          $ref: '#/components/schemas/Fabric.FabricCallRecordState'
          description: Where the recording currently stands.
        recording_id:
          type: string
          description: The unique identifier of the recording.
        url:
          type: string
          format: uri
          description: >-
            Where the recording is stored. Present on every state, including
            `recording` and `paused`; the file is complete once the state is
            `finished`.
        duration:
          type: number
          format: double
          description: >-
            How long the recording is, in seconds. Set once the state is
            `finished`.
        size:
          type: integer
          description: >-
            How large the recording file is, in bytes. Set once the state is
            `finished`.
        start_time:
          type: number
          format: double
          description: >-
            When the recording started, as a Unix timestamp in seconds. Set once
            the state is `finished`.
        first_frame_time:
          type: number
          format: double
          description: >-
            The first captured audio, as a Unix timestamp in seconds. Present
            when available; more precise than `start_time`.
        end_time:
          type: number
          format: double
          description: >-
            When the recording ended, as a Unix timestamp in seconds. Set once
            the state is `finished`.
        pause_behavior:
          $ref: '#/components/schemas/FabricCallRecordParamsPauseBehavior'
          description: >-
            How paused time is handled in the recording: `silence` inserts
            silence for the paused span, while `skip` leaves it out entirely.
        record:
          $ref: '#/components/schemas/Fabric.FabricRecordEventSpec'
          description: The settings this recording was captured with.
      required:
        - call_id
        - node_id
        - room_session_id
        - control_id
        - state
      description: >-
        Payload of the Call Fabric `call.record` event: recording state, the
        recording URL, and, once finished, the file metadata.
      title: Fabric.CallRecordParams
    ChannelsCallRecordMessagesCallRecordEventParams:
      type: object
      properties:
        event_type:
          $ref: >-
            #/components/schemas/ChannelsCallRecordMessagesCallRecordEventParamsEventType
          description: The event type — identifies which event this is.
        event_channel:
          type: string
          description: >-
            The channel the event was delivered on — for Calling events, the
            `protocol`

            string your connection received from `signalwire.connect`.
        timestamp:
          type: number
          format: double
          description: >-
            When the event was emitted, as a Unix timestamp in seconds. Always
            present.
        project_id:
          type: string
          description: >-
            Your project ID. Present on Calling events and most Call Fabric
            events; absent on `call.joined`, `call.left`, `member.joined`, and
            `member.left`.
        space_id:
          type: string
          description: >-
            Your space ID. Present on Calling events and most Call Fabric
            events; absent on `call.joined`, `call.left`, `member.joined`, and
            `member.left`.
        params:
          $ref: '#/components/schemas/Fabric.CallRecordParams'
          description: The event-specific payload.
      required:
        - event_type
        - event_channel
        - timestamp
        - params
      description: The event envelope.
      title: ChannelsCallRecordMessagesCallRecordEventParams
    call.record_callRecordEvent:
      type: object
      properties:
        jsonrpc:
          $ref: >-
            #/components/schemas/ChannelsCallRecordMessagesCallRecordEventJsonrpc
          description: JSON-RPC version. Always `2.0`.
        id:
          type: string
          description: >-
            Event id — a unique UUID generated for each event. Events are
            notifications: you do not reply to them.
        method:
          $ref: '#/components/schemas/ChannelsCallRecordMessagesCallRecordEventMethod'
          description: Always `signalwire.event`.
        params:
          $ref: '#/components/schemas/ChannelsCallRecordMessagesCallRecordEventParams'
          description: The event envelope.
      required:
        - jsonrpc
        - id
        - method
        - params
      description: >-
        Fires when a recording on a Call Fabric call starts, pauses, resumes, or
        finishes. Every state carries the recording URL; the finished event adds
        the duration and file size. SWML or a server-side application starts it
        on the leg; there is no client request that starts it.
      title: call.record_callRecordEvent

```