VOICE API

Voice API allows you to send automated calls to clients via API

  • HTTP API, Send Voice from any programming language.
  • SMPP server, Send voice using an SMPP client.
  • 99.9% SLA, We optimize the performance of all servers.
  • Maximum Connectivity, Compatible with all countries and operators.
VOICE API

Programming languages

Click on the programming language and access examples to integrate the Speech API with just copy and paste

Automatic Voice API functionality

Send voice text-to-speech

API method that allows you to send a voice call that automatically reproduces the message sent to a mobile or landline number. It allows programming the date / time sending.
Parameter Description Compulsory / Optional
class=voice Class requested: Class to which the request is made Compulsory
method=sendvoice Class method requested: Method of the class to which the request is made Compulsory
user User and e-mail of your Afilnet account Compulsory
password Password of your Afilnet account Compulsory
to Mobile or landline number where the voice call will be sent Compulsory
from Sender of the voice call, it must be a phone number, if an unaccepted sender is included, the voice call will be sent with an unknown sender Compulsory
message Message to be played by voice in voice call Compulsory
scheduledatetime Date and time of shipment in yyyy-mm-dd hh:mm:ss format Optional
language Language in which the voice call will be played, check attached table to see available values Optional
voice Voice with which the voice call will be played, check attached table to see available values Optional
output Output format of the result Optional

Answer:

  • status
  • result (if status=success), here you will receive the following values:
    • messageid
    • credits
  • error (if status=error), here you will receive the error code

Error codes:

Code Description
MISSING_USER User or email not included
MISSING_PASSWORD Password not included
MISSING_CLASS Class not included
MISSING_METHOD Method not included
MISSING_COMPULSORY_PARAM Compulsory parameter not included
INCORRECT_USER_PASSWORD Incorrect user or password
INCORRECT_CLASS Incorrect class
INCORRECT_METHOD Incorrect method
NO_ROUTE_AVAILABLE There are no available paths for the indicated destination
NO_CREDITS Your balance is insufficient

Parameters:

  • class : voice
  • method : sendvoice
  • user : user
  • password : password
  • to : 34600000000
  • from : 34900000000
  • message : voice+test
  • scheduledatetime :
  • language : en
  • voice : Joanna
  • output :

Request:

https://www.afilnet.com/api/http/?class=voice&method=sendvoice&user=user&password=password&to=34600000000&from=34900000000&message=voice+test&scheduledatetime=&language=en&voice=Joanna&output=

Send voice from template

API method that allows you to send an automated voice call to a recipient from a message saved as a template using the VOICE API . You can send a voice call from a message to any mobile device in the world and with a personalized sender (as long as the destination operator allows it). With this method you can also send scheduled voice at a desired date / time. This method also allows you to parameterize the voice message.
Parameter Description Compulsory / Optional
class=voice Class requested: Class to which the request is made Compulsory
method=sendvoicefromtemplate Class method requested: Method of the class to which the request is made Compulsory
user User and e-mail of your Afilnet account Compulsory
password Password of your Afilnet account Compulsory
to Mobile or landline number where the voice call will be sent Compulsory
idtemplate Identifier of the template that contains the message that the voice call will play Compulsory
params Parameters to be substituted in the template for voice call customization, each {{parameter}} will be replaced by the assigned value Optional
scheduledatetime Date and time of shipment in yyyy-mm-dd hh:mm:ss format Optional
language Language in which the voice call will be played, check attached table to see available values Optional
voice Voice with which the voice call will be played, check attached table to see available values Optional
output Output format of the result Optional

Answer:

  • status
  • result (if status=success), here you will receive the following values:
    • messageid
    • credits
  • error (if status=error), here you will receive the error code

Error codes:

Code Description
MISSING_USER User or email not included
MISSING_PASSWORD Password not included
MISSING_CLASS Class not included
MISSING_METHOD Method not included
MISSING_COMPULSORY_PARAM Compulsory parameter not included
INCORRECT_USER_PASSWORD Incorrect user or password
INCORRECT_CLASS Incorrect class
INCORRECT_METHOD Incorrect method
NO_ROUTE_AVAILABLE There are no available paths for the indicated destination
NO_CREDITS Your balance is insufficient
NOT_ACCESS_TO_TEMPLATE You haven't access to the selected template

Parameters:

  • class : voice
  • method : sendvoicefromtemplate
  • user : user
  • password : password
  • to : 34600000000
  • idtemplate : 1000
  • params : mobile:123456789,name:test+name
  • scheduledatetime :
  • language : en
  • voice : Joanna
  • output :

Request:

https://www.afilnet.com/api/http/?class=voice&method=sendvoicefromtemplate&user=user&password=password&to=34600000000&idtemplate=1000¶ms=mobile:123456789,name:test+name&scheduledatetime=&language=en&voice=Joanna&output=

Send bulk voice

