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.
Automatic Voice API functionality
Send voice text-to-speech
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:
Send voice from template
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:
Send bulk voice
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:
Send bulk voice from template
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:
Get voice delivery status
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:
Get list of 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:
ANNEX: List of languages and voices for available voice calls
In this annex you will find all the possible combinations of languages and voices that you can use when sending voice call messages
Language (Language) | Gender | Name (voice) |
---|---|---|
ar | female | Hoda |
ar | male | Naayf |
ar | female | Zeina |
ar | female | Aisha |
ar | male | Farooq |
ar | male | Hussein |
ar | female | Amal |
bg | male | Ivan |
bn | female | Sushmita |
bn | male | Sayan |
ca | female | Conchita |
ca | female | Herena |
cs | male | Jakub |
da | female | Helle |
da | male | Mads |
da | female | Naja |
de | female | Angela |
de | male | Hans |
de | female | Vicki |
de | male | Stefan |
de | female | Marlene |
de | female | Hedda |
de-at | male | Michael |
de-ch | male | Karsten |
el | female | Afroditi |
el | male | Stefanos |
el | female | Sophia |
en | female | Jane |
en | female | Jessica |
en | female | Joanna |
en | male | Joey |
en | male | Justin |
en | female | Kendra |
en | female | Kimberly |
en | male | Matthew |
en | female | Zira |
en | female | Ivy |
en | male | Guy |
en | male | Benjamin |
en | female | Salli |
en-au | male | Russell |
en-au | female | Nicole |
en-au | female | Catherine |
en-au | female | Hayley |
en-ca | female | Heather |
en-ca | female | Alice |
en-gb | female | Rosie |
en-gb | female | Hazel |
en-gb | male | George |
en-gb | female | Emma |
en-gb | male | Brian |
en-gb | female | Amy |
en-gb-wls | male | Geraint |
en-ie | male | Sean |
en-in | male | Ravi |
en-in | female | Aditi |
en-in | female | Heera |
en-in | female | Priya |
en-in | female | Raveena |
es | female | Penelope |
es | male | Miguel |
es | female | Linda |
es | female | Laura |
es | male | Enrique |
es | female | Lupe |
es | male | Pablo |
es-cl | female | Francisca |
es-mx | female | Hilda |
es-mx | female | Mia |
es-mx | male | Raul |
fi | female | Milla |
fi | female | Evelin |
fi | female | Heidi |
fr | male | Picart |
fr | male | Mathieu |
fr | female | Juliette |
fr | female | Lea |
fr | female | Celine |
fr | female | Hortense |
fr-ca | female | Caroline |
fr-ca | female | Chantal |
fr-ca | female | Harmonie |
fr-ch | male | Guillaume |
gu | female | Leela |
gu | male | Dinesh |
he | male | Asaf |
hi | female | Kalpana |
hi | male | Hemant |
hi | female | Aadita |
hr | male | Matej |
hu | male | Szabolcs |
id | female | Indah |
id | male | Andika |
id | male | Reza |
id | female | Nurul |
id | male | Arif |
is | male | Karl |
is | female | Dora |
it | female | Lucia |
it | male | Cosimo |
it | female | Carla |
it | female | Bianca |
it | male | Giorgio |
it | female | Gianna |
ja | male | Ichiro |
ja | male | Takumi |
ja | female | Haruka |
ja | female | Ayumi |
ja | female | Mizuki |
kn | male | Shashank |
kn | female | Namratha |
ko | male | Minho |
ko | male | Himchan |
ko | female | Jina |
ko | female | Sumi |
ko | female | Yumi |
ko | female | Seoyeon |
ko | female | Heami |
ml | female | Kirti |
ml | male | Vishnu |
ms | male | Rizwan |
nl | male | Ruben |
nl | female | Lotte |
nl | female | Hanna |
no | female | Liv |
no | female | Hulda |
pl | male | Jacek |
pl | female | Ewa |
pl | male | Jan |
pl | female | Paulina |
pl | female | Maja |
pt-br | female | Camila |
pt-br | male | Daniel |
pt-br | female | Vitoria |
pt-br | male | Ricardo |
pt-br | female | Heloisa |
pt-pt | female | Abrielle |
pt-pt | female | Jacinda |
pt-pt | male | Jeraldo |
pt-pt | male | Henriques |
pt-pt | female | Ines |
pt-pt | female | Helia |
pt-pt | male | Cristiano |
pt-pt | female | Amalia |
ro | female | Carmen |
ro | male | Andrei |
ru | female | Ekaterina |
ru | female | Irina |
ru | male | Pavel |
ru | female | Tatyana |
ru | male | Maxim |
sk | male | Filip |
sl | male | Lado |
sv | female | Astrid |
sv | female | Hedvig |
ta | female | Shruti |
ta | male | Valluvar |
ta | male | Ganesh |
te | male | Vijay |
te | female | Samantha |
te | female | Chitra |
th | male | Pattara |
th | female | Somsi |
tr | female | Filiz |
tr | female | Seda |
vi | female | Lien |
vi | male | Quan |
vi | male | An |
vi | male | Thao |
vi | female | Mai |
wls | female | Gwyneth |
zh-cn | female | Lin |
zh-cn | female | Akemi |
zh-cn | female | Liu |
zh-cn | male | Wang |
zh-cn | male | Huang |
zh-cn | male | Chen |
zh-cn | female | Zhiyu |
zh-cn | female | Yaoyao |
zh-cn | female | Lily |
zh-cn | male | Kangkang |
zh-cn | female | Huihui |
zh-cn | male | Zhang |
zh-tw | female | Yating |
zh-tw | male | Zhiwei |
zh-tw | female | Hanhan |
Tools that enhance our Voice API
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
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
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
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
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
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
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
The Text to Speech API allows you to make thousands of calls per minute.White list security
Enable white lists and allow connections only from the included IPs.Send calls from Templates
Use the templates and send calls with predesigned messages.Delivery status information
Obtain the delivery status of your calls through the API.Multiple accesses per account
You can create as many users to connect to the API with the same account as you want.Subaccounts
Create sub-accounts for other companies or departments with their own API connection and balance.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