Ricky logorickyDocs

Crear una ubicación

POST
/knowledge/locations

Agrega una sucursal o un lugar que los agentes pueden compartir.

Permiso: knowledge:write.

Autorización

bearerAuth
headerAuthorizationBearer <clave>

Una clave de API de la organización, rky_live_…, creada en Configuración → API. Envíala solo desde un servidor.

Parámetros de cabecera

Idempotency-Key?string

Opcional. Un valor que eliges, único por escritura lógica, de 8 a 200 caracteres: un UUID o un ID de tu sistema, como order-10482-ready. Reintentar con la misma clave y el mismo cuerpo repite la primera respuesta en lugar de repetir la escritura.

Longitud8 <= length <= 200

Cuerpo de la solicitud

application/json
  1. body

Una ubicación necesita un nombre, una dirección y sus coordenadas.

name*string

Nombre con que la conocen los clientes.

Longitud1 <= length <= 200
address*string

Dirección completa, tal como la leen los clientes.

Longitud1 <= length <= 500
latitude*number

Latitud del pin en el mapa, confirmada, no estimada.

Rango-90 <= value <= 90
longitude*number

Longitud del pin en el mapa, confirmada, no estimada.

Rango-180 <= value <= 180
street?|

Calle.

city?|

Ciudad.

state?|

Estado, provincia o región.

postal_code?|

Código postal.

country?|

País.

country_code?|

Código de país, ISO 3166-1 alfa-2.

phone?|

Teléfono con código de país, por ejemplo +507 6000-1234.

email?|

Correo.

hours?|

Horario de atención, en texto libre.

Cuerpo de la respuesta

Éxito.

application/json
  1. response
data*

Una sucursal o un lugar que los agentes pueden enviar como ubicación de WhatsApp.

curl -X POST 'https://getricky.ai/api/v1/knowledge/locations' \  -H 'Idempotency-Key: order-10482-ready' \  -H 'Content-Type: application/json' \  -d '{  "name": "Casa Nativa Albrook",  "address": "Albrook Mall, local 214, Panamá",  "latitude": 8.9733,  "longitude": -79.5511,  "phone": "+507 6000-0000",  "hours": "Lunes a sábado, 10:00 a 20:00"}'
{  "data": {    "id": "c3d4e5f6-a7b8-4c9d-8e0f-1a2b3c4d5e6f",    "name": "Casa Nativa Albrook",    "address": "Albrook Mall, local 214, Panamá",    "latitude": 8.9733,    "longitude": -79.5511,    "street": "Albrook Mall, local 214",    "city": "Panamá",    "state": "Panamá",    "postal_code": null,    "country": "Panamá",    "country_code": "PA",    "phone": "+50760000000",    "email": "albrook@example.com",    "hours": "Lunes a sábado, 10:00 a 20:00"  }}