clients (GET)

Retorna uma lista de clientes com sua informação. Request (pedido):

Parâmetros:

• – id do cliente.ISe omitido, a lista completa de clientes é enviada.

• Se o parâmetro transport é especificado, então a lista de transportes disponíveis para o cliente especificado é retornado.

• Se o parâmetro last_question é especificado, então o ultimo item do menu enviado ao cliente é retornado.

• Se o parâmetro dialogs é especificado, então a lista de conversas do cliente é retornada.

• Se o parâmetro questions é especificado, então uma lista de itens do menu que foram enviados ao cliente usando scripts é retornada.Opcionalmente, é possível especificar o interval de tempo.

• phone – Filtro do número de telefone do cliente.

• tags– filtro de tags,separadas por vírgula. Clientes com pelo menos uma tag da lista são retornados.

• created_after – clientes com a data de criação (rastreada pela primeira mensagem) depois **********after specified unix time are returned.

• order (asc or desc) – (crescente ou decrescente) – ordem dos registros é retornada . O padrão é ordem crescente.

Se id ou phone são omitidos, uma lista complete de clientes é retornada. Resposta típica sem id do cliente especificado (lista complete de clientes):

Resposta típica quando o id do cliente é especificado(um cliente com informações estendidas):

Alguns campos:

• assigned_name – ao nome atribuído ao cliente – veja clients (PUT).

• comment –comentário sobre o cliente, feito por um operador.

• custom_fields – dados json dos campos personalizados do seu cliente com seu id, nome e valor. Esses campos são visíveis para operadores no cadastro do cliente. Eles podem ser controlados pelo admin na seção Configurações > Geral.

• phone – número de telefone do cliente, se existe. Disponível apenas para WhatsApp, Viber, Viber Business e SMS. Para outros mensageiros, é armazenado o id do mensageiro respective. Veja também client_phone abaixo.

• client_phone – número do cliente se o cliente revelou seu número de telegone em mensageiros que não os exibem por padrão (atualmente telegram e facebook).

• name – apelido do cliente na plataforma(se disponível). Veja abaixo uma resposta típica ao especificar id do cliente e key do transporte/canal. Esses, na verade, são os transportes (com canais) que dado cliente usou para conversar com a sua central de conversas e podem ser usados para responder para esse cliente.

Veja abaixo uma resposta típica ao especificar o id do cliente e a key last_question. Esserequest retorna o ultimo item do menu enviado a esse cliente mais cedo.