Con Voice Biometrics Opt-In API, es posible obtener el estado de consentimiento de un contacto determinado para que la inscripción se active en consecuencia, sin necesidad de intervención humana.
Obtención de un cliente OAuth para llamar a la API
Para obtener acceso a cualquier API de Talkdesk, siga las instrucciones proporcionadas en Crear un nuevo OAuth client.
Nota: Si no tiene la aplicación, el artículo anterior también explica cómo hacer la petición de acceso.
A continuación, puede encontrar una captura de pantalla con la configuración del cliente OAuth necesaria para acceder a Identity Voice Biometrics Opt-In API.
Nota: En el "Grant Type", solo están seleccionadas las casillas "Client credentials" y "Refresh token". Deberá seleccionar el ámbito "voicebiometrics-consent:write" si pretende establecer el estado de consentimiento, y/o el ámbito "voicebiometrics-consent:read" si pretende leerlo.
Después de guardar el nuevo cliente de OAuth, asegúrese de guardar el Client ID y Client Secret information, ya que será necesaria en los siguientes pasos.
Configurar una Integración
Para poder utilizar la API en el flujo de Studio, primero hay que configurar una integración:
1. En Admin [1], vaya a Integrations [2] y haga clic en Add integration [3].
2. Seleccione la opción Custom integration [4] y elija Add integration [5].
3. Rellene los datos de la integración como figura en la siguiente captura de pantalla:
-
Basic information [6]:
- "Name": pegue "Identity Voice Bio Opt-in API".
- "Description": pegue "Identity Voice Biometrics Opt-In API to read and set the user consent status”.
- Copie y pegue en el Base path [7]: API.talkdeskapp.<region>/voicebiometrics/contacts.
- Seleccione el Authentication type [8].
- Introduzca la "Client ID" de OAuth [9].
- Coloque el "Client Secret" de OAuth [10].
- “Access Token URL”: coloque your_org.mytalkdesk.<región>/oauth/token y reemplace <your_org> (incluido el <>) con el nombre de su cuenta [11]. Puede verificar el nombre de su cuenta en la URL de su navegador: https://your_org.mytalkdesk.<region>/
- Elija el "OpenID Auth Scheme"[12].
Sugerencia: Ajuste los dominios de URL a su dominio Regional Cloud (com, eu, ca, etc.) tanto en la URL de la ruta base como en la URL del token de acceso. Asegúrese de que tanto la "Base path" como la "Access Token URL" estén configuradas como "https://".
- Haga clic en Save en la esquina superior derecha de la página.
Configurar una acción para establecer el estado de Opt-in
1. Vaya a la sección Actions [1] y haga clic en Add Action [2].
2. Rellene la "Basic Information" [3] para la acción con:
- Name: “Set Opt-in Status”.
- Description: “Sets the Opt-in status for Voice Biometrics”.
- Añada los datos de la URL con los valores, copiando y pegándolos:
- “Relative path” [4]: /{{contact_id}} /consent
- “Display name” [5]: contact_id
- Establezca el método de la ruta relativa como PUT [6].
4. En la sección "Inputs and Outputs", rellene el "Input Schema" [7] con los siguientes valores:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"title": "status",
"type": "string"
}
},
"required": [
"status"
],
"additionalProperties": false
}
5. En la parte superior derecha de la página, seleccione Save as Draft.
6. Vuelva a la pestaña "Actions" y haga clic en la acción recién creada.
7. En la parte superior derecha de la página Action, seleccione Test Action.
8. Rellene un contact_id aleatorio (cualquier número de su elección, "123" por ejemplo) y en el "Input JSON" pegue el código de la captura de pantalla.
9. Para probar la acción, haga clic en Execute.
10. Ahora puede publicar la acción seleccionando el botón Publish en la esquina superior derecha de la página.
Configurar una acción para leer el estado del Opt-in
1. Vaya a la sección Actions [1] y haga clic en Add action [2].
2. Rellene la "Basic Information" [3] de la acción con lo siguiente:
- Name: “Set Opt-in Status”.
- Description: “Sets the Opt-in status for Voice Biometrics”.
- Añada los datos de la URL con los valores copiando/pegando:
- “Relative path” [4]: /{{contact_id}} /consent
- “Display name” [5]: contact_id
- Establezca el método de la ruta relativa como GET [6].
4. En la sección "Inputs and Outputs", rellene el "Output Schema" [7] con los siguientes valores:
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"title": "HTTP connector",
"required": [],
"properties": {
"status": {
"title": "status",
"type": "string"
}
}
}
- En la parte superior derecha de la página, haga clic en Save as Draft.
- Vuelva a la pestaña Actions y seleccione la acción recién creada.
- En la parte superior derecha de la página de acciones, seleccione Test Action.
8. Introduzca un contact_id aleatorio (cualquier número de su elección, "123" por ejemplo). Para probar la acción, haga clic en Execute. Debería ver la salida de la API sin ningún error.
9. Ahora puede publicar la acción seleccionando el botón Publish en la esquina superior derecha de la página.
Uso de la Integración en Studio para establecer el consentimiento
La componente “Execute Action”en Studio le permite utilizar una integración en un flujo de Studio. Consulte la documentación del componente aquí.
Para configurar el componente para establecer el consentimiento para inscribirse en la biometría de voz, siga estos pasos:
1. Añade un nuevo componente "Execute Action", haciendo clic en Add step [1].
2. Selecciona la Connection [2] y Action [3] creado en el paso anterior. Ponga el ID de Voice Biometrics (en este caso el número de teléfono de origen) y la "CONSENTED [4] keyword as"status".
Este componente se puede utilizar ahora para confirmar que el usuario ha dado su consentimiento para que se recoja su voz para la autenticación por voz. Se puede utilizar, con un input IVR, para preguntar automáticamente al usuario si quiere inscribirse y dirigirlo a este componente.
Uso de la Integración en Studio para obtener el estado del consentimiento
Es posible que tenga que entender si un usuario ya ha dado su consentimiento. Para configurar un componente de acción de ejecución, siga estos pasos:
1. Añada un componente "Execute Action", como en el punto anterior, pero coloque "Get Voice Biometrics Opt-In" en el "Step Name".
2. Seleccione la "Connection" [1] y la "Action" [2] creadas en el paso anterior y la acción "Read opt-in status". Introduzca el Voice Biometrics ID (en este caso el número de teléfono de origen) como contact_id[3].
3. Ahora puede asignar el estado del consentimiento a una variable de salida (consent_status en este caso) [4]. Si el contenido de la variable es igual a “CONSENTED” significa que el usuario ya ha dado su consentimiento para que su voz sea utilizada para la Voice Biometrics Authentication.