> 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.collect

GET /

Receive call.collect events

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

## AsyncAPI Specification

```yaml
asyncapi: 2.6.0
info:
  title: call.collect
  version: subpackage_callCollect.call.collect
  description: Receive call.collect events
channels:
  /:
    description: Receive call.collect events
    publish:
      operationId: subpackage_callCollect.call.collect-publish
      summary: call.collect
      message:
        name: onCallCollectCallCollectEvent
        title: call.collect
        payload:
          $ref: '#/components/schemas/call.collect_callCollectEvent'
servers:
  production:
    url: wss://relay.signalwire.com/
    protocol: wss
    x-default: true
components:
  schemas:
    ChannelsCallCollectMessagesCallCollectEventJsonrpc:
      type: string
      enum:
        - '2.0'
      description: JSON-RPC version. Always `2.0`.
      title: ChannelsCallCollectMessagesCallCollectEventJsonrpc
    ChannelsCallCollectMessagesCallCollectEventMethod:
      type: string
      enum:
        - signalwire.event
      description: Always `signalwire.event`.
      title: ChannelsCallCollectMessagesCallCollectEventMethod
    ChannelsCallCollectMessagesCallCollectEventParamsEventType:
      type: string
      enum:
        - call.collect
      description: The event type — identifies which event this is.
      title: ChannelsCallCollectMessagesCallCollectEventParamsEventType
    Fabric.FabricCallCollectState:
      type: string
      enum:
        - collecting
        - error
        - finished
      title: Fabric.FabricCallCollectState
    FabricFabricCallCollectResultType:
      type: string
      enum:
        - digit
        - error
        - finished
        - no_input
        - no_match
        - speech
        - start_of_input
      title: FabricFabricCallCollectResultType
    Fabric.FabricCallCollectResult:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/FabricFabricCallCollectResultType'
      required:
        - type
      description: >-
        What the caller gave you. Read `type` to know which kind of result this
        is. The

        `error`, `no_input`, `no_match`, `start_of_input`, and `finished` types
        are markers

        with no extra data, while `digit` and `speech` include a `params` object
        with the

        collected input.
      title: Fabric.FabricCallCollectResult
    Fabric.CallCollectParams:
      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`.
        control_id:
          type: string
          description: >-
            The `control_id` of the collection this event refers to, from the
            request that started it.
        state:
          $ref: '#/components/schemas/Fabric.FabricCallCollectState'
          description: >-
            Where the collection currently stands. `error` means it stopped
            because something went wrong. Present for partial and continuous
            collections; a one-shot collect reports its `result` without a
            `state`.
        result:
          $ref: '#/components/schemas/Fabric.FabricCallCollectResult'
          description: >-
            What the caller gave. Check its `type` to handle digits, speech, or
            a no-input/no-match marker.
        final:
          type: boolean
          description: >-
            Relevant when the collect asked for partial or continuous results:
            `true` once the

            recognizer has finished the current utterance. With `continuous:
            true`, the

            collector then restarts to listen for the next one.
      required:
        - call_id
        - node_id
        - room_session_id
        - control_id
      description: >-
        Payload of the Call Fabric `call.collect` event: DTMF or speech input
        collected from the caller.
      title: Fabric.CallCollectParams
    ChannelsCallCollectMessagesCallCollectEventParams:
      type: object
      properties:
        event_type:
          $ref: >-
            #/components/schemas/ChannelsCallCollectMessagesCallCollectEventParamsEventType
          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.CallCollectParams'
          description: The event-specific payload.
      required:
        - event_type
        - event_channel
        - timestamp
        - params
      description: The event envelope.
      title: ChannelsCallCollectMessagesCallCollectEventParams
    call.collect_callCollectEvent:
      type: object
      properties:
        jsonrpc:
          $ref: >-
            #/components/schemas/ChannelsCallCollectMessagesCallCollectEventJsonrpc
          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/ChannelsCallCollectMessagesCallCollectEventMethod
          description: Always `signalwire.event`.
        params:
          $ref: >-
            #/components/schemas/ChannelsCallCollectMessagesCallCollectEventParams
          description: The event envelope.
      required:
        - jsonrpc
        - id
        - method
        - params
      description: >-
        Fires as input is collected from the caller on a Call Fabric call — DTMF
        digits or speech — reporting partial and final results so you can react
        to what they said or pressed. SWML or a server-side application starts
        it on the leg; there is no client request that starts it.
      title: call.collect_callCollectEvent

```