Funnelchat APIContactos y datos
Contactos, etiquetas, campos personalizados y notas, para guardar en Funnelchat lo que tu flujo necesita.
Contactos, etiquetas, campos personalizados y notas, para guardar lo que tu flujo necesita sin armar otra base. Todo disponible con conversations:read (leer) y conversations:write (escribir).
| Pieza | Para qué |
|---|---|
| Contactos | Listar, ver, crear o actualizar un contacto, o crearlo si no existe. |
| Campos personalizados | El estado de tu flujo, guardado en el contacto: crear un campo y asignarle un valor a un contacto. |
| Etiquetas | Crear y listar etiquetas, y ver los contactos de una. |
| Notas | Agregarle una nota a un contacto y leerlas. |
- Ponerle o quitarle una etiqueta a un contacto no está abierto a claves (
403 route_not_available): una etiqueta puede disparar un flow que manda mensajes. Para marcar a un contacto desde tu código, usá un campo personalizado. Ver Qué está abierto a claves. - Te enterás de los cambios con
contact.created,contact.tag_added,contact.tag_removedycontact.stage_changed(catálogo). - El teléfono de un contacto viene sin
+en la API y con+en los eventos (detalle).
Paso a paso: Sincronizar contactos.
Probalo acá
Tus contactos, con tu clave. Es una lectura: no cambia nada.
GET
Permiso requerido: conversations:read
httpheader
AuthorizationBearer <clave>name?stringemail?stringphone?stringwhatsapp_id?stringcountry_codes[]?array<string>status?stringimage?stringcreated_at?stringFormato
date-timecreated_from?stringFormato
date-timecreated_to?stringFormato
date-timetag_ids[]?array<integer>tag_mode?stringValor en
"all""any""exclude"custom_field_ids[]?array<integer>custom_field_mode?stringValor en
"all""any""exclude"custom_field_value?stringcustom_field_date_from?stringFormato
datecustom_field_date_to?stringFormato
datecustom_field_numeric_operator?stringValor en
"lt""eq""gt"custom_field_numeric_value?numberonly_with_phone?stringonly_with_mac?stringscopeToAdvisor?stringlead_score_categories[]?array<>Valor en
"insufficient_data""hot""warm""cold"lead_score_min?integerRango
0 <= value <= 100lead_score_max?integerRango
0 <= value <= 100lead_score_disqualified?|Valor en
"include""exclude""only"nulltag_filters?array<>custom_field_filters?array<>perPage?integerRango
1 <= value <= 100Por defecto
25orderBy?stringValor en
"id""name""email""phone""status""favorite""unread_messages""created_at""updated_at"orderByMethod?stringValor en
"asc""desc"OK
application/json- response
data*array<>links*meta*curl -X GET "https://example.com/contacts"{ "data": [ { "id": 0, "name": "string", "email": "string", "phone": "string", "whatsapp_id": "string", "whatsapp_username": "string", "has_phone": true, "country_code": "string", "status": 0, "image": "string", "notes": "string", "custom_fields": [ { "id": 0, "name": "string", "description": "string", "type": "string", "value": "string", "created_at": "string", "updated_at": "string", "contact_count": "string" } ], "created_at": "2019-08-24T14:15:22Z", "active_conversation": 0, "favorite": 0, "unread_messages": 0, "manually_unread": true, "last_message": { "text": "string", "file": "string", "date": "string", "type": "string", "own": "string", "deleted_at": "string", "deleted_scope": "string" }, "device_id": 0, "adviser_id": 0, "paused_at": "string", "mac_date": "string", "is_mac_inactive": true, "ai_assistant_name": "string", "stage_since": "string", "is_stagnant": true, "lead_score": { "score": 0, "signals_count": 0, "category": "string", "confidence": "string", "disqualified": true, "disqualified_at": "string", "updated_at": "string" }, "name_mismatch": [ null ] } ], "links": { "first": "string", "last": "string", "prev": "string", "next": "string" }, "meta": { "current_page": 0, "from": 0, "last_page": 0, "links": [ { "url": "string", "label": "string", "active": true } ], "path": "string", "per_page": 0, "to": 0, "total": 0 }}