Saltar al contenido
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Endpoints

Referencia completa para los endpoints de la API de Missive: Estadísticas, conversaciones, borradores, mensajes, Contactos, Etiquetas y más.

Estadísticas

Los endpoints de Estadísticas le permiten obtener un informe basado en un período seleccionado y filtros opcionales como Bandeja de equipo, Usuarios, Etiquetas, etc. Intervienen dos endpoints debido a la naturaleza asíncrona de la generación de informes: una solicitud para crear el informe y otra para obtener los datos poco después.

Los endpoints de la API de Estadísticas requieren un plan Productive o Business. Las capacidades de filtrado (Equipos, Usuarios, Etiquetas, Cuentas) requieren un plan Business.

Ejemplo de uso Sincronice automáticamente los datos de Estadísticas con su herramienta de Business Intelligence.

Crear informe de Estadísticas

POST /v1/analytics/reports

payload de solicitud
{
  "reports": {
    "organization": "0d9bab85-a74f-4ece-9142-0f9b9f36ff92",
    "start": 1691812800,
    "end": 1692371867,
    "time_zone": "America/Montreal"
  }
}
payload de solicitud
{
  "reports": {
    "organization": "0d9bab85-a74f-4ece-9142-0f9b9f36ff92",
    "start": 1691812800,
    "end": 1692371867,
    "time_zone": "America/Montreal",
    "equipos": [
      "0e24f298-965d-4475-9220-b32636a1e2c3"
    ],
    "usuarios": [
      "1ce8117e-ae42-4304-b953-c81656da4bd1",
      "74f91030-39b8-4627-9835-9cfbce9d67c1"
    ],
    "Cuentas": [
      "716be7a6-fd40-45a2-bfcb-43b9ed38d1f0",
      "a5d2aa1c-3828-4f90-bbd8-3dffaadda97e"
    ],
    "account_types": [
      "correo", 
      “sms”
    ],
    "shared_labels": [
      "bca0bb8f-8b2f-45f8-a59a-333de84f0184"
    ]
  }
}
Plantilla
{
  "reports": {
    "id": "8441d4a0-a0ad-4f0f-aa9c-1cc881057e42"
  }
}

Este ID debe incluirse luego en un Solicitud para obtener el informe.

Parámetros

Nombre (* obligatorio)
Descripción
Ejemplo

organización*

Cadena del ID de la organización

"0d9bab85-a74f-4ece-9142-0f9b9f36ff92"

start*

Inicio del período del informe

1691812800

end*

Fin del período del informe

1692371867

time_zone

Identificador de zona horaria ( reference)

"America/Montreal"

equipos

Array de cadenas de ID de equipos

["0e24f298-965d-4475-9220-b32636a1e2c3"]

usuarios

Array de cadenas de ID de usuario

["1ce8117e-ae42-4304-b953-c81656da4bd1"]

etiquetas_compartidas

Array de cadenas de ID de Etiqueta de organización

["bca0bb8f-8b2f-45f8-a59a-333de84f0184"]

cuentas

Arreglo de cadenas de ID de la cuenta

["716be7a6-fd40-45a2-bfcb-43b9ed38d1f0"]

account_types

Array de tipo string

["email", "sms"]

Equipos, Usuarios, Etiquetas compartidas, Cuentas Consultar ID de recursos.

account_types "personalizado", "email", "instagram", "live_chat", "messenger", “sms”, "whatsapp"

Obtener informe de Estadísticas

GET /v1/analytics/reports/:id

Recupere un informe usando su id devuelto por una solicitud Create report. Los datos del informe se devuelven como JSON.

La mayoría de los informes se completan en 2 o 3 segundos después de su creación, pero algunos pueden tardar 30 segundos o más. Caducan 60 segundos después de completarse. Se devuelve una respuesta vacía 404 para los informes incompletos, caducados o inexistentes.

Recupere un informe 5 segundos después de su creación y vuelva a intentarlo cada 5 segundos hasta que se devuelva una respuesta 200 satisfactoria.


Contactos

Los endpoints de Contactos le permiten administrar sus Contactos mediante programación.

Uso de ejemplo Sincronizar contactos automáticamente entre Missive y su CRM.

Crear contactos

POST /v1/contacts

Una solicitud exitosa devolverá nuevos Contactos recién creados.

Atributos

Nombre (* obligatorio)
Descripción
Ejemplo

contact_book*

string de ID de la Libreta de contactos

"551b8675-11e9-49c3-aac0-01fb8510d862"

first_name

string

"Philippe"

last_name

string

"Lehoux"

middle_name

string

"Antoine"

phonetic_first_name

string

"f ih l - IH - p ai"

phonetic_last_name

string

"l ay h oo"

phonetic_middle_name

string

"ah n t - w ah n"

prefix

string

"Sr."

suffix

string

"Jr."

nickname

string

"Phil"

file_as

string

"Missive"

notes

string

"¡Buen cliente potencial!"

starred

boolean

true

gender

string

"Masculino"

infos

Array que contiene objetos de información de contacto, vea a continuación los detalles

[{"kind": "email", "label": "work", "value": "phil@missiveapp.com"}]

memberships

Array que contiene objetos de membresía de contacto, vea a continuación los detalles

[{ "title": "CEO", "group": { "kind": "organization", "name": "Missive" }}]

infos

El método infos array le permite adjuntar datos de distintos tipos al contacto: email, twitter, phone_number, facebook, physical_address, url, custom.

Información con kind email

Nombre (* obligatorio)
Descripción
Ejemplo

kind*

string

"email"

valor*

Dirección de correo electrónico

"philippe@missiveapp.com"

label*

Tipo de Dirección de correo electrónico. Valores aceptados: home, work, personal, other

"work"

custom_label

Valor de etiqueta personalizada, usar solo si label es other

"old"

Información con kind phone_number

Nombre (* obligatorio)
Descripción
Ejemplo

kind*

string

"phone_number"

valor*

Número de teléfono

"+1 518 777-7777"

label*

Tipo de Número de teléfono. Valores aceptados: main, mobile, home, work, home_fax, work_fax, other_fax, pager, other

"mobile"

custom_label

Valor de etiqueta personalizada, usar solo si label es other

"old"

Información con kind twitter

Nombre (* obligatorio)
Descripción
Ejemplo

kind*

string

"twitter"

valor*

Nombre de usuario de Twitter

"@plehoux"

label*

Tipo de cuenta de Twitter. Valores aceptados: work, personal, other

"personal"

custom_label

Valor de etiqueta personalizada, usar solo si label es other

"old"

Información con kind facebook

Nombre (* obligatorio)
Descripción
Ejemplo

kind*

string

"facebook"

name*

Nombre de usuario de Facebook

"Philippe-Antoine Lehoux"

label*

Tipo de cuenta de Facebook. Valores aceptados: work, personal, other

"personal"

custom_label

Valor de etiqueta personalizada, usar solo si label es other

"old"

Información con kind physical_address

Nombre (* obligatorio)
Descripción
Ejemplo

kind*

string

"physical_address"

street

string

123 Fake Street

extended_address

string

Office 222

city

string

Quebec

region

string

QC

postal_code

string

G1K 3T4

po_box

string

PO#12345

country

string

Canadá

label*

Tipo de dirección. Valores aceptados: work, home, other

"work"

custom_label

Valor de etiqueta personalizada, usar solo si label es other

"old"

Información con kind url

Nombre (* obligatorio)
Descripción
Ejemplo

kind*

string

"url"

valor*

URL

"https://missiveapp.com/"

label*

Tipo de URL. Valores aceptados: homepage, Perfil, blog, work, personal, other

"homepage"

custom_label

Valor de etiqueta personalizada, usar solo si label es other

"admin"

Información con kind custom

Nombre (* obligatorio)
Descripción
Ejemplo

kind*

string

"personalizado"

valor*

string

"A custom value"

label*

Tipo de información personalizada. Valores aceptados: other

"other"

custom_label

Valor de etiqueta personalizada

"personalizado"

memberships

El método memberships array permite vincular un contacto a organizaciones o grupos. Una membresía siempre incorpora un grupo, que tiene un kind igual a cualquiera de grupo o organización.

  • Las Organizaciones se usan con mayor frecuencia para vincular Contactos con su lugar de trabajo.

  • Los grupos se usan para agrupar contactos. Piense en los grupos como etiquetas.

Nombre (* obligatorio)
Descripción
Ejemplo

departamento

se puede establecer si grupo es del tipo organización

"Finanzas"

title

se puede establecer si grupo es del tipo organización

"CFO"

ubicación

se puede establecer si grupo es del tipo organización

"Montreal"

description

se puede establecer si grupo es del tipo organización

“Gestionar reportes”

grupo*

Objeto, consulte los detalles a continuación

{"kind": "organization", "name": "Missive"}

memberships.group

Nombre (* obligatorio)
Descripción
Ejemplo

kind*

Tipo de grupo. Valores aceptados: organización, grupo

"organization"

name*

string

"Missive"

Propiedades del contacto

Nombre (* siempre presente)
Descripción

id*

UUID del contacto

eliminado*

Indica si el contacto está eliminado

modified_at*

Marca de tiempo Unix en que se modificó por última vez el contacto

contact_book*

UUID de la Libreta de contactos

first_name

last_name

middle_name

phonetic_first_name

phonetic_last_name

phonetic_middle_name

prefix

suffix

nickname

file_as

notes

starred

Booleano

gender

pronombres

job_title

infos

Arreglo de información de contacto (ver tipos de información de contacto en la documentación de la solicitud)

memberships

Arreglo de membresías de contacto (consulte la documentación de la solicitud)

Un contacto eliminado volvió a través de modified_since + include_deleted=true contendrá solo id, deleted: true, y modified_at.

Actualizar contacto(s)

PATCH /v1/contacts/:id1,:id2,:id3,...

Una solicitud exitosa devolverá los Contactos actualizados con contenido incrustado memberships y infos.

Atributos

Contacto id es obligatorio. Consulte la sección Crear contactos para otros atributos. Al actualizar un contacto, puede pasar solo los atributos que desea actualizar. En el ejemplo anterior, solo se actualizará el apellido.

Listar contactos

GET /v1/contacts

Este endpoint es útil para sincronizar Contactos de Missive con otro servicio o para encontrar Contactos según un término de búsqueda.

Parámetros

Nombre (* obligatorio)
Predeterminado
Descripción

contact_book*

ID de Libreta de contactos

order

last_name

El orden predeterminado es por el Apellido del contacto. Para obtener los Contactos actualizados más recientemente, pase last_modified

limit

50

Número de Contactos devueltos. Valor máximo: 200

offset

0

Desplazamiento usado para paginar.

modified_since

nulo

Para devolver solo Contactos que hayan sido modificados o creados desde un momento dado, pase una marca de tiempo Unix Epoch como 1556137749.

include_deleted

false

Para incluir los Contactos eliminados en los resultados de modified_since solicitudes, pasar true. Solo el contacto id y eliminado los atributos se devolverán ya que los datos del contacto se han eliminado de Missive.

Buscar

nulo

Cadena de texto para filtrar Contactos. Buscar Los términos se comparan con todos los datos de contacto: nombre, correo, teléfono, organización, campos personalizados, notas, etc.

Obtener un contacto

GET /v1/contacts/:id

