Acciones del Marco API

Las acciones del Framework API son acciones Studio que le permiten utilizar las API CXone en sus scripts. Puede usar la acción en lugar de llamar a la API usando métodos de integración tradicionales, como usar un snippet o la acción RestAPI. Todas las acciones de las API se encuentran en la pestaña Marco en Studio.

Las acciones de la API son diferentes de las acciones de Studio estándar. Actualmente no están documentadas en la ayuda en línea. Sin embargo, en el CXone portal para desarrolladores se documentan las API que corresponden a las acciones de las API. Puede usar esta documentación cuando trabaje con acciones de la API en sus scripts.

No toda API CXone tiene una acción de API correspondiente en Studio.

Versiones de las acciones de la API

Conforme se liberan nuevas versiones de las APIs CXone, es posible que se lancen nuevas versiones de las acciones correspondientes en Studio. Generalmente, es mejor usar la versión más reciente de la acción. Las versiones anteriores todavía funcionarán en la mayoría de los casos. Puede probar las diferentes versiones para ver cuáles funcionan y que ofrecen la funcionalidad que necesita.

Algunas acciones de la API tienen la versión en el nombre de la acción. Puede verlo cuando mira la estructura de árbol de las acciones en la pestaña Marco. No todas las acciones de la API incluyen el número de versión. Para estas acciones, puede encontrar la versión en las propiedades extendidas de la acción. Solo puede ver las propiedades extendidas en la pestaña Propiedades cuando está seleccionada la acción en la pestaña Marco.

No todas las versiones de cada API tienen una acción correspondiente en Studio.

Ver las Propiedades extendidas de las acciones de la API

1. En Studio, reorganice las pestañas para que pueda ver la pestaña Propiedades y la pestaña Marco al mismo tiempo.
2. En la pestaña Marco, haga clic en una acción de la API.
3. En la pestaña Propiedades, puede ver ahora las propiedades extendidas de la acción. En particular, son útiles las siguientes propiedades cuando se aprende sobre una acción de la API:
   • Varios > Parámetros > Verbo: Esta propiedad muestra el método o verbo asociado con la acción.
   • Varios > Parámetros > Versión: Esta propiedad muestra la versión de la API.
   • Varios > Web > URI: Esta propiedad puede ser útil al ubicar la documentación de la API en el portal del desarrollador.

   • Varios > Parámetros: En la sección Parámetros, puede expandir las propiedades para ver información adicional sobre cada una de las propiedades de la acción.

     Ver imagen

     

Localizar la documentación de la API

CXone Se documentan las API en el CXone Portal para desarrolladores. Las acciones API en Studio no tienen un enlace directo a la documentación correspondiente a sus API. Sin embargo, puede utilizar la información disponible en las propiedades ampliadas de la acción para ayudarle a localizar la documentación.

Utilizarla la URI requiere conocimiento general del sistema de CXone como un todo y de las diferentes API de CXone. Esto es porque determinar qué API coincide con una acción en Studio no siempre es claro. Conocer el flujo general de un contacto mediante CXone ayuda correctamente a interpretar un URI de acciones y aplicar las claves que se encuentran para la estructura de la documentación de la API en el portal de desarrolladores. Los ejemplos en esta sección demuestran la interpretación que pueda necesitarse.

La página de inicio de la sección de APIs del portal para desarrolladores ofrece una descripción general de cada CXone API.

Ejemplo 1

A veces, existe una correlación directa entre una acción y su API:

• Acción: Agent Assignments for given Skills
• URI: /services/$VERSION$/skills/agents
• Documentación de API : /API/AdminAPI#/Skills/getAgentsAllSkills

Según el nombre de la acción y la URI, las dos primeras API a considerar son la API de Agente y la API de Administración. Al mirar la lista de llamadas de la API a cada una, puede eliminar la API del Agente. Su descripción indica que se usa para administrar sesiones de agentes y no parece tener llamadas relacionadas con habilidades, según se muestra en la siguiente imagen.

La API de Administración indica que funciona con objetos del sistema, como habilidades. La lista de llamadas de API disponibles para esta API incluye habilidades, según se muestra en la siguiente imagen.

Cuando expande la sección Habilidades, una de las terminales es GET /skills/agents. La pequeña descripción de esta terminal dice que "Devuelve asignaciones de habilidades".

Ejemplo 2

A veces, no es obvia la correlación, como se muestra en el siguiente ejemplo. En casos como éste, necesitará aplicar su conocimiento de las APIs de CXone y la plataforma misma para encontrar la terminal de la API correspondiente. —

• Acción: Active Contact Details
• URI: /services/$VERSION$/contacts/active
• Documentación API:  /API/RealTimeDataAPI#/RealTime/ActiveContacts

Según el nombre y el URI de esta acción, no es inmediatamente obvio qué API mirar primero. Si no está seguro de por dónde empezar, puede consultar la documentación de cada API y examinar cualquier sección relacionada con los contactos. La API de Administración es la única que tiene una sección de contacto de nivel superior. Desafortunadamente, esta API no contiene terminales relacionadas con los contactos activos.

En este punto, puede introducir la palabra activo en el nombre de la acción y URI. Aprovechando su conocimiento de CXone, sabe que activo indica los contactos que se están manejando en ese momento. Esto lo lleva a mirar con más cuidado la API de Datos en Tiempo Real. Esta API solo tiene una sección, y cuando la expande, ve que una de las terminales es GET /contacts/active. La pequeña descripción de esta terminal dice que "Devuelve contactos activos".