EmailFax - Fax pela Internet
Serviço de envio e recebimento de Fax pela Internet
Conheça Mais
Fale com a Equipe
RJ (21) 4063-7955
Fax (21) 3724-0715API - Integração
Visão Geral
O web service do EmailFax é um serviço que permite a transmissão e recepção de fax diretamente da sua aplicação ou do seu sistema de gestão. Com a nossa API o seu desenvolvedor poderá integrar facilmente um programa existente à plataforma de envio de recebimento de fax do EmailFax. A API permite o envio de fax, consulta dos fax recebidos, consulta do saldo de créditos e até mesmo compra de créditos.
Atenção: A API está finalizada, porém em versão BETA. Para mais informações entre em contato conosco
Pré-requisitos
- Acesso a internet pela porta 80 ou 443.
- Suporte a Web Service utilizando protocolo SOAP.
- Habilitar o uso de API na conta do usuário.
Dados Técnicos
- Versão 1.01 (BETA)
- Última atualização: 08/02/2008
- WSDL: http://emailfax.com.br/api/wsdl
- Custo: gratuito
Referência dos Métodos
| EnviarFax | ||
|---|---|---|
| Parâmetros | ||
| Nome | Tipo | Comentário |
| Usuario | String | Login do usuário EmailFax |
| Senha | String | Senha do usuário EmailFax |
| NumeroFax | 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 Apêndice B) |
| Arquivo | Base64Binary | Dados binários do documento |
| TipoArquivo | String | Tipo do arquivo. Exemplo: DOC, HTML, PDF, etc. (veja Apêndice D) |
| Retorno | ||
| Retorno | Integer | Em caso de sucesso o retorno será um valor positivo relativo ao ID do Fax. Em caso de erro o valor será negativo. (veja Apêndice A) |
| StatusFax | ||
|---|---|---|
| Parâmetros | ||
| Nome | Tipo | Comentário |
| Usuario | String | Login do usuário EmailFax |
| Senha | String | Senha do usuário EmailFax |
| IdFax | String | ID do Fax retornado pelo método EnviarFax. |
| Retorno | ||
| SubmetidoEm | DateTime | Data e hora que o fax foi submetido pelo usuário |
| FinalizadoEm | DateTime | Data e hora que o fax acabou de ser enviado para o destinatário |
| NumeroDestino | String | Número do fax de destino com o formato padrão (veja Apêndice B) |
| PaginasSubmetidas | Integer | Número de páginas submetidas originalmente |
| PaginasEnviadas | Integer | Número de páginas enviadas com sucesso |
| Status | Integer | Status da transmissão. -150 = Erro interno; -1 = Id incorreto; -2 = Não enviado; -3 = Processando; 0 = OK; maior que 0 = Erro. (veja Apêndice C) |
| Duracao | Integer | Duração em segundos do envio do fax |
| Creditos | Float | Quantidade de créditos utilizadas pela transmissão |
| Saldo | ||
|---|---|---|
| Parâmetros | ||
| Nome | Tipo | Comentário |
| Usuario | String | Login do usuário no EmailFax |
| Senha | String | Senha do usuário EmailFax |
| Retorno | ||
| Saldo | Float | Retorna o valor do saldo atual da conta |
Apêndice A - Códigos de Retorno
Atenção: Os códigos de retorno indicam o sucesso ou falha na comunicação com o Web Service. Eles NÃO estão relacionados com o sucesso ou falha na transmissão do fax.
| Valor | Descrição |
|---|---|
| (qualquer valor maior que 0) | ID do Fax. Indica sucesso na conexão com o Web Service. |
| -112 | Faltando o número de fax |
| -123 | Documento anexado inválido |
| -150 | Erro interno do sistema |
| -1003 | Erro de autenticação |
| -1004 | Faltando o tipo do arquivo |
| -1005 | Fax não existe |
| -3007 | Sem permissão para esta ação |
Apêndice B - Formato do Número de Fax
O EmailFax trabalha com um formato padrão de número de fax. Este é o formato recebido e retornado pelos métodos da API.
O formato é: 00 <Código-País> <Código-Localidade> <Número>.
Examplo: Um número no Rio de Janeiro, Brasil seria: 00552137240715, onde:
00 é constante;
55 é o código do país (Brasil);
21 é o código da localidade (Rio de Janeiro);
37240715 é o número do fax (Número da BielSystems).
Apêndice C - Códigos de Erro
Os códigos de erro indicam o erro na transmissão do fax.
| Valor | Descrição |
|---|---|
| 3072 | Erro na transmissão |
| 3080 | Erro na transmissão |
| 3211 | Incompatibilidade do aparelho de fax |
| 3220 | Incompatibilidade do aparelho de fax |
| 3223 | Desconectado inesperadamente |
| 3224 | O fax remoto falhou na resposta |
| 3225 | Incompatibilidade do aparelho de fax |
| 3230 | O sinal de desconexão foi recebido no momento da negociação da transmissão |
| 3231 | Incompatibilidade do aparelho de fax |
| 3233 | Incompatibilidade do aparelho de fax |
| 3264 | Incompatibilidade do aparelho de fax |
| 3267 | Incompatibilidade do aparelho de fax |
| 3268 | Erro de transmissão (após a quebra de página) |
| 3269 | Incompatibilidade do aparelho de fax** |
| 3300 | Erro na transmissão |
| 3510 | Erro na transmissão |
| 3830 | Erro na transmissão |
| 3912 | Sinal de atendimento não detectado |
| 3931 | Ocupado – Linha em uso |
| 3932 | Sinal de ocupado rápido – A linha deve estar em débito ou desconectada |
| 3933 | Ocupado ou erro na transmissão |
| 3935 | Sem resposta (provavelmente falta de papel) |
| 3936 | Atendido por voz humana |
| 3937 | Sinal de ocupado após tocar |
| 3938 | Número de telefone não operacional |
| 6001 | Número de telefone não operacional. Número não atribuído? |
| 6003 | Erro na transmissão |
| 6004 | Erro na transmissão |
| 6016 | Erro na transmissão |
| 6017 | Ocupado – Linha em uso |
| 6018 | Sem resposta (provavelmente falta de papel) |
| 6019 | Erro na transmissão |
| 6021 | Ligação rejeitada |
| 6022 | Este número mudou |
| 6027 | Número de telefone não operacional – Número inválido? |
| 6028 | Número de telefone não operacional – Número não atribuído. |
| 6029 | Ligação rejeitada |
| 6031 | Erro na transmissão |
| 6034 | Erro na transmissão |
| 6038 | Erro na transmissão |
| 6041 | Erro na transmissão |
| 6042 | Erro na transmissão |
| 6043 | Erro na transmissão |
| 6044 | Erro na transmissão |
| 6047 | Erro na transmissão |
| 6050 | Erro na transmissão |
| 6054 | Erro na transmissão |
| 6057 | Erro na transmissão |
| 6058 | Erro na transmissão |
| 6063 | Erro na transmissão |
| 6065 | Erro na transmissão |
| 6069 | Erro na transmissão |
| 6079 | Erro na transmissão |
| 6088 | Destino incompatível |
| 6095 | Destino incompatível |
| 6097 | Destino incompatível |
| 6099 | Destino incompatível |
| 6100 | Destino incompatível |
| 6102 | Erro na transmissão |
| 6111 | Erro na transmissão |
| 6127 | Erro na transmissão |
| 7004 | Erro na transmissão |
| 7012 | Erro na transmissão |
| 7013 | Erro na transmissão |
| 8021 | Sem resposta (provavelmente falta de papel) |
| 8025 | Ocupado – Linha em uso |
| 204000 | Erro de randeriação, certifique-se de que é um formato válido, sem macro nem senha de proteção |
| 204001 | Erro de randerização, certifique-se de que é um formato válido, sem macro nem senha de proteção |
| 205000 | Erro interno, contate o suporte |
| 205001 | Erro interno, contate o suporte |
| 206001 | Erro interno, contate o suporte. |
| 207001 | Status não pode ser atualizado, contate o suporte |
Apêndice D - Tipos de Arquivos
| Valor | Descrição |
|---|---|
| BMP | image/x-windows-bmp |
| XLS | application/x-msexcel |
| TXT | plain/text |
| TXT | application/octet-stream |
| TXT | text/plain |
| application/pdf | |
| HTM | text/html |
| XLS | application/excel |
| PPT | application/powerpoint |
| XLS | application/x-excel |
| RTF | text/richtext |
| TXT | application/plain |
| RTF | application/x-rtf |
| JPG | image/jpeg |
| XLS | application/vnd.ms-excel |
| JPG | image/pjpeg |
| TIF | image/x-tiff |
| DOC | application/msword |
| RTF | application/rtf |
| GIF | image/gif |
| PPT | application/x-mspowerpoint |
| PPT | application/mspowerpoint |
| TIF | image/tiff |
| PCX | image/x-pcx |
| BMP | image/bmp |
| PS | application/postscript |
| PPT | application/vnd.ms-powerpoint |