アウトバウンドキャンペーンを一覧表示

curl -G https://api.elevenlabs.io/v1/convai/outbound-campaigns/campaigns \
     -d agent_id=agent_id \
     -d channel=phone \
     -d cursor=cursor \
     -d mode=voice \
     -d page_size=1 \
     -d search=search \
     -d status=active

{
  "campaigns": [
    {
      "campaign_id": "campaign_id",
      "call_name": "call_name",
      "agent_id": "agent_id",
      "channel_config": {
        "channel": "phone",
        "agent_phone_number_id": "agent_phone_number_id"
      },
      "status": "active",
      "policy": {
        "timezone": "timezone",
        "retry": {},
        "calling_periods": [
          {
            "weekdays": [
              1
            ],
            "intervals": [
              {
                "start": "start",
                "end": "end"
              }
            ]
          }
        ],
        "data_collection": {},
        "followup_context": {}
      },
      "variant": "simple",
      "created_at_unix": 1,
      "updated_at_unix": 1,
      "channel": "phone",
      "mode": "voice",
      "counts": {
        "leads": 1,
        "terminal_leads": 1,
        "open_attention": 1
      },
      "agent_name": "agent_name",
      "source": "ui",
      "outcome": {
        "type": "data_collection",
        "data_collection_id": "data_collection_id",
        "equals": [
          "equals"
        ]
      },
      "scheduled_time_unix": 1,
      "branch_id": "branch_id",
      "environment": "environment",
      "target_concurrency_limit": 1
    }
  ],
  "has_more": true,
  "next_cursor": "next_cursor"
}

ワークスペースのアウトバウンドキャンペーンを新しい順に一覧表示します。

クエリパラメータ

page_sizeintegerオプション1-500デフォルト値 100

返す項目の最大数。

statusenumオプション

これらのいずれかのステータスにあるキャンペーンのみ。

agent_idstringオプション

このエージェントが実行するキャンペーンのみ。

channelenumオプション

このチャネルのキャンペーンのみ。

許可された値:

modeenumオプション

音声キャンペーンのみ、またはメッセージキャンペーンのみ。

許可された値:

searchstringオプション<=256 characters

名前にこのテキストを含むキャンペーンのみ。

cursorstringオプション

次のページを取得するために使用します。カーソルはレスポンスで返されます。

レスポンス

成功レスポンス。

campaignslist of objects

has_moreboolean

next_cursorstringオプション

エラー

422

Outbound Campaigns List Request Unprocessable Entity Error

ヘッダー

クエリパラメータ

レスポンス

エラー