Obtenga un contacto específico usando el contacto id. Intentar obtener un contacto eliminado producirá una respuesta 404.


Libretas de contactos

En Missive, los Contactos se almacenan en Libretas de contactos. Las Libretas de contactos pueden ser privadas o compartidas con varios miembros de una organización.

Listar libretas de contactos

GET /v1/contact_books

Lista las libretas de contactos a las que el usuario autenticado tiene acceso. Recuerde que una libreta de contactos id es obligatoria al crear un contacto mediante programación.

Parámetros

Nombre (* obligatorio)
Predeterminado
Descripción

limit

50

Número de libretas de contactos devueltas. Valor máximo: 200

offset

0

Desplazamiento usado para paginar.

Propiedades de la Libreta de contactos

Nombre (* siempre presente)
Descripción

id*

UUID de la Libreta de contactos

name*

Nombre de la Libreta de contactos

usuario*

UUID del usuario propietario

organización

UUID de la organización para libretas compartidas

share_with_organization*

Indica si la libreta está “Compartido con todos” para Todos los miembros de la organización.

share_with_team

UUID del equipo si se comparte con un equipo específico

compartir_con_usuarios*

Arreglo de UUID de usuarios con quienes se comparte explícitamente el libro

description

Descripción

importando*

Si una importación está actualmente en curso

texto de error de importación

Mensaje de error de la última importación fallida

import_rows_count

Total de filas en la importación actual/última

import_processed_rows_count

Filas procesadas hasta ahora en la importación actual/última


Grupos de contactos

Los Contactos pueden agruparse tanto en Organizaciones como en grupos. Las Organizaciones suelen usarse para mapear un grupo de contactos relacionados (empresas). Los grupos se usan para agrupar contactos no relacionados; piense en los grupos como Etiquetas.

Listar grupos de contactos

GET /v1/contact_groups

Listar grupos de contactos u Organizaciones vinculados a una Libreta de contactos.

Parámetros

Nombre (* obligatorio)
Predeterminado
Descripción

contact_book*

ID de Libreta de contactos

kind*

Cualquiera de las dos grupo o organización.

limit

50

Número de grupos de contactos devueltos. Valor máximo: 200

offset

0

Desplazamiento usado para paginar.

Propiedades del grupo de contactos

Nombre (* siempre presente)
Descripción

id*

UUID del grupo de contactos

name*

Nombre del grupo de contactos


Conversaciones

Gestionar el Estado de la conversación (finalizar, mover, asignar, etc.)

Usar Actualizar conversaciones para cambiar el Estado de la conversación sin agregar una publicación. Use Publicaciones, Mensajes, o Borradores cuando también quiera crear contenido visible en la conversación.

Las publicaciones son útiles para automatizaciones e Integraciones que deben dejar un rastro visible que muestre qué desencadenó la acción.

Listar conversaciones

GET /v1/conversations

Listar conversaciones visibles para el usuario propietario del API token. Deben filtrarse por buzón, etiqueta compartida o bandeja de equipo.

Devuelve conversaciones ordenadas de la actividad más reciente a la más antigua. Para paginar, pase un hasta parámetro igual a la last_activity_at de la conversación más antigua devuelta en la página anterior. La última página se alcanza cuando se devuelven menos conversaciones que limit o si todas las conversaciones de una página tienen el mismo last_activity_at.

Una página puede devolver más conversaciones que limit. Las conversaciones en las que el usuario del API token es un invitado se devolverán con datos limitados, que contendrán solo los id y last_activity_at campos.

Parámetros

Nombre
Descripción

limit

Número de conversaciones devueltas. Valor predeterminado: 25. Máx: 50.

hasta

Valor de marca de tiempo en tiempo Unix usado para paginar. Use el last_activity_at de la conversación más antigua de la página anterior.

Bandeja de entrada

Pasar true para listar conversaciones en la Bandeja de entrada.

todo

Pasar true para listar conversaciones en el buzón Todos.

asignada

Pasar true para listar las conversaciones asignadas al usuario.

finalizada

Pasar true para listar conversaciones en Finalizadas.

pospuesta

Pasar true para listar conversaciones en Pospuestas.

marcada

Pasar true para listar conversaciones en Destacadas.

eliminada

Pasar true para listar conversaciones en Papelera.

spam

Pasar true para listar conversaciones en Spam. Nota: Missive usa "Spam" en la interfaz, aunque algunos proveedores de correo llaman a esto "Junk".

borradores

Pasar true para listar conversaciones en Borradores.

etiqueta compartida

ID de etiqueta compartida. Lista las conversaciones en la etiqueta compartida.

bandeja de equipo

ID del equipo. Lista las conversaciones en la bandeja de equipo.

finalizadas del equipo

ID del equipo. Lista las conversaciones en el buzón Finalizadas del equipo.

team_all

ID del equipo. Enumera las conversaciones en el buzón All del equipo.

organización

ID de organización. Filtra las conversaciones para dejar solo las compartidas con la organización. No hay uso para el organización parámetro al pasar un etiqueta compartida o team_ parámetro.

email

Cadena de dirección de correo electrónico. Filtra las conversaciones por una dirección de correo electrónico de contacto específica (p. ej., user@example.com). Coincide con la dirección en los From, To, Cc, Bcc y Reply-To encabezados. Mutuamente excluyente con domain y contact_organization.

domain

Cadena de dominio. Filtra las conversaciones por contactos de un dominio de correo electrónico específico (p. ej., example.com no @example.com). Coincide con el dominio en el From, To, Cc, Bcc y Reply-To encabezados. Mutuamente excluyente con email y contact_organization.

contact_organization

UUID de organización o grupo de contactos. Filtra las conversaciones por contactos que pertenecen a una organización de contactos o a un grupo de contactos específico. Mutuamente excluyente con email y domain.

Obtener una conversación

GET /v1/conversations/:id

Obtenga una conversación específica usando el id.

La conversación devuelta puede tener un iddistinto. Esto ocurre cuando las conversaciones se fusionan; pasar una conversación antigua id seguirá funcionando, pero se devolverá la nueva conversación id .

Propiedades de la conversación

Nombre (* siempre presente)
Descripción

id*

UUID de la conversación

created_at*

Marca de tiempo Unix cuando se creó la conversación

subject

Asunto de la conversación

latest_message_subject

Asunto del último mensaje en la conversación

organización

Objeto Organization (id, name)

color

Color HEX o nombre de color (good, warning, danger)

authors*

Arreglo de autores de mensajes (name, address)

external_authors*

Subconjunto de authors excluyendo a los compañeros de trabajo

usuarios*

Arreglo de usuarios con acceso (vea las propiedades de acceso del usuario más abajo)

assignees*

Subconjunto de usuarios que están asignados a la conversación

assignee_names*

Nombres visibles de los responsables separados por comas

assignee_emails*

Correos electrónicos de los responsables separados por comas

etiquetas_compartidas*

Arreglo de objetos de etiqueta compartida en la conversación

shared_label_names*

Nombres de etiquetas compartidas separados por comas

equipo

Objeto compacto de equipo (vea las propiedades del equipo compacto a continuación)

messages_count*

Número de mensajes en la conversación

drafts_count*

Número de borradores en la conversación

send_later_messages_count*

Número de mensajes programados (para enviar más tarde)

attachments_count*

Número de archivos adjuntos en todos los mensajes

tasks_count*

Número de tareas en la conversación

completed_tasks_count*

Número de tareas completadas

last_activity_at*

Marca de tiempo de Unix de la actividad más reciente de la conversación

closed_at

Marca de tiempo Unix cuando se finalizó la tarea o la conversación asignada

web_url*

URL para abrir la conversación en la app web

app_url*

URL para abrir la conversación en la aplicación de escritorio

Cuando el usuario del API token es un invitado en la conversación, solo id y last_activity_at se devuelven.

Propiedades compactas del equipo

El método equipo el objeto incrustado en las respuestas de conversación es un objeto compacto del equipo. Para la estructura completa del equipo, use Listar equipos, Crear equipo(s), o Actualizar equipo(s).

Nombre (* siempre presente)
Descripción

id*

UUID del equipo

name*

Nombre del equipo

organización*

UUID de la organización

active_members*

Arreglo de UUID de usuario de los miembros activos del equipo

observadores*

Arreglo de UUID de usuario de los observadores del equipo

Propiedades de acceso del usuario

Elementos dentro de usuarios y assignees en una conversación.

Nombre (* siempre presente)
Descripción

id*

UUID del usuario

name*

Nombre visible del usuario

email*

Correo del usuario

asignada*

Si el usuario está Asignada a la conversación

sin asignar*

Si la conversación está en el buzón Sin asignar del usuario

finalizada*

Si la conversación está en el buzón Finalizadas del usuario

archivada*

Si la conversación está archivada para el usuario (no está en la bandeja de entrada)

marcada*

Si la conversación está destacada (marcada) para el usuario

pospuesta*

Si la conversación está pospuesta para el usuario

eliminada*

Si la conversación está en la Papelera del usuario

spam*

Si la conversación está en el buzón de Spam del usuario

Actualizar conversaciones

PATCH /v1/conversations/:id

Actualice una o más conversaciones sin crear una publicación. Use este endpoint para finalizar, reabrir, mover, asignar, etiquetar, recolorear o renombrar conversaciones silenciosamente. Los eventos del sistema aún pueden aparecer en Missive. Cuando la actualización cambia Etiquetas compartidas, las Reglas de cambio de Etiquetas compartidas siguen ejecutándose.

Para actualizar varias conversaciones en una sola solicitud, pase IDs separados por comas:

PATCH /v1/conversations/:id,:id2,:id3

El cuerpo de la solicitud debe incluir un conversations array con exactamente un objeto por cada ID en la URL. Cada objeto debe incluir el correspondiente id.

Si una conversación fue fusionada, puede pasar la conversación anterior id. La respuesta devuelve la Conversación actual id. En solicitudes masivas, no pase dos IDs que resuelvan en la misma Conversación fusionada.

La respuesta usa la misma estructura de objeto de conversación documentada en Propiedades de la conversación.

Atributos

Nombre (* obligatorio)
Descripción
Ejemplo

id*

Cadena del ID de conversación. Debe coincidir con un ID pasado en la URL.

"6d3c9b1c-7067-4a28-8ea6-ea91340b67cc"

subject

Asunto de la Nueva conversación

“Reembolso aprobado”

color

código de color HEX o “bueno” "advertencia" “peligro” string

"#000", “peligro”

conversation_color

Igual que color

"#000", “peligro”

organización

Cadena del ID de la organización

"90beb742-27a3-44cf-95bc-7e5097167c9d"

equipo

Cadena del ID del equipo

"646bb7f1-2066-40be-b8f6-bacb8b3b7419"

force_team

boolean

false

agregar_usuarios

Array de cadenas de ID de usuario

["7343bccf-cf35-4b33-99b0-b1d3c69c5f5c"]

add_assignees

Array de cadenas de ID de usuario

["7343bccf-cf35-4b33-99b0-b1d3c69c5f5c"]

remove_assignees

Array de cadenas de ID de usuario

["7343bccf-cf35-4b33-99b0-b1d3c69c5f5c"]

agregar_etiquetas_compartidas

Array de cadenas de ID de etiquetas compartidas

["9825718b-3407-40b8-800d-a27361c86102"]

remove_shared_Etiquetas

