GET
/
v1
/
voice
/
campaigns
cURL
curl --request GET \
  --url https://api.comm.com/api/v1/voice/campaigns \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "status": "<string>",
      "meta": {
        "send_type": "manual",
        "segment_ids": [
          {}
        ],
        "filter_segment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "number_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "agent_ids": [
          "<string>"
        ],
        "number_ids": [
          "<string>"
        ],
        "manual_data": {
          "send_amount": 2,
          "send_datetime": "<string>",
          "throttle_batch_size": 1
        },
        "recurring_data": {
          "days_of_week": [
            "<string>"
          ],
          "daily_recurring_data": {
            "Mon": [
              "<any>"
            ],
            "Tue": [
              "<any>"
            ],
            "Wed": [
              "<any>"
            ],
            "Thu": [
              "<any>"
            ],
            "Fri": [
              "<any>"
            ],
            "Sat": [
              "<any>"
            ],
            "Sun": [
              "<any>"
            ]
          },
          "selected_recurring_time": {
            "send_amount": 2,
            "send_datetime": "<string>"
          },
          "weekly_contact_limit": 2,
          "daily_contact_limit": 2,
          "is_active": true
        },
        "feed_data": {
          "days_of_week": [
            "<string>"
          ],
          "weekly_schedule": {
            "default": {},
            "Mon": {},
            "Tue": {},
            "Wed": {},
            "Thu": {},
            "Fri": {},
            "Sat": {},
            "Sun": {}
          },
          "feed_id": "<string>",
          "feed_ids": [
            "<string>"
          ],
          "is_active": true,
          "auto_analyze": true,
          "hourly_calls_limit": 1
        },
        "stopped_reason": "<string>",
        "hlr_settings": {
          "is_active": true,
          "number_of_retries": 1,
          "delay_between_retries": 1,
          "additional_time_increment": 1,
          "retry_until": "<string>"
        }
      },
      "sends": [
        {
          "id": "<string>",
          "next_step_timestamp": "<string>",
          "status": "<string>",
          "meta": {
            "send_type": "manual",
            "segment_ids": [
              {}
            ],
            "filter_segment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "number_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "agent_ids": [
              "<string>"
            ],
            "number_ids": [
              "<string>"
            ],
            "manual_data": {
              "send_amount": 2,
              "send_datetime": "<string>",
              "throttle_batch_size": 1
            },
            "recurring_data": {
              "days_of_week": [
                "<string>"
              ],
              "daily_recurring_data": {
                "Mon": [
                  "<any>"
                ],
                "Tue": [
                  "<any>"
                ],
                "Wed": [
                  "<any>"
                ],
                "Thu": [
                  "<any>"
                ],
                "Fri": [
                  "<any>"
                ],
                "Sat": [
                  "<any>"
                ],
                "Sun": [
                  "<any>"
                ]
              },
              "selected_recurring_time": {
                "send_amount": 2,
                "send_datetime": "<string>"
              },
              "weekly_contact_limit": 2,
              "daily_contact_limit": 2,
              "is_active": true
            },
            "feed_data": {
              "days_of_week": [
                "<string>"
              ],
              "weekly_schedule": {
                "default": {},
                "Mon": {},
                "Tue": {},
                "Wed": {},
                "Thu": {},
                "Fri": {},
                "Sat": {},
                "Sun": {}
              },
              "feed_id": "<string>",
              "feed_ids": [
                "<string>"
              ],
              "is_active": true,
              "auto_analyze": true,
              "hourly_calls_limit": 1
            },
            "stopped_reason": "<string>",
            "hlr_settings": {
              "is_active": true,
              "number_of_retries": 1,
              "delay_between_retries": 1,
              "additional_time_increment": 1,
              "retry_until": "<string>"
            }
          },
          "created_at": "<string>",
          "updated_at": "<string>",
          "voice_campaign_id": "<string>",
          "calls_count": "<string>"
        }
      ]
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
integer | null
per_page
integer | null
search_ids
string<uuid>[]
with[]
enum<string>[]

Response

Array of VoiceCampaignResource

data
VoiceCampaignResource · object[]
required