API de dados comerciais

Dados comerciais são campos personalizados que podem ser associados aos metadados da chamada. Usando a API de dados corporativos, você pode atualizar os valores dos campos de dados corporativos existentes para quaisquer interações fechadas. Você não pode adicionar novos campos de dados da empresa usando esta API. Essa API funciona junto com a ação MCR META DATA no Studio. Essa ação permite enviar dados de interação para um único contato durante interações ao vivo.

A documentação do API de dados corporativos está disponível no portal da Comunidade de Desenvolvedores .

Antes que você comece

Você pode testar CXone Mpower APIs no portal do desenvolvedor . Efetue login com uma conta CXone Mpower e faça solicitações com o locatário da sua conta.

Para começar a usar as APIs, você deve se registrar no NiCE para receber credenciais válidas usadas para autenticação. Revise a página Introdução no portal do desenvolvedor para obter instruções.

Uso dessas APIs

Entidade: para atualizar a API de dados corporativos, você precisa da permissão Pesquisa e reprodução > APIs > Atualizar dados da empresa.

Atualizar dados comerciais

Para uma interação fechada, atualize as informações do campo de dados comerciais existentes para todos os segmentos disponíveis para o ACD contactIdfornecido.

Método: PUT

Endpoint: /business-data-manager/v1/business-data/contact/{ACD contactId}

Parâmetros:

contactId*:

string

Identificador exclusivo do ACD contactId para o qual atualizar os valores de dados corporativos.

URL: https://na1.test.nice-incontact.com/business-data-manager/v1/business-data/contact/8675309

Tipo: PUT

[ { "business_data_name1": "string of text" }, { "business_data_name2": true, }, { "business_data_name3": 1234, } ]

Resposta

  • Status 204 - O servidor atendeu à solicitação com sucesso e não há conteúdo adicional para enviar no corpo da carga útil de resposta.

  • Status 400 - A solicitação continha parâmetros de entrada incorretos.

  • Status 401 - Falha de autenticação. Credenciais incorretas.

  • Status 403 - Permissões necessárias.

  • Status 404 - Contato solicitado não encontrado.

  • Status 500 - Erro interno do servidor.

Atualizar dados comerciais

Para uma interação fechada, atualize as informações do campo de dados comerciais existentes para o segmento especificado no ACD contactIdfornecido.

Método: PUT

Endpoint: /business-data-manager/v1/business-data/contact/{ACD contactId}/segment/{segmentId}

Parâmetros:

contactId*:

string

Identificador exclusivo do ACD contactId que contém o segmento com os valores de dados comerciais a serem atualizados.
segmentId*:

string

Identificador exclusivo do segmento ACD contactId com os valores de dados comerciais a serem atualizados.

URL: https://na1.test.nice-incontact.com/business-data-manager/v1/business-data/contact/{ACD contactId}/segment/b2e28d4e-ef22-4597-a104-2e740f729686

Tipo: PUT

[ { "business_data_name1": "string of text" }, { "business_data_name2": true, }, { "business_data_name3": 8675309, } ]

Resposta

  • Status 204 - O servidor atendeu à solicitação com sucesso e não há conteúdo adicional para enviar no corpo da carga útil de resposta.

  • Status 400 - A solicitação continha parâmetros de entrada incorretos.

  • Status 401 - Falha de autenticação. Credenciais incorretas.

  • Status 403 - Permissões necessárias.

  • Status 404 - Segmento solicitado não encontrado.

  • Status 500 - Erro interno do servidor.