Array de cadenas de ID de etiquetas compartidas

["e4aae78f-e932-40a2-9ece-ed764aa85790"]

agregar a la bandeja de entrada

boolean

true

agregar_a_bandeja_de_equipo

boolean

true

finalizar

boolean

true

Reabrir

boolean

true

organización

organización es necesario al usar agregar_usuarios, add_assignees, remove_assignees, o agregar_etiquetas_compartidas.

equipo

equipo cambia el equipo de la conversación cuando la conversación no está ya vinculada a otro equipo.

force_team

force_team fuerza un nuevo equipo incluso si la conversación ya está en otro equipo.

add_assignees, remove_assignees

add_assignees asigna usuarios a la conversación. remove_assignees elimina a los Usuarios de los responsables de la conversación. Ambos requieren organización, y los IDs de usuario deben pertenecer a miembros de esa organización.

agregar_etiquetas_compartidas, eliminar_etiquetas_compartidas

agregar_etiquetas_compartidas y remove_shared_Etiquetas administrar Etiquetas compartidas en la conversación. Al agregar Etiquetas, deben pertenecer a organización y ser visibles para el usuario del API token.

agregar_a_bandeja_de_equipo

agregar_a_bandeja_de_equipo mueve la conversación a una Bandeja de equipo. Al proporcionar agregar_a_bandeja_de_equipo, el equipo campo es obligatorio.

agregar a la bandeja de entrada

agregar a la bandeja de entrada mueve la conversación a Bandeja de entrada para todas las personas que tienen acceso a la conversación.

finalizar

finalizar finaliza la conversación para todas las personas que tienen acceso a la conversación.

Reabrir

Reabrir reabre la conversación para todas las personas que tienen acceso a la conversación.

Listar mensajes de la conversación

GET /v1/conversations/:id/messages

Lista los mensajes de la conversación pasada como id. Los borradores se excluyen.

Devuelve mensajes ordenados de más nuevos a más antiguos. Para paginar, pase un hasta parámetro igual a la delivered_at del mensaje más antiguo devuelto en la página anterior. Se alcanza la última página cuando se devuelven menos mensajes que limit se devuelven o si todos los mensajes de una página tienen el mismo delivered_at.

Una página puede devolver más mensajes que limit.

Parámetros

Nombre
Descripción

limit

Número de mensajes devueltos. Valor predeterminado: 10. Máx: 10

hasta

Valor de marca de tiempo en tiempo Unix usado para paginar. Use el delivered_at del mensaje más antiguo de la página anterior.

Propiedades del mensaje

La misma estructura es devuelta por Listar mensajes de la conversación, Listar borradores de conversación, Listar mensajes, y Obtener un mensaje. El body campo solo se incluye en Obtener un mensaje. Algunas claves son específicas del canal (consulte las notas más abajo).

Nombre (* siempre presente)
Descripción

id*

UUID de la entrada

type*

Tipo de mensaje: email, custom_email, custom_text, custom_html, twilio_message, messenger_message, instagram_message, etc.

preview*

Vista previa breve de texto del Cuerpo del mensaje

delivered_at*

Marca de tiempo Unix cuando se entregó el mensaje

updated_at*

Marca de tiempo Unix de la última actualización del mensaje

created_at*

Marca de tiempo Unix cuando el registro del mensaje se creó en Missive

from_field*

Remitente. Canal de correo: objeto con name, address. Otros canales: objeto con id, name, username. Para WhatsApp, consulte la nota sobre cambios incompatibles más abajo.

to_fields*

Array de destinatarios con la misma estructura que from_field

attachments*

Array de objetos de adjunto (consulte Propiedades del adjunto)

references*

Array of Message-ID cadenas a las que hace referencia este mensaje

subject

Asunto del correo. Solo canal de correo

cc_fields

Array de destinatarios en CC. Solo canal de correo

bcc_fields

Array de destinatarios en BCC. Solo canal de correo

reply_to_fields

Array de destinatarios de Reply-To. Solo canal de correo

email_message_id

Correo Message-ID encabezado (envuelto en <>). Solo canal de correo

in_reply_to

Array of Message-ID cadenas a las que responde este mensaje. Solo canal de correo

external_id

ID del mensaje del proveedor. Solo canales que no son de correo (SMS, Messenger, etc.)

author

Usuario que escribió el mensaje (para salida)

body

Cuerpo HTML del mensaje. Solo devuelto por Obtener un mensaje

account_author

Alias heredado de from_field. Solo devuelto para mensajes de SMS, Messenger y Twitter

account_recipients

Alias heredado de to_fields. Solo devuelto para mensajes de SMS, Messenger y Twitter

Cuando el usuario del API token no está relacionado con el mensaje (no es el autor, destinatario o seguidor), campos sensibles como body, previewy las listas de destinatarios pueden ocultarse.

Propiedades de los archivos adjuntos

Devueltas dentro del attachments array de mensajes, borradores, comentarios, publicaciones y Plantillas.

Nombre (* siempre presente)
Descripción

id*

UUID del adjunto

filename*

Nombre original del archivo

extension*

Extensión del archivo (p. ej. png, pdf)

media_type*

Tipo MIME de nivel superior (p. ej. image, application)

sub_type*

Subtipo MIME (p. ej. png, pdf)

size*

Tamaño del archivo en bytes

url*

URL firmada para descargar el archivo

width

Ancho de la imagen en píxeles

height

Altura de la imagen en píxeles

Listar comentarios de la conversación

GET /v1/conversations/:id/comments

Lista los comentarios de la conversación pasada como id.

Devuelve los comentarios ordenados del más reciente al más antiguo. Para paginar, pase un hasta parámetro igual a la created_at del comentario más antiguo devuelto en la página anterior. Se alcanza la última página cuando se devuelven menos comentarios que limit se devuelven o si todos los comentarios de una página tienen el mismo created_at.

Una página puede devolver más comentarios que limit.

Parámetros

Nombre
Descripción

limit

Cantidad de comentarios devueltos. Valor predeterminado: 10. Máx: 10

hasta

Valor de marca de tiempo en tiempo Unix usado para paginar. Use el created_at del comentario más antiguo de la página anterior.

Propiedades del comentario

Nombre (* siempre presente)
Descripción

id*

ID único de la entrada del comentario

body*

Contenido textual del comentario

created_at*

Marca de tiempo en que se creó el comentario

mentions*

Arreglo de menciones de usuarios en el comentario, con índices para ubicarlas en el texto del cuerpo

author*

Usuario que creó el comentario

attachment

Archivo adjunto al comentario

task

Si el comentario está asociado a una tarea, el objeto completo de la tarea (vea Tareas)

Listar borradores de conversación

GET /v1/conversations/:id/drafts

Lista los mensajes en borrador de la conversación pasada como id.

Devuelve los borradores ordenados del más reciente al más antiguo. Para paginar, pase un hasta parámetro igual a la delivered_at del borrador más antiguo devuelto en la página anterior. Se llega a la última página cuando se devuelven menos borradores que limit se devuelven o si todos los borradores de una página tienen el mismo delivered_at.

Una página puede devolver más borradores que limit.

Parámetros

Nombre
Descripción

limit

Cantidad de borradores devueltos. Predeterminado: 10. Máx: 10

hasta

Valor de marca de tiempo en tiempo Unix usado para paginar. Use el delivered_at del borrador más antiguo de la página anterior.

Lista las publicaciones de la conversación

GET /v1/conversations/:id/posts

Lista las publicaciones de la conversación pasada como id.

Devuelve las publicaciones ordenadas de la más reciente a la más antigua. Para paginar, pase un hasta parámetro igual a la created_at de la publicación más antigua devuelta en la página anterior. Se llega a la última página cuando se devuelven menos publicaciones que limit se devuelven o si todas las publicaciones de una página tienen el mismo created_at.

Una página puede devolver más publicaciones que limit.

Parámetros

Nombre
Descripción

limit

Cantidad de publicaciones devueltas. Predeterminado: 10. Máx: 10

hasta

Valor de marca de tiempo en tiempo Unix usado para paginar. Use el created_at de la publicación más antigua de la página anterior.

Propiedades de la publicación

Devuelto por Lista las publicaciones de la conversación. Consulte Crear una publicación para conocer el significado de cada campo.

Nombre (* siempre presente)
Descripción

id*

UUID de la entrada de la publicación

created_at*

Marca de tiempo Unix en que se creó la publicación

username

Nombre mostrado como autor de la publicación

username_icon

URL de la imagen mostrada como avatar del autor de la publicación

conversation_icon

URL de la imagen usada como icono de la conversación

notification

Objeto con title y body usado para mostrar una notificación

text

Cuerpo de texto sin formato de la publicación

Markdown

Cuerpo de Markdown de la publicación

attachments

Arreglo de objetos de adjuntos (bloques con formato o archivos)

from_field

Objeto con name, address, o phone_number para la búsqueda del autor

references

Arreglo de cadenas de referencia de mensajes

Fusionar conversaciones

POST /v1/conversations/:id/merge

Fusione la conversación pasada como :id en la conversación pasada como destino. Después de fusionarlas, la conversación de origen (:id) se marca como reemplazada y todos sus mensajes, comentarios y demás entradas pasan a formar parte de la conversación de destino.

Cuando las conversaciones se intercambian durante la fusión (por ejemplo, al fusionar una conversación de organización en una conversación privada, o cuando la de origen tiene significativamente más entradas), la conversación devuelta id puede diferir de la pasada como destino.

Parámetros

Nombre * obligatorio
Descripción

destino*

UUID de la conversación de destino (la que sobrevive).

subject

Nuevo asunto para la conversación fusionada.

El UUID de la conversación de origen se pasa en la URL como :id.


Borradores

El endpoint de borradores le permite crear borradores de correo, SMS, WhatsApp y Missive Live Chat que pueden enviarse de inmediato o editarse y enviarse desde la app de Missive. Puede crear borradores en una nueva conversación o agregarlos como respuesta a una existente.

Este es el endpoint que debe usar para enviar correos. Para enviarlo inmediatamente, incluya send: true en su solicitud. Para responder a una conversación existente, use los parámetros de conversation o references .

Ejemplo de uso: Cree un nuevo borrador en una etiqueta compartida llamada "Follow up" con un cuerpo específico cada vez que alguien complete un formulario en su sitio web.

Crear un borrador

POST /v1/drafts

Atributos

Nombre (* obligatorio)
Descripción
Ejemplo

subject

string

"Hello"

body

Cadena HTML o de texto

"<b>World!</b>"

quote_previous_message

boolean

false

add_default_signature

boolean

false

from_field Correo

Objeto con "address" y "name" llaves.

{"address": "philippe@missiveapp.com", "name": "Philippe Lehoux"}

from_field SMS & WhatsApp

Objeto con "phone_number" clave, debe coincidir con un número de cuenta al que tenga acceso, con el formato "+" seguido solo de dígitos. Un "type" clave con valores de "signalwire", "twilio", "twilio_whatsapp" o "whatsapp" debe proporcionarse cuando el número de teléfono coincide con cuentas de distintos tipos.

{"phone_number": "+18005550199", "type": "whatsapp"}

from_field Canal personalizado

Objeto con "id", "username" y "name" llaves.

{"id": "12345", "username": "@missiveapp", "name": "Missive"}

to_fields Correo

