Plantilla de artículo

General

¿Cómo habilito mi cuenta de desarrollador?

Para acceder a la API y las funciones relacionadas, primero debe habilitar la cuenta de desarrollador. Ver Preferencias de configuración personal Para más información.

¿Cómo puedo empezar a utilizar la API de Social Connect?

Ver el Guía paso a paso de la API de Qualtrics Social Connect.

¿Qué tipo de cuenta necesito para utilizar la API de Social Connect?

El acceso a la API no está incluido en todos los planes de precios. Contacto con el soporte técnico si tiene preguntas sobre lo que incluye su licencia.

¿Tienes una biblioteca cliente en lenguaje de programación x?

Qualtrics no ofrece bibliotecas de clientes, pero existen bibliotecas para el protocolo OAuth en casi todos los idiomas, consulte http://oauth.net/code/.

¿Puedo probar rápidamente la API?

Puede probar la API a través de Consola API. Aquí, elegirá un punto final y completará los parámetros requeridos. Aparecerá un resultado inmediato para que puedas ver si la API produjo el resultado deseado.

¿Puedes aumentar los límites de velocidad de la API ?

Ver Limitación de velocidad para obtener una descripción general de los límites de velocidad de la API . Nuestros límites de velocidad actuales son más que suficientes para los casos de uso estándar. Sin embargo, si necesita límites de velocidad adicionales, contacto con Soporte y describa el caso de uso de su aplicación y los límites de velocidad solicitados.

¿Cómo funciona el filtrado en la API?

Varios puntos finales de la API Social Connect le permiten pasar un parámetro de cadena de filtro .

Por ejemplo, supongamos que está obteniendo una lista de menciones. Puede filtro las menciones para que solo se devuelvan las menciones con una etiqueta determinada.

El parámetro de filtro siempre es una cadena. Su sintaxis permite la búsqueda de varias propiedades de los datos (palabras mencionadas, etiquetas, estado, tiempo de resolución, …) y combinarlas mediante una sintaxis booleana y anidada.

Cuando creas un filtro en la plataforma Social Connect, el filtro tiene una representación textual asociada. Esta representación aparecerá en la ventana de filtro después de que haya seleccionado sus campos de filtro . Puede copiar este parámetro para luego usarlo en sus llamadas API .

¿Qué método se utiliza para firmar webhooks?

Ver Webhooks Para más información.

¿Por qué tengo un límite de 20 llamadas API por hora?

Si se utiliza la Consola API , el límite de velocidad es de 20 llamadas autenticadas por hora, en lugar de las 350 llamadas por hora estándar para otros clientes API . Si experimenta este límite de 20 llamadas, asegúrese de estar usando el token de acceso para su aplicación API , no la Consola API .

Autenticación API

¿Cómo se autentican las llamadas API ?

Qualtrics utiliza el protocolo estándar OAuth 2.0. Ver Autenticación Para más información.

¿Realmente necesito implementar OAuth para mi aplicación?

Si no necesita que los usuarios de su aplicación autentiquen su cuenta de Qualtrics Social Connect, puede generar un token OAuth para su propia cuenta de usuario. Vaya a la descripción general de la aplicación, haga clic en Editar siguiente a su solicitud registrada, vaya a la Tokens de acceso pestaña. Si haces clic Autorizarse a mí mismoSe generará un token de acceso para el usuario que inició sesión actualmente (con sus permisos). Puede utilizar este token de acceso para firmar solicitudes de API .

¿Cuánto tiempo son válidos los tokens de acceso?

Ver el Autenticación Página para obtener más información.

¿A qué cuentas y datos puedo acceder con un token?

Se genera un token de acceso OAuth para un usuario específico de Social Connect. Este usuario tiene acceso a una o más cuentas (puede ver cuáles a través del punto final `/me/accounts`). Los datos a los que puede acceder dependen de las cuentas a las que tiene acceso el usuario y de cuál es su rol de usuario en esa cuenta .

Trabajar con menciones

¿Cómo puedo obtener menciones de mi Bandeja de entrada de Social Connect en mi propia aplicación?

