API para números de teléfono y documentos

Con la ayuda de API puedes implementar la conexión y gestión de los números virtuales desde tu propia interfaz (admin del panel) sin necesidad de entrar en el área personal de Zadarma.

Todas las posibilidades y métodos API de Zadarma - https://zadarma.com/es/support/api/

Para la conexión del número se requiere la identificación del usuario final. Los documentos del usuario también se cargan por API.

Posibilidades de API:

• selección y conexión de números virtuales
• ajustes de números ya conectados
• labores con documentos para la conexión de números (información sobre los requisitos de conexión, carga de documentos, verificación de documentos ya cargados para el pedido de un determinado número)

Secuencia de pasos para la conexión de un número a través de API:

1. Obtención del listado actual de países y destinos para el pedido, mostrarlos al usuario
2. Obtención y visualización del listado de números disponibles para conectar
3. Creación de grupo de documentos para usuario (si todavía no ha sido creado) y carga de documentos (en caso de requerir)
4. Conexión del número seleccionado al grupo de documentos
5. Vinculación del número al SIP o a SIP URI (set_sip_id)

Conexión de nuevos números

Método GET /v1/direct_numbers/countries/ obtención del listado de países en los que se puede conectar el número, si la solicitud se envía sin parámetros la respuesta será en el idioma del área personal, al agregar el parámetro opcional language se puede obtener la respuesta en uno de los idiomas del área personal.

Método GET /v1/direct_numbers/country/ para obtener el listado de destinos en el país en el que se puede conectar el número. Parámetro obligatorio country - código iso del país (ISO 3166-1 alpha-2); Parámetros opcionales language y direction_id. En la respuesta aparecerá el conjunto de datos con la descripción del número: país, ciudad, coste de conexión, cuota mensual, particularidades, posibilidad de recibir SMS, etc.

Obtención del listado de números disponibles para conectar, método GET /v1/direct_numbers/available/<DIRECTION_ID>/ con parámetros DIRECTION_ID - ID del destino o ru495; y mask - parámetro opcional para la búsqueda de coincidencias en los números.

Se puede conectar el número con la ayuda del método POST /v1/direct_numbers/order/.

El número ya conectado se puede extender por los meses deseados por el método POST /v1/direct_numbers/prolong/

Interacción con los números ya conectados

Método GET /v1/direct_numbers/ (sin parámetros) devuelve el conjunto con la información de los números ya conectados.

Método GET /v1/direct_numbers/number/ se puede obtener la información sobre un determinado número conectado, la solicitud se envía con los parámetros type y number

Estado de autorenovación del número (será o no automáticamente extendido para el próximo periodo o se desactivará al final el periodo pagado), se puede conocer a través del método GET /v1/direct_numbers/autoprolongation/ con los parámetros de solictud type y number

Para modificar el estado de autorenovación existe el método PUT /v1/direct_numbers/autoprolongation/ con parámetros de solicitud type, number y value

Método PUT /v1/direct_numbers/set_caller_name/ - ajuste o activación del Nombre del número (letras latinas, hasta 30 caracteres), también se envía en el encabezado From en una llamada entrante en calidad de CALLERID(name).

A través del método PUT /v1/direct_numbers/set_sip_id/ se pueden enviar las llamadas del número virtual a un determinado SIP, servidor externo a través de SIP URI o activar el modo de prueba. Parámetros obligatorios de solicitud type, number y sip_id - sip o dirección del servidor externo, por ejemplo 1234567890@myserver.com test_mode - opcional, (on|off) - para activar el modo de prueba.

Trabajo con documentos

El grupo de documentos son datos de la persona o empresa que será el usuario final del número virtuales, se pueden tener varios grupos.

Creación de nuevos grupos de documentos, método POST /v1/documents/groups/create/

Se pueden actualizar los datos del grupo de documentos ya existente con el método PUT /v1/documents/groups/update/<GROUPID>/ .

La carga de archivo de documento para el grupo de documentos se realiza con el método POST /v1/documents/upload/ .

Con el método GET /v1/documents/groups/list/ se puede obtener el listado de grupos de documentos y con el método GET /v1/documents/groups/get/<ID>/ donde ID es el identificador del grupo, 0 - grupo de documentos principal, se puede obtener la información sobre un grupo de documentos determinado.

El método GET /v1/documents/files devuelve el listado de documentos/archivos previamente cargados en el grupo de documentos. group_id - parámetro opcional, ID del grupo de documentos, (0 o si no establecido - grupo de documentos principal).

Verificación: sirve o no el grupo de documentos para la conexión del número de una determinada ciudad/destino se realiza a través del método GET /v1/documents/groups/valid/<ID>/ .