API mdpay omnisuite

1 API Omnisuite para mdpay

1.1 Introducción

En este documento definimos las invocaciones mínimas a realizar a endpoints de Omnisuite para activar el pago asistido Será necesario:

• Obtener Id de usuario
• Obtener UniqueId de la llamada del usuario
• Enviar tonos DTMF a esa llamada

1.2 Autenticación

Todas las peticiones deben incluir el siguiente encabezado de seguridad:

• Header: x-api-key
• Valor: El API KEY de usuario de omnisuite proporcionado.

1.3 Endpoints

1.3.1 Obtener ID de un usuario

Recupera el identificador de un usuario específico basado en filtros.

• Método: GET
• URL: https://omnisuite.cliente.com/users
• Parámetros de consulta (Query Params):
• fields: Especifica los campos a retornar (ej. id).
• filter: Criterio de búsqueda (ej. jac).
• sort: Orden de los resultados (ej. id).

Ejemplo de solicitud:

GET https://omnisuite.cliente.com//users?fields=id&filter=jac&sort=id

1.3.2 Consultar llamadas de un usuario

Obtiene el registro o estado de las llamadas asociadas a un ID de usuario.

*Método: POST

• URL: https://omnisuite.cliente.com/webbar/calls
• Cuerpo de la petición (JSON):

{
  "userId": 5
}

1.3.3 Enviar DTMF a una llamada

Permite enviar una secuencia de dígitos DTMF a una llamada activa.

• Método: POST
• URL: https://omnisuite.cliente.com/webbar/send-dtmf
• Cuerpo de la petición (JSON)

{
  "digits": "###444*12345#",
  "duration": 100,
  "uniqueId": "1770732063.80",
  "userId": 5
}

El valor “duration” indica la duración del envío en ms (en el ejemplo anterior serían 100ms, que es el valor recomendado)