# Transcription status callback

POST 

Payload sent by SignalWire to your Transcription Status Callback URL when the status of a transcription changes.

Configure this callback by enabling transcription on a recording via the
[Record](/docs/compatibility-api/cxml/reference/voice/record) verb (`transcribe=true`) and setting `transcribeCallback`
to your webhook URL.

Your app can use these parameters to handle the transcription — for example, uploading the text to
your CRM, sending it via email, or forwarding the body via SignalWire SMS.

Reference: https://signalwire.com/docs/compatibility-api/rest/recording-transcriptions/webhooks/transcription-status-callback

## OpenAPI 3.1 Webhook Specification

```yaml
openapi: 3.1.0
info:
  title: compatibility
  version: 1.0.0
paths: {}
webhooks:
  transcription-status-callback:
    post:
      operationId: transcription-status-callback
      summary: Transcription status callback
      description: >-
        Payload sent by SignalWire to your Transcription Status Callback URL
        when the status of a transcription changes.


        Configure this callback by enabling transcription on a recording via the

        [Record](/docs/compatibility-api/cxml/reference/voice/record) verb
        (`transcribe=true`) and setting `transcribeCallback`

        to your webhook URL.


        Your app can use these parameters to handle the transcription — for
        example, uploading the text to

        your CRM, sending it via email, or forwarding the body via SignalWire
        SMS.
      responses:
        '200':
          description: Webhook received successfully
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                TranscriptionSid:
                  type: string
                  description: The unique, 34-character ID of the transcription.
                TranscriptionText:
                  type: string
                  description: The text of the transcription.
                TranscriptionStatus:
                  $ref: >-
                    #/components/schemas/WebhooksTranscriptionStatusCallbackPayloadContentApplicationJsonSchemaTranscriptionStatus
                  description: The status of the transcription.
                TranscriptionUrl:
                  type: string
                  description: The URL for the transcription's REST API resource.
                RecordingSid:
                  type: string
                  description: >-
                    The unique, 34-character identifier for the recording from
                    which the transcription was generated.
                RecordingUrl:
                  type: string
                  description: >-
                    The URL for the audio recording from which the transcription
                    was generated.
              required:
                - TranscriptionSid
                - TranscriptionText
                - TranscriptionStatus
                - TranscriptionUrl
                - RecordingSid
                - RecordingUrl
components:
  schemas:
    WebhooksTranscriptionStatusCallbackPayloadContentApplicationJsonSchemaTranscriptionStatus:
      type: string
      enum:
        - completed
        - failed
      description: The status of the transcription.
      title: >-
        WebhooksTranscriptionStatusCallbackPayloadContentApplicationJsonSchemaTranscriptionStatus

```