API para Números de Teléfono y Documentos

Con la API de Megacall, puedes integrar y gestionar números virtuales directamente desde tu interfaz administrativa, eliminando la necesidad de acceder a la cuenta personal de Megacall.

Todas las capacidades y métodos de la API de Megacall se detallan en el siguiente enlace: Documentación de la API de Megacall.

La identificación del usuario y la presentación de documentos a menudo son requisitos previos para conectar números, y estos procesos pueden facilitarse a través de la API.

Características de la API:

• Selección y conexión de números virtuales.

• Configuración de números conectados.

• Manejo de documentos requeridos para la conexión de números (proporcionar información sobre los requisitos de conexión, cargar y verificar documentos previamente presentados para una conexión de número específica).

Pasos para conectar un número mediante la API:

• Obtener una lista actualizada de países y destinos disponibles para la conexión y mostrarla al usuario.

• Recuperar y mostrar una lista de números disponibles para la conexión.

• Crear un grupo de usuarios para documentos (si aún no se ha hecho) y cargar los documentos necesarios (si es necesario).

• Conectar el número elegido utilizando el grupo designado de documentos.

• Enrutar números a SIP login o SIP URI (set_sip_id).

Nueva conexión de número

La conexión de un nuevo número a través de la API de Megacall implica varios pasos:

1. Obtener una Lista de Países Disponibles:

Utiliza el siguiente método para obtener una lista de países disponibles para la conexión de números:

• Método: GET /v1/direct_numbers/countries/

• Parámetros: Ninguno (o parámetro opcional de idioma para el idioma de respuesta)

• Respuesta: Lista de países disponibles.

2. Obtener Destinos dentro de un País:

Para recibir una lista de destinos dentro de un país, utiliza el siguiente método:

• Método: GET /v1/direct_numbers/country/

• Parámetros:

• país: Código de país ISO (ISO 3166-1 alpha-2)

• Opcional: idioma, direction_id

• Respuesta: Matriz de datos que describe números disponibles para conexión dentro del país especificado.

3. Recibir una Lista de Números Disponibles:

Utiliza el siguiente método para obtener una lista de números disponibles para conexión:

• Método: GET /v1/direct_numbers/available/<DIRECTION_ID>/

• Parámetros:

• DIRECTION_ID: ID de destino o ru495

• Opcional: máscara para buscar coincidencias de números

• Respuesta: Lista de números disponibles.

4. Conectar un Número:

Conecta el número elegido utilizando el siguiente método:

• Método: POST /v1/direct_numbers/order/

• Parámetros: Los parámetros requeridos incluyen el número.

• Respuesta: Confirmación de la conexión del número.

5. Ampliar un Número Conectado Anteriormente:

Si es necesario, amplía un número conectado anteriormente de antemano:

• Método: POST /v1/direct_numbers/prolong/

• Parámetros: Los parámetros requeridos incluyen número y meses.

• Respuesta: Confirmación de la extensión del número.

Estos pasos te guiarán a través del proceso de conexión y gestión de números virtuales a través de la API de Megacall.

Interacciones con números conectados

Al trabajar con números conectados en la API de Megacall, puedes realizar diversas acciones relacionadas con la gestión y obtención de información sobre estos números. Aquí se presentan los métodos relevantes:

1. Obtener Información sobre Números Conectados:

• Método: GET /v1/direct_numbers/

• Parámetros: Ninguno

• Respuesta: Matriz de información sobre los números ya conectados.

2. Obtener Información sobre un Número Conectado Específico:

• Método: GET /v1/direct_numbers/number/

• Parámetros: tipo, número (El tipo puede ser 'virtual' o 'sim', y el número es el número conectado)

• Respuesta: Información sobre el número conectado especificado.

3. Obtener Estado de Extensión Automática del Número:

• Método: GET /v1/direct_numbers/autoprolongation/

• Parámetros: tipo, número

• Respuesta: Estado de extensión automática del número especificado.

4. Cambiar el Estado de Extensión Automática:

• Método: PUT /v1/direct_numbers/autoprolongation/

• Parámetros: tipo, número, valor (El valor puede ser 'on' u 'off')

• Respuesta: Confirmación del cambio en el estado de extensión automática.

5. Establecer o Habilitar el Nombre del Número (Caller ID):

• Método: PUT /v1/direct_numbers/set_caller_name/

• Parámetros: tipo, número, caller_name

• Respuesta: Confirmación de establecer o habilitar el nombre del número.

6. Enrutar Llamadas desde un Número Virtual:

• Método: PUT /v1/direct_numbers/set_sip_id/

• Parámetros: tipo, número, sip_id, test_mode (opcional, 'on' u 'off')

• Respuesta: Confirmación de enrutar llamadas o habilitar el modo de prueba para el número virtual especificado.

Estos métodos te permiten obtener información sobre números conectados, gestionar el estado de extensión automática, establecer nombres de llamada y enrutar llamadas desde números virtuales en el sistema de Megacall.

Interactuando con documentos

Al trabajar con documentos en la API de Megacall para la conexión de números, puedes realizar diversas acciones relacionadas con grupos de documentos. Aquí se presentan los métodos relevantes:

1. Crear un Nuevo Grupo de Documentos:

• Método: POST /v1/documents/groups/create/

• Parámetros: Ninguno (Los parámetros para el nuevo grupo, como el nombre del grupo, pueden ser necesarios en el cuerpo de la solicitud)

• Respuesta: Confirmación de la creación del nuevo grupo de documentos.

2. Actualizar Información en un Grupo Existente de Documentos:

• Método: PUT /v1/documents/groups/update/<ID_GRUPO>/

• Parámetros: ID_GRUPO - ID del grupo de documentos a actualizar (por ejemplo, 1 para el grupo principal)

• Respuesta: Confirmación de la actualización del grupo de documentos.

3. Subir Archivo de Documento a un Grupo:

• Método: POST /v1/documents/upload/

• Parámetros: Sube el archivo del documento a través del cuerpo de la solicitud y especifica el group_id si es necesario.

• Respuesta: Confirmación de la carga del archivo del documento.

4. Recibir una Lista de Grupos de Documentos:

• Método: GET /v1/documents/groups/list/

• Parámetros: Ninguno

• Respuesta: Lista de grupos de documentos.

5. Recibir Información Sobre un Grupo Específico de Documentos:

• Método: GET /v1/documents/groups/get/<ID>/

• Parámetros: ID - Identificación del grupo (0 para el grupo principal)

• Respuesta: Información sobre el grupo de documentos especificado.

6. Recibir una Lista de Archivos/Documentos Subidos:

• Método: GET /v1/documents/files

• Parámetros: group_id (opcional) - ID del grupo de documentos (0 o no especificado para el grupo principal)

• Respuesta: Lista de archivos/documentos subidos anteriormente.

7. Verificar si el Grupo de Documentos es Adecuado para la Conexión de Números:

• Método: GET /v1/documents/groups/valid/<ID>/

• Parámetros: ID - Identificación del grupo

• Respuesta: Confirmación de la idoneidad del grupo para la conexión de números.

Estos métodos te permiten gestionar grupos de documentos, cargar archivos y verificar la validez de los grupos de documentos para la conexión de números solicitada en el sistema de Megacall.