Arreglo de objetos. Objeto con "address" y "name" llaves.

[{"address": "philippe@missiveapp.com", "name": "Philippe Lehoux"}]

to_fields SMS & WhatsApp

Arreglo de objetos. Objeto con "phone_number" clave; solo se permite un elemento y debe estar formateado como "+" seguido únicamente de dígitos.

[{"phone_number": "+18005550199"}]

to_fields Messenger & Instagram

Arreglo de objetos. Objeto con la "id" clave.

[{"id": "1736313053102918"}]

to_fields Canal personalizado

Arreglo de objetos. Objeto con "id", "username" y "name" llaves.

[{"id": "12345", "username": "@missiveapp", "name": "Missive"}]

to_fields Missive Live Chat

Arreglo de un objeto. Objeto con "id", "username" y "name" llaves.

[{ id: '123', username: 'phil@acme.com', name: 'Phil [Unverified]' }]

cc_fields

Arreglo de objetos con "address" y "name" llaves.

[{"address": "philippe@missiveapp.com", "name": "Philippe Lehoux"}]

bcc_fields

Arreglo de objetos con "address" y "name" llaves.

[{"address": "philippe@missiveapp.com", "name": "Philippe Lehoux"}]

cuenta Canal personalizado & Missive Live Chat, Messenger & Instagram

ID de la cuenta. Puede encontrar este ID en la configuración del canal personalizado, en la configuración de Missive Live Chat o en Configuración > API > ID de recursos.

"fbf74c47-d0a0-4d77-bf3c-2118025d8102"

attachments

Arreglo que contiene archivos; vea más abajo para más detalles

[{"base64_data": "iVBORw0KGgoAAAANS…", "filename": "logo.png"}]

references

Arreglo de cadenas para anexar a una conversación existente.

["<some-reference-123>"]

from_field

Objeto con los "phone_number", "address" o "name" claves, usadas para hacer coincidir los contactos en la barra lateral de Missive y completar la línea de autores en la vista previa de la conversación

{"phone_number": "+4187249887", "name": "Paul"}

conversation

Cadena del ID de la conversación para anexar a una conversación existente

"5bb24363-69e5-48ed-80a9-feee988bc953"

equipo

Cadena del ID del equipo

"646bb7f1-2066-40be-b8f6-bacb8b3b7419"

force_team

boolean

false

organización

Cadena del ID de la organización

"90beb742-27a3-44cf-95bc-7e5097167c9d"

agregar_usuarios

Array de cadenas de ID de usuario

["7343bccf-cf35-4b33-99b0-b1d3c69c5f5c"]

add_assignees

Array de cadenas de ID de usuario

["7343bccf-cf35-4b33-99b0-b1d3c69c5f5c"]

remove_assignees

Array de cadenas de ID de usuario

["7343bccf-cf35-4b33-99b0-b1d3c69c5f5c"]

conversation_subject

string

"New user!"

conversation_color

código de color HEX o “bueno” "advertencia" “peligro” string

"#000", “peligro”

agregar_etiquetas_compartidas

Array de cadenas de ID de etiquetas compartidas

["9825718b-3407-40b8-800d-a27361c86102"]

remove_shared_Etiquetas

Array de cadenas de ID de etiquetas compartidas

["e4aae78f-e932-40a2-9ece-ed764aa85790"]

agregar a la bandeja de entrada

boolean

false

agregar_a_bandeja_de_equipo

boolean

false

finalizar

boolean

false

send

boolean

false

send_at

Timestamp value in Unix time

1684540565

auto_followup

boolean, send_at is required when passing true

false

external_response_id WhatsApp

El ID de Twilio o Meta de la plantilla que está usando.

474808552386201

external_response_variables WhatsApp

Un objeto que contiene los valores de las variables de la plantilla que está usando.

{ "1": "Philippe", "2": "This awesome project" }

body

El cuerpo HTML o de texto de su mensaje. Las etiquetas de párrafo HTML normales en Missive no mostrarán el espaciado deseado.

Por ejemplo, para obtener el espaciado esperado entre párrafos, debería cambiar esto:

a:

El modo oscuro se maneja por usted. Cuando un lector que usa el tema oscuro abre un correo diseñado para un fondo claro, Missive genera una versión oscura de su bodycorreo: los fondos claros se oscurecen, el texto oscuro codificado de forma fija (por ejemplo, negro) se aclara para que siga siendo legible, y los colores de marca saturados se conservan tal como están. Los lectores pueden cambiar un mensaje individual de vuelta a sus colores originales. Aun así, puede dejar los colores del texto sin estilo para que hereden el tema del lector, pero codificar los colores de forma fija ya no rompe la legibilidad en el modo oscuro.

quote_previous_message

Cuando trueel borrador incluirá una versión citada del último mensaje de la conversación.

add_default_signature

Cuando true, la firma configurada para el alias de correo saliente se añade al body, igual que cuando redacta un borrador en Missive. Solo funciona para correos y solo cuando el from_field alias tiene una firma.

send

Establezca en true para enviar el borrador inmediatamente al crearlo.

Las reglas salientes se activan automáticamente. Cuando envíe un mensaje mediante la API con send: true, se ejecutarán todas las reglas de mensajes salientes que coincidan. Esto incluye las reglas con steps que envían seguimientos, lo que habilita secuencias de correo automatizadas. Consulte Secuencias de correo automatizadas a continuación.

send_at

Programe el borrador para enviarse más tarde. No se puede combinar con send: true.

auto_followup

Cuando auto_followup es true, el borrador programado para enviarse más tarde con send_at se descartará cuando haya una respuesta en la conversación.

from_field

from_field debe tener un address que coincida con uno de sus alias de correo en Missive, o un phone_number que coincida con una de sus cuentas de Twilio o SignalWire. Para canales personalizados, puede pasar cualquier id, username y name sin restricción.

attachments

El método attachments arreglo permite adjuntar hasta 25 archivos al borrador. El payload JSON total de su solicitud no debe superar 10 MB.

Nombre (* obligatorio)
Descripción
Ejemplo

base64_data*

El contenido del archivo codificado en base64

"iVBORw0KGgoAAAANS…"

filename*

Nombre de archivo del adjunto

"logo.png"

references

El método references arreglo permite anexar un borrador a una conversación existente. Dado que ya existe una conversación e incluye un correo con un Message-ID: <a@a.com> o References: <a@a.com> encabezado, puede agregar "references": ["<a@a.com>"] a su solicitud para que el borrador se anexe a esa conversación.

Si las referencias pasadas en la solicitud se relacionan con más de una conversación, el borrador se anexará a la primera conversación encontrada. Si no se proporciona ninguna referencia, el borrador se creará en una nueva conversación. Si se proporciona una o más referencias pero ninguna coincide con una conversación existente, el borrador se creará en una nueva conversación.

Los chevrones alrededor de las referencias son opcionales. Tanto ["<some-reference-123>"] y ["some-reference-123"] harían referencia a la misma conversación.

conversation

Si conoce el ID de una conversación existente de Missive en la que quiere crear su borrador, puede pasarlo como conversation en lugar de usar references.

subject

El método subject el campo se pasa literalmente al correo saliente. Cuando responda a una conversación de correo existente, establezca siempre subject a Re: [the original subject]Los clientes de correo como Gmail usan la coincidencia de la línea de asunto para agrupar los mensajes —un asunto vacío o que no coincida hará que la respuesta aparezca como una nueva conversación en el lado del destinatario, aunque esté correctamente agrupada dentro de Missive.

El método references y conversation los parámetros solo los usa Missive para localizar la conversación correcta. No controlan el References encabezado. Una vez identificada la conversación, Missive establece automáticamente el In-Reply-To y References encabezado de correo según el último correo de la conversación.

equipo

equipo permite vincular la conversación del borrador a un equipo. Cuando una conversación ya está vinculada a un equipo, este campo se ignora.

force_team

force_team permite forzar un nuevo equipo incluso si la conversación ya está en otro equipo.

organización

organización permite limitar la búsqueda de conversaciones a las ya asociadas con una organización. Si se crea una nueva conversación y organización se pasa, la nueva conversación se vinculará con esa organización.

agregar_usuarios

agregar_usuarios determina qué usuarios obtendrán acceso a la conversación. Al proporcionar agregar_usuarios, el organización campo es obligatorio.

add_assignees

add_assignees permite asignar usuarios a la conversación. Los responsables existentes permanecerán asignados. Al proporcionar add_assignees, el organización campo es obligatorio.

remove_assignees

remove_assignees permite quitar responsables de la conversación. Al proporcionar remove_assignees, el organización campo es obligatorio.

agregar_etiquetas_compartidas, eliminar_etiquetas_compartidas

agregar_etiquetas_compartidas y remove_shared_Etiquetas permiten administrar las etiquetas compartidas que se aplican a la conversación del borrador.

agregar_a_bandeja_de_equipo

agregar_a_bandeja_de_equipo permite mover la conversación del borrador a una bandeja de equipo. Al proporcionar agregar_a_bandeja_de_equipo, el equipo campo es obligatorio.

agregar a la bandeja de entrada

agregar a la bandeja de entrada permite mover la conversación del borrador a la bandeja de entrada para todos los que tengan acceso a la conversación.

finalizar

finalizar permite finalizar la conversación del borrador para todos los que tengan acceso a la conversación.

external_response_id, external_response_variables

external_response_id y external_response_variables se usan para las plantillas de WhatsApp. Son obligatorios si está iniciando una conversación de WhatsApp con un usuario con el que no ha interactuado previamente en las últimas 24 horas.

external_response_id es el ID de Twilio o Meta de la plantilla que está usando. Puede encontrarlo en Twilio Content Template Builder o en WhatsApp Manager. En WhatsApp Manager, el ID de Meta no se muestra en la lista de plantillas; solo aparece en la URL cuando abre una plantilla específica:

El valor después de template-details&childRoute=CAPI&id= (p. ej. 2222222222222222) es el ID de Meta que se debe usar como external_response_id.

external_response_variables es un objeto donde las claves son el marcador de posición de la plantilla y los valores son el contenido que desea usar para dicho marcador. Asegúrese de proporcionar claves de cadena para todas las variables. Solo se admiten variables del cuerpo de texto ({{1}}, {{2}}, etc.) son compatibles — las plantillas con encabezados de medios (documentos, imágenes u otros medios definidos como un componente de encabezado en Meta) no se pueden enviar a través de Missive.

Enviar un mensaje

Para enviar un nuevo mensaje o una respuesta, use Crear un borrador con el send: true parámetro.

Caso de uso: secuencias de correo automatizadas

Combine la API con reglas automáticas de seguimiento para crear campañas de goteo activadas por eventos externos (p. ej., envíos de formularios, actualizaciones del CRM).

Cómo funciona:

  1. Cree una regla de mensaje saliente que se active con una frase específica en el cuerpo de su correo

  2. Agregue steps a la regla. Cada paso espera, verifica No respondida por los destinatarios y envía un seguimiento con Enviar plantilla

  3. Use la API para enviar el correo inicial que contiene esa frase desencadenante

  4. Los pasos envían los correos de seguimiento (p. ej., 1, 3 y 7 días después)

  5. Si un destinatario responde, los siguientes seguimientos no se envían

Ejemplo: un formulario del sitio web activa una secuencia de correo

