Updates a MediaProcessor resource identified by a SID

POST /v1/MediaProcessors/{Sid}

A MediaProcessor resource provides the ability to capture content from a web application with a Twilio Media Extension to create a livestream.

Updates a MediaProcessor resource identified by a SID.

Path parameters

  • Sid string Required

    The SID of the MediaProcessor resource to update.

Body

  • Status string Required

    The status of the MediaProcessor. Can be ended.

    Value is ended.

Responses

  • 200

    OK

    Hide response attributes Show response attributes object
    • account_sid string | null

      The SID of the Account that created the resource

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

    • date_created string(date-time) | null

      The ISO 8601 date and time in GMT when the resource was created

    • date_updated string(date-time) | null

      The ISO 8601 date and time in GMT when the resource was last updated

    • ended_reason string | null

      The reason why a MediaProcessor ended

    • extension string | null

      The Media Extension name or URL

    • extension_context string | null

      The Media Extension context

    • max_duration integer | null

      Maximum MediaProcessor duration in seconds

    • sid string | null

      The unique string that identifies the resource

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^ZX[0-9a-fA-F]{32}$.

    • status string | null

      The status of the MediaProcessor

      Values are failed, started, or ended.

    • status_callback string(uri) | null

      The URL to which Twilio will send MediaProcessor event updates

    • status_callback_method string(http-method) | null

      The HTTP method Twilio should use to call the status_callback URL

      Values are HEAD, GET, POST, PATCH, PUT, or DELETE.

    • url string(uri) | null

      The absolute URL of the resource
POST /v1/MediaProcessors/{Sid} 
curl \
 -X POST https://media.twilio.com/v1/MediaProcessors/{Sid} \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'Status=ended'
Request example 
{
  "Status": "ended"
}
Request examples 
{
  "Status": "ended"
}
Response examples (200) 
{
  "account_sid": "string",
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "ended_reason": "string",
  "extension": "string",
  "extension_context": "string",
  "max_duration": 42,
  "sid": "string",
  "status": "failed",
  "status_callback": "https://example.com",
  "status_callback_method": "HEAD",
  "url": "https://example.com"
}
Response examples (200) 
{
  "account_sid": "string",
  "date_created": "2024-05-04T09:42:00+00:00",
  "date_updated": "2024-05-04T09:42:00+00:00",
  "ended_reason": "string",
  "extension": "string",
  "extension_context": "string",
  "max_duration": 42,
  "sid": "string",
  "status": "failed",
  "status_callback": "https://example.com",
  "status_callback_method": "HEAD",
  "url": "https://example.com"
}