GET/api/v4/locations/{locationId}/voice-assistants

Obtenir les fiches d’un établissement sur les assistants vocaux

Renvoie l’état de synchronisation des fiches d’un établissement sur Google Assistant, Alexa, Siri, Cortana et Bixby.

Nécessite une clé API. Consultez Authentification pour le format de l’en-tête et la rotation des clés.

Paramètres

Chemin

NomTypeObligatoireDescription
locationIdstringobligatoireLocation ID. Accepts either the base64-encoded node ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`) or the raw numeric database ID (e.g. `1800289`).

Réponses

200Array of voice assistant listings with per-assistant sync status.
Response
{  "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.

Renvoie l’état des fiches des assistants vocaux pour un seul établissement. Listings API synchronise les données de l’établissement avec Google Assistant, Amazon Alexa, Apple Siri, Microsoft Cortana et Samsung Bixby afin que l’entreprise apparaisse dans les résultats de recherche vocale. Le segment de chemin locationId accepte l’ID de nœud encodé en base64 provenant de n’importe quelle réponse concernant un établissement, ou l’ID numérique brut de la base de données ; les deux désignent le même établissement.

Cas d’utilisation : afficher les fiches des assistants vocaux nécessitant une action dans un tableau de bord. Affichez un widget par établissement indiquant si ses fiches sont prêtes pour la recherche vocale en parcourant le tableau et en signalant chaque entrée où actionRequired vaut true ou où syncIssue est non nul. Dans l’exemple ci-dessus, Google Assistant et Bixby nécessitent une intervention. La raison la plus courante pour laquelle Google Assistant nécessite une intervention est l’absence de connexion Google, car ses résultats proviennent de la connexion à Google Business Profile. Associez ces lignes à Connecter Google afin que le client puisse connecter le compte. Les résultats de Siri proviennent de la fiche Apple Maps de l’établissement.

Valeurs de l’état de synchronisation : IN_PROGRESS (soumission en cours), REQUIRING_ACTION (informations requises de la part du client avant que Listings API puisse effectuer la synchronisation), LIVE (publié) et NOT_SUBMITTED. errors est un tableau de chaînes de caractères décrivant les erreurs du côté des plateformes de publication ; connectedAccountId relie l’assistant au compte connecté utilisé pour la synchronisation, le cas échéant (e.g. Google Assistant via la connexion Google).

Les appels à cet endpoint sont comptabilisés dans la limite de débit de votre compte. Si vous interrogez régulièrement l’état des fiches des assistants vocaux pour de nombreux établissements, parcourez les établissements par pages à l’aide de l’endpoint de liste des établissements et espacez les appels ; une réponse 429 inclut un en-tête Retry-After qui vous indique quand reprendre.

Request
curl -X GET 'https://listingsapi.com/api/v4/locations/<locationId>/voice-assistants' \  -H "Authorization: API $LISTINGSAPI_KEY"