La frase "Here is the quote you requested" activa su regla de seguimiento, que inicia la secuencia de correos de seguimiento.

Eliminar un borrador

DELETE /v1/drafts/:id

Elimina un borrador de una conversación. El :id parámetro es el ID del borrador (devuelto en la respuesta de crear borrador).


Mensajes

Crear un mensaje

POST /v1/messages

Cree un mensaje entrante en un canal personalizado. Los canales personalizados permiten a los usuarios integrar proveedores de mensajes que no están integrados en Missive.

Atributos

Nombre (* obligatorio)
Descripción
Ejemplo

cuenta*

ID de la cuenta. Puede encontrar este ID en la configuración del canal personalizado.

"fbf74c47-d0a0-4d77-bf3c-2118025d8102"

subject

Solo canal de correo: cadena

"Hello"

body

Cadena HTML o de texto según el tipo de mensaje del canal.

"<b>World!</b>"

from_field*

Canal de correo: objeto con "address" y "name" claves. Canal de texto o HTML: objeto con "id", "username" y "name" llaves.

{ "address": "philippe@missiveapp.com", "name": "Philippe Lehoux" } o { "id": "12345", "username": "@missiveapp", "name": "Missive" }

to_fields

Canal de correo: arreglo de objetos con "address" y "name" claves. Canal de texto o HTML: arreglo de objetos con "id", "username" y "name" llaves.

[{ "address": "philippe@missiveapp.com", "name": "Philippe Lehoux" }] o [{ "id": "12345", "username": "@missiveapp", "name": "Missive" }]

cc_fields

Solo canal de correo: arreglo de objetos con "address" y "name" llaves.

[{ "address": "philippe@missiveapp.com", "name": "Philippe Lehoux" }]

bcc_fields

Solo canal de correo: arreglo de objetos con "address" y "name" llaves.

[{ "address": "philippe@missiveapp.com", "name": "Philippe Lehoux" }]

delivered_at

Marca de tiempo de entrega del mensaje. Si se omite, el mensaje se marca como entregado en el momento de la solicitud.

1563806347

attachments

Arreglo que contiene archivos; vea más abajo para más detalles.

[{ "base64_data": "iVBORw0KGgoAAAANS...", "filename": "logo.png" }]

external_id

ID único usado para identificar mensajes que no son de correo (SMS, mensajes directos de Instagram, etc.).

"some-id-123"

references

Arreglo de cadenas para anexar a una conversación existente.

["some-reference-123"]

conversation

Cadena del ID de la conversación para anexar a una conversación existente

"5bb24363-69e5-48ed-80a9-feee988bc953"

equipo

Cadena del ID del equipo

Predeterminado según la configuración de uso compartido del canal: Bandeja de entrada o Bandeja de equipo

force_team

boolean

false

organización

Cadena del ID de la organización

"90beb742-27a3-44cf-95bc-7e5097167c9d"

agregar_usuarios

Array de cadenas de ID de usuario

["7343bccf-cf35-4b33-99b0-b1d3c69c5f5c"]

add_assignees

Array de cadenas de ID de usuario

["7343bccf-cf35-4b33-99b0-b1d3c69c5f5c"]

remove_assignees

Array de cadenas de ID de usuario

["7343bccf-cf35-4b33-99b0-b1d3c69c5f5c"]

conversation_subject

string

"New user!"

conversation_color

código de color HEX o “bueno” "advertencia" “peligro” string

"#000", “peligro”

agregar_etiquetas_compartidas

Array de cadenas de ID de etiquetas compartidas

["9825718b-3407-40b8-800d-a27361c86102"]

remove_shared_Etiquetas

Array de cadenas de ID de etiquetas compartidas

["e4aae78f-e932-40a2-9ece-ed764aa85790"]

agregar a la bandeja de entrada

boolean

Predeterminado según la configuración de uso compartido del canal: Bandeja de entrada o Bandeja de equipo

agregar_a_bandeja_de_equipo

boolean

Predeterminado según la configuración de uso compartido del canal: Bandeja de entrada o Bandeja de equipo

finalizar

boolean

false

attachments

El método attachments arreglo permite adjuntar archivos a los mensajes. El payload JSON total de su solicitud no debe superar 10 MB.

Nombre (* obligatorio)
Descripción
Ejemplo

base64_data*

El contenido del archivo codificado en base64

"iVBORw0KGgoAAAANS..."

filename*

Nombre de archivo del adjunto

"logo.png"

references

El método references arreglo permite anexar un mensaje a una conversación existente. Dado que ya existe una conversación e incluye un mensaje con external_id: "some-id-123" o references: ["some-id-123"], puede agregar "references": ["some-id-123"] a su solicitud para que el mensaje se añada a esa conversación.

Si las referencias incluidas en la solicitud se corresponden con más de una conversación, el mensaje se añadirá a la primera conversación encontrada. Si no se proporciona ninguna referencia, el mensaje se creará en una nueva conversación. Si se proporciona una o más referencias, pero ninguna coincide con una conversación existente, el mensaje se creará en una nueva conversación.

conversation

Si conoce el ID de una conversación existente de Missive en la que desea crear su mensaje, puede pasarlo como conversation en lugar de usar references.

equipo

equipo le permite vincular la conversación del mensaje a un equipo. Cuando una conversación ya está vinculada a un equipo, este campo se ignora.

force_team

force_team permite forzar un nuevo equipo incluso si la conversación ya está en otro equipo.

organización

organización permite limitar la búsqueda de conversaciones a las ya asociadas con una organización. Si se crea una nueva conversación y organización se pasa, el mensaje se vinculará a esa organización.

agregar_usuarios

agregar_usuarios determina qué usuarios obtendrán acceso a la conversación. Al proporcionar agregar_usuarios, el organización campo es obligatorio.

add_assignees

add_assignees permite asignar usuarios a la conversación. Los responsables existentes permanecerán asignados. Al proporcionar add_assignees, el organización campo es obligatorio.

remove_assignees

remove_assignees permite quitar responsables de la conversación. Al proporcionar remove_assignees, el organización campo es obligatorio.

agregar_etiquetas_compartidas, eliminar_etiquetas_compartidas

agregar_etiquetas_compartidas y remove_shared_Etiquetas le permiten administrar Etiquetas compartidas que se aplican a la conversación del mensaje.

agregar_a_bandeja_de_equipo

agregar_a_bandeja_de_equipo le permite mover la conversación del mensaje a una Bandeja de equipo. Cuando proporcione agregar_a_bandeja_de_equipo, el equipo campo es obligatorio.

agregar a la bandeja de entrada

agregar a la bandeja de entrada le permite mover la conversación del mensaje a Bandeja de entrada para todos los que tengan acceso a la conversación.

finalizar

finalizar le permite finalizar la conversación del mensaje para todos los que tengan acceso a la conversación.

Obtener un mensaje

GET /v1/messages/:id

Obtenga los encabezados, el cuerpo y los archivos adjuntos de un mensaje específico usando el mensaje id.

Para recuperar varios mensajes en una sola llamada, pase IDs de mensaje separados por comas:

GET /v1/messages/:id,:id2,:id3

Al obtener varios mensajes con IDs separados por comas, la respuesta devuelve un arreglo de objetos de mensaje bajo la messages clave, en el mismo formato que se muestra arriba.

Imágenes en línea

Marcado de imágenes en línea en el mensaje body El HTML no contiene ningún src atributo; en su lugar, contienen un data-missive-attachment-id atributo con el archivo adjunto id. El archivo adjunto y su URL están disponibles en la respuesta GET bajo la attachments clave.

Listar mensajes

GET /v1/messages?email_message_id=Message-ID

Obtener mensajes que coincidan con un correo Message-ID.

Los datos del mensaje incluyen encabezados, cuerpo y archivos adjuntos en el mismo formato que Obtener un mensaje.

La mayoría de las veces, solo un mensaje coincide con un Message-ID dado, como lo requieren los estándares de correo electrónico. Sin embargo, los servidores emisores que no cumplan con el estándar pueden enviarle varios mensajes con el mismo Message-ID; en ese caso, este endpoint devolverá los 10 más recientes.

Parámetros

Nombre (* obligatorio)
Predeterminado
Descripción

email_message_id*

``

El método Message-ID que se encuentra en el encabezado de un correo.


Organizaciones

Listar Organizaciones

GET /v1/organizations

Enumera las Organizaciones de las que forma parte el usuario autenticado.

Parámetros

Nombre (* obligatorio)
Predeterminado
Descripción

limit

50

Número de organizaciones devueltas. Valor máximo: 200

offset

0

Desplazamiento usado para paginar.

Propiedades de la organización

Nombre (* siempre presente)
Descripción

id*

UUID de la organización

name*

Nombre de la organización


Plantillas

Lista de plantillas

GET /v1/Plantillas

Listar las Plantillas para el usuario autenticado.

Parámetros

Nombre (* obligatorio)
Predeterminado
Descripción

organización

nulo

ID de la organización

limit

50

Número de plantillas devueltas. Valor máximo: 200

offset

0

Desplazamiento usado para paginar.

Imágenes en línea

Marcado de imágenes en línea en la plantilla body El HTML no contiene ningún src atributo; en su lugar, contienen un data-missive-attachment-id atributo con el archivo adjunto id. El archivo adjunto y su URL están disponibles en la respuesta GET bajo la attachments clave.

Propiedades de la plantilla

Nombre (* siempre presente)
Descripción

id*

UUID de la plantilla

title*

Título de la plantilla

body*

Cuerpo HTML de la plantilla

subject

Línea de asunto

modified_at*

Marca de tiempo Unix de la última modificación de la plantilla

organización

UUID de la organización

usuario

UUID de usuario para plantillas personales

share_with_team

UUID del equipo cuando se aplica a un equipo

etiquetas_compartidas*

Arreglo de UUID de etiquetas compartidas

to_fields*

Arreglo de objetos de destinatario (address, name)

cc_fields*

Array de objetos de destinatarios en CC

bcc_fields*

Array de objetos de destinatarios en CCO

attachments*

Array de objetos de adjunto (consulte Propiedades del adjunto)

external_id

Identificador externo

external_source

Identificador de la fuente externa

Obtener una plantilla

GET /v1/Plantillas/:id

Obtener una plantilla específica usando la plantilla id.

Crear plantilla(s)

POST /v1/Plantillas

Una solicitud exitosa devolverá las Plantillas recién creadas.

Atributos

Nombre (* obligatorio)
Descripción
Ejemplo

title

Título de la plantilla (máximo 500 caracteres)

“Plantilla de correo de bienvenida”

organización

Cadena del ID de la organización. O bien organización o usuario es obligatorio (pero no ambos).

"0d9bab85-a74f-4ece-9142-0f9b9f36ff92"

usuario

Cadena del ID de usuario para Plantillas personales. O bien organización o usuario es obligatorio (pero no ambos).

"a41a00fd-453d-49d7-a487-9765c35a3b70"

body

Cadena HTML que contiene el contenido de la plantilla

"<p>Hello!</p>"

subject

Cadena de asunto (máximo 500 caracteres)

"Welcome!"

share_with_team

Cadena del ID del equipo para compartir la plantilla con un equipo específico. organización es obligatorio

"646bb7f1-2066-40be-b8f6-bacb8b3b7419"

etiquetas_compartidas

