API de datos DE negocio
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 el MCR META DATA acción 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 DE negocio está disponible en el portal de Developer Community
.
Antes de Comenzar
Puede probar las API de NiCE CXone en el portal para desarrolladores
. Inicie sesión con una cuenta de NiCE CXone y, luego, podrá realizar solicitudes con el abonado
High-level organizational grouping used to manage technical support, billing, and global settings for your NiCE CXone system. de su cuenta.
Para comenzar a usar las API, debe registrarse con NiCE para recibir credenciales válidas que se utilizan para la autenticación. Revise la página de comenzar
en el portal para desarrolladores para obtener instrucciones.
El uso de estas API requiere el siguiente permiso:
Entidad: Para actualizar la API de datos DE negocio, necesita el permiso Search & Playback > Reproducción > APIs > Update Business Data.
Actualizar Datos DE negocio
Para una interacción cerrada, actualice la información del campo de datos DE negocio existente para todos los segmentos disponibles para el Id DE contacto principal dado.
Una interacción cerrada se refiere a una interacción que ha finalizado por completo. El fin de un contacto individual, un tramo de llamada o un segmento no necesariamente indica que la interacción esté cerrada, ya que una interacción puede contener múltiples contactos y segmentos mientras los participantes se unen o se van.
Espere al menos 5 minutos después de que la interacción completa se haya cerrado antes de llamar a la API, para asegurarse de que todos los segmentos asociados se hayan procesado y estén disponibles.
Método: PUT
Terminal: /business-data-manager/v1/business-data/contact/{masterContactId}
Parámetros:
| masterContactId*: |
Cadena de caracteres Identificador único de masterContactId para el que se actualizan los valores de los datos DE negocio. |
|---|
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 contenido adicional para enviar en el cuerpo de la carga útil de respuesta.
-
Estado 400: La solicitud tenía contenido con parámetros de entrada incorrectos.
-
Estado 401: fallo de autenticación. Credenciales incorrectas.
-
Estado 403: Se requieren Permisos.
-
Estado 404: Contacto solicitado no encontrado.
-
Estado 500: Error en el servidor Interna.
Actualizar Datos DE negocio
Para una interacción cerrada, actualice la información del campo de datos DE negocio existente para el segmento especificado en el masterContactId dado.
Método: PUT
Terminal: /business-data-manager/v1/business-data/contact/{masterContactId}/segment/{segmentId}
Parámetros:
| masterContactId*: |
Cadena de caracteres Identificador único del masterContactId que contiene el segmento con los valores de datos DE negocio que se deben actualizar. |
| segmentId*: |
Cadena de caracteres Identificador único del segmento de masterContactId con los valores de datos DE negocio a actualizar. |
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,
}
]
Respuesta
-
Estado 204: El servidor ha cumplido la solicitud de manera satisfactoria y no hay contenido adicional para enviar en el cuerpo de la carga útil de respuesta.
-
Estado 400: La solicitud contenido parámetros de entrada incorrectos.
-
Estado 401: fallo de autenticación. Credenciales incorrectas.
-
Estado 403: Se requieren Permisos.
-
Estado 404: el segmento solicitado no se encontró.
-
Estado 500: Error en el servidor interno.