Sign in

v1

latestOpenAPI 3.1.02026-07-2414238909.1 KB

Send a Voice Campaign

Send a Voice messaging campaign to multiple recipients. This is a paid service. For pricing check here

post/voice/campaign

Headers

Content-Typestring required

application/json

Authorizationstring required

Bearer {access_token}

Request body

fromstring 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

tostring[]

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.

contactsstring[]

The contacts of this call, must be a list with valid contact ids. Max length: 1000. One of "groups", "to", "contacts" parameters are required.

groupsstring[]

The lists of this call, must be a list with valid group names. Max length: 1000. One of "groups", "to", "contacts" parameters are required.

namestring

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 -

fileURLstring

The url of the wav file to play. One of fileURL or message parameters is required.

respectQuietHoursboolean

Indicates if the call should respect the quiet hours, default value: false.

ignoreDndboolean

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.

scheduledDatestring 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))

hangupDelayinteger

The time to wait for the call to be answered

collectDtmfDigitsboolean

Indicates if the voice campaign should collect DTMF digits at the end of the voice message.

collectDtmfAwaitSecondsinteger

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

trackingIdstring
typestring
statestring
createdAtstring
respectQuietHoursboolean
fromstring
tostring[]
contactsobject[]
groupsobject[]
costinteger

Example response

{
  "trackingId": "e21e65d7-030b-431f-82f9-d64c784b731a",
  "type": "Voice",
  "state": "Queued",
  "createdAt": "2017-03-29T10:20:47.43Z",
  "from": "+3069XXXXXXXX",
  "to": [
    "+3069XXXXXXXX"
  ],
  "message": {
    "language": "en-US",
    "gender": "female",
    "text": "This is a test message, please ignore. Have a good day!"
  },
  "voiceAnalysis": {
    "numberOfRecipients": 1,
    "recipientsPerCountry": {
      "GR": 1
    },
    "recipientCountries": {
      "+306977663000": "GR"
    }
  },
  "statuses": {
    "Queued": 1
  }
}