Arreglo de cadenas de ID de etiquetas compartidas. organización es obligatorio

["9825718b-3407-40b8-800d-a27361c86102"]

to_fields

Arreglo de objetos con "address" y "name" claves

[{"address": "support@example.com", "name": "Support"}]

cc_fields

Arreglo de objetos con "address" y "name" claves

[{"address": "manager@example.com", "name": "Manager"}]

bcc_fields

Arreglo de objetos con "address" y "name" claves

[{"address": "archive@example.com"}]

external_id

Cadena de identificador externo para sincronizar con otros sistemas. Cuando se proporciona, external_source es obligatorio.

"template-001"

external_source

Cadena de identificador del sistema de origen. Se requiere cuando external_id se proporciona. La combinación debe ser única por organización o usuario.

"knowledge-base"

attachments

Arreglo que contiene archivos; vea más abajo para más detalles

[{"base64_data": "iVBORw0KGgoAAAANS...", "filename": "logo.png"}]

attachments

El método attachments El array le permite adjuntar archivos a la respuesta. El payload JSON total de su solicitud no debe superar los 10 MB.

Nombre (* obligatorio)
Descripción
Ejemplo

base64_data*

El contenido del archivo codificado en base64

"iVBORw0KGgoAAAANS..."

filename*

Nombre de archivo del adjunto

"logo.png"

id

ID temporal para las referencias de imágenes en línea (consulte la sección de imágenes en línea más abajo)

"img1"

Imágenes en línea

Para incrustar imágenes en línea dentro del cuerpo de la respuesta, use un identificador temporal id en el adjunto y haga referencia a él en el HTML usando el data-missive-attachment-id atributo:

El servidor reemplazará el temporal id con el UUID real del archivo adjunto. Los adjuntos con un id lo que se hace referencia en el HTML del cuerpo se tratará como imágenes en línea; los adjuntos sin una referencia en el cuerpo se tratarán como adjuntos normales.

Actualizar Plantillas

PATCH /v1/Plantillas/:id1,:id2,:id3,...

Una solicitud exitosa devolverá las Plantillas actualizadas.

Atributos

Plantilla id es obligatorio. Consulte la sección Crear plantillas para ver otros atributos. Al actualizar una plantilla, puede pasar solo los atributos que desea actualizar. En el ejemplo anterior, solo se actualizarán el title y el body.

Las Plantillas creadas por Integraciones externas (como las plantillas de WhatsApp) no pueden actualizarse a través de este endpoint.

Eliminar plantillas

DELETE /v1/responses/:id1,:id2,:id3,...

Elimina una o más Plantillas.

Para las plantillas de la organización en organizaciones con la gestión restringida de plantillas activada (función del plan Enterprise), solo los administradores y propietarios de la organización tienen permiso para eliminar las plantillas.

Las plantillas creadas por integraciones externas (como las plantillas de WhatsApp) no se pueden eliminar mediante este endpoint.


Publicaciones

El endpoint de posts te permite inyectar datos en cualquier conversación de Missive y gestionar el Estado de la conversación. Puedes crear posts en Conversaciones nuevas o anexarlos a las existentes.

Las publicaciones son la forma recomendada para Gestionar conversaciones (finalizar, mover a la Bandeja de entrada, asignar Usuarios, agregar Etiquetas) desde Integraciones y automatizaciones. Cada publicación deja un rastro visible en la conversación que muestra qué desencadenó la acción.

Ejemplo de uso: Cada vez que alguien envía código a GitHub, cree una publicación que enumere los commits. Cuando un ticket de soporte se resuelve en su sistema, cree una publicación que finalice la conversación.

Gestionar conversaciones con publicaciones

Use publicaciones para realizar Acciones de conversación y dejar un rastro que muestre qué integración provocó el cambio. Estas son acciones comunes:

Para hacerlo
Use estos parámetros

Finalizar una conversación

close: true

Reabrir una conversación

reopen: true

Mover a la Bandeja de entrada (desarchivar)

add_to_inbox: true

Mover a una bandeja de equipo

add_to_team_inbox: true y equipo: "team-id"

Asignar usuarios

add_assignees: ["user-id"]

Eliminar responsables

remove_assignees: ["user-id"]

Añadir etiquetas

add_shared_labels: ["label-id"]

Quitar etiquetas

remove_shared_Etiquetas: ["label-id"]

Definir el color de la conversación

conversation_color: "#ff0000"

Cambiar equipo

equipo: "team-id" y force_team: true

Ejemplo: Finalizar una conversación con una publicación personalizada

Esto crea una publicación en la conversación y la finaliza. Los miembros del equipo verán la publicación que explica por qué la conversación se finalizó.

Crear una publicación

POST /v1/posts

La respuesta incluye:

  • conversation: ID de la conversación a la que se agregó la publicación

  • id: ID de la publicación (use este ID para eliminar la publicación)

Atributos

Nombre (* obligatorio)
Descripción
Ejemplo

username

Nombre del autor de la publicación, usado en lugar del nombre del propietario del API token

"Missive"

username_icon

Imagen del autor de la publicación, usada en lugar del avatar del propietario del API token

"https://s3.amazonaws.com/missive-assets/missive-avatar.png"

conversation_icon

Imagen usada como el icono en la Lista de conversaciones

"https://s3.amazonaws.com/missive-assets/missive-avatar.png"

conversation_subject

string

"New user!"

conversation_color

código de color HEX o “bueno” "advertencia" “peligro” string

"#000", “peligro”

text

Mensaje principal de una publicación

"¡Esta es una publicación!"

Markdown

Mensaje principal de una publicación, con formato Markdown

"¡Esta es una **publicación**!"

notification*

Objeto con las claves "title" y "body", usado para mostrar una notificación

{"title":"Un título", "body": "Un cuerpo"}

attachments

Array que contiene objetos adjuntos, vea abajo para más detalles

[{"text": "¡Este es un adjunto!"}]

references

Arreglo de cadenas para anexar a una conversación existente.

["<some-reference-123>"]

conversation

Cadena del ID de la conversación para anexar a una conversación existente

"5bb24363-69e5-48ed-80a9-feee988bc953"

organización

Cadena del ID de la organización

"90beb742-27a3-44cf-95bc-7e5097167c9d"

equipo

Cadena del ID del equipo

"646bb7f1-2066-40be-b8f6-bacb8b3b7419"

force_team

boolean

false

agregar_usuarios

Array de cadenas de ID de usuario

["7343bccf-cf35-4b33-99b0-b1d3c69c5f5c"]

add_assignees

Array de cadenas de ID de usuario

["7343bccf-cf35-4b33-99b0-b1d3c69c5f5c"]

remove_assignees

Array de cadenas de ID de usuario

["7343bccf-cf35-4b33-99b0-b1d3c69c5f5c"]

agregar_etiquetas_compartidas

Array de cadenas de ID de etiquetas compartidas

["9825718b-3407-40b8-800d-a27361c86102"]

remove_shared_Etiquetas

Array de cadenas de ID de etiquetas compartidas

["e4aae78f-e932-40a2-9ece-ed764aa85790"]

agregar a la bandeja de entrada

boolean

false

agregar_a_bandeja_de_equipo

boolean

false

finalizar

boolean

false

Reabrir

boolean

true

Validaciones

  • Cualquiera de las dos text, Markdown o attachments es obligatorio.

  • El método text y Markdown los campos tienen una longitud máxima de 8000 caracteres.

  • El payload JSON total de su solicitud no debe superar 10 MB.

references

El método references array le permite agregar una publicación a una conversación existente. Dado que ya existe una conversación e incluye un correo con un Message-ID: <a@a.com> o References: <a@a.com> encabezado, puede agregar "references": ["<a@a.com>"] a su solicitud para que la publicación se agregue a esa conversación.

Si las referencias pasadas en la solicitud se relacionan con más de una conversación, la publicación solo se insertará en la primera conversación encontrada. Si no se proporciona ninguna referencia, la publicación se insertará en una conversación nueva. Si se proporciona una o más referencias pero ninguna coincide con una conversación existente, la publicación se insertará en una conversación nueva.

Los chevrones alrededor de las referencias son opcionales. Tanto ["<some-reference-123>"] y ["some-reference-123"] harían referencia a la misma conversación.

conversation

Si conoce el ID de una conversación existente de Missive en la que quiere crear su publicación, puede pasarlo como conversation en lugar de usar references.

organización

organización le permite limitar la búsqueda de conversaciones a las que ya están asociadas con una organización. Si se crea una conversación nueva y organización se pasa, la conversación se vinculará a esa organización.

equipo

equipo le permite vincular la conversación de la publicación a un equipo. Cuando una conversación ya está vinculada a un equipo, este campo se ignora.

force_team

force_team permite forzar un nuevo equipo incluso si la conversación ya está en otro equipo.

agregar_usuarios

agregar_usuarios determina qué usuarios obtendrán acceso a la conversación. Al proporcionar agregar_usuarios, el organización campo es obligatorio.

add_assignees

add_assignees permite asignar usuarios a la conversación. Los responsables existentes permanecerán asignados. Al proporcionar add_assignees, el organización campo es obligatorio.

remove_assignees

remove_assignees permite quitar responsables de la conversación. Al proporcionar remove_assignees, el organización campo es obligatorio.

agregar_etiquetas_compartidas, eliminar_etiquetas_compartidas

agregar_etiquetas_compartidas y remove_shared_Etiquetas le permiten administrar Etiquetas compartidas aplicadas a la conversación de la publicación.

agregar_a_bandeja_de_equipo

agregar_a_bandeja_de_equipo mueve la conversación a la Bandeja de equipo para todos los que tienen acceso. Al proporcionar agregar_a_bandeja_de_equipo, el equipo el campo es obligatorio. Se mostrará un rastro de esta acción en la conversación.

agregar a la bandeja de entrada

agregar a la bandeja de entrada mueve la conversación a la Bandeja de entrada para todos los que tienen acceso (desarchiva la conversación). Se mostrará un rastro de esta acción en la conversación.

finalizar

finalizar finaliza la conversación para todos los que tienen acceso. Se mostrará un rastro de esta acción en la conversación.

Reabrir

Reabrir evita que las conversaciones finalizadas se vuelvan a abrir al crear una publicación. Establézcalo en true para mantener la conversación finalizada incluso después de agregar la nueva publicación.

attachments

El método attachments array admite dos tipos de adjuntos:

1. Bloques de adjunto formateados con los siguientes campos:

Nombre
Descripción
Ejemplo

color

código de color HEX o “bueno” "advertencia" “peligro” string

"#ccc", “peligro”

pretext

Cadena de texto

"¡Este es un pretexto!"

author_name

Nombre del autor del archivo adjunto

“Usuario - Phil”

author_link

URL que enlaza con el autor

"https://admin.myapp.com/users/phil"

icono_del_autor

URL de la imagen del autor del archivo adjunto

"https://myapp.com/phil.png"

title

Título del adjunto

“¡Este es un título!”

title_link

URL que enlaza al recurso del adjunto

"https://myapp.com/a-resource"

image_url

URL de imagen del adjunto

"https://myapp.com/a-resource.png"

text

Cadena de texto

"¡Esto es texto!"

Markdown

Cadena de texto, formateada con Markdown

"¡Esto es un **texto en negrita**!"

timestamp

Valor entero en tiempo Unix

1512395766