Utilice el punto final `/{account_id}/inbox/mentions` para recuperar todas las menciones en cualquiera de sus temas. Esta página de soporte de API cubre qué información se recupera de sus menciones.

También puedes diseñar un flujo de trabajo para llamar a los webhooks en tu aplicación usando la función de receta de automatización de Social Connect.

¿Por qué los tweets devueltos por la API carecen de detalles?

Para los tweets, Qualtrics solo puede devolver los datos específicos de Social Connect y el ID del tweet de Twitter. Esta es una restricción de los Términos de la API de Twitter.

Dado que tienes el ID del Tweet, puedes acceder al API de Twitter y uso del punto final “/statuses/lookup”  para obtener todos los detalles.

¿Por qué algunas publicaciones de Facebook son anónimas?

Las publicaciones públicas de Facebook (selectas por Social Connect a través de tu búsqueda de palabras clave, no los mensajes en tus páginas de Facebook) son anonimizadas. Esta es una limitación de la API de Facebook.

¿Puedo agregar mis propios mensajes a Social Connect?

Si tiene un formulario de contacto o un foro interno que desea que Social Connect supervise, puede llamar al punto final “/{account_id}/inbox/add” para agregar sus mensajes personalizados a Social Connect. Luego, podrás acceder a estos mensajes en tu bandeja de entrada y en información.

Los mensajes agregados a Social Connect a través de la API no se pueden responder desde Social Connect. Si desea tener esta integración más estrecha con su sistema personalizado, comuníquese con el soporte.

¿Puedo exportar casos a través de la API?

Puede utilizar el punto final de mención regular (exportar lista / actualizar mención individual) para exportar casos. Si solo desea devolver casos en su solicitud, puede utilizar el filtro ‘sub_category:case’.

¿Cuál es la diferencia entre casos y menciones para la API?

En Social Connect, una “mención” es el objeto central de un mensaje (un solo tweet, un solo mensaje privado, un solo comentario). También existe el concepto de “Caso”, que básicamente es una colección de menciones.

El uso principal de los casos es agrupar varios mensajes de un determinado usuario y respuestas de agentes en conversaciones.

Desde una perspectiva técnica, una “conversación de caso” consiste en:

• El caso en sí (que también es objeto de mención).
• Un caso puede tener etiquetas, un estado, un título, etc.
• Una lista de menciones que forman parte de la conversación.
• Las menciones que se han agrupado en el caso.

Ver Esta página de soporte de API para más información sobre casos y menciones.

¿Puedo importar mensajes a la bandeja de salida de Social Connect?

Puede crear borradores de nuevas publicaciones para que los administradores sociales las verifiquen, editen y publicar a través del punto final “/{account_id}/publisher/add”.

¿Puedo editar una mención a través de la API?

Puedes editar menciones existentes utilizando el punto final “/{account_id}/inbox/mention/{topic_id}/{id}”. La documentación de este punto final tiene ejemplos para actualizar las etiquetas de una mención, agregar una nota y más.

¿Cómo puedo eliminar todos los datos de un determinado usuario en Engage a través de la API?

Si desea eliminar todos los datos de un determinado cliente que se encuentra en su cuenta de Social Connect, deberá eliminar dos tipos de datos:

1. Todas las menciones de ese usuario en el sistema
2. Cualquier información sobre ese usuario que esté almacenada en el CRM de Social Connect.

Para encontrar todas las menciones de un determinado usuario, utilice el punto final “/{account_id}/inbox/mentions” y filtro por un determinado authorID, por ejemplo, “author.id:123”. Una vez que tenga esa lista de menciones, las menciones se pueden eliminar a través del punto final “/{account_id}/inbox/mention/{topic_id}/{id}”.

Para saber si sus agentes guardaron o no más datos de contacto en el CRM de Social Connect para un contacto, realice una solicitud GET a “/{account_id}/inbox/ contacto/{service}/{service_id}”. Si el objeto de respuesta contiene un .id de contacto, esto significa que hay un contacto para este usuario. Si la respuesta no contiene una propiedad .id de contacto, significa que no se almacenaron datos en Social Connect CRM.

