TelephonyCampaigns

List telephony campaigns

GET /agents/{agent_name}/telephony_campaigns

Lists the Agent's Campaigns without inline recipients. Filters are live views, not snapshots.

Header parameters

Foundry-Features enum required

A feature flag opt-in required when using preview operations or modifying persisted preview resources.

VoiceAgents=V1Preview

Path parameters

agent_name string required

Owning Agent; never overridden in recipient inputs.

Query parameters

limit integer

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

order enum

Sort order by the created_at timestamp of the objects. asc for ascending order anddesc for descending order.

ascdesc

after string

Opaque last_id bound to scope/filters/order; error cursors also bind instance/round/snapshot and survive cancel, not replacement. Exclusive with before; invalid tokens return 400 invalid_cursor.

before string

Opaque first_id for backward paging with unchanged scope/filters/order; exclusive with after.

status string | enum

Filter by Campaign business state.

Any of the following:

string

enum

validatingrunningcancellingcompletedfailedcancelleddeleting

api-version string required

The API version to use for this operation.

Responses

The request has succeeded.

Headers

Cache-Control enum required

Progress-bearing list responses are not cacheable.

no-store

Body

Content-Type: application/json

data TelephonyCampaign[] required

The requested list of items.

has_more boolean required

A value indicating whether there are additional values available not captured in this list.

first_id string

Opaque cursor for the first returned item; absent when empty.

last_id string

Opaque cursor for the last returned item; absent when empty. Deletion/name reuse does not move its original sort boundary.