pie de página

Cadena de texto

"¡Este es un pie de página!"

icono del pie de página

URL de la imagen del pie de página del adjunto

"https://myapp.com/logo.png"

fields

Array que contiene objetos de campo; consulte más abajo para más detalles

[{"title": "Paying customer","value": "yes"}]

2. Adjuntos de archivos binarios usando el mismo formato que los borradores y los mensajes:

Nombre (* obligatorio)
Descripción
Ejemplo

base64_data*

El contenido del archivo codificado en base64

"iVBORw0KGgoAAAANS..."

filename*

Nombre de archivo del adjunto

"logo.png"

Formatos admitidos para renderizado en línea: JPEG, PNG, GIF (imágenes), MOV, MP4 (video), MP3 (audio). Otros tipos de archivo aparecerán como adjuntos descargables.

attachments.fields

Nombre (* obligatorio)
Descripción
Ejemplo

title

Cadena de texto

"¿Cliente de pago?"

valor

Cadena de texto

"sí"

short

Boolean. Si es true, habrá dos campos por fila; de lo contrario, uno por fila.

true

Eliminar una publicación

DELETE /v1/posts/:id

Elimina una publicación de una conversación. El :id parámetro es el ID de la publicación (devuelto en la respuesta de creación de publicación).

Para las Conversaciones compartidas, el API token debe ser generado por un administrador en la organización que posee la conversación. Solo el propietario de la organización y los administradores tienen permiso para eliminar publicaciones en conversaciones compartidas con su organización.


Etiquetas compartidas

Crear Etiquetas compartidas(s)

POST /v1/shared_labels

Una solicitud exitosa devolverá las Etiquetas compartidas recién creadas.

Atributos

Nombre (* obligatorio)
Descripción
Ejemplo

name*

cadena de Nombre de la etiqueta

“Heroku”

organización*

Cadena del ID de la organización

"0d9bab85-a74f-4ece-9142-0f9b9f36ff92"

color

Código de color HEX

"#430098"

padre

Cadena del ID de la etiqueta compartida principal

"9b45a00fd-353s-89l2-a487-2465c35c3r91"

share_with_organization

Booleano

true

share_with_team

Cadena del ID del equipo

nil

compartir_con_usuarios

Array de cadenas de ID de usuario

[]

visibility

Cualquiera de las dos 'organization' o 'delegates' string

'organization'

share_with_organization, share_with_team, compartir_con_usuarios Los Usuarios afectados por cualquiera de esos parámetros tendrán acceso a todas las conversaciones de la etiqueta.

visibility

El parámetro visibility controla a quién es visible la etiqueta. Si el valor es organización, Todos los miembros de la organización pueden usar la etiqueta. Si el valor es delegados, solo Administradores y usuarios con uso compartido automático (Usuarios afectados por compartir_con_usuarios, share_with_organization, share_with_team) puede usar la etiqueta.

Actualizar etiquetas compartidas

PATCH /v1/shared_labels/:id1,:id2,:id3,...

Una solicitud exitosa devolverá las Etiquetas compartidas actualizadas.

Atributos

Etiqueta compartida id es obligatorio. Consulte la sección Crear etiqueta(s) compartida(s) para otros atributos. Puede pasar solo los atributos que desea actualizar. En el ejemplo anterior, se actualizarán el nombre y el color.