API method that allows you to send automated voice calls from a common message to a group of contacts . With this method you can also program the date / time you want and customize your voice messages.
Parameter Description Compulsory / Optional
class=voice Class requested: Class to which the request is made Compulsory
method=sendvoicetogroup Class method requested: Method of the class to which the request is made Compulsory
user User and e-mail of your Afilnet account Compulsory
password Password of your Afilnet account Compulsory
from Sender of the voice call, it must be a phone number, if an unaccepted sender is included, the voice call will be sent with an unknown sender Compulsory
countrycode Country prefix Compulsory
idgroup Group identifier containing the contacts to which the voice call will be sent Compulsory
message Message to be played by voice in voice call Compulsory
language Language in which the voice call will be played, check attached table to see available values Optional
voice Voice with which the voice call will be played, check attached table to see available values Optional
scheduledatetime Date and time of shipment in yyyy-mm-dd hh:mm:ss format Optional
output Output format of the result Optional

Answer:

  • status
  • result (if status=success), here you will receive the following values:
    • id
    • count
    • credits
    • destinations
      • messageid
      • destination
  • error (if status=error), here you will receive the error code

Error codes:

Code Description
MISSING_USER User or email not included
MISSING_PASSWORD Password not included
MISSING_CLASS Class not included
MISSING_METHOD Method not included
MISSING_COMPULSORY_PARAM Compulsory parameter not included
INCORRECT_USER_PASSWORD Incorrect user or password
INCORRECT_CLASS Incorrect class
INCORRECT_METHOD Incorrect method
NOT_ACCESS_TO_GROUP You are not allowed into the indicated group
NO_CREDITS Your balance is insufficient

Parameters:

  • class : voice
  • method : sendvoicetogroup
  • user : user
  • password : password
  • from : 34900000000
  • countrycode : 34
  • idgroup : 1
  • message : sms+test
  • language : en
  • voice : Joanna
  • scheduledatetime :
  • output :

Request:

https://www.afilnet.com/api/http/?class=voice&method=sendvoicetogroup&user=user&password=password&from=34900000000&countrycode=34&idgroup=1&message=sms+test&language=en&voice=Joanna&scheduledatetime=&output=

Send bulk voice from template

API method that allows you to send automated voice calls to a group of contacts with a previously defined message in a template. With this method you can also program the date / time you want and customize your voice messages.
Parameter Description Compulsory / Optional
class=voice Class requested: Class to which the request is made Compulsory
method=sendvoicetogroupfromtemplate Class method requested: Method of the class to which the request is made Compulsory
user User and e-mail of your Afilnet account Compulsory
password Password of your Afilnet account Compulsory
countrycode voice.sendvoicetogroupfromtemplate_countrycode Compulsory
idgroup Group identifier containing the contacts to which the voice call will be sent Compulsory
idtemplate Identifier of the template that contains the message that the voice call will play Compulsory
scheduledatetime Date and time of shipment in yyyy-mm-dd hh:mm:ss format Optional
language Language in which the voice call will be played, check attached table to see available values Optional
voice Voice with which the voice call will be played, check attached table to see available values Optional
output Output format of the result Optional

Answer:

  • status
  • result (if status=success), here you will receive the following values:
    • id
    • count
    • credits
    • destinations
      • messageid
      • destination
  • error (if status=error), here you will receive the error code

Error codes:

Code Description
MISSING_USER User or email not included
MISSING_PASSWORD Password not included
MISSING_CLASS Class not included
MISSING_METHOD Method not included
MISSING_COMPULSORY_PARAM Compulsory parameter not included
INCORRECT_USER_PASSWORD Incorrect user or password
INCORRECT_CLASS Incorrect class
INCORRECT_METHOD Incorrect method
NOT_ACCESS_TO_GROUP You are not allowed into the indicated group
NO_CREDITS Your balance is insufficient

Parameters:

  • class : voice
  • method : sendvoicetogroupfromtemplate
  • user : user
  • password : password
  • countrycode : 34
  • idgroup : 1
  • idtemplate : 1000
  • scheduledatetime :
  • language : en
  • voice : Joanna
  • output :

Request:

https://www.afilnet.com/api/http/?class=voice&method=sendvoicetogroupfromtemplate&user=user&password=password&countrycode=34&idgroup=1&idtemplate=1000&scheduledatetime=&language=en&voice=Joanna&output=

Get voice delivery status

API method that allows obtaining the delivery status of a list of automated voice calls.
Parameter Description Compulsory / Optional
class=voice Class requested: Class to which the request is made Compulsory
method=getdeliverystatus Class method requested: Method of the class to which the request is made Compulsory
user User and e-mail of your Afilnet account Compulsory
password Password of your Afilnet account Compulsory
messages voice.getdeliverystatus_messages Compulsory
output Output format of the result Optional

Answer:

  • status
  • result (if status=success), here you will receive the following values:
    • messageid
    • sms
    • deliverydate
    • deliverystatus
  • error (if status=error), here you will receive the error code

Error codes:

Code Description
MISSING_USER User or email not included
MISSING_PASSWORD Password not included
MISSING_CLASS Class not included
MISSING_METHOD Method not included
MISSING_COMPULSORY_PARAM Compulsory parameter not included
INCORRECT_USER_PASSWORD Incorrect user or password
INCORRECT_CLASS Incorrect class
INCORRECT_METHOD Incorrect method

