ASasksyllable
channels.targets

Get Channel Targets

Changed on

List channel targets for the current suborg.

Supports the standard ListManager filters via search_fields/search_field_values. In addition to target_mode (single value), target_mode_list accepts a comma-separated list of modes (e.g. voice,sms) and matches targets whose mode is any of the listed values. Whitespace around tokens is tolerated and empty tokens are ignored. If both target_mode and target_mode_list are supplied, the two filters are combined with AND. target_mode_list is filter-only and cannot be used as order_by.

get/api/v1/channels/targets

Request

  • Base URL
    https://api.syllable.cloud
  • URL
    https://api.syllable.cloud/api/v1/channels/targets
  • Auth
    API key in header Syllable-API-Key

Query parameters

pageinteger nullable

The page number from which to start (0-based)

limitinteger

The maximum number of items to return

Example:25
search_fieldsChannelTargetProperties[]

String names of fields to search. Correspond by index to search field values

search_field_valuesstring[]

Values of fields to search. Correspond by index to search fields. Unless field name contains "list", an individual search field value cannot be a list

order_by'id' | 'channel_id' | 'channel_name' | 'agent_id' | 'target' | 'target_mode' | 'fallback_target' | 'is_test' | 'updated_at' | 'a2p_verified'

Subset of [[ChannelTargetProperties]] that is valid as order_by. Filter-only fields are excluded so the generated OpenAPI client does not surface them as sortable.

The field whose value should be used to order the results

order_by_direction'asc' | 'desc'

The direction in which to order list results, either ascending or descending.

The direction in which to order the results

fieldsChannelTargetProperties[] nullable

The fields to include in the response

start_datetimestring nullable

The start datetime for filtering results

Example:2023-01-01T00:00:00Z
end_datetimestring nullable

The end datetime for filtering results

Example:2024-01-01T00:00:00Z

Response

Successful Response

pageinteger required

The page number of the results (0-based)

page_sizeinteger required

The number of items returned per page

total_pagesinteger nullable

The total number of pages of results given the indicated page size

total_countinteger nullable

The total number of items returned from the query

Changes

  • b9ac2e8b5b7bRevision changes
    • info

      added the optional property // to the response with the status

  • 360eb26e3e6cRevision changes
    • info

      added the enum value target_mode_list to the property anyOf[subschema #1]/items/ of the query request parameter fields

    • info

      added the enum value target_mode_list to the property items/ of the query request parameter search_fields