/api/v4/locations/{locationId}/voice-assistantsObtén las fichas de asistentes de voz de una ubicación
Devuelve el estado de sincronización de las fichas de asistentes de voz de una ubicación en Google Assistant, Alexa, Siri, Cortana y Bixby.
Parámetros
Ruta
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| locationId | string | obligatorio | Location ID. Accepts either the base64-encoded node ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`) or the raw numeric database ID (e.g. `1800289`). |
Respuestas
200Array of voice assistant listings with per-assistant sync status.
{ "data": { "voiceAssistantsForLocation": [ { "databaseId": "104468723", "voiceIdentifier": "GOOGLE_ASSISTANT", "name": "Google Assistant", "connectedAccountId": null, "syncStatus": "REQUIRING_ACTION", "actionRequired": true, "syncIssue": null, "errors": [] }, { "databaseId": "104468711", "voiceIdentifier": "SIRI", "name": "Siri", "connectedAccountId": null, "syncStatus": "IN_PROGRESS", "actionRequired": false, "syncIssue": null, "errors": [] }, { "databaseId": "104468714", "voiceIdentifier": "ALEXA", "name": "Alexa", "connectedAccountId": null, "syncStatus": "IN_PROGRESS", "actionRequired": false, "syncIssue": null, "errors": [] } ] }}401Unauthenticated, missing or invalid API key.
429Rate limit exceeded. Retry after the `Retry-After` header value.
Devuelve el estado de las fichas de asistentes de voz de una sola ubicación. Listings API sincroniza los datos de la ubicación con Google Assistant, Amazon Alexa, Apple Siri, Microsoft Cortana y Samsung Bixby para que el negocio aparezca en los resultados de búsqueda por voz. El segmento de ruta locationId acepta el ID de nodo en base64 de cualquier respuesta de ubicación o el ID numérico sin codificar de la base de datos; ambos corresponden a la misma ubicación.
Caso de uso: mostrar en un panel las fichas de asistentes de voz que requieren una acción. Muestra un widget de preparación para búsquedas por voz para cada ubicación recorriendo el array y marcando cada entrada en la que actionRequired sea true o syncIssue no sea nulo. En el ejemplo anterior, Google Assistant y Bixby requieren atención. El motivo más habitual por el que Google Assistant requiere atención es la falta de una conexión con Google, ya que sus resultados proceden de la conexión con Google Business Profile. Enlaza esas filas a Conectar Google para que el cliente pueda conectar la cuenta. Los resultados de Siri proceden de la ficha de la ubicación en Apple Maps.
Valores del estado de sincronización: IN_PROGRESS (envío en curso), REQUIRING_ACTION (se necesita información del cliente antes de que Listings API pueda sincronizar), LIVE (publicado) y NOT_SUBMITTED. errors es un array de cadenas de error de la plataforma de publicación; connectedAccountId vincula el asistente con la cuenta conectada que permite la sincronización cuando corresponde (e.g. Google Assistant a través de la conexión con Google).
Este endpoint cuenta para el límite de solicitudes de tu cuenta. Si consultas periódicamente el estado de los asistentes de voz en muchas ubicaciones, recórrelas por páginas con el endpoint de lista de ubicaciones y espacia las llamadas; una respuesta 429 incluye una cabecera Retry-After que te indica cuándo reanudarlas.
curl -X GET 'https://listingsapi.com/api/v4/locations/<locationId>/voice-assistants' \ -H "Authorization: API $LISTINGSAPI_KEY"