Los usuarios básicos pueden actualizar:

  • name: El nombre de la etiqueta

  • color: El color de la etiqueta como código de color hexadecimal (p. ej. #f96885)

  • padre: El ID de la etiqueta principal

Los usuarios administradores/propietarios también pueden actualizar:

  • visibility: Debe ser 'delegates' o 'organization'

  • share_with_organization: Si se comparte la etiqueta con toda la organización

  • share_with_team: El ID del equipo con el que compartir la etiqueta

  • compartir_con_usuarios: Un arreglo de IDs de usuarios con los que compartir la etiqueta

Lista de Etiquetas compartidas

GET /v1/shared_labels

Lista las Etiquetas compartidas en Organizaciones de las que el usuario autenticado forma parte y a las que tiene acceso.

Parámetros

Nombre (* obligatorio)
Predeterminado
Descripción

organización

nulo

ID de la organización

limit

50

Número de Etiquetas compartidas devueltas. Valor máximo: 200

offset

0

Desplazamiento usado para paginar.

Propiedades de la etiqueta compartida

Nombre (* siempre presente)
Descripción

id*

UUID de la etiqueta compartida

name*

Nombre de la etiqueta

name_with_parent_names*

Ruta completa de la etiqueta, incluidos los nombres de las etiquetas superiores, unidos por /

organización*

UUID de la organización

color

Código de color HEX

padre

UUID de la etiqueta principal

share_with_organization*

Si la etiqueta está compartida con Todos los miembros de la organización

share_with_team

UUID del equipo si se comparte con un equipo específico

compartir_con_usuarios*

Arreglo de UUID de usuarios con los que la etiqueta se comparte explícitamente

visibility*

organización o delegados


Equipos

Listar equipos

GET /v1/teams

Listar Equipos en Organizaciones de las que el usuario autenticado forma parte y a las que tiene acceso.

Parámetros

Nombre (* obligatorio)
Predeterminado
Descripción

organización

nulo

ID de la organización

limit

50

Número de Equipos devueltos. Valor máximo: 200

offset

0

Desplazamiento usado para paginar.

Crear equipo(s)

POST /v1/teams

Crear un nuevo equipo en una organización. El API token debe pertenecer a un administrador o propietario de la organización.

Atributos

Nombre (* obligatorio)
Descripción
Ejemplo

name*

cadena de Nombre del equipo

"Soporte"

organización*

Cadena del ID de la organización

"0d9bab85-a74f-4ece-9142-0f9b9f36ff92"

emoji

Código corto de emoji en :name: formato (vea Emojipedia para los códigos cortos)

":dart:"

color

"#2266ED"

active_members

Array de cadenas de ID de usuario para los miembros activos del equipo

["1ce8117e-ae42-4304-b953-c81656da4bd1"]

observadores

Array de cadenas de ID de usuario para los Observadores del equipo

["a41a00fd-453d-49d7-a487-9765c35a3b70"]

business_hours

Objeto de configuración de Horario laboral, vea abajo para más detalles

{"tz": "America/Montreal", "t": [...]}

inactivity_period

Período de inactividad en segundos antes de que una conversación se considere antigua

604800

team_mention_behavior

Quién recibe Notificaciones cuando se menciona el equipo

"only_active_members"

user_reply_behavior

Qué sucede cuando un usuario responde a una conversación sin asignar

"assign_user"

received_reply_behavior

Dónde mostrar las conversaciones asignadas cuando se recibe una nueva respuesta

"show_in_assignee_inbox"

comportamiento de la barra lateral del equipo

Qué mostrar en la barra lateral de este equipo

"show_team_space"

bandeja_de_equipo_habilitada

Si la Bandeja de equipo está activada

true

sala de chat habilitada

Si la sala de chat del equipo está habilitada

true

Miembros activos, seguidores

Los Miembros activos reciben notificaciones de los Nuevos mensajes en la Bandeja de equipo y también ven las conversaciones en la vista unificada de Bandejas de equipo. Los seguidores no reciben notificaciones de los Nuevos mensajes en la Bandeja de equipo y no ven las conversaciones en la vista unificada de Bandejas de equipo, pero pueden abrir y gestionar la Bandeja de equipo según sea necesario. Ambos tienen acceso a los Contactos, Plantillas, Calendarios e Integraciones compartidos con el equipo.

business_hours

El método business_hours El objeto define cuándo está disponible el equipo:

  • tz: Identificador de zona horaria (véase lista de zonas horarias)

  • t: Array de objetos de intervalo de tiempo, cada uno con:

    • d: Día de la semana (0 = domingo, 1 = lunes, ..., 6 = sábado)

    • s: Arreglo de dos enteros que representa las horas de inicio y fin en segundos desde la medianoche (p. ej., [32400, 61200] = de 9:00 a. m. a 5:00 p. m.)

inactivity_period

La cantidad de segundos de inactividad después de los cuales una conversación se considera obsoleta. Valores comunes: 86400 (1 día), 259200 (3 días), 604800 (1 semana).

team_mention_behavior

  • all_members: Todos los miembros del equipo (activos y quienes siguen) reciben Notificaciones cuando se menciona al equipo

  • solo_miembros_activos: Solo los Miembros activos reciben Notificaciones cuando se menciona al equipo

user_reply_behavior

  • assign_user: Asignar automáticamente al usuario a la conversación cuando responda

  • dejar en la bandeja de equipo: Deje la conversación en la Bandeja de equipo sin asignarla

received_reply_behavior

  • show_in_assignee_inbox: Mostrar en la bandeja de entrada del responsable cuando se recibe una nueva respuesta

  • show_in_team_inbox: Devolver a la Bandeja de equipo cuando se reciba una nueva respuesta

comportamiento de la barra lateral del equipo

  • show_team_space: Mostrar el Espacio de equipo completo en la barra lateral

  • mostrar_bandeja_de_equipo: Mostrar solo la Bandeja de equipo en la barra lateral

Actualizar equipo(s)

PATCH /v1/teams/:id1,:id2,:id3,...

Actualice uno o más equipos. El API token debe pertenecer a un administrador o propietario de la organización.

Una solicitud correcta devolverá los equipos actualizados.

Atributos

Equipo id Es obligatorio. Consulte la sección Crear equipo(s) para ver otros atributos. Puede pasar solo los atributos que desee actualizar. En el ejemplo anterior, solo se actualizarán el nombre, el emoji y Miembros activos.

Propiedades del equipo

La misma estructura es devuelta por Listar equipos, Crear equipo(s), y Actualizar equipo(s).

Nombre (* siempre presente)
Descripción

id*

UUID del equipo

name*

Nombre del equipo

organización*

UUID de la organización

active_members*

Arreglo de UUID de usuario de los miembros activos del equipo

observadores*

Arreglo de UUID de usuario de los observadores del equipo

emoji

Código corto del emoji (p. ej. :dart:)

color

Código de color HEX

business_hours

Objeto de configuración de Horario laboral

inactivity_period

Período de inactividad en segundos antes de que una conversación se considere antigua

bandeja_de_equipo_habilitada*

Si la Bandeja de equipo está activada

sala de chat habilitada*

Si la sala de chat del equipo está habilitada

team_mention_behavior*

solo_miembros_activos o all_members

user_reply_behavior*

assign_user o dejar en la bandeja de equipo

received_reply_behavior*

show_in_assignee_inbox o show_in_team_inbox

comportamiento de la barra lateral del equipo*

show_team_space o mostrar_bandeja_de_equipo


Usuarios

Los endpoints de usuario le permiten listar Usuarios en su organización.

El estado del usuario (disponibilidad, ausente, Fuera de la oficina) no está disponible mediante la API. Actualmente no hay endpoints para recuperar o actualizar el estado del usuario.

Listar Usuarios

GET /v1/users

Enumerar usuarios en organizaciones de las que forma parte el usuario autenticado.

Parámetros

Nombre (* obligatorio)
Predeterminado
Descripción

organización

nulo

ID de la organización

limit

50

Número de Usuarios devueltos. Valor máximo: 200

offset

0

Desplazamiento usado para paginar.

Propiedades del usuario

Nombre (* siempre presente)
Descripción

id*

UUID del usuario

name*

Nombre visible del usuario

email*

Correo del usuario

avatar_url*

URL del avatar del usuario

me

true cuando el usuario es el propietario del API token; se omite en caso contrario


Tareas

Los endpoints de tareas le permiten crear y gestionar tareas programáticamente.

Ejemplo de uso: cree automáticamente Tareas desde su herramienta de Gestión de proyectos o rastreador de errores.

Listar tareas

GET /v1/tasks

Enumere las Tareas a las que tiene acceso el usuario autenticado. Los resultados se ordenan por la hora de la última actividad (la más reciente primero) y se pueden filtrar por varios criterios.

Ejemplo de solicitud:

Parámetros de consulta

Nombre
Descripción
Ejemplo

limit

Número de tareas a devolver (mín. 2, máx. 50)

10

hasta

Marca de tiempo Unix para paginación, devuelve tareas con last_activity_at anterior a este valor

1692371867

organización

Filtrar por ID de la organización

"0d9bab85-a74f-4ece-9142-0f9b9f36ff92"

equipo

Filtrar por ID de equipo

"0e24f298-965d-4475-9220-b32636a1e2c3"

responsable

Filtrar por ID de usuario responsable

"1ce8117e-ae42-4304-b953-c81656da4bd1"

estado

Filtrar por estado. Uno de: todo, in_progress, finalizada

"todo"

type

Filtrar por tipo. Uno de: task, conversation, todo

"all"

conversation

Filtrar por el ID de la conversación principal (devuelve las subtareas de esa conversación)

"a5d2aa1c-3828-4f90-bbd8-3dffaadda97e"

due_at_gteq

Filtrar tareas con due_at mayor o igual que esta marca de tiempo Unix

1692371867

due_at_lteq

Filtrar tareas con due_at menor o igual que esta marca de tiempo Unix

1692400000

type

Filtrar tareas por su tipo:

  • task - Devolver solo tareas (subtareas de conversación o tareas independientes)

  • conversation - Devuelva solo conversaciones con tarea (asignadas o con fecha de vencimiento)

  • todo - Devuelva tanto tareas como conversaciones con tarea (predeterminado)

Paginación

Para paginar los resultados, use el last_activity_at valor de la última tarea en la respuesta como el hasta parámetro para la siguiente solicitud. Reste 1 a la marca de tiempo para evitar duplicados, ya que hasta es inclusiva.

Propiedades de la tarea

La misma estructura es devuelta por Listar tareas, Obtener una tarea, Crear una tarea, y Actualizar una tarea, y también está incrustado como el task campo en un comentario.

Nombre (* siempre presente)
Descripción

id*

UUID de la tarea

title*

Título de la tarea

estado*

todo, in_progress, o finalizada

type*

task o conversation

conversation

UUID de la conversación principal para las subtareas

description

Descripción de la tarea

due_at

Marca de tiempo Unix de cuándo vence la tarea

started_at

Marca de tiempo Unix de cuándo comenzó el trabajo

closed_at

Marca de tiempo Unix del momento en que se completó la tarea

assignees*

Array de responsables. UUIDs en List/Create/Update; objetos de usuario completos en Get a task y en comments

equipo

Equipo. UUID en List/Create/Update; objeto completo de equipo en Get a task y en comentarios

last_activity_at

Marca de tiempo Unix de la última actividad. Solo se incluye en Listar tareas

Obtener una tarea

GET /v1/tasks/:id

Obtenga una tarea por ID. Devuelve la tarea con todos los detalles, incluidos los responsables y la información del equipo.

El método assignees array contiene objetos de usuario completos con id, name, email, y avatar_url. El equipo el objeto contiene toda la información del equipo con id, name, y organización.

Crear una tarea

POST /v1/tasks

Cree una Nueva tarea. Las Tareas pueden ser independientes, conversaciones o crearse dentro de conversaciones.

Las Tareas creadas mediante la API aparecen en la Tareas solo lectura, no la Bandeja de entrada. Crear una tarea no hace que el propietario del API token siga automáticamente la conversación principal.

Al crear subtareas dentro de conversaciones, puede seguir automáticamente la conversación principal. Para desactivar esto, vaya a Configuración > Preferencias y busque “watch” para encontrar y desactivar la seguimiento automático al crear tareas opción.

Parámetros

Nombre (* obligatorio)
Descripción
Ejemplo

title*

Título de la tarea (máx. 1000 caracteres)

“Revisar solicitud de extracción”

description

Descripción de la tarea (máx. 10000 caracteres)

"Revise el PR #123, por favor"

estado

Estado de la tarea. Uno de: todo, in_progress, finalizada

"in_progress"

organización

Cadena del ID de la organización (obligatoria al usar equipo, responsables o add_users)

"0d9bab85-a74f-4ece-9142-0f9b9f36ff92"

equipo

Cadena de ID del equipo (se requiere el equipo o los responsables para las tareas independientes)

"0e24f298-965d-4475-9220-b32636a1e2c3"

assignees

Matriz de cadenas de ID de usuario (para tareas independientes se requiere equipo o responsables)

["1ce8117e-ae42-4304-b953-c81656da4bd1"]

due_at

Marca de tiempo Unix para la Fecha límite de la tarea

1692371867

subtarea

Booleano que indica si esta es una subtarea de una conversación

true

conversation

Cadena de ID de la conversación principal (obligatorio cuando la subtarea es true)

"a5d2aa1c-3828-4f90-bbd8-3dffaadda97e"

references

Array de cadenas para encontrar o crear la conversación principal (se usa al crear una subtarea)

["<some-reference-123>"]

conversation_subject

Asunto de la conversación principal al crear mediante referencias

“Nueva solicitud de función”

agregar_usuarios

Array de IDs de usuario para agregar a la conversación principal (solo para subtareas)

["74f91030-39b8-4627-9835-9cfbce9d67c1"]

agregar a la bandeja de entrada

Mover la conversación principal a Bandeja de entrada para todos los que tienen acceso (solo para subtareas)

true

Actualizar una tarea

PATCH /v1/tasks/:id

Actualizar los atributos de una tarea existente.

Parámetros

Nombre
Descripción
Ejemplo

title

Título de la tarea (máx. 1000 caracteres)

“Título de tarea actualizado”

description

Descripción de la tarea (máx. 10000 caracteres)

“Nueva descripción”

estado

Estado de la tarea. Uno de: todo, in_progress, finalizada

"in_progress"

assignees

Array de cadenas de ID de usuario

["1ce8117e-ae42-4304-b953-c81656da4bd1"]

equipo

Cadena del ID del equipo

"0e24f298-965d-4475-9220-b32636a1e2c3"

due_at

Marca de tiempo Unix para la Fecha límite de la tarea

1692371867

title

El título de la tarea que se mostrará en la lista de tareas y en los detalles de la tarea. Limitado a 1000 caracteres.

description

Una descripción más larga de la tarea que proporciona contexto o detalles adicionales. La descripción admite texto sin formato y está limitada a 10000 caracteres.

estado

El estado actual de la tarea. Puede ser uno de los siguientes:

  • todo - La tarea está pendiente y debe trabajarse

  • in_progress - La tarea está en curso

  • finalizada - La tarea ha sido completada o finalizada

Si no se especifica, las nuevas tareas usarán como valor predeterminado todo el estado.

organización

Se requiere el ID de la organización al asignar tareas a equipos o usuarios mediante equipo, assignees, o agregar_usuarios parámetros. Esto garantiza que la tarea se cree en el contexto organizativo correcto.

equipo

Para tareas independientes (no subtareas), se debe especificar equipo o assignees el ID de un equipo o de un usuario. Cuando se asigna un equipo, todos los miembros del equipo tendrán acceso a la tarea y esta aparecerá en la lista de tareas del equipo.

assignees

Para tareas independientes (no subtareas), se debe especificar equipo o assignees se debe especificar el ID de uno o más usuarios. Cuando se asignan usuarios, ellos serán responsables de completar la tarea y esta aparecerá en sus listas personales de tareas.

due_at

Establece una fecha límite para la tarea usando una marca de tiempo Unix. La tarea se marcará como vencida si no se completa para esta fecha. Configurar este campo es opcional.

subtarea

Cuando true, indica que esta tarea debe crearse como una subtarea dentro de una conversación. Las subtareas requieren un conversation ID o references para identificar la conversación principal.

conversation

Requerido al crear una subtarea (subtask: true). Especifica el ID de la conversación existente donde se debe crear la subtarea.

references

Una alternativa a conversation al crear subtareas. Permite encontrar o crear la conversación principal usando referencias de mensajes (como los Message-ID del correo electrónico). Si varias conversaciones coinciden con las referencias, la tarea se creará en la primera conversación que coincida.

conversation_subject

Al crear una subtarea usando references y se necesita crear una nueva conversación, este campo establece el asunto de esa nueva conversación.

agregar_usuarios

Al crear subtareas, este parámetro permite agregar usuarios adicionales a la conversación principal. Estos usuarios tendrán acceso tanto a la conversación como a la subtarea. El organización parámetro es obligatorio al usar agregar_usuarios.

agregar a la bandeja de entrada

Al crear subtareas, pase add_to_inbox: true para mover la conversación principal a la Bandeja de entrada para todas las personas con acceso. Sin esto, la conversación no aparecerá en la Bandeja de entrada de nadie como resultado de la creación de la tarea.


Hooks

Ejecute automáticamente flujos de trabajo en sistemas externos cuando lleguen nuevos mensajes o se agreguen comentarios.

Crear webhook

POST /v1/hooks

Cree una suscripción de webhook para recibir notificaciones de eventos específicos en Missive. Este endpoint permite la integración con servicios como Zapier, n8n y otros, o puede usarse directamente para integraciones personalizadas. Entre bastidores, este endpoint crea una regla de Missive con una acción de webhook; más adelante puede ver y editar estas reglas en su configuración de Reglas de Missive, igual que cualquier otra regla que cree manualmente.

Parámetros

Nombre (* obligatorio)
Predeterminado
Descripción

type *

Tipo de evento al que suscribirse. Valores admitidos: incoming_email, incoming_sms_message, incoming_facebook_message, incoming_whatsapp_message, incoming_twilio_chat_message, new_comment

url *

La URL del webhook que recibirá las notificaciones del evento

organización

nulo

ID de la organización. Si no se proporciona, crea una suscripción personal de webhook

content_contains

nulo

Solo se activa cuando el contenido contiene este texto

content_starts_with

nulo

Solo se activa cuando el contenido comienza con este texto

content_ends_with

nulo

Solo se activa cuando el contenido termina con este texto

Exclusivo de new_comment:

is_task

false

Solo se activa para comentarios de tareas

author

nulo

Solo se activa para comentarios del usuario con este ID

mention

nulo

Solo se activa cuando se menciona este ID de usuario

Exclusivo de incoming_email:

from_eq

nulo

Solo se activa para mensajes de esta dirección de correo electrónico exacta

subject_contains

nulo

Solo se activa para mensajes con este texto en el asunto

Eliminar webhook

DELETE /v1/hooks/:id

Elimine una suscripción de webhook. Detrás de escena, elimina la regla que contiene la acción de webhook.

Última actualización el 18 de septiembre de 2025


¿Necesita respuestas más específicas?\\

Última actualización