Parameters:

  • class : voice
  • method : getdeliverystatus
  • user : user
  • password : password
  • messages : 123456,123457,123458
  • output :

Request:

https://www.afilnet.com/api/http/?class=voice&method=getdeliverystatus&user=user&password=password&messages=123456,123457,123458&output=

Get list of voices

API method that returns the list of available voices.
Parameter Description Compulsory / Optional
class=voice Class requested: Class to which the request is made Compulsory
method=getdeliverystatus Class method requested: Method of the class to which the request is made Compulsory
user User and e-mail of your Afilnet account Compulsory
password Password of your Afilnet account Compulsory
lang voice language Optional

Answer:

  • status
  • result (if status=success), here you will receive the following values:
    • lang
    • gender
    • name
    • default
  • error (if status=error), here you will receive the error code

Error codes:

Code Description
MISSING_USER User or email not included
MISSING_PASSWORD Password not included
MISSING_CLASS Class not included
MISSING_METHOD Method not included
MISSING_COMPULSORY_PARAM Compulsory parameter not included
INCORRECT_USER_PASSWORD Incorrect user or password
INCORRECT_CLASS Incorrect class
INCORRECT_METHOD Incorrect method

Parameters:

  • class : voice
  • method : getdeliverystatus
  • user : user
  • password : password
  • lang : en

Request:

https://www.afilnet.com/api/http/?class=voice&method=getdeliverystatus&user=user&password=password&lang=en

Tools that enhance our Voice API

SECURE API CONNECTION

SECURE API CONNECTION

Security tailored to your business

Configure your API connections , create new accesses and manage existing ones.

Filter all API accesses by IP , add or remove enabled IPs to guarantee the security of your accesses.

Keep track of all connections made , API used and connection dates / time

MULTIPLE APIs

MULTIPLE APIs

Connectivity tailored to your business

We offer you multiple APIs to connect with us, we have an HTTP API, BASIC AUTH, SOAP and JWT Authentication so that you can connect with us the way you want.

Connect with any of the APIs in a secure, simple and centralized way . Afilnet API is perfect for your software.

API Logs

API Logs

Get to know each request in detail

Thanks to our logs you will be able to review all the requests made and the corresponding response from our API, which will allow you to consult details when you need them.

The information you can consult is the following:

  • Source IP of the request
  • Date & Time of the request
  • API & Method being called
  • Parameters sent to the API
  • API response
  • metadata

Steps to use Voice API

Using the Afilnet Voice API will only take a few minutes

01

Register as a client

You need to be a registered user to access the Voice API . Once you are registered you can make the requests you need about the API

02

Integrate the Voice API

Perform the SMS API integration in your favorite programming language. Remember that we help you if you have any questions or need help with the API

03

Request your free trial

We offer you credits to test the voice API before you buy. Make voice calls and test all the functionality you need

04

Welcome to Afilnet!

Everything ready!, has managed to improve its communications with Afilnet. We are here to support our API when you need it

Text to Speech API service features

Thousands of calls per minute

Thousands of calls per minute

The Text to Speech API allows you to make thousands of calls per minute.
White list security

White list security

Enable white lists and allow connections only from the included IPs.
Send calls from Templates

Send calls from Templates

Use the templates and send calls with predesigned messages.
Delivery status information

Delivery status information

Obtain the delivery status of your calls through the API.
Multiple accesses per account

Multiple accesses per account

You can create as many users to connect to the API with the same account as you want.
Subaccounts

Subaccounts

Create sub-accounts for other companies or departments with their own API connection and balance.

Numbers related to Text to Speech API

10,500

Clients

0.5M

Daily API Requests

1,300

Connected Operators

230

Connected countries

Frequently asked questions about the Text to Speech API

Here you can find frequently asked questions from the Text to Speech API, if you have any other questions or need help in integration you can contact us.

The use of the Text to Speech API of Afilnet has no cost, you pay for the services consumed through the API, but not by making use of it

Remember that we help companies to integrate the Text to Speech API, if you have problems with integration, please contact us and we will help you

Afilnet provides filters for White Lists by IP for the SMS API, which will allow you to use the API only from the IPs you want

You can use the API as much as you want, there is no limit to the use of the API

Try Afilnet for free!

Sign up for free and try Afilnet! We offer you a free trial of our services. *



(*) Promotion only valid for companies that have never used the Afilnet service before. When requesting the free balance, Afilnet may request to verify your company information


Bulk SMS · Email Marketing · Social network · Instant messaging · Certification · and much more
Continue IMPORTANT INFORMATION ABOUT COOKIES: If you continue to use this web we will assume that you accept the terms of use. You will find more information in our Cookies Policy.
Payment methods
Wire transfer
Credit card
Paypal
Western Union
Skrill
Crypto
Afilnet in your language

Copyright © 2022 Afilnet · All rights reserved