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

사업장의 음성 비서 등록 정보 조회

Google Assistant, Alexa, Siri, Cortana, Bixby에 대한 사업장의 음성 비서 등록 정보 동기화 상태를 반환합니다.

API 키가 필요합니다. 헤더 형식과 키 교체는 인증을 참고하세요.

매개변수

경로

이름유형필수설명
locationIdstring필수Location ID. Accepts either the base64-encoded node ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`) or the raw numeric database ID (e.g. `1800289`).

응답

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.

단일 사업장의 음성 비서 등록 정보 상태를 반환합니다. Listings API는 사업장이 음성 검색 결과에 표시되도록 사업장 데이터를 Google Assistant, Amazon Alexa, Apple Siri, Microsoft Cortana, Samsung Bixby에 동기화합니다. locationId 경로 세그먼트에는 사업장 응답에서 가져온 base64 노드 ID 또는 원시 숫자형 데이터베이스 ID를 사용할 수 있으며, 둘 다 동일한 사업장을 가리킵니다.

사용 사례: 대시보드에 "조치 필요" 음성 등록 정보 표시. 배열을 순회하면서 actionRequired가 true이거나 syncIssue가 null이 아닌 항목을 모두 표시하는 방식으로 사업장별 음성 검색 준비 상태 위젯을 만듭니다. 위 예시에서는 Google Assistant와 Bixby에 조치가 필요합니다. Google Assistant의 결과는 Google Business Profile 연결에서 제공되므로, Google Assistant에 조치가 필요한 가장 흔한 이유는 Google 연결이 없는 것입니다. 고객이 계정을 연결할 수 있도록 해당 행에 Google 연결 링크를 추가합니다. Siri 결과는 해당 사업장의 Apple Maps 등록 정보에서 제공됩니다.

동기화 상태 값: IN_PROGRESS(제출 진행 중), REQUIRING_ACTION(Listings API가 동기화하려면 고객 입력 필요), LIVE(게시됨), NOT_SUBMITTED입니다. errors는 게시 플랫폼 측 오류 문자열의 배열이며, connectedAccountId는 동기화에 사용되는 연결된 계정이 있는 경우 음성 비서를 해당 계정에 연결합니다(예: Google 연결을 통한 Google Assistant).

이 엔드포인트 호출은 계정의 요청 빈도 제한에 포함됩니다. 여러 사업장의 음성 상태를 폴링하는 경우 사업장 목록 엔드포인트를 사용하여 페이지 단위로 사업장을 조회하고 호출 간격을 둡니다. 429 응답에는 호출을 재개할 시점을 알려 주는 Retry-After 헤더가 포함됩니다.

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