Envío de mensajes de voz

//Envío de mensajes de voz

3. Envío de mensajes de voz

La plataforma Tell It permite la integración para envío de mensajes originados por su plataforma (MT: Mobile Terminated) por medio de nuestra API de voz a través de métodos de autenticación tipo Basic. El envío es a una API rest tipo POST.

Authorization = Basic Base64({usuario}:{contraseña})

Bajo este esquema se debe enviar una petición con la siguiente estructura.

URL para consumir el servicio:

https://apitellitvoice.aldeamo.com/voice/sendPost

Ejemplo de la petición (tipo POST)

  • Content-Type: application/json
  • JSON petición: 
{
    "country": Numeric,
    "dateToSend": "String",
    "type": "String",
    "message": "String",
    "format": "String",
    "paramsTTS": {
        "language": "String",
        "voice": "String"
    },
    "paramsAttempts": {
        "totalRetries": Numeric,
        "timeRetry": Numeric
    },
    "reproductions": Numeric,
    "addresseeList": [
        {
            "message": "String",
            "mobile": "String",
            "correlationLabel": "String",
            "tags": {
                "key": "String"
            }
        }
    ]
}
Parámetro Descripción Formato Obligatoriedad
Usuario Usuario de las credenciales creadas para el cliente. Obligatorio
Contraseña Contraseña asignada para el cliente. Obligatorio
country Código del país al que pertenece el teléfono de destino (Ejemplo: 57 para Colombia o 51 para Perú) Numeric Obligatorio
dateToSend Fecha y hora en la que se desea enviar el mensaje; el formato de la fecha DEBE ser "yyyy-MM-ddT HH:mm:ssZ". La zona horaria asignada a la fecha es la del país de destino; si no se envía, se asume que es inmediato. T=Indicativo Tiempo en ISO Z=Zona Horaria String Opcional
type Es la manera en la que se va a trabajar el audio. Existen 3 posibles valores:
TTS: (Text to speech) El audio se genera a partir de una cadena de texto. Permite enviar mensajes independientes a múltiples destinatarios en una sola petición.
URL: El archivo de audio se recupera desde una URL pública. Permite enviar mensajes independientes a múltiples destinatarios en una sola petición.
BASE64: El archivo de audio se envía codificado en base64. Permite el envío de un solo archivo a todos los destinatarios.
String Obligatorio
message Es el contenido del mensaje, dependiendo del type, puede ser un texto (type=TTS), una URL (type=URL) o la codificación del archivo en base 64 (type=BASE64) String Obligatorio
format Posibles valores:
MP3: Para archivos en formato .mp3
WAV: Para archivos en formato .wav
OGG: Para archivos en formato .ogg
String Opcional
*(Obligatorio solo para los type URL y BASE64)
paramsTTS Son los parámetros con los que se realizará la conversión de texto a audio, incluyen:
language: lenguaje del texto
voice: selecciona la voz con la que se leerá el texto *Los valores de language y voice se eligen de la tabla de lenguajes y voces que se muestra más abajo
String Opcional
*(Obligatorio solo para los type TTS )
paramsAttempts Aquí se configuran los parámetros de los intentos, incluye:
TotalRetries: Número total de intentos (llamadas), si no se especifica, tomará por defecto 3.
timeRetry: Tiempo (en segundos) entre cada intento, si no se especifica, tomará por defecto 180.
Numeric Opcional
reproductions Número de veces que se repite el audio dentro de la llamada Numeric Opcional (Por defecto toma valor de 1)
addresseeList Lista de destinatarios del mensaje, contiene:
Message: Mensaje que será transformado a audio mediante Text to Speech, TTS.
(Si el type es URL, aquí se puede colocar la URL del audio.)
String Opcional
mobile: Número de destino (NO contiene el código del país) String Obligatorio
CorrelationLabel: Identificador de correlación de cada mensaje en la petición. Se puede usar para agrupar y asociar transacciones en reportes. String Opcional
tags: Parámetros o variables (etiquetas) del mensaje TTS String Opcional (Solo se evalúa si es type TTS)

Lista de lenguajes y voces:

