Post v1smscampaigns stop - CommVoice Documentation

cURL

curl --request POST \
  --url https://api.comm.com/api/v1/sms/campaigns/{campaign}/stop/{campaignSend} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "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": false,
      "manual_data": {
        "send_amount": 200,
        "send_datetime": "<string>",
        "throttle_batch_size": 0
      },
      "multistep_data": {
        "step_size": 200,
        "step_delay": 5,
        "min_ctr": 123,
        "max_sms_to_send": 1,
        "max_minutes_to_send": 1,
        "send_datetime": "<string>",
        "is_active": true
      },
      "planner_data": {
        "days_of_week": "Mon",
        "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>"
          }
        },
        "multistep_data": {
          "step_size": 200,
          "step_delay": 5,
          "min_ctr": 123,
          "max_sms_to_send": 1,
          "max_minutes_to_send": 1,
          "send_datetime": "<string>",
          "is_active": true
        },
        "weekly_sms_contact_limit": 5,
        "daily_sms_contact_limit": 1,
        "is_active": true
      },
      "multistep_status": {
        "current_step": 0,
        "total_available_contacts": 0,
        "total_sent": 0,
        "last_sent_timestamp": 123,
        "start_timestamp": 123,
        "initial_brands": [],
        "steps_performance": [],
        "status": "in_progress",
        "status_reason": "No segments selected",
        "last_timezones": [],
        "planner_data": {
          "days_of_week": "Mon",
          "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>"
            }
          },
          "multistep_data": {
            "step_size": 200,
            "step_delay": 5,
            "min_ctr": 123,
            "max_sms_to_send": 1,
            "max_minutes_to_send": 1,
            "send_datetime": "<string>",
            "is_active": true
          },
          "weekly_sms_contact_limit": 5,
          "daily_sms_contact_limit": 1,
          "is_active": true
        }
      },
      "hlr_settings": {
        "is_active": false,
        "number_of_retries": 0,
        "delay_between_retries": 0,
        "additional_time_increment": 0,
        "retry_until": "<string>"
      }
    },
    "created_at": "<string>",
    "updated_at": "<string>",
    "sms_campaign_id": "<string>",
    "logs": [
      {
        "caller_id": "<string>",
        "caller_type": "Send",
        "text": "<string>",
        "created_at": "<string>"
      }
    ]
  }
}

POST

sms

campaigns

{campaign}

stop

{campaignSend}

cURL

