NAV Navbar

Netelip API Fax v1.0

shell php python

API Fax v1.0

Bienvenido a la documentación de la API Fax de Netelip. API Fax de Netelip permite conectar sus aplicaciones con la pasarela de envíos Fax M2M (de máquina a máquina) de Netelip a través de interfaz HTTPS.

Tenemos ejemplos en lenguajes de shell, php y python que pueden ver en el área oscura de la derecha. Puede cambiar el lenguaje de programación de los ejemplos en las pestañas que aparecen arriba a la derecha.

Para conocer todas las APIs disponibles, información general y restricciones aplicadas a su uso consulte "Documentación APIs".

Autentificación

Todos los ejemplos de la documentación se basan en este esqueleto:

# Asegurese de pasar siempre las cabeceras correctamente.
curl -X POST https//api.netelip.com/v1/fax/{endpoint} \
  --data "token=69cizi7zc2394b9f84e97e78b8913d0ie1z2i6b58iec943fbz478z13c00d59cz"

<?php
$url="https://api.netelip.com/v1/fax/{endpoint}";
$post = array(
   "token" => "69cizi7zc2394b9f84e97e78b8913d0ie1z2i6b58iec943fbz478z13c00d59cz",
);

$request = curl_init($url);
curl_setopt($request, CURLOPT_POST, 1);
curl_setopt($request, CURLOPT_TIMEOUT, 180);
curl_setopt($request, CURLOPT_POSTFIELDS, $post);
curl_setopt($request, CURLOPT_RETURNTRANSFER, 1);

$response = curl_exec($request);
if ($response !== false) {
   // Manejar datos devueltos por la petición
} else {
   // Manejar error de conexión
}

curl_close($request);
?>

#!/usr/bin/env python

import requests

url = 'https://api.netelip.com/v1/fax/{endpoint}'
data = {
    'token': '69cizi7zc2394b9f84e97e78b8913d0ie1z2i6b58iec943fbz478z13c00d59cz',
}

response = requests.post(url=url, data=data)

if response:
    # Manejar datos devueltos por la petición
else:
    # Manejar error de conexión

Reemplazar {endpoint} por el punto de entrada correcto.
El token usado es un token de ejemplo no válido.

API Fax de Netelip usa autentificación por token, para obtener su token acceda a 'Token de seguridad' que encontrará en su 'Panel de control' en sección datos personales.

Si todavía no es cliente de netelip puede registrarse en el siguiente enlace.

API Fax de Netelip espera en todas sus peticiones que se autentifique con un token similar a este:

69cizi7zc2394b9f84e97e78b8913d0ie1z2i6b58iec943fbz478z13c00d59cz

Fax

Enviar un fax

curl -X POST https//api.netelip.com/v1/fax/api.php \
  --header "Content-Type: multipart/form-data" \
  --form "token=69cizi7zc2394b9f84e97e78b8913d0ie1z2i6b58iec943fbz478z13c00d59cz" \
  --form "callerid=anonymous" \
  --form "destination=0034951554433" \
  --form "retry=3" \
  --form "upload_vdrive=false" \
  --form "uploaded_file=@{ruta}/mifax.pdf;filename=mifax.pdf"

<?php
$url = "https://api.netelip.com/v1/fax/api.php";
$post = array(
   "token"         => "69cizi7zc2394b9f84e97e78b8913d0ie1z2i6b58iec943fbz478z13c00d59cz",
   "callerid"      => "anonymous",
   "destination"   => "0034951554433",
   "retry"         => 3,
   "upload_vdrive" => 'false',
   "uploaded_file" => "@{ruta}/mifax.pdf;filename=mifax.pdf"
);

$request = curl_init($url);
curl_setopt($request, CURLOPT_POST, 1);
curl_setopt($request, CURLOPT_POSTFIELDS, $post);
curl_setopt($request, CURLOPT_TIMEOUT, 180);
curl_setopt($request, CURLOPT_RETURNTRANSFER, 1);

$response = curl_exec($request);
if ($response !== false) {
   $response_code = curl_getinfo($request, CURLINFO_HTTP_CODE);
   // manejar posibles respuestas a la petición.
   switch ($response_code) {
      case 200:
         // Gestionar petición correcta.
         break;
      case 405:
         // Gestionar insuficiente crédito.
   }
} else {
   // Manejar error de conexión
}

curl_close($request);
?>

#!/usr/bin/env python

import requests

url = 'https://api.netelip.com/v1/fax/api.php'
data = {
    'token'        : '69cizi7zc2394b9f84e97e78b8913d0ie1z2i6b58iec943fbz478z13c00d59cz',
    'callerid'     : 'anonymous',
    'destination'  : '0034951554433',
    'retry'        : 3,
    'upload_vdrive': 'false'
}
files = {
    'uploaded_file': open('/home/enrique/Documentos/prueba.pdf', 'rb')
}

response = requests.post(url=url, data=data, files=files)

if response:
    if response.status_code == 200:
        print(response.text)
    elif response.status_code == 405:
        print('No hay credito')
else:
    print('Error de conexion')

Los valores usados para los parámetros son solo de ejemplo.
Reemplazar {ruta} por la ubicación del fichero pdf.

En caso de éxito se devuelve una estructura en XML similar al siguiente: 

<?xml version="1.0"?>
<response>
  <status>200</status>
  <ID-FAX>1573484232.1235</ID-FAX>
</response>

Permite enviar fax a través de la pasarela. Para enviar un fax se realiza una petición de tipo POST y se adjunta un fichero de tipo pdf con un tamaño máximo de 2Mb.

