List of all Recording CompositionHook resources

GET /v1/CompositionHooks

Recording composition hooks

List of all Recording CompositionHook resources.

Query parameters

Enabled boolean

Read only CompositionHook resources with an enabled value that matches this parameter.
DateCreatedAfter string(date-time)

Read only CompositionHook resources created on or after this ISO 8601 datetime with time zone.
DateCreatedBefore string(date-time)

Read only CompositionHook resources created before this ISO 8601 datetime with time zone.
FriendlyName string

Read only CompositionHook resources with friendly names that match this string. The match is not case sensitive and can include asterisk * characters as wildcard match.
PageSize integer

How many resources to return in each list page. The default is 50, and the maximum is 1000.

Minimum value is 1, maximum value is 1000.

Responses

• 200

OK
Hide response attributes Show response attributes object
- composition_hooks array[object]
  
  Hide composition_hooks attributes Show composition_hooks attributes
  
  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}$.
  
  audio_sources array[string] | null
  
  The array of track names to include in the compositions created by the composition hook
  
  audio_sources_excluded array[string] | null
  
  The array of track names to exclude from the compositions created by the composition hook
  
  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
  
  enabled boolean | null
  
  Whether the CompositionHook is active
  
  format string | null
  
  The container format of the media files used by the compositions created by the composition hook
  
  Values are mp4 or webm.
  
  friendly_name string | null
  
  The string that you assigned to describe the resource
  
  resolution string | null
  
  The dimensions of the video image in pixels expressed as columns (width) and rows (height)
  
  sid string | null
  
  The unique string that identifies the resource
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^HK[0-9a-fA-F]{32}$.
  
  status_callback string(uri) | null
  
  The URL to send status information to your application
  
  status_callback_method string(http-method) | null
  
  The HTTP method we should use to call status_callback
  
  Values are HEAD, GET, POST, PATCH, PUT, or DELETE.
  
  trim boolean | null
  
  Whether intervals with no media are clipped
  
  url string(uri) | null
  
  The absolute URL of the resource
  
  video_layout
  
  A JSON object that describes the video layout of the Composition
- meta object
  
  Hide meta attributes Show meta attributes
  
  first_page_url string(uri)
  
  key string
  
  next_page_url string(uri)
  
  page integer
  
  page_size integer
  
  previous_page_url string(uri)
  
  url string(uri)

GET /v1/CompositionHooks

curl \
 -X GET https://video.twilio.com/v1/CompositionHooks \
 --user "username:password"

Response examples (200)

{
  "composition_hooks": [
    {
      "account_sid": "string",
      "audio_sources": [
        "string"
      ],
      "audio_sources_excluded": [
        "string"
      ],
      "date_created": "2023-05-04T09:42:00+00:00",
      "date_updated": "2023-05-04T09:42:00+00:00",
      "enabled": true,
      "format": "mp4",
      "friendly_name": "string",
      "resolution": "string",
      "sid": "string",
      "status_callback": "https://example.com",
      "status_callback_method": "HEAD",
      "trim": true,
      "url": "https://example.com"
    }
  ],
  "meta": {
    "first_page_url": "https://example.com",
    "key": "string",
    "next_page_url": "https://example.com",
    "page": 42,
    "page_size": 42,
    "previous_page_url": "https://example.com",
    "url": "https://example.com"
  }
}