curl --request POST \
  --url https://api.comm.com/api/v1/sms/campaigns/{campaign}/stop/{campaignSend} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "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": false,
      "manual_data": {
        "send_amount": 200,
        "send_datetime": "<string>",
        "throttle_batch_size": 0
      },
      "multistep_data": {
        "step_size": 200,
        "step_delay": 5,
        "min_ctr": 123,
        "max_sms_to_send": 1,
        "max_minutes_to_send": 1,
        "send_datetime": "<string>",
        "is_active": true
      },
      "planner_data": {
        "days_of_week": "Mon",
        "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>"
          }
        },
        "multistep_data": {
          "step_size": 200,
          "step_delay": 5,
          "min_ctr": 123,
          "max_sms_to_send": 1,
          "max_minutes_to_send": 1,
          "send_datetime": "<string>",
          "is_active": true
        },
        "weekly_sms_contact_limit": 5,
        "daily_sms_contact_limit": 1,
        "is_active": true
      },
      "multistep_status": {
        "current_step": 0,
        "total_available_contacts": 0,
        "total_sent": 0,
        "last_sent_timestamp": 123,
        "start_timestamp": 123,
        "initial_brands": [],
        "steps_performance": [],
        "status": "in_progress",
        "status_reason": "No segments selected",
        "last_timezones": [],
        "planner_data": {
          "days_of_week": "Mon",
          "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>"
            }
          },
          "multistep_data": {
            "step_size": 200,
            "step_delay": 5,
            "min_ctr": 123,
            "max_sms_to_send": 1,
            "max_minutes_to_send": 1,
            "send_datetime": "<string>",
            "is_active": true
          },
          "weekly_sms_contact_limit": 5,
          "daily_sms_contact_limit": 1,
          "is_active": true
        }
      },
      "hlr_settings": {
        "is_active": false,
        "number_of_retries": 0,
        "delay_between_retries": 0,
        "additional_time_increment": 0,
        "retry_until": "<string>"
      }
    },
    "created_at": "<string>",
    "updated_at": "<string>",
    "sms_campaign_id": "<string>",
    "logs": [
      {
        "caller_id": "<string>",
        "caller_type": "Send",
        "text": "<string>",
        "created_at": "<string>"
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

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

Path Parameters

campaign

string<uuid>

required

The campaign ID

campaignSend

string<uuid>

required

The campaign send ID

Response

SmsCampaignSendResource

data

SmsCampaignSendResource · object

required

Show child attributes

data.id

string

required

data.next_step_timestamp

string

required

data.status

string

required

data.meta

SmsCampaignMetaData · object

required

Show child attributes

data.meta.send_type

enum<string> | null

required

Available options:

manual,

multistep,

planner,

recurring,

feed

data.meta.segment_ids

object[]

required

data.meta.sms_routing_plan_id

string<uuid> | null

required

data.meta.filter_segment_id

string<uuid> | null

required

data.meta.domain_plan_id

string<uuid> | null

required

data.meta.use_dedicated_domains

boolean

default:false

required

data.meta.manual_data

CampaignManualData · object

required

Show child attributes

data.meta.manual_data.send_amount

integer

default:200

required

Required range: x >= 1

data.meta.manual_data.send_datetime

string | null

required

data.meta.manual_data.throttle_batch_size

integer

default:0

required

Required range: x >= 0

data.meta.multistep_data

CampaignMultistepData · object

required

Show child attributes

data.meta.multistep_data.step_size

integer

default:200

required

Required range: x >= 1

data.meta.multistep_data.step_delay

integer

default:5

required

Required range: x >= 1

data.meta.multistep_data.min_ctr

number | null

required

data.meta.multistep_data.max_sms_to_send

integer | null

required

Required range: x >= 0

data.meta.multistep_data.max_minutes_to_send

integer | null

required

Required range: x >= 0

data.meta.multistep_data.send_datetime

string | null

required

data.meta.multistep_data.is_active

boolean | null

default:true

required

data.meta.planner_data

CampaignPlannerData · object

required

Show child attributes

data.meta.planner_data.days_of_week

string[]

required

Minimum array length: 1

data.meta.planner_data.weekly_schedule

WeeklyScheduleData · object

required

Show child attributes

data.meta.planner_data.weekly_schedule.default

HoursOfDay · object

required

Show child attributes

data.meta.planner_data.weekly_schedule.default.start

string

required

data.meta.planner_data.weekly_schedule.default.end

string

required

data.meta.planner_data.weekly_schedule.Mon

HoursOfDay · object

required

Show child attributes

data.meta.planner_data.weekly_schedule.Mon.start

string

required

data.meta.planner_data.weekly_schedule.Mon.end

string

required

data.meta.planner_data.weekly_schedule.Tue

HoursOfDay · object

required

Show child attributes

data.meta.planner_data.weekly_schedule.Tue.start

string

required

data.meta.planner_data.weekly_schedule.Tue.end

string

required

data.meta.planner_data.weekly_schedule.Wed

HoursOfDay · object

required

Show child attributes

data.meta.planner_data.weekly_schedule.Wed.start

string

required

data.meta.planner_data.weekly_schedule.Wed.end

string

required

data.meta.planner_data.weekly_schedule.Thu

HoursOfDay · object

required

Show child attributes

data.meta.planner_data.weekly_schedule.Thu.start

string

required

data.meta.planner_data.weekly_schedule.Thu.end

string

required

data.meta.planner_data.weekly_schedule.Fri

HoursOfDay · object

required

Show child attributes

data.meta.planner_data.weekly_schedule.Fri.start

string

required

data.meta.planner_data.weekly_schedule.Fri.end

string

required

data.meta.planner_data.weekly_schedule.Sat

HoursOfDay · object

required

Show child attributes

data.meta.planner_data.weekly_schedule.Sat.start

string

required

data.meta.planner_data.weekly_schedule.Sat.end

string

required

data.meta.planner_data.weekly_schedule.Sun

HoursOfDay · object

required

Show child attributes

data.meta.planner_data.weekly_schedule.Sun.start

string

required

data.meta.planner_data.weekly_schedule.Sun.end

string

required

data.meta.planner_data.multistep_data

CampaignMultistepData · object

required

Show child attributes

data.meta.planner_data.multistep_data.step_size

integer

default:200

required

Required range: x >= 1

data.meta.planner_data.multistep_data.step_delay

integer

default:5

required

Required range: x >= 1

data.meta.planner_data.multistep_data.min_ctr

number | null

required

data.meta.planner_data.multistep_data.max_sms_to_send

integer | null

required

Required range: x >= 0

data.meta.planner_data.multistep_data.max_minutes_to_send

integer | null

required

Required range: x >= 0

data.meta.planner_data.multistep_data.send_datetime

string | null

required

data.meta.planner_data.multistep_data.is_active

boolean | null

default:true

required

data.meta.planner_data.weekly_sms_contact_limit

integer

default:5

required

Required range: x >= 1

data.meta.planner_data.daily_sms_contact_limit

integer

default:1

required

Required range: x >= 1

data.meta.planner_data.is_active

boolean

default:true

required

data.meta.multistep_status

CampaignMultistepStatusData · object

required

Show child attributes

data.meta.multistep_status.current_step

integer | null

default:0

required

data.meta.multistep_status.total_available_contacts

integer | null

default:0

required

data.meta.multistep_status.total_sent

integer | null

default:0

required

data.meta.multistep_status.last_sent_timestamp

integer | null

required

data.meta.multistep_status.start_timestamp

number | null

required

data.meta.multistep_status.initial_brands

string[] | null

required

data.meta.multistep_status.steps_performance

string[] | null

required

data.meta.multistep_status.status

string | null

default:in_progress

required

data.meta.multistep_status.status_reason

enum<string> | null

required

Available options:

No segments selected,

No timezones found,

No contacts found,

Planner is not active,

Multistep is not active,

Stopped by user,

CTR lower than min CTR,

Max SMS to send reached,

Max time to send reached,

Send timeout

data.meta.multistep_status.last_timezones

string[] | null

required

data.meta.multistep_status.planner_data

CampaignPlannerData · object

required

Show child attributes

data.meta.multistep_status.planner_data.days_of_week

string[]

required

Minimum array length: 1

data.meta.multistep_status.planner_data.weekly_schedule

WeeklyScheduleData · object

required

Show child attributes

data.meta.multistep_status.planner_data.weekly_schedule.default

HoursOfDay · object

required

Show child attributes

data.meta.multistep_status.planner_data.weekly_schedule.default.start

string

required

data.meta.multistep_status.planner_data.weekly_schedule.default.end

string

required

data.meta.multistep_status.planner_data.weekly_schedule.Mon

HoursOfDay · object

required

Show child attributes

data.meta.multistep_status.planner_data.weekly_schedule.Mon.start

string

required

data.meta.multistep_status.planner_data.weekly_schedule.Mon.end

string

required

data.meta.multistep_status.planner_data.weekly_schedule.Tue

HoursOfDay · object

required

Show child attributes

data.meta.multistep_status.planner_data.weekly_schedule.Tue.start

string

required

data.meta.multistep_status.planner_data.weekly_schedule.Tue.end

string

required

data.meta.multistep_status.planner_data.weekly_schedule.Wed

HoursOfDay · object

required

Show child attributes

data.meta.multistep_status.planner_data.weekly_schedule.Wed.start

string

required

data.meta.multistep_status.planner_data.weekly_schedule.Wed.end

string

required

data.meta.multistep_status.planner_data.weekly_schedule.Thu

HoursOfDay · object

required

Show child attributes

data.meta.multistep_status.planner_data.weekly_schedule.Thu.start

string

required

data.meta.multistep_status.planner_data.weekly_schedule.Thu.end

string

required

data.meta.multistep_status.planner_data.weekly_schedule.Fri

HoursOfDay · object

required

Show child attributes

data.meta.multistep_status.planner_data.weekly_schedule.Fri.start

string

required

data.meta.multistep_status.planner_data.weekly_schedule.Fri.end

string

required

data.meta.multistep_status.planner_data.weekly_schedule.Sat

HoursOfDay · object

required

Show child attributes

data.meta.multistep_status.planner_data.weekly_schedule.Sat.start

string

required

data.meta.multistep_status.planner_data.weekly_schedule.Sat.end

string

required

data.meta.multistep_status.planner_data.weekly_schedule.Sun

HoursOfDay · object

required

Show child attributes

data.meta.multistep_status.planner_data.weekly_schedule.Sun.start

string

required

data.meta.multistep_status.planner_data.weekly_schedule.Sun.end

string

required

data.meta.multistep_status.planner_data.multistep_data

CampaignMultistepData · object

required

Show child attributes

data.meta.multistep_status.planner_data.multistep_data.step_size

integer

default:200

required

Required range: x >= 1

data.meta.multistep_status.planner_data.multistep_data.step_delay

integer

default:5

required

Required range: x >= 1

data.meta.multistep_status.planner_data.multistep_data.min_ctr

number | null

required

data.meta.multistep_status.planner_data.multistep_data.max_sms_to_send

integer | null

required

Required range: x >= 0

data.meta.multistep_status.planner_data.multistep_data.max_minutes_to_send

integer | null

required

Required range: x >= 0

data.meta.multistep_status.planner_data.multistep_data.send_datetime

string | null

required

data.meta.multistep_status.planner_data.multistep_data.is_active

boolean | null

default:true

required

data.meta.multistep_status.planner_data.weekly_sms_contact_limit

integer

default:5

required

Required range: x >= 1

data.meta.multistep_status.planner_data.daily_sms_contact_limit

integer

default:1

required

Required range: x >= 1

data.meta.multistep_status.planner_data.is_active

boolean

default:true

required

data.meta.hlr_settings

HlrSettingsData · object

required

Show child attributes

data.meta.hlr_settings.is_active

boolean

default:false

required

data.meta.hlr_settings.number_of_retries

integer

default:0

required

Required range: x >= 0

data.meta.hlr_settings.delay_between_retries

integer

default:0

required

Required range: x >= 0

data.meta.hlr_settings.additional_time_increment

integer

default:0

required

Required range: x >= 0

data.meta.hlr_settings.retry_until

string | null

required

data.created_at

string

required

data.updated_at

string

required

data.sms_campaign_id

string

required

data.logs

SmsCampaignLogResource · object[]

Show child attributes

data.logs.caller_id

string

required

data.logs.caller_type

enum<string>

required

Available options:

Send,

Campaign

data.logs.text

string

required

data.logs.created_at

string

required

Post v1smscampaigns plannerstop Get v1smscampaigns domains cost

⌘I

Endpoints

Authorizations

Path Parameters

Response