API de datos empresariales

Los datos comerciales son campos personalizados que se pueden asociar con los metadatos de la llamada. Con la API de Datos comerciales, puede actualizar los valores de los campos de datos comerciales existentes para cualquier interacción cerrada. No puede agregar nuevos campos de datos comerciales utilizando esta API. Esta API funciona junto con la acción MCR META DATA en Studio. Esta acción le permite enviar datos de interacción de un único contacto durante las interacciones en directo.

La documentación de la API de datos comerciales está disponible en el portal de la comunidad de desarrolladores .

Antes de que empiece

Puede probar las API de NiCE CXone en el portal para desarrolladores . Inicie sesión con una cuenta de NiCE CXone; luego podrá realizar solicitudes con el abonadoClosed Agrupación organizativa de alto nivel utilizada para administrar el soporte técnico, la facturación y la configuración global de su sistema NiCE CXone. de su cuenta.

Para empezar a usar las API, debe registrarse con NiCE para recibir credenciales válidas que se utilizan para la autenticación. Revise la página comenzar en el portal para desarrolladores para obtener instrucciones.

Uso de estas API requiere el siguiente permiso:

Entidad: Para actualizar la API de datos comerciales, necesita el permiso Buscar y reproducir > API > Actualizar datos comerciales.

Actualizar datos comerciales

Para una interacción cerrada, actualice la información del campo de datos comerciales existente para todos los segmentos disponibles para el ACD contactId determinado.

Método: PUT

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

Parámetros:

ID de contacto*:

cadena

Identificador único del ACD contactId para el que se actualizarán los valores de los datos comerciales.

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, } ]

Respuesta

  • Estado 204: El servidor ha cumplido la solicitud de manera satisfactoria y no hay más contenidos para enviar en el cuerpo de la carga útil de respuesta.

  • Estado 400: La solicitud contenía parámetros de entrada incorrectos.

  • Estado 401: Falla de autenticación. Credenciales incorrectas.

  • Estado 403: Se requieren permisos.

  • Estado 404: No se encontró el contacto solicitado.

  • Estado 500: Error de servidor interno.

Actualizar datos comerciales

Para una interacción cerrada, actualice la información del campo de datos comerciales existente para el segmento especificado en el ACD contactId dado.

Método: PUT

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

Parámetros:

ID de contacto*:

cadena

Identificador único del ACD contactId que contiene el segmento con los valores de datos comerciales que se actualizarán.
ID de segmento*:

cadena

Identificador único del segmento ACD contactId con los valores de datos comerciales que se actualizarán.

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, } ]

Respuesta

  • Estado 204: El servidor ha cumplido la solicitud de manera satisfactoria y no hay más contenidos para enviar en el cuerpo de la carga útil de respuesta.

  • Estado 400: La solicitud contenía parámetros de entrada incorrectos.

  • Estado 401: Falla de autenticación. Credenciales incorrectas.

  • Estado 403: Se requieren permisos.

  • Estado 404: No se encontró el segmento solicitado.

  • Estado 500: Error de servidor interno.