Fax

A API de fax permite enviar uma transação e consultar seu status a qualquer momento.

Campos

Nome Tipo Comentário
id Integer ID do Fax retornado pelo método EnviarFax.
numero_destino String Número de destino no formato 00998877777777, sendo 99 o código do país, 88 o código da localidade e 77777777 o número do fax. (veja Formato do Número do Fax)
arquivos[tipo] String Tipo do arquivo. Exemplo: DOC, HTML, PDF, etc. (veja Tipos de Arquivos)
arquivos[dados] Base64Binary Dados binários do arquivo codificado em Base64
submetido_em DateTime Data e hora que o fax foi submetido pelo usuário
finalizado_em DateTime Data e hora que o fax acabou de ser enviado para o destinatário
paginas_submetidas Integer Número de páginas submetidas originalmente
paginas_enviadas Integer Número de páginas enviadas com sucesso
status Integer Status da transmissão.
-1 => pré-processando;
-2 => processado, pronto para ser enviado;
-3 => enviando;
-4 => fax com erro no processamento;
0 => fax enviado com sucesso;
> 0 => falha na transmissão do fax (veja Códigos de Erro)
duracao Integer Duração em segundos do envio do fax
creditos Float Quantidade de créditos utilizadas pela transmissão

Enviar Fax

POST /api/enviar_fax

Cria uma transação de envio de fax.

Exemplo de Chamada

curl -u $usuario:$senha -X POST -H 'Content-Type: application/json' -d '$requisicao' https://emailfax.com.br/api/enviar_fax

Requisição

{
 "numero_destino": "00998877777777",
 "arquivos":
  [
   {"tipo": "PNG", "dados": "BASE64BLABLABLA"},
   {"tipo": "TXT", "dados": "texto bla bla bla"}
  ]
}

Retorno

Sucesso
Status: 201 Created
Parâmetro 'json' não informado
Status: 400 Bad Request

Parâmetro 'json' não informado
Erro na validação de parâmetros (parâmetro em branco ou inváido)
Status: 400 Bad Request

Parâmetro 'xxxx' [em branco, inválido].
Usuário sem créditos
Status: 403 Forbidden
	
Sem créditos o suficiente.
Login/Senha inválidos
Status: 401 Unauthorized
Erro interno
Status: 500 Internal Server Error

Status do Fax

GET /api/status_fax/#{id}

Retorna o status da transação.

Exemplo de Chamada

curl -u $usuario:$senha -X GET https://emailfax.com.br/api/status_fax/132020070

Retorno

Fax enviado com sucesso
Status: 200 OK

{
 "numero_destino": "0016466664348",
 "duracao": 31,
 "status": 0,
 "creditos": 1.0,
 "submetido_em":"2009-10-22T00:16:55Z",
 "paginas_submetidas": 1,
 "finalizado_em": "2009-10-22T00:17:45Z",
 "paginas_enviadas": 1
}
Fax processando
Status: 200 OK

{"status": -3}
Fax com erro no processamento
Status: 200 OK

{"status": -4}
Fax com erro na transmissão
Status: 200 OK

{"status": #{codigo_erro}, "error_message", "#{mensagem_erro}"}
Parâmetro ID não informado
Status: 400 Bad Request

Parâmetro 'id' não informado.
Parâmetro ID inválido
Status: 400 Bad Request

Parâmetro 'id' inválido.
ID inexistente
Status: 404 Not Found

Not found.
Login/Senha inválidos
Status: 401 Unauthorized
Erro
Status: 500 Internal Server Error