v1

latestOpenAPI 3.1.02026-07-2414238909.1 KB

Analyze a Voice Campaign

Analyzing a voice campaign sendout is useful when the user needs information about the send out before actually sending it.

post/voice/analysis

Headers

Content-Typestring required

application/json

Authorizationstring required

Bearer {access_token}

Request body

fromstring required

The sender id for this call

groupsstring[]

The groups of contacts selected as recipients of this call. One of "groups", "to", "contacts" parameters is required.

contactsstring[]

The contacts selected as recipients of this call. One of "groups", "to", "contacts" parameters is required.

tostring[]

The recipients of this call, must be a list with valid numbers (mobiles or landlines). One of "groups", "to", "contacts" parameters is required.

fileURLstring

The url of the wav file to play

Response

200

numberOfRecipientsinteger

contactsobject

recipientsPerGroupobject

totalInGroupsinteger

Example response

{
  "numberOfRecipients": 2,
  "recipientsPerCountry": {
    "GR": 1,
    "GB": 1
  },
  "recipientCountries": {
    "+447123123456": "GB",
    "+306977663127": "GR"
  }
}