Endpoints de usuários finais

Os endpoints da API de usuários finais fornecem acesso aos objetos de usuários finais. Um objeto de usuário final é criado para cada usuário final da Contact Center AI Platform (CCAI Platform).

A seguir estão os endpoints da API de chamada:

Atualizar usuário final

Esse endpoint permite atualizar os detalhes de um usuário final, incluindo:

  • voce@sua-empresa.com

  • nome

  • número de telefone

{
    "identifier": "string",
    "email": "string",
    "name": "string",
    "phone": "string"
}

Endpoint:

Method: POST
Type: RAW
URL: https://{subdomain}.{domain}/apps/api/v1/end_users

Cabeçalhos:

Chave Valor Descrição
Content-Type aplicativo/json
Aceitar aplicativo/json

Corpo:

{
    "identifier": "abc123",
    "email": "joe@mydomain.com",
    "name": "Joe Smith",
    "phone": "+16171231234"
}

Exemplo de solicitação e respostas

As seções a seguir fornecem exemplos de solicitações para o endpoint.

ID e identificador do usuário final

Este exemplo mostra como atualizar um usuário final fornecendo o ID.

Solicitação

Cabeçalhos:

Chave Valor Descrição
Content-Type aplicativo/json

Corpo:

{
    "identifier": "string",
    "email": "string",
    "name": "string",
    "phone": "string"
}
Resposta
{
    "id": "integer",
    "identifier": "string"
}

Código de status: 200

Receber usuário final

Esse endpoint permite recuperar um usuário final usando o id ou identifier.

Endpoint:

Method: GET
Type:
URL: https://{subdomain}.{domain}/apps/api/v1/end_users

Cabeçalhos:

Chave Valor Descrição
Content-Type aplicativo/json

Query:

Chave Valor Descrição
ID integer ID interno do usuário final
identificador string Identificador externo do usuário final

Exemplo de solicitação e respostas

As seções a seguir fornecem exemplos de solicitações para o endpoint.

Receber por ID

Este exemplo mostra como recuperar um usuário final fornecendo o ID.

Solicitação

Cabeçalhos:

Chave Valor Descrição
Content-Type aplicativo/json

Query:

Chave Valor Descrição
ID integer ID interno do usuário final
Resposta
{
    "id": "integer",
    "identifier": "string"
}

Código de status: 200

Receber por identificador

Este exemplo mostra como recuperar um usuário final fornecendo o identificador.

Solicitação

Cabeçalhos:

Chave Valor Descrição
Content-Type aplicativo/json

Query:

Chave Valor Descrição
identificador string Identificador externo do usuário final
Resposta
{
    "id": "integer",
    "identifier": "string"
}

Código de status: 200