---
title: "Send a Voice Campaign"
method: POST
path: "/voice/campaign"
---

# Send a Voice Campaign

`POST /voice/campaign`

Send a Voice messaging campaign to multiple recipients. This is a paid service. For pricing check [here](https://dev.routee.net/#/management/financial/pricing)

## Headers

- `Content-Type` string, required
- `Authorization` string, required

## Request body

- object
  - `from` string, required — The sender id for this call. The sender id can be a telephone number or an alphanumeric string. NOTICE: Alphanumeric sender is not supported by all networks (e.g. Greek networks). Check restrictions and features here: https://go.routee.net/#/management/restrictions-and-features
  - `to` string[] — The recipients of this call, must be a list with valid numbers (mobiles or landlines). Max length: 1000. One of "groups", "to", "contacts" parameters are required.
  - `contacts` string[] — The contacts of this call, must be a list with valid contact ids. Max length: 1000. One of "groups", "to", "contacts" parameters are required.
  - `groups` string[] — The lists of this call, must be a list with valid group names. Max length: 1000. One of "groups", "to", "contacts" parameters are required.
  - `name` string — The name of the voice campaign. The name of the campaign. If you want to be able to track the whole campaign from Routee web platform use a name. Must be between 2 and 30 characters and contain only latin letters, numbers, spaces and -
  - `fileURL` string — The url of the wav file to play. One of fileURL or message parameters is required.
  - `message` object — Represents the text message to be converted to speech. One of fileURL or message parameters is required.
    - `gender` string — The gender of the voice message to be played. Check [here](/docs/text-to-speech) for possible values
    - `language` string — The language of the voice message to be played. Check [here](/docs/text-to-speech) for possible values
    - `text` string — The text of the voice message to be played
  - `respectQuietHours` boolean — Indicates if the call should respect the quiet hours, default value: false.
  - `ignoreDnd` boolean — Use this option when sending transactional messages. By enabling this option, Routee will ignore any Do Not Disturb list and will send the campaign to all the recipients you have provided. This option may violate user privacy.
  - `scheduledDate` string, date — The date and time (in UTC), that the call campaign will be executed at. (eg YYYY-MM-DDThh:mm:ssTZD where TZD is the time zone designator (Z or +hh:mm or -hh:mm))
  - `hangupDelay` integer — The time to wait for the call to be answered
  - `campaignCallback` object — Information about a DLR callback for the progress of the Voice campaign.
    - `url` string — The URL that Routee will POST to, each time your campaign status changes to one of the following: Scheduled, Queued, Sent, Running, Finished, or Failed.
    - `strategy` string — When the URL will be called. Two possible values: on every status change (OnChange) or when a final status arrives (OnCompletion).
  - `callback` object — Defines the notification callback information for an individual message progress of the Voice campaign
    - `url` string, required — A URL that Routee will POST to, when a status change of a voice message occurs.
    - `strategy` string, required — Defines when the URL will be called. Two possible values: on every status change (OnChange) or when a final status arrives (OnCompletion).
  - `collectDtmfDigits` boolean — Indicates if the voice campaign should collect DTMF digits at the end of the voice message.
  - `collectDtmfAwaitSeconds` integer — If you enable the collectDtmfDigits you can set the duration of the pause that will be added at the end of the voice message.

## Response `200`

200

- object
  - `trackingId` string
  - `type` string
  - `state` string
  - `createdAt` string
  - `respectQuietHours` boolean
  - `from` string
  - `to` string[]
  - `contacts` object[]
  - `groups` object[]
  - `message` object
    - `language` string
    - `gender` string
    - `text` string
  - `voiceAnalysis` object
    - `numberOfRecipients` integer
    - `recipientsPerCountry` object
      - `GR` integer
    - `recipientCountries` object
      - `+306977663000` string
    - `contacts` object
    - `recipientsPerGroup` object
    - `totalInGroups` integer
  - `statuses` object
    - `Unknown` integer
    - `Queued` integer
    - `Initiated` integer
    - `Ringing` integer
    - `InProgress` integer
    - `Completed` integer
    - `Busy` integer
    - `NoAnswer` integer
    - `Failed` integer
    - `Unsent` integer
    - `Terminated` integer
  - `cost` integer

## Other responses

- `400` — 400

---

[API](https://skmtc.net/routee/apis/auth.md) · [All operations](https://skmtc.net/routee/apis/auth/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/routee/auth/versions/5cef04e8f7d8/schema)