POST
/
v1
/
voice
/
campaigns
cURL
curl --request POST \
  --url https://api.comm.com/api/v1/voice/campaigns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>"
}'
{
  "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": [
            {
              "send_time": "<string>",
              "send_amount": 2
            }
          ],
          "Tue": [
            {
              "send_time": "<string>",
              "send_amount": 2
            }
          ],
          "Wed": [
            {
              "send_time": "<string>",
              "send_amount": 2
            }
          ],
          "Thu": [
            {
              "send_time": "<string>",
              "send_amount": 2
            }
          ],
          "Fri": [
            {
              "send_time": "<string>",
              "send_amount": 2
            }
          ],
          "Sat": [
            {
              "send_time": "<string>",
              "send_amount": 2
            }
          ],
          "Sun": [
            {
              "send_time": "<string>",
              "send_amount": 2
            }
          ]
        },
        "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": {
            "start": "<string>",
            "end": "<string>"
          },
          "Mon": {
            "start": "<string>",
            "end": "<string>"
          },
          "Tue": {
            "start": "<string>",
            "end": "<string>"
          },
          "Wed": {
            "start": "<string>",
            "end": "<string>"
          },
          "Thu": {
            "start": "<string>",
            "end": "<string>"
          },
          "Fri": {
            "start": "<string>",
            "end": "<string>"
          },
          "Sat": {
            "start": "<string>",
            "end": "<string>"
          },
          "Sun": {
            "start": "<string>",
            "end": "<string>"
          }
        },
        "feed_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "is_active": true,
        "auto_analyze": true,
        "hourly_calls_limit": 1
      },
      "stopped_reason": "<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": [
                {
                  "send_time": "<string>",
                  "send_amount": 2
                }
              ],
              "Tue": [
                {
                  "send_time": "<string>",
                  "send_amount": 2
                }
              ],
              "Wed": [
                {
                  "send_time": "<string>",
                  "send_amount": 2
                }
              ],
              "Thu": [
                {
                  "send_time": "<string>",
                  "send_amount": 2
                }
              ],
              "Fri": [
                {
                  "send_time": "<string>",
                  "send_amount": 2
                }
              ],
              "Sat": [
                {
                  "send_time": "<string>",
                  "send_amount": 2
                }
              ],
              "Sun": [
                {
                  "send_time": "<string>",
                  "send_amount": 2
                }
              ]
            },
            "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": {
                "start": "<string>",
                "end": "<string>"
              },
              "Mon": {
                "start": "<string>",
                "end": "<string>"
              },
              "Tue": {
                "start": "<string>",
                "end": "<string>"
              },
              "Wed": {
                "start": "<string>",
                "end": "<string>"
              },
              "Thu": {
                "start": "<string>",
                "end": "<string>"
              },
              "Fri": {
                "start": "<string>",
                "end": "<string>"
              },
              "Sat": {
                "start": "<string>",
                "end": "<string>"
              },
              "Sun": {
                "start": "<string>",
                "end": "<string>"
              }
            },
            "feed_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "is_active": true,
            "auto_analyze": true,
            "hourly_calls_limit": 1
          },
          "stopped_reason": "<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.

Body

application/json

Response

201
application/json

VoiceCampaignResource

The response is of type object.