Analyze a Voice Campaign

post

https://connect.routee.net/voice/analysis

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Response Parameters

KEY	DESCRIPTION
contacts	The details of each contact. The key refers to the id of the contact given in the request
numberOfRecipients	The total number of recipients
recipientCountries	For each recipient the country that the mobile belongs to (country format in ISO 3166-1 alpha-2)
recipientsPerCountry	The total recipients per country (country format in ISO 3166-1 alpha-2)
recipientsPerGroup	For each group the number of recipients that it contains without the blacklisted contacts
totalInGroups	The total number of recipients in all given groups excluding the ones already specified and the blacklisted
errors.code	The code of error
errors.developerMessage	Message of error
errors.property	The numbers of invalid recipients

ERROR CODES

Status	Code	Description
403		User is not authenticated
404		User is not found

Body Params

from

string

required

The sender id for this call

groups

array of strings

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

groups

contacts

array of strings

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

contacts

array of strings

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

fileURL

string

The url of the wav file to play

message

object

Represents the text message to be converted to wav file

Headers

Content-Type

string

required

Defaults to application/json

application/json

Authorization

string

required

Defaults to Bearer {access_token}

Bearer {access_token}

Responses

Language

Loading…

Response

Choose an example:

application/json

200200

400400