GET
/
v1
/
sms
/
campaigns
cURL
curl --request GET \
  --url https://api.comm.com/api/v1/sms/campaigns \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "meta": {
        "send_type": "manual",
        "segment_ids": [
          {}
        ],
        "sms_routing_plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "filter_segment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "domain_plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "use_dedicated_domains": true,
        "manual_data": {
          "send_amount": 2,
          "send_datetime": "<string>",
          "throttle_batch_size": 1
        },
        "multistep_data": {
          "step_size": 2,
          "step_delay": 2,
          "min_ctr": 123,
          "max_sms_to_send": 1,
          "max_minutes_to_send": 1,
          "send_datetime": "<string>",
          "is_active": true
        },
        "planner_data": {
          "days_of_week": [
            "<string>"
          ],
          "weekly_schedule": {
            "default": {},
            "Mon": {},
            "Tue": {},
            "Wed": {},
            "Thu": {},
            "Fri": {},
            "Sat": {},
            "Sun": {}
          },
          "multistep_data": {
            "step_size": 2,
            "step_delay": 2,
            "min_ctr": 123,
            "max_sms_to_send": 1,
            "max_minutes_to_send": 1,
            "send_datetime": "<string>",
            "is_active": true
          },
          "weekly_sms_contact_limit": 2,
          "daily_sms_contact_limit": 2,
          "is_active": true
        },
        "multistep_status": {
          "current_step": 123,
          "total_available_contacts": 123,
          "total_sent": 123,
          "last_sent_timestamp": 123,
          "start_timestamp": 123,
          "initial_brands": [
            "<string>"
          ],
          "steps_performance": [
            "<string>"
          ],
          "status": "<string>",
          "status_reason": "No segments selected",
          "last_timezones": [
            "<string>"
          ],
          "planner_data": {
            "days_of_week": [
              "<any>"
            ],
            "weekly_schedule": {},
            "multistep_data": {},
            "weekly_sms_contact_limit": 2,
            "daily_sms_contact_limit": 2,
            "is_active": true
          }
        },
        "hlr_settings": {
          "is_active": true,
          "number_of_retries": 1,
          "delay_between_retries": 1,
          "additional_time_increment": 1,
          "retry_until": "<string>"
        }
      },
      "id": "<string>",
      "name": "<string>",
      "status": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "team_id": "<string>",
      "offers": [
        {
          "id": "<string>",
          "name": "<string>",
          "url": "<string>",
          "profit": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "sends": [
        {
          "id": "<string>",
          "next_step_timestamp": "<string>",
          "status": "<string>",
          "meta": {
            "send_type": "manual",
            "segment_ids": [
              {}
            ],
            "sms_routing_plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "filter_segment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "domain_plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "use_dedicated_domains": true,
            "manual_data": {
              "send_amount": 2,
              "send_datetime": "<string>",
              "throttle_batch_size": 1
            },
            "multistep_data": {
              "step_size": 2,
              "step_delay": 2,
              "min_ctr": 123,
              "max_sms_to_send": 1,
              "max_minutes_to_send": 1,
              "send_datetime": "<string>",
              "is_active": true
            },
            "planner_data": {
              "days_of_week": [
                "<string>"
              ],
              "weekly_schedule": {
                "default": {},
                "Mon": {},
                "Tue": {},
                "Wed": {},
                "Thu": {},
                "Fri": {},
                "Sat": {},
                "Sun": {}
              },
              "multistep_data": {
                "step_size": 2,
                "step_delay": 2,
                "min_ctr": 123,
                "max_sms_to_send": 1,
                "max_minutes_to_send": 1,
                "send_datetime": "<string>",
                "is_active": true
              },
              "weekly_sms_contact_limit": 2,
              "daily_sms_contact_limit": 2,
              "is_active": true
            },
            "multistep_status": {
              "current_step": 123,
              "total_available_contacts": 123,
              "total_sent": 123,
              "last_sent_timestamp": 123,
              "start_timestamp": 123,
              "initial_brands": [
                "<string>"
              ],
              "steps_performance": [
                "<string>"
              ],
              "status": "<string>",
              "status_reason": "No segments selected",
              "last_timezones": [
                "<string>"
              ],
              "planner_data": {
                "days_of_week": [
                  "<any>"
                ],
                "weekly_schedule": {},
                "multistep_data": {},
                "weekly_sms_contact_limit": 2,
                "daily_sms_contact_limit": 2,
                "is_active": true
              }
            },
            "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>",
          "logs": [
            {
              "caller_id": "<string>",
              "caller_type": "Send",
              "text": "<string>",
              "created_at": "<string>"
            }
          ],
          "sms_campaign_id": "<string>"
        }
      ],
      "logs": [
        {
          "caller_id": "<string>",
          "caller_type": "Send",
          "text": "<string>",
          "created_at": "<string>"
        }
      ]
    }
  ],
  "meta": {
    "current_page": 123,
    "from": 123,
    "last_page": 123,
    "links": [
      {
        "url": "<string>",
        "label": "<string>",
        "active": true
      }
    ],
    "path": "<string>",
    "per_page": 123,
    "to": 123,
    "total": 123
  },
  "links": {
    "first": "<string>",
    "last": "<string>",
    "prev": "<string>",
    "next": "<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
type
enum<string>
Available options:
planned,
default
search_ids
string<uuid>[]
with[]
enum<string>[]

Response

Paginated set of SmsCampaignResource

data
SmsCampaignResource · object[]
required
meta
object
required