Una vez que tenga un .id de contacto, puede realizar una solicitud DELETE al punto final /{account_id}/inbox/ contacto/{contact_id} para eliminar toda la información.

Trabajar con contactos  ​

¿Cómo puedo encontrar detalles de contacto de una mención o caso?

Si un La API devuelve una mención o un caso, contendrá una lista de Objetos “action_link”. Los enlaces de acción contienen información para el objeto actual sobre qué otros puntos finales de API o URL en la aplicación web son relevantes para este objeto. Para las menciones y los casos, uno de los enlaces de acción incluidos es donde puede obtener los datos de contacto del autor de la mención o el caso.

Al utilizar el punto final /{account_id}/inbox/cases, el objeto de contacto del autor de la mención se incluye de forma predeterminada. Qualtrics no incluye el objeto de contacto completo para las menciones, pero a través de los enlaces de acción, este objeto se puede obtener realizando una llamada API independiente.

Publicación

¿Puedo usar la API de Clarabridge Engage para publicar en un canal social?

No, la API no permite publicar directamente en plataformas de terceros. Esto significa que no puedes usar la API de Social Connect para publicar un tweet o un comentario en Facebook.

Sin embargo, puedes utilizar la API de Social Connect para crear borradores o poner mensajes en cola para su aprobación. Estos se publicarán cuando se aprueben o se publiquen a través de la interfaz de Social Connect. El punto final para redactar mensajes es /{account_id}/publisher/add.

Gestión de usuarios

¿Puedo cambiar el estado de los usuarios a través de la API?

No, no puedes cambiar el estado de los usuarios a través de la API. Si bien no puede cambiar el estado, puede cambiar el nombre, la empresa, el correo electrónico, el avatar y el horario comercial a través del punto final /{account_id}/settings/user/{id}.

¿Puedo cambiar el rol de usuario de los usuarios a través de la API?

Es posible cambiar el rol de usuario de un usuario a través de nuestra API. Sin embargo, por razones de seguridad no es posible cambiar un rol de usuario a Administrador. Todos los demás roles de usuario se pueden cambiar a través del punto final /{account_id}/settings/user/{id}.

¿Puedo crear nuevos usuarios a través de la API?

Por razones de seguridad esto no es posible a través de API.

Trabajar con perfiles sociales

¿Puedo recuperar información sobre los perfiles sociales en mis temas?

Puede obtener información sobre un determinado perfil social a través del punto final “/{account_id}/inbox/ contacto/{service}/{service_id}”. Esto incluirá cualquier detalle que haya completado para esa persona dentro del CRM de Social Connect, como género, correo electrónico o atributos personalizados que haya agregado para este usuario.

Trabajar con Información

¿Puedo obtener estadísticas de Clarabridge Engage?

Puede extraer datos de Información utilizando 2 puntos finales de API diferentes;

1. El punto final “/{account_id}/dashboards/export/{dashboard_id}” devuelve los datos de todos los widgets en un Tablero determinado. Una vez que usted o sus usuarios hayan configurado paneles personalizados, puede usar este punto final para obtener los datos detrás de ellos.
2. El punto final “/{account_id}/ información/facets” actúa como el equivalente API de la función Chart Builder en Social Connect.

Problemas

¿Dónde puedo encontrar el ID de mi cuenta ?

Una vez que se haya autenticado, puede obtener una lista de todas las cuentas (y sus identificaciones) a las que un usuario tiene acceso a través del punto final “/me/accounts”.

¿Dónde puedo encontrar el ID de mi tema?

Una vez que se haya autenticado, podrá obtener una lista de todos los temas (y sus identificaciones) a los que un usuario tiene acceso a través del punto final “/me/accounts”.

¿Dónde puedo encontrar mi ID de usuario?

Una vez que se haya autenticado, puede obtener detalles sobre el usuario que se autentica (incluida su identificación) a través del punto final “/me”.