Como configurar a API do Dropbox Fax

Este artigo contém informações sobre como configurar a Dropbox Fax API usando os endpoints v1, garantir que esteja funcionando e comprar linhas de fax adicionais, se necessário.

Como configurar a Dropbox Fax API usando os endpoints v1

Para começar a usar os endpoints v1:

1. Envie um e-mail para support@hellosign.com com o endereço de e-mail que você deseja usar na sua conta do Dropbox Fax. Você receberá uma resposta assim que o acesso à Dropbox Fax API for habilitado. Saiba mais sobre os preços da Dropbox Fax API.
2. Entre na sua conta do Dropbox Fax. Anote o GUID da sua conta, pois ele será necessário para a maioria das solicitações de API (ou endpoints).
3. Faça a sua primeira solicitação de API e obtenha as informações de configuração da sua conta:

Um exemplo disso seria:

Outro exemplo (lembre-se de codificar o URL):

A resposta será uma representação em JSON das configurações da sua conta.

4. Para adicionar novamente os URLs de retorno de chamada para os seus faxes de entrada e saída com um POST:

5. Para consultar as linhas de fax disponíveis:

A resposta incluirá a FaxLine que você escolheu ao assinar um plano Premium.

6. Para comprar um número de fax, é necessário verificar quais DDDs estão disponíveis em cada estado (nem todos os DDDs estão disponíveis) com um GET:

7. Compre um número de fax usando um dos DDDs disponíveis identificados na etapa 6:

8. Para enviar um fax:

Isso inicia o processo de envio de fax. Receber uma resposta HTTP 200 não garante que o fax será enviado, pois pode ocorrer um erro na conversão do arquivo. No entanto, assim que o StatusCode do fax se tornar E (de Erro) ou S (de Sucesso), você receberá um POST no URL de retorno de chamada informado na etapa 4. Saiba mais sobre os eventos de retorno de chamada.

Valores possíveis de StatusCode:

• T = Transmitindo/Enviando.
• P = Pendente/Convertendo.
• S = Enviado com sucesso.
• E = Erro. Falha na conversão ou no envio completo.
• H = Em espera. Esse erro ocorre se sua conta não estiver confirmada ou se você tiver excedido o número de páginas de fax sem uma assinatura mensal.

Valores possíveis de ErrorCode (apenas para referência quando o StatusCode estiver definido como E):

• B = Sinal de ocupado recebido.
• N = Sem resposta.
• A = Número não atribuído (geralmente, significa que foi desconectado).
• D = A linha está desconectada ou inacessível.
• L = Este número está na lista de bloqueios (isso não deve ocorrer com números dos EUA).
• U = Erro desconhecido. Isso geralmente ocorre quando alguém atende a linha ou quando há um erro durante a transmissão do fax.
  

Observação:

• Se você enviar um fax e a máquina de fax do destinatário for compatível com a identificação do assinante (CSID), o identificador de chamadas exibirá seu número de fax principal ou o número de fax especificado no parâmetro “From”. O seu número de fax principal aparecerá no próprio fax. Se você tiver várias linhas do Dropbox Fax, poderá escolher qual delas usar como máquina de envio incluindo o parâmetro “From” no URL:

Para saber o formato do valor de “From”, consulte o campo “Number” retornado ao chamar /FaxLines (consulte a etapa 5 acima).

• Você pode enviar vários arquivos e faxes em uma única chamada: basta transformar os parâmetros “file” e/ou “To” em arrays:

ou

• Você pode adicionar uma página de rosto gerada pelo Dropbox Fax especificando um ou mais dos seguintes parâmetros: CoverPageTo, CoverPageFrom e CoverPageMessage.
• Os faxes enviados pela API não são armazenados em nossos servidores após o envio bem-sucedido. Eles são removidos. Portanto, você não pode visualizá-los na interface do usuário. No entanto, os faxes recebidos enviados com sucesso via POST para seu retorno de chamada são armazenados nos nossos servidores e ficam disponíveis na tela “documentos”.
• Há um limite de 200 faxes pendentes por dia. Se você atingir esse limite, verá o erro 429:

Como verificar os status dos faxes?

1. Você pode localizar o GUID de transmissão na resposta JSON retornada pela chamada de API na etapa 8. Além disso, é possível verificar o status de todas as suas transmissões omitindo o GUID de transmissão:

Esses resultados são paginados. Você pode acessar páginas diferentes especificando os parâmetros de URL Page e PageSize. Consulte os elementos de resposta FirstPageUri, NextPageUri, PreviousPageUri e LastPageUri para saber como funciona a paginação.

2. Assim que o código de status do fax for definido como S ou E, verifique se o seu URL de retorno de chamada para fax de saída foi acionado. Ele deve receber um POST com um parâmetro chamado “json”, que contém todas as informações que você receberia na resposta de uma chamada (veja a etapa 1).

Se um retorno de chamada POST bem-sucedido for impedido por um problema de servidor ou rede, o Dropbox tentará novamente nesses intervalos:

• 15 minutos
• 45 minutos
• 1 hora e 30 minutos
• 2 horas e 45 minutos
• 4 horas
• 8 horas e 15 minutos
• 16 horas e 30 minutos

Em cada intervalo, o Dropbox poderá tentar enviar o POST várias vezes se não receber um código de resposta 200.

3. Se você enviou o fax para o seu próprio número do Dropbox Fax (útil para testes), verifique se o seu URL de retorno de chamada para fax de entrada também foi acionado.
4. Liste as FaxLines que você comprou:

5. Para excluir uma FaxLine, faça uma chamada DELETE para o URI dessa FaxLine (especificado na resposta da etapa anterior):

Se a operação for bem-sucedida, você receberá uma resposta 200.