Tutorial da API REST

Nós preparamos alguns CURL-exemplos baseados em Com a ajuda da ferramenta CURL, você pode testar nossa API rapidamente a partir da linha de comando. Isso deve fornecer uma compreensão direta de como usar nossa API.

Todas as solicitações de API precisam ser autenticadas com um token de API. O token da API deve ser passado como cabeçalho de autorização com cada solicitação.

Há um token de API para cada organização qu permite acesso apenas aos dados da respectiva organização. Há também um token de API da empresa qu permite o acesso a todos os dados.

Recupere uma lista de mensagens de seus clientes quando você estiver desconectado. Os métodos suportados são GET e DELETE. O resultado é uma matriz JSON que consiste de objetos para cada email. Se você usa Javascript API para passar seus dados customizados para o chat de cliente, eles serão incluídos no campo "customizar" como um objeto.

Você pode adicionar filtros à consulta por meio de parâmetros GET para especificar o conjunto de resultados. Os parâmetros suportados são:

• count - Número de itens a serem buscados. O valor padrão é 100, o limite superior é 1000
• until - Filtre itens que são criados até data determinada. Formato: %A-%m-%d
• after - Filtre itens que são criados após determinada data. Formato: %A-%m-%d
• organization - Filtre itens que pertencem a uma organização específica, especificada pelo ID da organização.

Você pode buscar mensagens offline individuais usando a "id" do item no URL.

Você pode buscar mensagens offline para organizações específicas se estiver usando um token de API da empresa. Esse parâmetro não terá efeito se você estiver usando um token da API da organização.

Você pode excluir mensagens offline individuais usando o método HTTP DELETE.

Você também pode deletar todas as suas mensagens offline, ou um subconjunto, definido pelos filtros descritos acima.

Obtenha uma lista de todas nossas sessões de chat anteriores. Os métodos suportados são GET e DELETE. O resultado é uma matriz JSON que consiste de objetos para cada sessão de chat. Se você usa Javascript API para passar seus dados customizados para o chat de cliente, eles serão incluídos no campo "customizar" como um objeto.

Você pode adicionar filtros à consulta por meio de parâmetros GET para especificar o conjunto de resultados. Os parâmetros suportados são:

• count - Número de itens a serem buscados. O valor padrão é 100, o limite superior é 1000
• until - Filtre itens que são criados até data determinada. Formato: %A-%m-%d
• after - Filtre itens que são criados após determinada data. Formato: %A-%m-%d
• organization - Filtre itens que pertencem a uma organização específica, especificada pelo ID da organização.

Você pode buscar sessões de chat individuais usando a "id" do item no URL.

Você pode buscar sessões de chat para organizações específicas se estiver usando um token de API da empresa. Esse parâmetro não terá efeito se você estiver usando um token da API da organização.

Você pode deletar sessões de chat individuais usando o método HTTP DELETE.

Você também pode deletar todas as sessões de chat, ou um subconjunto, definido pelos filtros descritos acima.

Também oferecemos uma API para sua Team acessar. Você pode buscar uma lista de todos os Operators em sua conta. Você pode obter detalhes como "nome de usuário", "email" e "id" primário, que podem ser usados ​​em outras chamadas API para manipular o estado do Operator.

Você pode adicionar filtros à consulta por meio de parâmetros GET para especificar o conjunto de resultados. Os parâmetros suportados são:

• organization - Filtre os Operators que pertencem a uma organização específica, especificada pelo ID da organização.

Esse parâmetro só pode ser usado com um token de API da empresa. Esse parâmetro não terá efeito se você estiver usando um token da API da organização.

Você pode buscar Operators individuais usando seu "id" no URL.

Com esta API, você pode procurar o status atual de um operator. Você pode ler o status online e o uso atual do slot de chat.

Com esta API você pode alterar o status remoto de um Operator. Se você definir um Operator como ausente, ele não receberá novos chats, mas poderá terminar os chats que estão em execução. Este estado é persistente, mesmo que o Operator fique offline e retorne online novamente. A API é útil para forçar o estado de um aplicativo que necessita de toda a atenção do agente de chat.

Também oferecemos uma API para acessar seus Audit Log. Você pode buscar uma lista de todas as entradas de Audit Log.

• organization - Filtre as entradas Audit Log que pertencem a uma organização específica, especificada pela ID da organização.

Esse parâmetro só pode ser usado com um token de API da empresa. Esse parâmetro não terá efeito se você estiver usando um token da API da organização.

Você pode fazer até 1500 pedidos API por janela de 15 min. Este limite de taxa é aplicado quando você faz uma solicitação API usando seu IP secreto e remoto.

Solicite até 1000 itens por pedido, isso é controlado pelo parâmetro "contar" GET.

Preparamos alguns exemplos sobre como acessar a API Userlike a partir de python. É bastante simples, usamos httlib2 para a solicitação HTTP e adicionamos a Autorização aos cabeçalhos HTTP.

Recupere uma lista de mensagens de seus clientes quando você estiver offline.

Obtenha uma lista de todas nossas sessões de chat anteriores, incluindo a transcrição.

Obtenha uma lista de todas as sessões de chat anteriores e exclua-as.

Alterar o status ausente de um Operator.