Lenguaje Voz Descripción
es-CO es-CO-GonzaloNeural Español Colombia Hombre (Gonzalo)
es-CO es-CO-SalomeNeural Español Colombia Mujer (Salome)
es-MX es-MX-DaliaNeural Español México Mujer (Dalia)
es-MX es-MX-JorgeNeural Español México Hombre (Jorge)
es-MX es-MX-HildaRUS Español México Mujer (Hilda)
es-MX es-MX-Raul Español México Hombre (Raul)
es-AR es-AR-ElenaNeural Español Argentina Mujer (Elena)
es-AR es-AR-TomasNeural Español Argentina Hombre (Tomas)
es-ES es-ES-AlvaroNeural Español España Hombre (Alvaro)
es-ES es-ES-ElviraNeural Español España Mujer (Elvira)
es-ES es-ES-HelenaRUS Español España Mujer (Helena)
es-ES es-ES-Laura Español España Mujer (Laura)
es-ES es-ES-Pablo Español España Hombre (Pablo)
es-US es-US-AlonsoNeural Español Estados Unidos Hombre (Alonso)
es-US es-US-PalomaNeural Español Estados Unidos Mujer (Paloma)
en-US en-US-JennyNeural Inglés Estados Unidos Mujer (Jenny)
en-US en-US-JennyMultilingualNeural Inglés Estados Unidos Mujer (Jenny Multilingual)
en-US en-US-GuyNeural Inglés Estados Unidos Hombre (Guy)
en-US en-US-AriaNeural Inglés Estados Unidos Mujer (Aria)
en-US en-US-AmberNeural Inglés Estados Unidos Mujer (Amber)
en-US en-US-AnaNeural Inglés Estados Unidos Mujer (Ana)
en-US en-US-AshleyNeural Inglés Estados Unidos Mujer (Ashley)
en-US en-US-BrandonNeural Inglés Estados Unidos Hombre (Brandon)
en-US en-US-ChristopherNeural Inglés Estados Unidos Hombre (Christopher)
en-US en-US-CoraNeural Inglés Estados Unidos Mujer (Cora)
en-US en-US-ElizabethNeural Inglés Estados Unidos Mujer (Elizabeth)
en-US en-US-EricNeural Inglés Estados Unidos Hombre (Eric)
en-US en-US-JacobNeural Inglés Estados Unidos Hombre (Jacob)
en-US en-US-MichelleNeural Inglés Estados Unidos Mujer (Michelle)
en-US en-US-MonicaNeural Inglés Estados Unidos Mujer (Monica)
en-US en-US-AriaRUS Inglés Estados Unidos Mujer (Aria)
en-US en-US-BenjaminRUS Inglés Estados Unidos Hombre (Benjamin)
en-US en-US-GuyRUS Inglés Estados Unidos Hombre (Guy)
en-US en-US-ZiraRUS Inglés Estados Unidos Mujer (Zira)
en-GB en-GB-LibbyNeural Inglés Reino Unido Mujer (Libby)
en-GB en-GB-MiaNeural Inglés Reino Unido Mujer (Mia)
en-GB en-GB-RyanNeural Inglés Reino Unido Hombre (Ryan)
en-GB en-GB-George Inglés Reino Unido Hombre (George)
en-GB en-GB-HazelRUS Inglés Reino Unido Mujer (Hazel)
en-GB en-GB-Susan Inglés Reino Unido Mujer (Susan)
pt-BR pt-BR-FranciscaNeural Portugués Brasil Mujer (Francisca)
pt-BR pt-BR-AntonioNeural Portugués Brasil Hombre (Antonio)
pt-BR pt-BR-Daniel Portugués Brasil Hombre (Daniel)
pt-BR pt-BR-HeloisaRUS Portugués Brasil Mujer (Heloisa)
pt-PT pt-PT-DuarteNeural Portugués Portugal Hombre (Duarte)
pt-PT pt-PT-FernandaNeural Portugués Portugal Mujer (Fernanda)
pt-PT pt-PT-RaquelNeural Portugués Portugal Mujer (Raquel)
pt-PT pt-PT-HeliaRUS Portugués Portugal Mujer (Helia)
2021-09-13T11:43:37-05:00