Ricky logorickyDocs

Crear un contacto del directorio

POST
/knowledge/contacts

Agrega una tarjeta de contacto que los agentes pueden enviar a los clientes.

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 tarjeta de contacto necesita un nombre visible y un teléfono o un correo.

display_name*string

Nombre que muestra la tarjeta de contacto.

Longitud1 <= length <= 200
first_name?|

Nombre.

last_name?|

Apellido.

prefix?|

Prefijo del nombre, como Dr..

suffix?|

Sufijo del nombre.

company?|

Empresa.

department?|

Departamento.

job_title?|

Cargo.

description?|

Cuándo deben compartirlo los agentes.

phone?|

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

phone_type?|null
email?|

Correo.

email_type?|null

Cuerpo de la respuesta

Éxito.

application/json
  1. response
data*

Una tarjeta de contacto del directorio de conocimiento, que los agentes pueden enviar a los clientes.

curl -X POST 'https://getricky.ai/api/v1/knowledge/contacts' \  -H 'Idempotency-Key: order-10482-ready' \  -H 'Content-Type: application/json' \  -d '{  "display_name": "Ventas Casa Nativa",  "department": "Ventas",  "phone": "+507 6000-1111",  "phone_type": "WORK",  "email": "ventas@example.com"}'
{  "data": {    "id": "a7b8c9d0-e1f2-4a3b-8c4d-5e6f7a8b9c0d",    "display_name": "Ventas Casa Nativa",    "first_name": "Valeria",    "last_name": "Ruiz",    "prefix": null,    "suffix": null,    "company": "Casa Nativa",    "department": "Ventas",    "job_title": "Gerente de ventas",    "description": "Pedidos al por mayor.",    "phone": "+50760001111",    "phone_type": "WORK",    "email": "ventas@example.com",    "email_type": "WORK"  }}