Skip to main content

Forking stop

POST 

/calls/:call_control_id/actions/fork_stop

Stop forking a call.

Expected Webhooks:

  • call.fork.stopped

Request

Path Parameters

    call_control_id stringrequired

    Unique identifier and token for controlling the call

Body

required

Stop forking media request

    client_state string

    Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.

    command_id string

    Use this field to avoid duplicate commands. Telnyx will ignore any command with the same command_id for the same call_control_id.

    stream_type string

    Possible values: [raw, decrypted]

    Default value: raw

    Optionally specify a stream_type. This should match the stream_type that was used in fork_start command to properly stop the fork.

Responses

200: Successful response upon making a call control command.

Schema

    data

    object

    result string

default: Unexpected error

Schema

    errors

    Error[]

  • Array [

  • code integerrequired
    title stringrequired
    detail string

    source

    object

    pointer json-pointer

    JSON pointer (RFC6901) to the offending entity.

    parameter string

    Indicates which query parameter caused the error.

    meta object
  • ]

Callbacks

Loading...