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 em conjunto com a ação MCR meta DATA em Studio. Esta ação permite enviar dados de interação para um contato único durante interações em tempo real.
A documentação da API de Dados comerciais está disponível no portal Developer Community
.
Antes de Iniciar
Você pode testar as NiCE CXone APIs no portal do desenvolvedor
. Faça login com uma conta NiCE CXone e, em seguida, você pode fazer solicitações com o locatário
Agrupamento organizacional de alto nível usado para gerenciar o suporte técnico, o faturamento e as configurações globais do seu sistema NiCE CXone. da sua conta.
Para começar a usar a API, você deve registrar-se com NiCE para receber credenciais válidas usadas para autenticação. Revise a página de Introdução
no portal do desenvolvedor para obter instruções.
Uso dessas APIs requer a seguinte permissão:
Entidade: Para atualizar a API de dados comerciais, você precisa da permissão Pesquisar e Reproduzir > API > Update Business Data.
Atualizar Dados comerciais
Para uma interação encerrada, atualize as informações do campo de dados comerciais existentes para todos os segmentos disponíveis para o Id do contato principal fornecido.
Uma interação fechada refere-se a uma interação que foi totalmente encerrada. O encerramento de um contato individual, perna de chamada ou segmento não indica necessariamente que a interação está fechada, já que uma interação pode conter múltiplos contatos e segmentos enquanto os participantes entram ou saem.
Aguarde pelo menos 5 minutos após o encerramento completo da interação antes de chamar a API para garantir que todos os segmentos associados tenham sido processados e estejam disponíveis.
Método: PUT
Terminal: /business-data-manager/v1/business-data/contact/{masterContactId}
Parâmetros:
| masterContactId*: |
Sequência Identificador exclusivo do masterContactId para o qual atualizar os valores de dados comerciais. |
|---|
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 contido 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 de servidor Interna.
Atualizar Dados comerciais
Para uma interação fechada, atualize as informações de campo de dados comerciais existentes para o segmento especificado no masterContactId fornecido.
Método: PUT
Terminal: /business-data-manager/v1/business-data/contact/{masterContactId}/segment/{segmentId}
Parâmetros:
| masterContactId*: |
Sequência Identificador exclusivo do masterContactId que contém o segmento com os valores de dados comerciais a serem atualizados. |
| segmentId*: |
Sequência Identificador exclusivo do segmento masterContactId com os valores de dados comerciais a serem atualizados. |
URL: https://na1.test.nice-incontact.com/business-data-manager/v1/business-data/contact/{masterContactId}/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 - O segmento solicitado não foi encontrado.
-
Status 500 - Erro de servidor interno.