Autenticação no meio da sessão por API

Nesta página, explicamos como usar endpoints de API de chamada e chat para autenticação no meio da sessão nos seus canais do SDK.

Os usuários podem iniciar uma sessão de suporte, como um chat de suporte, sem fazer a autenticação. Quando a autenticação de usuário final se torna necessária, é possível iniciar um fluxo de autenticação. Após a autenticação, você pode atualizar o identificador end_user para vincular a sessão ao usuário final verificado.

URI e autenticação

O URI de base desse novo endpoint varia de acordo com o comm_type.

Para o comm_type call:

POST https://<subdomain>.<domain>//apps/api/v1/calls/:call_id/end_user

Para o comm_type chat:

POST https://<subdomain>.<domain>//apps/api/v1/chats/:chat_id/end_user

Operações de API

Parâmetros

O corpo da solicitação da API precisa ter os seguintes campos:

ID Nome do campo Tipo Obrigatório? Descrição Exemplos de valores
0 identifier String Sim Identificador externo exclusivo fornecido.
1 name String Não O nome genérico ou identificador associado à interação. Ajuda na pesquisa de clientes. John Doe
2 email String Não O endereço de e-mail genérico associado à interação. Ajuda na pesquisa de clientes. john@doe.com
3 phone String Não O número de telefone genérico associado à interação. Ajuda na pesquisa de clientes. 123-456-7890

Exemplos de API

Exemplo de resposta da API

Exemplo de resposta de sucesso:

202 Accepted

{
 "message": "accepted"
}

Exemplos de respostas de falha

Parâmetros ausentes
400 {"message": "param is missing or the value is empty: comm_type"}
400 {"message": "param is missing or the value is empty: identifier"}
Fazer referência a um tipo de comunicação diferente de ligação ou chat
404 {"message": "Not Found"}
Sessão inativa
400 {"message": "Call is already ended"}
400 {"message": "Chat is already ended"}
Solicitação de CRM não compatível
400 {"message": "Unsupported CRM request"}
Pedido duplicado
400 {"message": "Duplicate request: Please wait for the interval to expire"}

Exemplo de solicitação de API

Tipo de comunicação de chamada

POST https://<subdomain>.<domain>/apps/api/v1/calls/:call_id/end_user
Content-Type: application/json
Authorization: Bearer <your_access_token>

{
    "identifier": "unique_external_id",
    "name": "John Doe",
    "email": "johndoe@example.com",
    "phone": "123-456-7890"
}

Tipo de comunicação do chat

POST https://<subdomain>.<domain>/apps/api/v1/chats/:chat_id/end_user
Content-Type: application/json
Authorization: Bearer <your_access_token>

{
    "identifier": "unique_external_id",
    "name": "Jane Smith",
    "email": "janesmith@example.com",
    "phone": "098-765-4321"
}

Documentação da API Apps

Para outros endpoints da API Apps, consulte Publicação da API Apps.