En la petición se debe indicar el token de autentificación, el origen, el destino, los posibles intentos, si se almacena en vdrive y el fichero pdf a enviar.

Para más información sobre los parámetros usados consultar el apartado 'Parámetros de las consultas'.

HTTP Request

POST https//api.netelip.com/v1/fax/api.php

Parámetros

Parametro Tipo Obligatorio
token string SI
callerid string SI
destination string SI
retry integer SI
upload_vdrive boolean SI
uploaded_file string SI

Respuesta

Si la petición se realiza correctamente se devolverá una cadena en formato XML donde se incluye el código HTTP/S correspondiente y el id del fax enviado.

Consultar los posibles códigos de error para la consulta en el apartado 'Errores'.

Obtener el estado de un fax

curl -X POST https//api.netelip.com/v1/fax/status.php \
  --data "token=69cizi7zc2394b9f84e97e78b8913d0ie1z2i6b58iec943fbz478z13c00d59cz" \
  --data "id-fax=1573484232.1235" 

<?php
$url = "https://api.netelip.com/v1/fax/status.php";
$post = array(
   "token"  => "69cizi7zc2394b9f84e97e78b8913d0ie1z2i6b58iec943fbz478z13c00d59cz",
   "id-fax" => "1573484232.1235",
);

$request = curl_init($url);
curl_setopt($request, CURLOPT_POST, 1);
curl_setopt($request, CURLOPT_POSTFIELDS, $post);
curl_setopt($request, CURLOPT_TIMEOUT, 180);
curl_setopt($request, CURLOPT_RETURNTRANSFER, 1);

$response = curl_exec($request);
$response_code = curl_getinfo($request, CURLINFO_HTTP_CODE);
if ($response !== false) {
   echo $response;
} 

curl_close($request);
?>

#!/usr/bin/env python

import requests

url = 'https://api.netelip.com/v1/fax/status.php'
data = {
    'token': '69cizi7zc2394b9f84e97e78b8913d0ie1z2i6b58iec943fbz478z13c00d59cz',
    'id-fax': '1573484232.1235'
}

response = requests.post(url=url, data=data)

if response.status_code == 200:
    print(response.text)

Los valores usados para los parámetros son solo de ejemplo.

Ejemplo de las posibles respuestas.

OK

<?xml version="1.0"?>
<response>
  <status>OK</status>
  <ID-FAX>1573484232.1235</ID-FAX>
</response>

ERROR

<?xml version="1.0"?>
<response>
  <status>ERROR</status>
  <ID-FAX>1573484232.1235</ID-FAX>
</response>

Permite conocer el estado de entrega de un fax enviado.
Para conocer el estado del fax enviado se realizará una petición de tipo POST.

En la petición se debe indicar el token de autentificación y el id del fax a consultar.

Para más información sobre los parámetros usados consultar el apartado 'Parámetros de las consultas'.

HTTP Request

POST https//api.netelip.com/v1/fax/status.php

Parámetros

Parametro Tipo Obligatorio
token string SI
id-fax string SI

Respuesta

Si la petición se realiza correctamente se devolverá una cadena en formato XML indicando el estado de entrega del fax y la fecha en la que fue entregado si es así.

Los posibles estados devueltos son OK y ERROR.

Consultar los posibles códigos de error para la consulta en el apartado 'Errores'.

Parámetros de las consultas

token

Ejemplo de token:

69cizi7zc2394b9f84e97e78b8913d0ie1z2i6b58iec943fbz478z13c00d59cz

Token de seguridad que encontrará en su panel de control, sección datos personales

callerid

Ejemplo de callerid anónimo: 

anonymous

Ejemplo de callerid fijo: 

34951223344

Identificador de llamada que se presentará al destinatario del fax.
En caso de que el usuario tenga el identificador de llamada de netelip "personalizado", podrá presentar cualquier identificador de llamada, sino, solo podrá presentar uno de los identificadores de llamada de netelip u oculto.

destination

Ejemplo de fijo español: 

0034951223344

Ejemplo múltiples destinatarios:

0034951223344,0034951443322

Número de teléfono de destino. El número debe estar escrito en formato internacional con "00" delante.

Si se desea enviar el fax a distintos destinatarios, se añadrirán los distintos destinatarios separados por ",".

retry

Ejemplo de retry:

3

Número de intentos de envío de fax, en caso de fallar el envío de fax se volverá a intentar el envío tantas veces se indique en el parámetro. El número de intentos no puede ser mayor de 3.

upload_vdrive

Valor que indica si el fax a enviar debe guardar copia en "vDrive". Si su cuenta de vDrive no está habilitada el fax no será guardado.

Los valores postibles son "true" o "false".

Ejemplo de upload_vdrive:

false

uploaded_file

Ejemplos uploaded_file:

@/home/mi-usuario/Documentos/factura.pdf
@/home/mi-usuario/Documentos/factura.pdf;filename=factura.pdf

La ruta del fichero y el separardor de directorios depende de su sistema.

Fichero a subir. El fichero no puede superar los 2MB y debe ser un fichero en formatao PDF.

id-fax

Ejemplo de id-fax:

1573484232.1235

Identificador del Fax enviado, devuelto en la petición de envío.

Errores

API Fax de Netelip usa los siguientes códigos de error.

Cód. Error Significado
200 OK -- Petición realizada correctamente.
401 Unauthorized -- Error de autentificación, compruebe token.
402 Exedido el número máximo de destinatarios.
403 Fichero PDF no válido.
404 Fichero PDF superior a 2MB.
405 Insuficiente crédito para envío de fax.
410 Falta algún parámetro en la estructura del POST.
shell php python