Endpunkte
Vollständige Referenz für Missive API-Endpunkte: Statistiken, Unterhaltungen, Entwürfe, Beiträge, Kontakte, Labels und mehr.
Statistiken
Statistiken-Endpunkte ermöglichen es Ihnen, einen Bericht auf Grundlage eines ausgewählten Zeitraums und optionaler Filter wie Team-Posteingang, Nutzer, Labels usw. abzurufen. Aufgrund der asynchronen Natur der Berichtserstellung sind zwei Endpunkte beteiligt: eine Anfrage, um den Bericht zu erstellen, und eine weitere, um die Daten kurz danach abzurufen.
Beispielverwendung: Statistiken automatisch mit Ihrem Business-Intelligence-Tool synchronisieren.
Statistikenbericht erstellen
POST /v1/analytics/reports
{
"reports": {
"Organisation": "0d9bab85-a74f-4ece-9142-0f9b9f36ff92",
"start": 1691812800,
"end": 1692371867,
"time_zone": "America/Montreal"
}
}{
"reports": {
"Organisation": "0d9bab85-a74f-4ece-9142-0f9b9f36ff92",
"start": 1691812800,
"end": 1692371867,
"time_zone": "America/Montreal",
"teams": [
"0e24f298-965d-4475-9220-b32636a1e2c3"
],
"Nutzer": [
"1ce8117e-ae42-4304-b953-c81656da4bd1",
"74f91030-39b8-4627-9835-9cfbce9d67c1"
],
"Konten": [
"716be7a6-fd40-45a2-bfcb-43b9ed38d1f0",
"a5d2aa1c-3828-4f90-bbd8-3dffaadda97e"
],
"account_types": [
"E-Mail",
"SMS"
],
"shared_labels": [
"bca0bb8f-8b2f-45f8-a59a-333de84f0184"
]
}
}{
"reports": {
"id": "8441d4a0-a0ad-4f0f-aa9c-1cc881057e42"
}
}Diese ID muss dann in eine Bericht anfordern.
Parameter
Organisation*
Organisations-ID-String
"0d9bab85-a74f-4ece-9142-0f9b9f36ff92"
Start*
Beginn des Berichtszeitraums
1691812800
end*
Ende des Berichtszeitraums
1692371867
Teams
Array von Team-ID-Strings
["0e24f298-965d-4475-9220-b32636a1e2c3"]
Nutzer
Array von Benutzer-ID-Strings
["1ce8117e-ae42-4304-b953-c81656da4bd1"]
geteilte Labels
Array von Zeichenfolgen für Label der Organisation-IDs
["bca0bb8f-8b2f-45f8-a59a-333de84f0184"]
Konten
Array von Konto-ID-Strings
["716be7a6-fd40-45a2-bfcb-43b9ed38d1f0"]
account_types
Array von Strings
["E-Mail", "SMS"]
Teams, Nutzer, shared_labels, Konten
Siehe Ressourcen-IDs.
account_types
„benutzerdefiniert“, „E-Mail“, "Instagram", "live_chat", „Messenger“, "SMS", "WhatsApp"
Statistikenbericht abrufen
GET /v1/Statistiken/reports/:id
Rufen Sie einen Bericht mithilfe seiner id ab, die von einer Create report-Anfrage zurückgegeben wurde. Die Berichtsdaten werden als JSON zurückgegeben.
Die meisten Berichte sind innerhalb von 2 oder 3 Sekunden nach der Erstellung abgeschlossen, einige können jedoch 30 Sekunden oder länger dauern. Sie laufen 60 Sekunden nach Abschluss ab. Für unvollständige, abgelaufene oder nicht vorhandene Berichte wird eine leere 404-Antwort zurückgegeben.
Kontakte
Kontakt-Endpunkte ermöglichen es Ihnen, Ihre Kontakte programmgesteuert zu verwalten.
Beispielverwendung: Kontakte zwischen Missive und Ihrem CRM automatisch synchronisieren.
Kontakte erstellen
POST /v1/contacts
Eine erfolgreiche Anfrage gibt neu erstellte Kontakte zurück.
Attribute
contact_book*
Adressbuch-ID-Zeichenfolge
"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
„Herr“
Namenszusatz
string
„Jr.“
Spitzname
string
„Phil“
file_as
string
„Missive“
notes
string
Toller Interessent!
Markiert
boolean
true
Geschlecht
string
„Männlich“
Infos
Array mit Kontaktinformationsobjekten, Details siehe unten
[{"kind": "email", "label": "work", "value": "phil@missiveapp.com"}]
Mitgliedschaften
Array mit Kontaktmitgliedschaftsobjekten, siehe unten für Details
[{ "title": "CEO", "group": { "kind": "organization", "name": "Missive" }}]
Infos
Die Infos array ermöglicht es Ihnen, Daten verschiedener Arten einem Kontakt zuzuordnen: email, twitter, phone_number, facebook, physical_address, url, custom.
Infos mit kind email
kind*
string
„E-Mail“
value*
E-Mail-Adresse
"philippe@missiveapp.com"
Label*
Typ der E-Mail-Adresse. Zulässige Werte: privat, Arbeit, persönlich, sonstige
„work“
custom_label
Benutzerdefinierter Label-Wert, nur verwenden, wenn Label ist sonstige
„old“
Infos mit kind phone_number
kind*
string
„phone_number“
value*
Telefonnummer
"+1 518 777-7777"
Label*
Typ der Telefonnummer. Zulässige Werte: Hauptnummer, Mobil, privat, Arbeit, home_fax, work_fax, other_fax, Pager, sonstige
„mobile“
custom_label
Benutzerdefinierter Label-Wert, nur verwenden, wenn Label ist sonstige
„old“
Infos mit kind twitter
kind*
string
„twitter“
value*
Twitter-Benutzername
„@plehoux“
Label*
Twitter-Kontotyp. Zulässige Werte: Arbeit, persönlich, sonstige
„personal“
custom_label
Benutzerdefinierter Label-Wert, nur verwenden, wenn Label ist sonstige
„old“
Infos mit kind facebook
kind*
string
„facebook“
name*
Facebook-Benutzername
„Philippe-Antoine Lehoux“
Label*
Facebook-Kontotyp. Zulässige Werte: Arbeit, persönlich, sonstige
„personal“
custom_label
Benutzerdefinierter Label-Wert, nur verwenden, wenn Label ist sonstige
„old“
Infos mit kind physical_address
kind*
string
„physical_address“
Straße
string
123 Fake Street
extended_address
string
Büro 222
Stadt
string
Quebec
Region
string
QC
postal_code
string
G1K 3T4
po_box
string
PO#12345
Land
string
Kanada
Label*
Adresstyp. Zulässige Werte: Arbeit, privat, sonstige
„work“
custom_label
Benutzerdefinierter Label-Wert, nur verwenden, wenn Label ist sonstige
„old“
Infos mit kind url
kind*
string
„url“
value*
URL
„https://missiveapp.com/“
Label*
URL-Typ. Zulässige Werte: Startseite, Profil, blog, Arbeit, persönlich, sonstige
"homepage"
custom_label
Benutzerdefinierter Label-Wert, nur verwenden, wenn Label ist sonstige
"admin"
Infos mit kind custom
kind*
string
„benutzerdefiniert“
value*
string
"A custom value"
Label*
Benutzerdefinierter Info-Typ. Zulässige Werte: sonstige
"other"
custom_label
Benutzerdefinierter Label-Wert
„benutzerdefiniert“
Mitgliedschaften
Die Mitgliedschaften array ermöglicht es Ihnen, einen Kontakt mit Organisationen oder Gruppen zu verknüpfen. Eine Mitgliedschaft bettet immer eine zugehörige Gruppe, die eine kind gleich einem von beiden Gruppe oder Organisation.
Organisationen werden meist verwendet, um Kontakte mit ihrem Arbeitsort zu verknüpfen.
Gruppen werden verwendet, um Kontakte zusammenzufassen. Betrachten Sie Gruppen als Labels.
Abteilung
kann festgelegt werden, wenn Gruppe ist vom Typ Organisation
„Finanzen“
title
kann festgelegt werden, wenn Gruppe ist vom Typ Organisation
„CFO“
Standort
kann festgelegt werden, wenn Gruppe ist vom Typ Organisation
„Montreal“
description
kann festgelegt werden, wenn Gruppe ist vom Typ Organisation
„Reporting bearbeiten“
Gruppe*
Objekt, siehe unten für Details
{"kind": "organization", "name": "Missive"}
memberships.group
kind*
Gruppentyp. Zulässige Werte: Organisation, Gruppe
"Organisation"
name*
string
„Missive“
Kontakteigenschaften
Die gleiche Form wird von Kontakte erstellen, Kontakt(e) aktualisieren, Kontakte auflisten, und Einen Kontakt abrufen.
id*
Kontakt-UUID
gelöscht*
Ob der Kontakt gelöscht ist
modified_at*
Unix-Zeitstempel, wann der Kontakt zuletzt geändert wurde
contact_book*
Adressbuch-UUID
first_name
last_name
middle_name
phonetic_first_name
phonetic_last_name
phonetic_middle_name
prefix
Namenszusatz
Spitzname
file_as
notes
Markiert
Boolescher Wert
Geschlecht
Pronomen
job_title
Infos
Array von Kontaktdaten (siehe Arten von Kontaktinformationen in der Anfragedokumentation)
Mitgliedschaften
Array von Kontaktmitgliedschaften (siehe Anforderungsdokumentation)
Kontakt(e) aktualisieren
PATCH /v1/contacts/:id1,:id2,:id3,...
Eine erfolgreiche Anfrage gibt die aktualisierten Kontakte mit eingebetteten zurück Mitgliedschaften und Infos.
Attribute
Kontakt id ist erforderlich. Siehe den Abschnitt Kontakte erstellen für weitere Attribute. Wenn Sie einen Kontakt aktualisieren, können Sie nur die Attribute übergeben, die Sie aktualisieren möchten. Im obigen Beispiel wird nur der Nachname aktualisiert.
Kontakte auflisten
GET /v1/contacts
Dieser Endpoint ist nützlich, um Missive-Kontakte mit einem anderen Dienst zu synchronisieren oder Kontakte anhand eines Suchbegriffs zu finden.
Parameter
contact_book*
Adressbuch-ID
order
last_name
Die Standardreihenfolge erfolgt nach dem Nachnamen des Kontakts. Um die zuletzt aktualisierten Kontakte zu erhalten, übergeben Sie last_modified
limit
50
Anzahl der zurückgegebenen Kontakte. Maximalwert: 200
offset
0
Versatz für die Paginierung.
modified_since
null
Um nur Kontakte zurückzugeben, die seit einem bestimmten Zeitpunkt geändert oder erstellt wurden, übergeben Sie einen Unix-Epoch-Zeitstempel wie 1556137749.
include_deleted
false
Gelöschte Kontakte in die Ergebnisse von einbeziehen modified_since Anfragen, durchlassen true. Nur der Kontakt id und gelöscht Attribute werden zurückgegeben, da die Kontaktdaten aus Missive gelöscht wurden.
Suchen
null
Textzeichenfolge zum Filtern von Kontakten. Suchen Begriff(e) werden mit allen Kontaktinformationen abgeglichen: Name, E-Mail, Telefon, Organisation, benutzerdefinierte Felder, Notizen usw.
Einen Kontakt abrufen
GET /v1/contacts/:id
Einen bestimmten Kontakt mithilfe des contact abrufen id. Der Versuch, einen gelöschten Kontakt abzurufen, führt zu einer 404-Antwort.
Adressbücher
In Missive werden Kontakte in Adressbüchern gespeichert. Adressbücher können privat sein oder mit verschiedenen Mitgliedern einer Organisation geteilt werden.
Adressbücher auflisten
GET /v1/contact_books
Listen Sie die Adressbücher auf, auf die der authentifizierte Benutzer Zugriff hat. Denken Sie daran, dass ein Adressbuch id beim programmgesteuerten Erstellen eines Kontakts erforderlich ist.
Parameter
limit
50
Anzahl der zurückgegebenen Adressbücher. Maximalwert: 200
offset
0
Versatz für die Paginierung.
Adressbuch-Eigenschaften
id*
Adressbuch-UUID
name*
Adressbuchname
Benutzer*
UUID des zugehörigen Benutzers
Organisation
Organisation-UUID für geteilte Bücher
Mit Organisation teilen*
Ob das Buch mit Alle in der Organisation geteilt ist
share_with_team
Team-UUID, wenn mit einem bestimmten Team geteilt
mit_Nutzer_teilen*
Array von Benutzer-UUIDs, mit denen das Buch ausdrücklich geteilt ist
description
Beschreibung
Importieren*
Ob ein Import derzeit in Bearbeitung ist
Import-Fehlertext
Fehlermeldung vom letzten fehlgeschlagenen Import
import_rows_count
Gesamtzahl der Zeilen im aktuellen/letzten Import
import_processed_rows_count
Bisher im aktuellen/letzten Import verarbeitete Zeilen
Kontaktgruppen
Kontakte können sowohl in Organisationen als auch in Gruppen gruppiert werden. Organisationen werden typischerweise verwendet, um eine Gruppe zusammenhängender Kontakte abzubilden (Unternehmen). Gruppen werden verwendet, um nicht zusammenhängende Kontakte zu gruppieren; betrachten Sie Gruppen als Labels.
Kontaktgruppen auflisten
GET /v1/contact_groups
Kontaktgruppen oder Organisationen auflisten, die mit einem Adressbuch verknüpft sind.
Parameter
contact_book*
Adressbuch-ID
kind*
Entweder Gruppe oder Organisation.
limit
50
Anzahl der zurückgegebenen Kontaktgruppen. Maximaler Wert: 200
offset
0
Versatz für die Paginierung.
Eigenschaften der Kontaktgruppe
id*
UUID der Kontaktgruppe
name*
Name der Kontaktgruppe
Unterhaltungen
Unterhaltungen auflisten
GET /v1/conversations
Unterhaltungen auflisten, die für den Nutzer sichtbar sind, dem der API token gehört. Muss nach Postfach, geteiltem Label oder Team gefiltert werden.
Gibt Unterhaltungen in der Reihenfolge von der neuesten zur ältesten Aktivität zurück. Um zu paginieren, übergeben Sie einen bis param gleich dem last_activity_at der ältesten Unterhaltung, die auf der vorherigen Seite zurückgegeben wurde. Die letzte Seite ist erreicht, wenn weniger Unterhaltungen als limit zurückgegeben werden oder wenn alle Unterhaltungen auf einer Seite denselben last_activity_at.
Parameter
limit
Anzahl der zurückgegebenen Unterhaltungen. Standard: 25. Max.: 50.
bis
Zeitstempelwert in Unix-Zeit, der zur Paginierung verwendet wird. Verwenden Sie den last_activity_at der ältesten Unterhaltung von der vorherigen Seite.
Posteingang
Übergeben Sie true um Unterhaltungen im Posteingang aufzulisten.
alle
Übergeben Sie true um Unterhaltungen im Postfach Alle aufzulisten.
Zugewiesen
Übergeben Sie true um Unterhaltungen aufzulisten, die Zugewiesen an den Benutzer sind.
Erledigt
Übergeben Sie true um Unterhaltungen im Postfach Erledigt aufzulisten.
Zurückgestellt
Übergeben Sie true um Unterhaltungen im Postfach Zurückgestellt aufzulisten.
Markiert
Übergeben Sie true um Unterhaltungen im Postfach Markiert aufzulisten.
Gelöscht
Übergeben Sie true um Unterhaltungen im Papierkorb aufzulisten.
Als Spam markiert
Übergeben Sie true um Unterhaltungen im Spam aufzulisten. Anmerkung: Missive verwendet „Spam“ in der Benutzeroberfläche, obwohl einige E-Mail-Anbieter dafür einen anderen Begriff verwenden.
Entwürfe
Übergeben Sie true um Unterhaltungen in Entwürfen aufzulisten.
Geteiltes Label
ID des geteilten Labels. Unterhaltungen im geteilten Label auflisten.
Team-Posteingang
Team-ID. Unterhaltungen im Team-Posteingang auflisten.
Team-Erledigt
Team-ID. Unterhaltungen im Postfach Erledigt des Teams auflisten.
team_all
Team-ID. Unterhaltungen im Postfach „Alle“ des Teams auflisten.
Organisation
Organisation-ID. Unterhaltungen nur auf diejenigen filtern, die für die Organisation geteilt sind. Es gibt keinen Nutzen für den Organisation Parameter, wenn Sie einen Geteiltes Label oder team_ Parameter übergeben.
email
E-Mail-Adresse-String. Unterhaltungen nach einer bestimmten Kontakt-E-Mail-Adresse filtern (z. B., user@example.com). Entspricht der Adresse in den From, To, Cc, Bcc und Antwort an Header. Schließt sich gegenseitig mit Domain und contact_organization.
Domain
Domain-String. Filtern Sie Unterhaltungen nach Kontakten aus einer bestimmten E-Mail-Domain (z. B., example.com nicht @example.com). Entspricht der Domain in der From, To, Cc, Bcc und Antwort an Header. Schließt sich gegenseitig mit email und contact_organization.
contact_organization
UUID der Kontakt-Organisation oder -Gruppe. Filtern Sie Unterhaltungen nach Kontakten, die zu einer bestimmten Kontakt-Organisation oder Kontaktgruppe gehören. Nicht kombinierbar mit email und Domain.
Unterhaltung abrufen
GET /v1/conversations/:id
Rufen Sie eine bestimmte Unterhaltung mithilfe der Unterhaltung id.
Unterhaltungseigenschaften
Die gleiche Form wird von Unterhaltungen auflisten, Unterhaltung abrufen, Unterhaltungen aktualisieren, und Unterhaltungen zusammenführen.
id*
UUID der Unterhaltung
created_at*
Unix-Zeitstempel, als die Unterhaltung erstellt wurde
subject
Betreff der Unterhaltung
latest_message_subject
Betreff der letzten Nachricht in der Unterhaltung
Organisation
Organisation-Objekt (id, name)
color
HEX-Farbe oder Farbname (gut, Warnung, Gefahr)
Autoren*
Array von Nachrichtenautoren (name, address)
externe_Autoren*
Teilmenge von Autoren ohne Kollegen
Nutzer*
Array von Nutzern mit Zugriff (siehe unten User access properties)
zugewiesene Personen*
Teilmenge von Nutzer die der Unterhaltung zugewiesen sind
assignee_names*
Durch Kommas getrennte Anzeigenamen der zugewiesenen Personen
assignee_emails*
Durch Kommas getrennte E-Mail-Adressen der zugewiesenen Personen
geteilte Labels*
Array von geteilten Label-Objekten in der Unterhaltung
shared_label_names*
Durch Kommas getrennte Namen der geteilten Labels
team
Kompaktes Team-Objekt (siehe unten die Eigenschaften des kompakten Teams)
messages_count*
Anzahl der Nachrichten in der Unterhaltung
drafts_count*
Anzahl der Entwürfe in der Unterhaltung
send_later_messages_count*
Anzahl geplanter (später gesendeter) Nachrichten
attachments_count*
Anzahl der Anhänge in allen Nachrichten
Aufgaben_count*
Anzahl der Aufgaben in der Unterhaltung
completed_tasks_count*
Anzahl erledigter Aufgaben
last_activity_at*
Unix-Zeitstempel der jüngsten Aktivität der Unterhaltung
closed_at
Unix-Zeitstempel, zu dem die Aufgabe bzw. die Unterhaltung als erledigt markiert wurde
web_url*
URL zum Öffnen der Unterhaltung in der Web-App
app_url*
URL zum Öffnen der Unterhaltung in der Desktop-App
Kompakte Team-Eigenschaften
Die team Das in den Antworten zu Unterhaltungen eingebettete Objekt ist ein kompaktes Teamobjekt. Für die vollständige Team-Struktur verwenden Sie Teams auflisten, Team(s) erstellen, oder Team(s) aktualisieren.
id*
Team-UUID
name*
Teamname
Organisation*
Organisation-UUID
active_members*
Array von Benutzer-UUIDs für aktive Teammitglieder
Beobachter*
Array von Benutzer-UUIDs für Beobachter des Teams
Zugriffseigenschaften des Benutzers
Elemente innerhalb Nutzer und zugewiesene Personen in einer Unterhaltung.
id*
Benutzer-UUID
name*
Anzeigename des Benutzers
email*
E-Mail des Benutzers
Zugewiesen*
Ob dem Benutzer die Unterhaltung zugewiesen ist
nicht zugewiesen*
Ob sich die Unterhaltung im Postfach „Nicht zugewiesen“ des Nutzers befindet
Erledigt*
Ob sich die Unterhaltung im Postfach „Erledigt“ des Nutzers befindet
archiviert*
Ob die Unterhaltung für den Nutzer archiviert ist (nicht im Posteingang)
Markiert*
Ob die Unterhaltung für den Nutzer mit Stern markiert ist
Zurückgestellt*
Ob die Unterhaltung für den Nutzer zurückgestellt ist
Gelöscht*
Ob sich die Unterhaltung im Papierkorb des Nutzers befindet
Als Spam markiert*
Ob sich die Unterhaltung im Spam des Nutzers befindet
Unterhaltungen aktualisieren
PATCH /v1/conversations/:id
Aktualisieren Sie eine oder mehrere Unterhaltungen, ohne einen Beitrag zu erstellen. Verwenden Sie diesen Endpoint, um Unterhaltungen stillschweigend als erledigt zu markieren, wieder zu öffnen, zu verschieben, zuzuweisen, Labels hinzuzufügen, neu einzufärben oder umzubenennen. Systemereignisse können in Missive weiterhin erscheinen. Wenn die Aktualisierung Geteilte Labels ändert, werden Regeln für Label-Änderungen weiterhin ausgeführt.
Um mehrere Unterhaltungen in einer Anfrage zu aktualisieren, übergeben Sie durch Kommas getrennte IDs:
PATCH /v1/conversations/:id,:id2,:id3
Der Request-Body muss ein conversations array mit genau einem Objekt für jede ID in der URL enthalten. Jedes Objekt muss die übereinstimmende id.
Die Antwort verwendet dieselbe Objektstruktur der Unterhaltung, die in Unterhaltungseigenschaften.
Attribute
id*
Unterhaltungs-ID-String. Muss mit einer ID übereinstimmen, die in der URL übergeben wurde.
"6d3c9b1c-7067-4a28-8ea6-ea91340b67cc"
subject
Betreff für Neue Unterhaltung
„Rückerstattung genehmigt“
color
HEX-Farbcode oder „gut“ „Warnung“ „Gefahr“ string
"#000", „Gefahr“
Unterhaltungsfarbe
Wie color
"#000", „Gefahr“
Organisation
Organisations-ID-String
"90beb742-27a3-44cf-95bc-7e5097167c9d"
team
Team-ID-Zeichenkette
"646bb7f1-2066-40be-b8f6-bacb8b3b7419"
force_team
boolean
false
Nutzer hinzufügen
Array von Benutzer-ID-Strings
["7343bccf-cf35-4b33-99b0-b1d3c69c5f5c"]
Zugewiesene Personen hinzufügen
Array von Benutzer-ID-Strings
["7343bccf-cf35-4b33-99b0-b1d3c69c5f5c"]
remove_assignees
Array von Benutzer-ID-Strings
["7343bccf-cf35-4b33-99b0-b1d3c69c5f5c"]
geteilte Labels hinzufügen
Array von Zeichenketten mit geteilten Label-IDs
["9825718b-3407-40b8-800d-a27361c86102"]
remove_shared_labels
Array von Zeichenketten mit geteilten Label-IDs
["e4aae78f-e932-40a2-9ece-ed764aa85790"]
Zum Posteingang hinzufügen
boolean
true
Zum Team-Posteingang hinzufügen
boolean
true
Erledigen
boolean
true
Wieder öffnen
boolean
true
Organisation
Organisation ist erforderlich bei Verwendung von Nutzer hinzufügen, Zugewiesene Personen hinzufügen, remove_assignees, oder geteilte Labels hinzufügen.
team
team ändert das Team der Unterhaltung, wenn die Unterhaltung nicht bereits mit einem anderen Team verknüpft ist.
force_team
force_team erzwingt ein neues Team, selbst wenn die Unterhaltung bereits in einem anderen Team ist.
add_assignees, remove_assignees
Zugewiesene Personen hinzufügen weist Nutzer der Unterhaltung zu. remove_assignees entfernt Nutzer aus den zugewiesenen Personen der Unterhaltung. Beide erfordern Organisation, und die Nutzer-IDs müssen Mitgliedern dieser Organisation gehören.
add_shared_labels, remove_shared_labels
geteilte Labels hinzufügen und remove_shared_labels verwaltet Geteilte Labels in der Unterhaltung. Beim Hinzufügen von Labels müssen sie zu Organisation gehören und für den Nutzer des API token sichtbar sein.
Zum Team-Posteingang hinzufügen
Zum Team-Posteingang hinzufügen verschiebt die Unterhaltung in einen Team-Posteingang. Wenn Sie Zum Team-Posteingang hinzufügen, angeben, team ist das Feld erforderlich.
Zum Posteingang hinzufügen
Zum Posteingang hinzufügen verschiebt die Unterhaltung für alle mit Zugriff auf die Unterhaltung in den Posteingang.
Erledigen
Erledigen markiert die Unterhaltung für alle mit Zugriff auf die Unterhaltung als erledigt.
Wieder öffnen
Wieder öffnen öffnet die Unterhaltung für alle mit Zugriff auf die Unterhaltung wieder.
Nachrichten der Unterhaltung auflisten
GET /v1/conversations/:id/messages
Listet die Nachrichten in der übergebenen Unterhaltung auf id. Entwürfe werden ausgeschlossen.
Gibt Nachrichten zurück, sortiert von neu nach alt. Für die Seitennavigation übergeben Sie ein bis param gleich dem delivered_at der ältesten Nachricht, die auf der vorherigen Seite zurückgegeben wurde. Die letzte Seite ist erreicht, wenn weniger Nachrichten als limit zurückgegeben werden oder wenn alle Nachrichten auf einer Seite denselben delivered_at.
Parameter
limit
Anzahl der zurückgegebenen Nachrichten. Standard: 10. Max.: 10
bis
Zeitstempelwert in Unix-Zeit, der zur Paginierung verwendet wird. Verwenden Sie den delivered_at der ältesten Nachricht der vorherigen Seite.
Nachrichteneigenschaften
Die gleiche Form wird von Nachrichten der Unterhaltung auflisten, Entwürfe der Unterhaltung auflisten, Nachrichten auflisten, und Nachricht abrufen. Das body Feld ist nur enthalten in Nachricht abrufen. Einige Schlüssel sind kanalspezifisch (siehe Hinweise unten).
id*
Eintrags-UUID
type*
Nachrichtentyp: email, custom_email, custom_text, custom_html, twilio_message, messenger_message, instagram_message, usw.
preview*
Kurze Textvorschau des Nachrichtentexts
delivered_at*
Unix-Zeitstempel, wenn die Nachricht zugestellt wurde
updated_at*
Unix-Zeitstempel, wenn die Nachricht zuletzt aktualisiert wurde
created_at*
Unix-Zeitstempel, wenn der Nachrichtendatensatz in Missive erstellt wurde
from_field*
Absender. E-Mail-Kanal: Objekt mit name, address. Andere Kanäle: Objekt mit id, name, username. Für WhatsApp siehe den Hinweis zu Breaking Changes unten.
to_fields*
Array von Empfängern in derselben Form wie from_field
attachments*
Array von Anhang-Objekten (siehe Anhang-Eigenschaften)
references*
Array von Message-ID Zeichenketten, auf die diese Nachricht verweist
subject
E-Mail-Betreff. Nur E-Mail-Kanal
cc_fields
Array von CC-Empfängern. Nur E-Mail-Kanal
bcc_fields
Array von BCC-Empfängern. Nur E-Mail-Kanal
reply_to_fields
Array von Reply-To-Empfängern. Nur E-Mail-Kanal
email_message_id
E-Mail Message-ID Header (eingeschlossen in <>). Nur E-Mail-Kanal
in_reply_to
Array von Message-ID Zeichenketten, auf die diese Nachricht antwortet. Nur E-Mail-Kanal
external_id
Nachrichten-ID des Anbieters. Nur Nicht-E-Mail-Kanäle (SMS, Messenger usw.)
author
Benutzer, der die Nachricht verfasst hat (bei ausgehenden Nachrichten)
body
HTML-Text der Nachricht. Wird nur von Nachricht abrufen
account_author
Älterer Alias für from_field. Wird nur für SMS-, Messenger- und Twitter-Nachrichten zurückgegeben
account_recipients
Älterer Alias für to_fields. Wird nur für SMS-, Messenger- und Twitter-Nachrichten zurückgegeben
Eigenschaften von Anhängen
Zurückgegeben im attachments Array von Nachrichten, Entwürfen, Kommentaren, Beiträgen und Vorlagen.
id*
UUID des Anhangs
filename*
Ursprünglicher Dateiname
extension*
Dateierweiterung (z. B. png, pdf)
media_type*
MIME-Typ der obersten Ebene (z. B. image, application)
sub_type*
MIME-Untertyp (z. B. png, pdf)
size*
Dateigröße in Bytes
url*
Signierte URL zum Herunterladen der Datei
width
Bildbreite in Pixeln
height
Bildhöhe in Pixeln
Kommentare der Unterhaltung auflisten
GET /v1/conversations/:id/comments
Kommentare in der als übergebenen Unterhaltung auflisten id.
Gibt Kommentare sortiert von neuestem zu ältestem zurück. Um zu paginieren, übergeben Sie ein bis param gleich dem created_at des ältesten Kommentars, der auf der vorherigen Seite zurückgegeben wurde. Die letzte Seite ist erreicht, wenn weniger Kommentare als limit zurückgegeben werden oder wenn alle Kommentare auf einer Seite denselben created_at.
Parameter
limit
Anzahl der zurückgegebenen Kommentare. Standard: 10. Max.: 10
bis
Zeitstempelwert in Unix-Zeit, der zur Paginierung verwendet wird. Verwenden Sie den created_at des ältesten Kommentars von der vorherigen Seite.
Kommentar-Eigenschaften
id*
Eindeutige ID des Kommentareintrags
body*
Textinhalt des Kommentars
created_at*
Zeitstempel, zu dem der Kommentar erstellt wurde
Erwähnungen*
Array der Benutzer-Erwähnungen im Kommentar, mit Indizes, um sie im Textkörper zu lokalisieren
author*
Benutzer, der den Kommentar erstellt hat
Anhang
Datei, die an den Kommentar angehängt ist
Aufgabe
Wenn der Kommentar einer Aufgabe zugeordnet ist, das vollständige Aufgabenobjekt (siehe Aufgaben)
Entwürfe der Unterhaltung auflisten
GET /v1/conversations/:id/drafts
Entwurfsnachrichten in der als übergebenen Unterhaltung auflisten id.
Gibt Entwürfe in Reihenfolge von neuestem zu ältestem zurück. Zum Paginieren übergeben Sie einen bis param gleich dem delivered_at des ältesten Entwurfs, der auf der vorherigen Seite zurückgegeben wurde. Die letzte Seite ist erreicht, wenn weniger Entwürfe als limit zurückgegeben werden oder wenn alle Entwürfe auf einer Seite dieselbe delivered_at.
Parameter
limit
Anzahl der zurückgegebenen Entwürfe. Standard: 10. Max.: 10
bis
Zeitstempelwert in Unix-Zeit, der zur Paginierung verwendet wird. Verwenden Sie den delivered_at des ältesten Entwurfs von der vorherigen Seite.
Unterhaltungsbeiträge auflisten
GET /v1/conversations/:id/posts
Beiträge in der als übergebenen Unterhaltung auflisten id.
Gibt Beiträge in Reihenfolge von neuestem zu ältestem zurück. Zum Paginieren übergeben Sie einen bis param gleich dem created_at des ältesten Beitrags, der auf der vorherigen Seite zurückgegeben wurde. Die letzte Seite ist erreicht, wenn weniger Beiträge als limit zurückgegeben werden oder wenn alle Beiträge auf einer Seite dieselbe created_at.
Parameter
limit
Anzahl der zurückgegebenen Beiträge. Standard: 10. Max.: 10
bis
Zeitstempelwert in Unix-Zeit, der zur Paginierung verwendet wird. Verwenden Sie den created_at des ältesten Beitrags von der vorherigen Seite.
Beitrags-Eigenschaften
Zurückgegeben von Unterhaltungsbeiträge auflisten. Siehe Einen Beitrag erstellen für die Bedeutung jedes Feldes.
id*
UUID des Beitrags-Eintrags
created_at*
Unix-Zeitstempel, als der Beitrag erstellt wurde
username
Angezeigter Name des Beitragsautors
username_icon
Bild-URL, die als Avatar des Beitragsautors angezeigt wird
conversation_icon
Bild-URL, die als Unterhaltungssymbol verwendet wird
notification
Objekt mit title und body zum Rendern einer Benachrichtigung verwendet
text
Klartextkörper des Beitrags
markdown
Markdown-formatierter Inhalt des Beitrags
attachments
Array von Anhang-Objekten (formatierte Blöcke oder Dateien)
from_field
Objekt mit name, address, oder phone_number zur Suche des Autors
references
Array von Nachrichten-Referenzstrings
Unterhaltungen zusammenführen
POST /v1/conversations/:id/merge
Führen Sie die Unterhaltung zusammen, die als :id in die Unterhaltung, die als Ziel. Nach dem Zusammenführen wird die Quell-Unterhaltung (:id) als ersetzt markiert, und alle ihre Nachrichten, Kommentare und anderen Einträge werden Teil der Ziel-Unterhaltung.
Parameter
Ziel*
UUID der Ziel-Unterhaltung (die bestehen bleibt).
subject
Neuer Betreff für die zusammengeführte Unterhaltung.
Die UUID der Quell-Unterhaltung wird in der URL als :id.
Entwürfe
Das drafts endpoint ermöglicht es Ihnen, E-Mail-, SMS-, WhatsApp- und Missive Live Chat-Entwürfe zu erstellen, die entweder sofort gesendet oder bearbeitet und aus der Missive-App gesendet werden können. Sie können Entwürfe in einer neuen Unterhaltung erstellen oder sie als Antwort an eine bestehende anhängen.
Entwurf erstellen
POST /v1/drafts
Attribute
subject
string
"Hello"
body
HTML- oder Text-Zeichenfolge
"<b>World!</b>"
quote_previous_message
boolean
false
add_default_signature
boolean
false
from_field E-Mail
Objekt mit "address" und "name" Schlüssel.
{"address": "philippe@missiveapp.com", "name": "Philippe Lehoux"}
from_field SMS & WhatsApp
Objekt mit „phone_number“ Schlüssel, er muss mit einer Kontonummer übereinstimmen, auf die Sie Zugriff haben, formatiert als "+" gefolgt nur von Ziffern. Ein optionaler "type" Schlüssel mit Werten von "signalwire", "twilio", "twilio_whatsapp" oder "WhatsApp" muss angegeben werden, wenn die Telefonnummer Konten unterschiedlicher Typen entspricht.
{"phone_number": "+18005550199", "type": "whatsapp"}
from_field Benutzerdefinierter Kanal
Objekt mit "id", "username" und "name" Schlüssel.
{"id": "12345", "username": "@missiveapp", "name": "Missive"}
to_fields E-Mail
Array von Objekten. Objekt mit "address" und "name" Schlüssel.
[{"address": "philippe@missiveapp.com", "name": "Philippe Lehoux"}]
to_fields SMS & WhatsApp
Array von Objekten. Objekt mit „phone_number“ Schlüssel, nur ein Element ist zulässig und es muss formatiert sein als "+" gefolgt nur von Ziffern.
[{"phone_number": "+18005550199"}]
to_fields Messenger & Instagram
Array von Objekten. Objekt mit dem "id" Schlüssel.
[{"id": "1736313053102918"}]
to_fields Benutzerdefinierter Kanal
Array von Objekten. Objekt mit "id", "username" und "name" Schlüssel.
[{"id": "12345", "username": "@missiveapp", "name": "Missive"}]
to_fields Missive Live Chat
Array mit einem Objekt. Objekt mit "id", "username" und "name" Schlüssel.
[{ id: '123', username: 'phil@acme.com', name: 'Phil [Unverified]' }]
cc_fields
Array von Objekten mit "address" und "name" Schlüssel.
[{"address": "philippe@missiveapp.com", "name": "Philippe Lehoux"}]
bcc_fields
Array von Objekten mit "address" und "name" Schlüssel.
[{"address": "philippe@missiveapp.com", "name": "Philippe Lehoux"}]
Konto Benutzerdefinierter Kanal & Missive Live Chat, Messenger & Instagram
Konto-ID. Sie finden diese ID im benutzerdefinierten Kanal, in den Missive Live Chat-Einstellungen oder unter Einstellungen > API > Ressourcen-IDs.
"fbf74c47-d0a0-4d77-bf3c-2118025d8102"
attachments
Array mit Dateien, siehe unten für Details
[{"base64_data": "iVBORw0KGgoAAAANS…", "filename": "logo.png"}]
references
Array von Strings zum Anhängen an eine bestehende Unterhaltung.
["<some-reference-123>"]
from_field
Objekt mit den „phone_number“, "address" oder "name" Schlüsseln, die verwendet werden, um Kontakte in der Missive-Seitenleiste abzugleichen und die Autorenzeile in der Vorschau der Unterhaltung zu füllen
{"phone_number": "+4187249887", "name": "Paul"}
conversation
Unterhaltungs-ID-String zum Anhängen an eine bestehende Unterhaltung
"5bb24363-69e5-48ed-80a9-feee988bc953"
team
Team-ID-Zeichenkette
"646bb7f1-2066-40be-b8f6-bacb8b3b7419"
force_team
boolean
false
Organisation
Organisations-ID-String
"90beb742-27a3-44cf-95bc-7e5097167c9d"
Nutzer hinzufügen
Array von Benutzer-ID-Strings
["7343bccf-cf35-4b33-99b0-b1d3c69c5f5c"]
Zugewiesene Personen hinzufügen
Array von Benutzer-ID-Strings
["7343bccf-cf35-4b33-99b0-b1d3c69c5f5c"]
remove_assignees
Array von Benutzer-ID-Strings
["7343bccf-cf35-4b33-99b0-b1d3c69c5f5c"]
conversation_subject
string
"Neuer Nutzer!"
Unterhaltungsfarbe
HEX-Farbcode oder „gut“ „Warnung“ „Gefahr“ string
"#000", „Gefahr“
geteilte Labels hinzufügen
Array von Zeichenketten mit geteilten Label-IDs
["9825718b-3407-40b8-800d-a27361c86102"]
remove_shared_labels
Array von Zeichenketten mit geteilten Label-IDs
["e4aae78f-e932-40a2-9ece-ed764aa85790"]
Zum Posteingang hinzufügen
boolean
false
Zum Team-Posteingang hinzufügen
boolean
false
Erledigen
boolean
false
send
boolean
false
send_at
Zeitstempelwert in Unix-Zeit
1684540565
auto_followup
boolesch, send_at ist erforderlich, wenn übergeben true
false
external_response_id WhatsApp
Die Twilio- oder Meta-ID der Vorlage, die Sie verwenden.
474808552386201
external_response_variables WhatsApp
Ein Objekt, das die Variablenwerte für die Vorlage enthält, die Sie verwenden.
{ "1": "Philippe", "2": "This awesome project" }
body
Der HTML-/Text-Inhalt Ihrer Nachricht. Gewöhnliche HTML-Absatz-Tags in Missive zeigen nicht den gewünschten Abstand an.
Zum Beispiel würden Sie dies ändern, um den erwarteten Abstand zwischen Absätzen zu erhalten:
zu:
quote_previous_message
Wenn true, enthält der Entwurf eine zitierte Version der letzten Nachricht in der Unterhaltung.
add_default_signature
Wenn true, wird die für den sendenden E-Mail-Alias festgelegte Signatur zu dem body, genau wie beim Verfassen eines Entwurfs in Missive. Funktioniert nur für E-Mails und nur, wenn der from_field Alias eine Signatur hat.
send
Setzen Sie es auf true um den Entwurf sofort nach dem Erstellen zu senden.
send_at
Planen Sie, dass der Entwurf zu einem späteren Zeitpunkt gesendet wird. Kann nicht kombiniert werden mit send: true.
auto_followup
Wenn auto_followup ist true, wird der geplante Entwurf zu einem späteren Zeitpunkt mit send_at verworfen, wenn es eine Antwort in der Unterhaltung gibt.
from_field
from_field muss entweder ein address haben, das zu einem Ihrer E-Mail-Aliasse in Missive passt, oder ein phone_number haben, das zu einem Ihrer Twilio- oder SignalWire-Konten passt. Für benutzerdefinierte Kanäle können Sie jeden id, username und name ohne Einschränkung übergeben.
attachments
Die attachments Mit diesem Array können Sie dem Entwurf bis zu 25 Dateien anhängen. Die gesamte JSON-Payload Ihrer Anfrage darf 10 MB nicht überschreiten.
base64_data*
Der base64-kodierte Inhalt der Datei
"iVBORw0KGgoAAAANS…"
filename*
Dateiname des Anhangs
"logo.png"
references
Die references Mit diesem Array können Sie einen Entwurf an eine bestehende Unterhaltung anhängen. Wenn bereits eine Unterhaltung existiert und eine E-Mail mit einem Message-ID: <a@a.com> oder References: <a@a.com> Header enthält, können Sie "references": ["<a@a.com>"] zu Ihrer Anfrage hinzufügen, damit der Entwurf an diese Unterhaltung angehängt wird.
Wenn die in der Anfrage übergebenen references mit mehr als einer Unterhaltung verknüpft sind, wird der Entwurf an die zuerst gefundene Unterhaltung angehängt. Wenn keine reference angegeben wird, wird der Entwurf in einer neuen Unterhaltung erstellt. Wenn eine oder mehrere references angegeben werden, aber keine davon mit einer bestehenden Unterhaltung übereinstimmt, wird der Entwurf in einer neuen Unterhaltung erstellt.
Spitzenklammern um references sind optional. Beide ["<some-reference-123>"] und ["some-reference-123"] würden auf dieselbe Unterhaltung verweisen.
conversation
Wenn Sie die ID einer bestehenden Missive-Unterhaltung kennen, in der Sie Ihren Entwurf erstellen möchten, können Sie sie als conversation anstatt references.
subject
Die subject wird unverändert an die ausgehende E-Mail übergeben. Wenn Sie auf eine bestehende E-Mail-Unterhaltung antworten, setzen Sie immer subject zu Re: [the original subject]. E-Mail-Clients wie Gmail verwenden den Betreffabgleich für die Threading-Funktion — ein leerer oder nicht übereinstimmender Betreff führt dazu, dass die Antwort beim Empfänger als neuer Thread erscheint, obwohl sie in Missive korrekt gruppiert ist.
team
team ermöglicht es Ihnen, die Unterhaltung des Entwurfs einem Team zuzuordnen. Wenn eine Unterhaltung bereits einem Team zugeordnet ist, wird dieses Feld ignoriert.
force_team
force_team ermöglicht es Ihnen, ein neues Team zu erzwingen, auch wenn die Unterhaltung bereits in einem anderen Team ist.
Organisation
Organisation ermöglicht es Ihnen, die Suche nach Unterhaltungen auf solche zu beschränken, die bereits einer Organisation zugeordnet sind. Wenn eine neue Unterhaltung erstellt wird und Organisation übergeben wird, wird die neue Unterhaltung dieser Organisation zugeordnet.
Nutzer hinzufügen
Nutzer hinzufügen bestimmt die Nutzer, die Zugriff auf die Unterhaltung erhalten. Beim Übergeben von Nutzer hinzufügen, angeben, Organisation ist das Feld erforderlich.
Zugewiesene Personen hinzufügen
Zugewiesene Personen hinzufügen ermöglicht es Ihnen, Nutzer der Unterhaltung zuzuweisen. Vorhandene zugewiesene Personen bleiben zugewiesen. Beim Übergeben von Zugewiesene Personen hinzufügen, angeben, Organisation ist das Feld erforderlich.
remove_assignees
remove_assignees ermöglicht es Ihnen, zugewiesene Personen aus der Unterhaltung zu entfernen. Beim Übergeben von remove_assignees, angeben, Organisation ist das Feld erforderlich.
add_shared_labels, remove_shared_labels
geteilte Labels hinzufügen und remove_shared_labels ermöglichen es Ihnen, geteilte Labels zu verwalten, die auf die Unterhaltung des Entwurfs angewendet werden.
Zum Team-Posteingang hinzufügen
Zum Team-Posteingang hinzufügen ermöglicht es Ihnen, die Unterhaltung des Entwurfs in einen Team-Posteingang zu verschieben. Beim Übergeben von Zum Team-Posteingang hinzufügen, angeben, team ist das Feld erforderlich.
Zum Posteingang hinzufügen
Zum Posteingang hinzufügen ermöglicht es Ihnen, die Unterhaltung des Entwurfs in den Posteingang für alle Personen mit Zugriff auf die Unterhaltung zu verschieben.
Erledigen
Erledigen ermöglicht es Ihnen, die Unterhaltung des Entwurfs für alle Personen mit Zugriff auf die Unterhaltung als erledigt zu markieren.
external_response_id, external_response_variables
external_response_id und external_response_variables werden für WhatsApp-Vorlagen verwendet. Sie sind erforderlich, wenn Sie eine WhatsApp-Unterhaltung mit einem Nutzer beginnen, mit dem Sie in den letzten 24 Stunden noch nicht interagiert haben.
external_response_id ist die Twilio- oder Meta-ID der Vorlage, die Sie verwenden. Sie finden diese entweder im Twilio Content Template Builder oder im WhatsApp Manager. Im WhatsApp Manager wird die Meta-ID nicht in der Vorlagenliste angezeigt -- sie erscheint nur in der URL, wenn Sie eine bestimmte Vorlage öffnen:
Der Wert nach template-details&childRoute=CAPI&id= (z. B. 2222222222222222) ist die Meta-ID, die Sie als external_response_id.
external_response_variables ist ein Objekt, bei dem die Schlüssel die Platzhalter in der Vorlage sind und die Werte der Inhalt, den Sie für den jeweiligen Platzhalter verwenden möchten. Achten Sie darauf, String-Schlüssel für alle Variablen anzugeben. Nur Textkörper-Variablen ({{1}}, {{2}}, etc.) werden unterstützt -- Vorlagen mit Medien-Headern (Dokumente, Bilder oder andere Medien, die in Meta als Header-Komponente definiert sind) können nicht über Missive gesendet werden.
Eine Nachricht senden
Um eine neue Nachricht oder eine Antwort zu senden, verwenden Sie Entwurf erstellen mit dem send: true Parameter übergeben.
Anwendungsfall: Automatisierte E-Mail-Sequenzen
Kombinieren Sie die API mit automatischen Follow-up-Regeln um Drip-Kampagnen zu erstellen, die durch externe Ereignisse ausgelöst werden (z. B. Formularübermittlungen, CRM-Aktualisierungen).
So funktioniert’s:
Erstellen Sie eine Regel für ausgehende Nachrichten, die bei einer bestimmten Phrase in Ihrem E-Mail-Text ausgelöst wird
Fügen Sie steps der Regel hinzu. Jeder Schritt wartet, prüft Nicht beantwortet bei den Empfängern und sendet ein Follow-up mit Vorlage senden
Verwenden Sie die API, um die erste E-Mail mit dieser Trigger-Phrase zu senden
Die Schritte senden die Follow-up-E-Mails (z. B. 1, 3 und 7 Tage später)
Wenn ein Empfänger antwortet, werden die nächsten Follow-ups nicht gesendet
Beispiel: Website-Formular löst E-Mail-Sequenz aus
Die Phrase „Hier ist das von Ihnen angeforderte Angebot“ löst Ihre Follow-up-Regel aus, die die Folge der Follow-up-E-Mails startet.
Einen Entwurf löschen
DELETE /v1/drafts/:id
Löscht einen Entwurf aus einer Unterhaltung. Der :id Parameter ist die ID des Entwurfs (zurückgegeben in der Antwort von Entwurf erstellen).
Nachrichten
Eine Nachricht erstellen
POST /v1/messages
Erstellen Sie eine eingehende Nachricht in einem benutzerdefinierten Kanal. Benutzerdefinierte Kanäle ermöglichen es Nutzern, Nachrichtenanbieter zu integrieren, die nicht in Missive integriert sind.
Attribute
Konto*
Konto-ID. Sie finden diese ID in den Einstellungen des benutzerdefinierten Kanals.
"fbf74c47-d0a0-4d77-bf3c-2118025d8102"
subject
Nur E-Mail-Kanal: String
"Hello"
body
HTML- oder Text-String basierend auf dem Nachrichtentyp des Kanals.
"<b>World!</b>"
from_field*
E-Mail-Kanal: Objekt mit "address" und "name" Schlüsseln. Text- oder HTML-Kanal: Objekt mit "id", "username" und "name" Schlüssel.
{ "address": "philippe@missiveapp.com", "name": "Philippe Lehoux" } oder { "id": "12345", "username": "@missiveapp", "name": "Missive" }
to_fields
E-Mail-Kanal: Array von Objekten mit "address" und "name" Schlüsseln. Text- oder HTML-Kanal: Array von Objekten mit "id", "username" und "name" Schlüssel.
[{ "address": "philippe@missiveapp.com", "name": "Philippe Lehoux" }] oder [{ "id": "12345", "username": "@missiveapp", "name": "Missive" }]
cc_fields
Nur E-Mail-Kanal: Array von Objekten mit "address" und "name" Schlüssel.
[{ "address": "philippe@missiveapp.com", "name": "Philippe Lehoux" }]
bcc_fields
Nur E-Mail-Kanal: Array von Objekten mit "address" und "name" Schlüssel.
[{ "address": "philippe@missiveapp.com", "name": "Philippe Lehoux" }]
delivered_at
Zeitstempel der Zustellung der Nachricht. Wenn weggelassen, wird die Nachricht zum Zeitpunkt der Anfrage als zugestellt markiert.
1563806347
attachments
Array mit Dateien, siehe unten für Details.
[{ "base64_data": "iVBORw0KGgoAAAANS...", "filename": "logo.png" }]
external_id
Eindeutige ID zur Identifizierung von Nicht-E-Mail-Nachrichten (SMS, Instagram-DMs usw.).
"some-id-123"
references
Array von Strings zum Anhängen an eine bestehende Unterhaltung.
["some-reference-123"]
conversation
Unterhaltungs-ID-String zum Anhängen an eine bestehende Unterhaltung
"5bb24363-69e5-48ed-80a9-feee988bc953"
team
Team-ID-Zeichenkette
Standard basierend auf den Freigabeeinstellungen des Kanals: Posteingang oder Team-Posteingang
force_team
boolean
false
Organisation
Organisations-ID-String
"90beb742-27a3-44cf-95bc-7e5097167c9d"
Nutzer hinzufügen
Array von Benutzer-ID-Strings
["7343bccf-cf35-4b33-99b0-b1d3c69c5f5c"]
Zugewiesene Personen hinzufügen
Array von Benutzer-ID-Strings
["7343bccf-cf35-4b33-99b0-b1d3c69c5f5c"]
remove_assignees
Array von Benutzer-ID-Strings
["7343bccf-cf35-4b33-99b0-b1d3c69c5f5c"]
conversation_subject
string
"Neuer Nutzer!"
Unterhaltungsfarbe
HEX-Farbcode oder „gut“ „Warnung“ „Gefahr“ string
"#000", „Gefahr“
geteilte Labels hinzufügen
Array von Zeichenketten mit geteilten Label-IDs
["9825718b-3407-40b8-800d-a27361c86102"]
remove_shared_labels
Array von Zeichenketten mit geteilten Label-IDs
["e4aae78f-e932-40a2-9ece-ed764aa85790"]
Zum Posteingang hinzufügen
boolean
Standard basierend auf den Freigabeeinstellungen des Kanals: Posteingang oder Team-Posteingang
Zum Team-Posteingang hinzufügen
boolean
Standard basierend auf den Freigabeeinstellungen des Kanals: Posteingang oder Team-Posteingang
Erledigen
boolean
false
attachments
Die attachments Mit diesem Array können Sie Dateien an Nachrichten anhängen. Die gesamte JSON-Payload Ihrer Anfrage darf 10 MB nicht überschreiten.
base64_data*
Der base64-kodierte Inhalt der Datei
"iVBORw0KGgoAAAANS..."
filename*
Dateiname des Anhangs
"logo.png"
references
Die references Mit diesem Array können Sie eine Nachricht an eine bestehende Unterhaltung anhängen. Wenn bereits eine Unterhaltung existiert und eine Nachricht mit einem external_id: "some-id-123" oder references: ["some-id-123"], Sie können hinzufügen "references": ["some-id-123"] zu Ihrer Anfrage, damit die Nachricht an diese Unterhaltung angehängt wird.
Wenn die in der Anfrage übergebenen Verweise zu mehr als einer Unterhaltung gehören, wird die Nachricht an die zuerst gefundene Unterhaltung angehängt. Wenn kein Verweis angegeben ist, wird die Nachricht in einer neuen Unterhaltung erstellt. Wenn ein oder mehrere Verweise angegeben sind, aber keiner davon mit einer vorhandenen Unterhaltung übereinstimmt, wird die Nachricht in einer neuen Unterhaltung erstellt.
conversation
Wenn Sie die ID einer vorhandenen Missive-Unterhaltung kennen, in der Sie Ihre Nachricht erstellen möchten, können Sie sie als conversation anstatt references.
team
team Damit können Sie die Unterhaltung der Nachricht mit einem Team verknüpfen. Wenn eine Unterhaltung bereits mit einem Team verknüpft ist, wird dieses Feld ignoriert.
force_team
force_team ermöglicht es Ihnen, ein neues Team zu erzwingen, auch wenn die Unterhaltung bereits in einem anderen Team ist.
Organisation
Organisation ermöglicht es Ihnen, die Suche nach Unterhaltungen auf solche zu beschränken, die bereits einer Organisation zugeordnet sind. Wenn eine neue Unterhaltung erstellt wird und Organisation Wenn es übergeben wird, wird die Nachricht dieser Organisation zugeordnet.
Nutzer hinzufügen
Nutzer hinzufügen bestimmt die Nutzer, die Zugriff auf die Unterhaltung erhalten. Beim Übergeben von Nutzer hinzufügen, angeben, Organisation ist das Feld erforderlich.
Zugewiesene Personen hinzufügen
Zugewiesene Personen hinzufügen ermöglicht es Ihnen, Nutzer der Unterhaltung zuzuweisen. Vorhandene zugewiesene Personen bleiben zugewiesen. Beim Übergeben von Zugewiesene Personen hinzufügen, angeben, Organisation ist das Feld erforderlich.
remove_assignees
remove_assignees ermöglicht es Ihnen, zugewiesene Personen aus der Unterhaltung zu entfernen. Beim Übergeben von remove_assignees, angeben, Organisation ist das Feld erforderlich.
add_shared_labels, remove_shared_labels
geteilte Labels hinzufügen und remove_shared_labels ermöglichen es Ihnen, Geteilte Labels zu verwalten, die auf die Unterhaltung der Nachricht angewendet werden.
Zum Team-Posteingang hinzufügen
Zum Team-Posteingang hinzufügen ermöglicht es Ihnen, die Unterhaltung der Nachricht in einen Team-Posteingang zu verschieben. Wenn Sie angeben Zum Team-Posteingang hinzufügen, angeben, team ist das Feld erforderlich.
Zum Posteingang hinzufügen
Zum Posteingang hinzufügen ermöglicht es Ihnen, die Unterhaltung der Nachricht für alle mit Zugriff auf die Unterhaltung in den Posteingang zu verschieben.
Erledigen
Erledigen ermöglicht es Ihnen, die Unterhaltung der Nachricht für alle mit Zugriff auf die Unterhaltung als erledigt zu markieren.
Nachricht abrufen
GET /v1/messages/:id
Ruft die Header, den Inhalt und die Anhänge einer bestimmten Nachricht mithilfe der Nachricht ab id.
Um mehrere Nachrichten mit einem einzigen Aufruf abzurufen, übergeben Sie durch Kommas getrennte Nachrichten-IDs:
GET /v1/messages/:id,:id2,:id3
Wenn Sie mehrere Nachrichten mit durch Kommas getrennten IDs abrufen, gibt die Antwort ein Array von Nachrichtenobjekten unter dem messages Schlüssel im gleichen Format zurück, wie oben gezeigt.
Inline-Bilder
Inline-Bilder-Markup in der Nachricht body HTML enthält kein src Attribut, stattdessen enthalten sie ein data-missive-attachment-id Attribut mit dem Anhang id. Der Anhang und seine URL sind in der GET-Antwort unter dem attachments Schlüssel.
Nachrichten auflisten
GET /v1/messages?email_message_id=Message-ID
Nachrichten abrufen, die mit einer E-Mail übereinstimmen Message-ID.
Nachrichtendaten enthalten Header, Body und Anhänge im selben Format wie Nachricht abrufen.
Meistens entspricht nur eine Nachricht einer bestimmten Message-ID, wie es die E-Mail-Standards vorsehen. Nicht konforme Absenderserver können Ihnen jedoch mehrere Nachrichten mit derselben Message-ID senden; in diesem Fall gibt dieser endpoint die neuesten 10 zurück.
Parameter
email_message_id*
``
Die Message-ID im Header einer E-Mail gefunden.
Organisationen
Organisationen auflisten
GET /v1/organizations
Listen Sie die Organisationen auf, denen der authentifizierte Benutzer angehört.
Parameter
limit
50
Anzahl der zurückgegebenen Organisationen. Maximalwert: 200
offset
0
Versatz für die Paginierung.
Organisationseigenschaften
id*
Organisation-UUID
name*
Organisationsname
Vorlagen
Vorlagen auflisten
GET /v1/Vorlagen
Vorlagen für den authentifizierten Benutzer auflisten.
Parameter
Organisation
null
Organisation-ID
limit
50
Anzahl der zurückgegebenen Vorlagen. Maximalwert: 200
offset
0
Versatz für die Paginierung.
Inline-Bilder
Inline-Bilder-Markup in der Vorlage body HTML enthält kein src Attribut, stattdessen enthalten sie ein data-missive-attachment-id Attribut mit dem Anhang id. Der Anhang und seine URL sind in der GET-Antwort unter dem attachments Schlüssel.
Vorlageneigenschaften
Die gleiche Form wird von Vorlagen auflisten, Eine Vorlage abrufen, Vorlage(n) erstellen, und Vorlage(n) aktualisieren.
id*
Vorlagen-UUID
title*
Vorlagentitel
body*
HTML-Text der Vorlage
subject
Betreffzeile
modified_at*
Unix-Zeitstempel, wann die Vorlage zuletzt geändert wurde
Organisation
Organisation-UUID
Benutzer
Benutzer-UUID für persönliche Vorlagen
share_with_team
Team-UUID, wenn auf ein Team beschränkt
geteilte Labels*
Array von UUIDs geteilter Labels
to_fields*
Array von Empfängerobjekten (address, name)
cc_fields*
Array von CC-Empfängerobjekten
bcc_fields*
Array von BCC-Empfängerobjekten
attachments*
Array von Anhang-Objekten (siehe Anhang-Eigenschaften)
external_id
Externe Kennung
external_source
Kennung der externen Quelle
Eine Vorlage abrufen
GET /v1/responses/:id
Eine bestimmte Vorlage mithilfe der Vorlage abrufen id.
Vorlage(n) erstellen
POST /v1/responses
Eine erfolgreiche Anfrage gibt neu erstellte Vorlagen zurück.
Attribute
title
Vorlagen-Titel string (maximal 500 Zeichen)
"Willkommens-E-Mail-Vorlage"
Organisation
Organisation-ID string. Entweder Organisation oder Benutzer ist erforderlich (aber nicht beides).
"0d9bab85-a74f-4ece-9142-0f9b9f36ff92"
Benutzer
Zeichenfolge der Benutzer-ID für persönliche Vorlagen. Entweder Organisation oder Benutzer ist erforderlich (aber nicht beides).
"a41a00fd-453d-49d7-a487-9765c35a3b70"
body
HTML-Zeichenfolge mit dem Inhalt der Vorlage
"<p>Hallo!</p>"
subject
Zeichenfolge für die Betreffzeile (max. 500 Zeichen)
"Willkommen!"
share_with_team
Zeichenfolge der Team-ID, um die Vorlage mit einem bestimmten Team zu teilen. Organisation ist erforderlich
"646bb7f1-2066-40be-b8f6-bacb8b3b7419"
geteilte Labels
Array von Zeichenfolgen mit geteilten Label-IDs. Organisation ist erforderlich
["9825718b-3407-40b8-800d-a27361c86102"]
to_fields
Array von Objekten mit "address" und "name" Schlüssel
[{"address": "support@example.com", "name": "Support"}]
cc_fields
Array von Objekten mit "address" und "name" Schlüssel
[{"address": "manager@example.com", "name": "Manager"}]
bcc_fields
Array von Objekten mit "address" und "name" Schlüssel
[{"address": "archive@example.com"}]
external_id
Externe Kennungszeichenfolge zum Synchronisieren mit anderen Systemen. Wenn angegeben, external_source ist erforderlich.
"template-001"
external_source
Kennungszeichenfolge des Quellsystems. Erforderlich, wenn external_id angegeben ist. Die Kombination muss pro Organisation oder Benutzer eindeutig sein.
"knowledge-base"
attachments
Array mit Dateien, siehe unten für Details
[{"base64_data": "iVBORw0KGgoAAAANS...", "filename": "logo.png"}]
attachments
Die attachments array ermöglicht es Ihnen, Dateien an die response anzuhängen. Die gesamte JSON payload Ihrer Anfrage darf 10 MB nicht überschreiten.
base64_data*
Der base64-kodierte Inhalt der Datei
"iVBORw0KGgoAAAANS..."
filename*
Dateiname des Anhangs
"logo.png"
id
Temporäre ID für Inline-Bildverweise (siehe Abschnitt Inline-Bilder unten)
"img1"
Inline-Bilder
Um Bilder inline im response body einzubetten, verwenden Sie eine temporäre id im Anhang und verweisen Sie im HTML mithilfe des data-missive-attachment-id Attribut:
Der Server wird das Temporäre ersetzen id mit der tatsächlichen UUID des Anhangs. Anhänge mit einer id Alles, was im HTML-Body referenziert wird, wird als Inline-Bilder behandelt; Anhänge ohne Verweis im Body werden als normale Anhänge behandelt.
Vorlage(n) aktualisieren
PATCH /v1/Vorlagen/:id1,:id2,:id3,...
Eine erfolgreiche Anfrage gibt die aktualisierten Vorlagen zurück.
Attribute
Vorlage id ist erforderlich. Weitere Attribute finden Sie im Abschnitt „Vorlagen erstellen“. Wenn Sie eine Vorlage aktualisieren, können Sie nur die Attribute übergeben, die Sie aktualisieren möchten. Im obigen Beispiel werden nur Titel und Inhalt aktualisiert.
Vorlage löschen
DELETE /v1/responses/:id1,:id2,:id3,...
Löscht eine oder mehrere Vorlagen.
Für Organisationsvorlagen in Organisationen mit aktivierter eingeschränkter Vorlagenverwaltung (Feature des Enterprise-Plans) haben nur Organisations-Admins und -Eigentümer die Berechtigung, Vorlagen zu löschen.
Beiträge
Der Posts-Endpoint ermöglicht es Ihnen, Daten in jede Missive-Unterhaltung einzufügen und den Status der Unterhaltung zu verwalten. Sie können Posts in Neue Unterhaltungen erstellen oder sie an bestehende Unterhaltungen anhängen.
Posts sind die empfohlene Möglichkeit, Unterhaltungen zu verwalten (als erledigt markieren, in den Posteingang verschieben, Nutzern zuweisen, Labels hinzufügen) über Integrationen und Automatisierungen. Jeder Post hinterlässt eine sichtbare Spur in der Unterhaltung und zeigt, was die Aktion ausgelöst hat.
Beispielverwendung: Jedes Mal, wenn jemand Code auf Github pusht, erstellen Sie einen Beitrag, der die Commits auflistet. Wenn ein Support-Ticket in Ihrem System gelöst wird, erstellen Sie einen Beitrag, der die Unterhaltung als erledigt markiert.
Unterhaltungen mit Beiträgen verwalten
Verwenden Sie Beiträge, um Aktionen für Unterhaltung auszuführen und gleichzeitig eine Spur zu hinterlassen, die zeigt, welche Integration die Änderung ausgelöst hat. Hier sind häufige Aktionen:
Eine Unterhaltung als erledigt markieren
close: true
Eine Unterhaltung wieder öffnen
reopen: true
In den Posteingang verschieben (Archivierung aufheben)
add_to_inbox: true
In Team-Posteingang verschieben
add_to_team_inbox: true und team: "team-id"
Nutzer zuweisen
add_assignees: ["user-id"]
Zugewiesene entfernen
remove_assignees: ["user-id"]
Labels hinzufügen
add_shared_labels: ["label-id"]
Labels entfernen
remove_shared_labels: ["label-id"]
Farbe der Unterhaltung festlegen
conversation_color: "#ff0000"
Team wechseln
team: "team-id" und force_team: true
Beispiel: Unterhaltung mit einem benutzerdefinierten Beitrag als erledigt markieren
Dies erstellt einen Beitrag in der Unterhaltung und markiert sie als erledigt. Teammitglieder sehen den Beitrag, der erklärt, warum die Unterhaltung als erledigt markiert wurde.
Einen Beitrag erstellen
POST /v1/posts
Die Antwort enthält:
conversation: ID der Unterhaltung, zu der der Beitrag hinzugefügt wurdeid: ID des Beitrags (verwenden Sie diese ID zum Löschen des Beitrags)
Attribute
username
Name des Beitragsautors, der anstelle des Namens des API token-Besitzers verwendet wird
„Missive“
username_icon
Bild des Beitragsautors, das anstelle des Avatars des API token-Besitzers verwendet wird
"https://s3.amazonaws.com/missive-assets/missive-avatar.png"
conversation_icon
Bild, das als Symbol in der Unterhaltungsliste verwendet wird
"https://s3.amazonaws.com/missive-assets/missive-avatar.png"
conversation_subject
string
"Neuer Nutzer!"
Unterhaltungsfarbe
HEX-Farbcode oder „gut“ „Warnung“ „Gefahr“ string
"#000", „Gefahr“
text
Hauptnachricht eines Beitrags
"Dies ist ein Beitrag!"
markdown
Hauptnachricht eines Beitrags, formatiert mit Markdown
"Dies ist ein **Beitrag**!"
notification*
Objekt mit den Schlüsseln „title“ und „body“, das zum Rendern einer Benachrichtigung verwendet wird
{"title":"Ein Titel", "body": "Ein Text"}
attachments
Array mit Anhang-Objekten, siehe unten für Details
[{"text": "Dies ist ein Anhang!"}]
references
Array von Strings zum Anhängen an eine bestehende Unterhaltung.
["<some-reference-123>"]
conversation
Unterhaltungs-ID-String zum Anhängen an eine bestehende Unterhaltung
"5bb24363-69e5-48ed-80a9-feee988bc953"
Organisation
Organisations-ID-String
"90beb742-27a3-44cf-95bc-7e5097167c9d"
team
Team-ID-Zeichenkette
"646bb7f1-2066-40be-b8f6-bacb8b3b7419"
force_team
boolean
false
Nutzer hinzufügen
Array von Benutzer-ID-Strings
["7343bccf-cf35-4b33-99b0-b1d3c69c5f5c"]
Zugewiesene Personen hinzufügen
Array von Benutzer-ID-Strings
["7343bccf-cf35-4b33-99b0-b1d3c69c5f5c"]
remove_assignees
Array von Benutzer-ID-Strings
["7343bccf-cf35-4b33-99b0-b1d3c69c5f5c"]
geteilte Labels hinzufügen
Array von Zeichenketten mit geteilten Label-IDs
["9825718b-3407-40b8-800d-a27361c86102"]
remove_shared_labels
Array von Zeichenketten mit geteilten Label-IDs
["e4aae78f-e932-40a2-9ece-ed764aa85790"]
Zum Posteingang hinzufügen
boolean
false
Zum Team-Posteingang hinzufügen
boolean
false
Erledigen
boolean
false
Wieder öffnen
boolean
true
Validierungen
Entweder
text,markdownoderattachmentsist erforderlich.Die
textundmarkdownFelder haben eine maximale Länge von 8000 Zeichen.Die gesamte JSON payload Ihrer Anfrage darf 10 MB nicht überschreiten.
references
Die references Array ermöglicht es Ihnen, einen Beitrag an eine bestehende Unterhaltung anzuhängen. Wenn bereits eine Unterhaltung existiert und eine E-Mail mit einer Message-ID: <a@a.com> oder References: <a@a.com> Header enthält, können Sie "references": ["<a@a.com>"] zu Ihrer Anfrage hinzu, damit der Beitrag an diese Unterhaltung angehängt wird.
Wenn die in der Anfrage übergebenen Referenzen mit mehr als einer Unterhaltung verknüpft sind, wird der Beitrag nur in die zuerst gefundene Unterhaltung eingefügt. Wenn keine Referenz angegeben wird, wird der Beitrag in eine neue Unterhaltung eingefügt. Wenn eine oder mehrere Referenzen angegeben werden, aber keine davon mit einer vorhandenen Unterhaltung übereinstimmt, wird der Beitrag in eine neue Unterhaltung eingefügt.
Spitzenklammern um references sind optional. Beide ["<some-reference-123>"] und ["some-reference-123"] würden auf dieselbe Unterhaltung verweisen.
conversation
Wenn Sie die ID einer vorhandenen Missive-Unterhaltung kennen, in der Sie Ihren Beitrag erstellen möchten, können Sie sie als conversation anstatt references.
Organisation
Organisation ermöglicht es Ihnen, die Suche nach Unterhaltungen auf die zu beschränken, die bereits einer Organisation zugeordnet sind. Wenn eine neue Unterhaltung erstellt wird und Organisation übergeben wird, wird die Unterhaltung mit dieser Organisation verknüpft.
team
team ermöglicht es Ihnen, die Unterhaltung des Beitrags einem Team zuzuordnen. Wenn eine Unterhaltung bereits mit einem Team verknüpft ist, wird dieses Feld ignoriert.
force_team
force_team ermöglicht es Ihnen, ein neues Team zu erzwingen, auch wenn die Unterhaltung bereits in einem anderen Team ist.
Nutzer hinzufügen
Nutzer hinzufügen bestimmt die Nutzer, die Zugriff auf die Unterhaltung erhalten. Beim Übergeben von Nutzer hinzufügen, angeben, Organisation ist das Feld erforderlich.
Zugewiesene Personen hinzufügen
Zugewiesene Personen hinzufügen ermöglicht es Ihnen, Nutzer der Unterhaltung zuzuweisen. Vorhandene zugewiesene Personen bleiben zugewiesen. Beim Übergeben von Zugewiesene Personen hinzufügen, angeben, Organisation ist das Feld erforderlich.
remove_assignees
remove_assignees ermöglicht es Ihnen, zugewiesene Personen aus der Unterhaltung zu entfernen. Beim Übergeben von remove_assignees, angeben, Organisation ist das Feld erforderlich.
add_shared_labels, remove_shared_labels
geteilte Labels hinzufügen und remove_shared_labels ermöglichen es Ihnen, Geteilte Labels zu verwalten, die auf die Unterhaltung des Beitrags angewendet werden.
Zum Team-Posteingang hinzufügen
Zum Team-Posteingang hinzufügen verschiebt die Unterhaltung in einen Team-Posteingang für alle mit Zugriff. Bei Angabe von Zum Team-Posteingang hinzufügen, angeben, team Dieses Feld ist erforderlich. Ein Hinweis auf diese Aktion wird in der Unterhaltung angezeigt.
Zum Posteingang hinzufügen
Zum Posteingang hinzufügen verschiebt die Unterhaltung für alle mit Zugriff in den Posteingang (hebt die Archivierung der Unterhaltung auf). Ein Hinweis auf diese Aktion wird in der Unterhaltung angezeigt.
Erledigen
Erledigen markiert die Unterhaltung für alle mit Zugriff als erledigt. Ein Hinweis auf diese Aktion wird in der Unterhaltung angezeigt.
Wieder öffnen
Wieder öffnen verhindert, dass erledigte Unterhaltungen beim Erstellen eines Beitrags wieder geöffnet werden. Setzen Sie es auf true um die Unterhaltung auch nach dem Hinzufügen des neuen Beitrags erledigt zu lassen.
attachments
Die attachments Array unterstützt zwei Arten von Anhängen:
1. Formatierte Anhang-Blöcke mit den folgenden Feldern:
color
HEX-Farbcode oder „gut“ „Warnung“ „Gefahr“ string
"#ccc", „Gefahr“
pretext
Textzeichenfolge
"Dies ist ein Vorspann!"
author_name
Name des Autors des Anhangs
„Benutzer - Phil“
author_link
URL, die auf den Autor verlinkt
"https://admin.myapp.com/users/phil"
author_icon
Bild-URL des Autors des Anhangs
"https://myapp.com/phil.png"
title
Anhang-Titel
„Dies ist ein Titel!“
title_link
URL, die auf die Anhangsressource verweist
"https://myapp.com/a-resource"
image_url
Bild-URL des Anhangs
"https://myapp.com/a-resource.png"
text
Textzeichenfolge
"Das ist Text!"
markdown
Textzeichenfolge, formatiert mit Markdown
"Das ist ein **fetter Text**!"
timestamp
Ganzzahliger Wert in Unix-Zeit
1512395766
footer
Textzeichenfolge
"This is a footer!"
footer_icon
Bild-URL der Fußzeile des Anhangs
"https://myapp.com/logo.png"
fields
Array mit Feldobjekten, Details siehe unten
[{"title": "Paying customer","value": "yes"}]
2. Binäre Dateianhänge im gleichen Format wie Entwürfe und Nachrichten:
base64_data*
Der base64-kodierte Inhalt der Datei
"iVBORw0KGgoAAAANS..."
filename*
Dateiname des Anhangs
"logo.png"
Unterstützte Inline-Darstellungsformate: JPEG, PNG, GIF (Bilder), MOV, MP4 (Video), MP3 (Audio). Andere Dateitypen werden als herunterladbare Anhänge angezeigt.
attachments.fields
title
Textzeichenfolge
„Zahlender Kunde?“
value
Textzeichenfolge
„ja“
Kurz
Boolean. Wenn true, gibt es zwei Felder pro Zeile, andernfalls eines pro Zeile.
true
Einen Post löschen
DELETE /v1/posts/:id
Löscht einen Post aus einer Unterhaltung. Der :id Parameter ist die ID des Posts (zurückgegeben in der Antwort zum Erstellen eines Posts).
Geteilte Labels
Geteilte Labels erstellen
POST /v1/shared_labels
Eine erfolgreiche Anfrage gibt neu erstellte Geteilte Labels zurück.
Attribute
name*
Label-Name string
"Heroku"
Organisation*
Organisations-ID-String
"0d9bab85-a74f-4ece-9142-0f9b9f36ff92"
color
HEX-Farbcode
"#430098"
parent
ID-Zeichenkette des übergeordneten geteilten Labels
"9b45a00fd-353s-89l2-a487-2465c35c3r91"
Mit Organisation teilen
Boolescher Wert
true
share_with_team
Team-ID-Zeichenkette
nil
mit_Nutzer_teilen
Array von Benutzer-ID-Strings
[]
visibility
Entweder 'Organisation' oder 'delegates' string
'Organisation'
Mit Organisation teilen, share_with_team, mit_Nutzer_teilen
Nutzer, die von einem der beiden Parameter betroffen sind, haben Zugriff auf alle Unterhaltungen im Label.
visibility
Der Parameter visibility steuert, für wen das Label sichtbar ist. Wenn der Wert ist Organisation, alle in der Organisation können das Label verwenden. Wenn der Wert Delegierte, nur Admins und Nutzer mit automatischem Teilen (Nutzer, die von mit_Nutzer_teilen, Mit Organisation teilen, share_with_team) können das Label verwenden.
Geteilte Labels aktualisieren
PATCH /v1/shared_labels/:id1,:id2,:id3,...
Eine erfolgreiche Anfrage gibt die aktualisierten Geteilte Labels zurück.
Attribute
Geteiltes Label id ist erforderlich. Weitere Attribute finden Sie im Abschnitt „Geteilte Label erstellen“. Sie können nur die Attribute übergeben, die Sie aktualisieren möchten. Im obigen Beispiel werden der Name und die Farbe aktualisiert.
Basic-Nutzer können Folgendes aktualisieren:
name: Der Name des Labelscolor: Die Farbe des Labels als Hex-Farbcode (z. B. #f96885)parent: Die ID des übergeordneten Labels
Admin-/Besitzer-Nutzer können zusätzlich Folgendes aktualisieren:
visibility: Muss entweder 'Delegierte' oder 'Organisation' seinMit Organisation teilen: Ob das Label mit der gesamten Organisation geteilt werden sollshare_with_team: Die ID des Teams, mit dem das Label geteilt werden sollmit_Nutzer_teilen: Ein Array von Benutzer-IDs, mit denen das Label geteilt wird
Geteilte Labels auflisten
GET /v1/shared_labels
Geteilte Labels in Organisationen auflisten, denen der authentifizierte Benutzer angehört und auf die er Zugriff hat.
Parameter
Organisation
null
Organisation-ID
limit
50
Anzahl der zurückgegebenen Geteilten Labels. Maximaler Wert: 200
offset
0
Versatz für die Paginierung.
Eigenschaften von Geteilten Labels
Die gleiche Form wird von Geteilte Labels auflisten, Geteilte Labels erstellen, und Geteilte Labels aktualisieren.
id*
UUID des geteilten Labels
name*
Label-Name
name_with_parent_names*
Vollständiger Label-Pfad einschließlich übergeordneter Namen, verbunden durch /
Organisation*
Organisation-UUID
color
HEX-Farbcode
parent
UUID des übergeordneten Labels
Mit Organisation teilen*
Ob das Label mit allen in der Organisation geteilt ist
share_with_team
Team-UUID, wenn mit einem bestimmten Team geteilt
mit_Nutzer_teilen*
Array von Benutzer-UUIDs, mit denen das Label explizit geteilt ist
visibility*
Organisation oder Delegierte
Teams
Teams auflisten
GET /v1/teams
Teams in Organisationen auflisten, denen der authentifizierte Nutzer angehört und auf die er Zugriff hat.
Parameter
Organisation
null
Organisation-ID
limit
50
Anzahl der zurückgegebenen Teams. Maximalwert: 200
offset
0
Versatz für die Paginierung.
Team(s) erstellen
POST /v1/teams
Erstellen Sie ein Neues Team in einer Organisation. Der API token muss einem Admin oder Inhaber der Organisation gehören.
Attribute
name*
Teamname-Zeichenfolge
„Support“
Organisation*
Organisations-ID-String
"0d9bab85-a74f-4ece-9142-0f9b9f36ff92"
active_members
Array von Benutzer-ID-Strings für aktive Teammitglieder
["1ce8117e-ae42-4304-b953-c81656da4bd1"]
Beobachter
Array von Benutzer-ID-Strings für Beobachter des Teams
["a41a00fd-453d-49d7-a487-9765c35a3b70"]
business_hours
Konfigurationsobjekt für Geschäftszeiten, siehe unten für Details
{"tz": "America/Montreal", "t": [...]}
inactivity_period
Inaktivitätszeitraum in Sekunden, bevor eine Unterhaltung als veraltet gilt
604800
team_mention_behavior
Wer Benachrichtigungen erhält, wenn das Team erwähnt wird
"only_active_members"
user_reply_behavior
Was passiert, wenn ein Benutzer auf eine nicht zugewiesene Unterhaltung antwortet
"assign_user"
received_reply_behavior
Wo zugewiesene Unterhaltungen angezeigt werden, wenn eine neue Antwort eingeht
"show_in_assignee_inbox"
team_sidebar_behavior
Was in der Seitenleiste für dieses Team angezeigt werden soll
"show_team_space"
team_inbox_enabled
Ob der Team-Posteingang aktiviert ist
true
chat_room_enabled
Ob der Team-Chatraum aktiviert ist
true
active_members, observers
Aktive Mitglieder werden über Neue Nachrichten im Team-Posteingang benachrichtigt und sehen außerdem Unterhaltungen in der vereinheitlichten Ansicht der Team-Posteingänge. Beobachter werden nicht über Neue Nachrichten im Team-Posteingang benachrichtigt und sehen Unterhaltungen in der vereinheitlichten Ansicht der Team-Posteingänge nicht, können den Team-Posteingang aber bei Bedarf öffnen und verwalten. Beide erhalten Zugriff auf Kontakte, Vorlagen, Kalender und Integrationen, die mit dem Team geteilt werden.
business_hours
Die business_hours Das Objekt definiert, wann das Team verfügbar ist:
tz: Kennung der Zeitzone (siehe Liste der Zeitzonen)t: Array von Zeitfenster-Objekten, die jeweils Folgendes enthalten:d: Wochentag (0 = Sonntag, 1 = Montag, ..., 6 = Samstag)s: Array aus zwei Ganzzahlen, die Start- und Endzeiten in Sekunden seit Mitternacht darstellen (z. B.,[32400, 61200]= 9:00 AM bis 5:00 PM)
inactivity_period
Die Anzahl der Sekunden ohne Aktivität, nach denen eine Unterhaltung als inaktiv gilt. Übliche Werte: 86400 (1 Tag), 259200 (3 Tage), 604800 (1 Woche).
team_mention_behavior
all_members: Alle Teammitglieder (aktive und Mitlesende) erhalten Benachrichtigungen, wenn das Team erwähnt wirdonly_active_members: Nur Aktive Mitglieder erhalten Benachrichtigungen, wenn das Team erwähnt wird
user_reply_behavior
assign_user: Den Benutzer automatisch der Unterhaltung zuweisen, wenn er antwortetIm Team-Posteingang belassen: Unterhaltung im Team-Posteingang belassen, ohne zuzuweisen
received_reply_behavior
Im Posteingang der zugewiesenen Person anzeigen: Im Posteingang der zugewiesenen Person anzeigen, wenn eine neue Antwort eingehtshow_in_team_inbox: Zurückverschieben in den Team-Posteingang, wenn eine neue Antwort eingeht
team_sidebar_behavior
show_team_space: Den gesamten Team-Bereich in der Seitenleiste anzeigenTeam-Posteingang anzeigen: Nur den Team-Posteingang in der Seitenleiste anzeigen
Team(s) aktualisieren
PATCH /v1/teams/:id1,:id2,:id3,...
Aktualisieren Sie ein oder mehrere Teams. Das API token muss einem Administrator oder Inhaber der Organisation gehören.
Eine erfolgreiche Anfrage gibt die aktualisierten Teams zurück.
Attribute
Team id ist erforderlich. Siehe den Abschnitt Team(s) erstellen für weitere Attribute. Sie können nur Attribute übergeben, die Sie aktualisieren möchten. Im obigen Beispiel werden nur der Name, das Emoji und Aktive Mitglieder aktualisiert.
Team-Eigenschaften
Die gleiche Form wird von Teams auflisten, Team(s) erstellen, und Team(s) aktualisieren.
id*
Team-UUID
name*
Teamname
Organisation*
Organisation-UUID
active_members*
Array von Benutzer-UUIDs für aktive Teammitglieder
Beobachter*
Array von Benutzer-UUIDs für Beobachter des Teams
Emoji
Emoji-Kurzcode (z. B. :dart:)
color
HEX-Farbcode
business_hours
Konfigurationsobjekt für Geschäftszeiten
inactivity_period
Inaktivitätszeitraum in Sekunden, bevor eine Unterhaltung als veraltet gilt
team_inbox_enabled*
Ob der Team-Posteingang aktiviert ist
chat_room_enabled*
Ob der Team-Chatraum aktiviert ist
team_mention_behavior*
only_active_members oder all_members
user_reply_behavior*
assign_user oder Im Team-Posteingang belassen
received_reply_behavior*
Im Posteingang der zugewiesenen Person anzeigen oder show_in_team_inbox
team_sidebar_behavior*
show_team_space oder Team-Posteingang anzeigen
Nutzer
User-Endpunkte ermöglichen es Ihnen, Nutzer in Ihrer Organisation aufzulisten.
Nutzer auflisten
GET /v1/users
Nutzer in Organisationen auflisten, denen der authentifizierte Nutzer angehört.
Parameter
Organisation
null
Organisation-ID
limit
50
Anzahl der zurückgegebenen Nutzer. Maximalwert: 200
offset
0
Versatz für die Paginierung.
Benutzereigenschaften
id*
Benutzer-UUID
name*
Anzeigename des Benutzers
email*
E-Mail des Benutzers
avatar_url*
URL des Benutzer-Avatars
mich
true wenn der Benutzer der Inhaber des API token ist; andernfalls weglassen
Aufgaben
Aufgaben-Endpoints ermöglichen es Ihnen, Aufgaben programmgesteuert zu erstellen und zu verwalten.
Beispielverwendung: Erstellen Sie automatisch Aufgaben aus Ihrem Projektmanagement-Tool oder Bug-Tracker.
Aufgaben auflisten
GET /v1/tasks
Listet die Aufgaben auf, auf die der authentifizierte Benutzer Zugriff hat. Die Ergebnisse sind nach dem Zeitpunkt der letzten Aktivität sortiert (aktuellste zuerst) und können nach verschiedenen Kriterien gefiltert werden.
Beispielanfrage:
Abfrageparameter
limit
Anzahl der zurückzugebenden Aufgaben (min. 2, max. 50)
10
bis
Unix-Zeitstempel für die Paginierung, gibt Aufgaben mit last_activity_at vor diesem Wert zurück
1692371867
Organisation
Nach Organisations-ID filtern
"0d9bab85-a74f-4ece-9142-0f9b9f36ff92"
team
Nach Team-ID filtern
"0e24f298-965d-4475-9220-b32636a1e2c3"
assignee
Nach Benutzer-ID der zugewiesenen Person filtern
"1ce8117e-ae42-4304-b953-c81656da4bd1"
state
Nach Status filtern. Einer von: todo, in_progress, Erledigt
"todo"
type
Nach Typ filtern. Einer von: Aufgabe, conversation, alle
"all"
conversation
Nach ID der übergeordneten Unterhaltung filtern (gibt Unteraufgaben dieser Unterhaltung zurück)
"a5d2aa1c-3828-4f90-bbd8-3dffaadda97e"
due_at_gteq
Aufgaben filtern nach due_at größer als oder gleich diesem Unix-Zeitstempel
1692371867
due_at_lteq
Aufgaben filtern nach due_at kleiner als oder gleich diesem Unix-Zeitstempel
1692400000
type
Aufgaben nach ihrem Typ filtern:
Aufgabe- Nur Aufgaben zurückgeben (Unteraufgaben von Unterhaltungen oder eigenständige Aufgaben)conversation- Nur Unterhaltungen mit Aufgaben zurückgeben (zugewiesene oder fällige Unterhaltungen)alle- Sowohl Aufgaben als auch Unterhaltungen mit Aufgaben zurückgeben (Standard)
Paginierung
Um durch die Ergebnisse zu paginieren, verwenden Sie den last_activity_at Wert der letzten Aufgabe in der Antwort als den bis Parameter für die nächste Anfrage. Ziehen Sie 1 vom Zeitstempel ab, um Duplikate zu vermeiden, da bis inklusive ist.
Aufgabeneigenschaften
Die gleiche Form wird von Aufgaben auflisten, Eine Aufgabe abrufen, Eine Aufgabe erstellen, und Eine Aufgabe aktualisieren, und ist außerdem als das eingebettet Aufgabe Feld in einem Kommentar.
id*
Aufgaben-UUID
title*
Aufgabentitel
state*
todo, in_progress, oder Erledigt
type*
Aufgabe oder conversation
conversation
UUID der übergeordneten Unterhaltung für Unteraufgaben
description
Aufgabenbeschreibung
due_at
Unix-Zeitstempel dafür, wann die Aufgabe fällig ist
started_at
Unix-Zeitstempel dafür, wann die Arbeit begonnen hat
closed_at
Unix-Zeitstempel für den Zeitpunkt, an dem die Aufgabe als erledigt markiert wurde
zugewiesene Personen*
Array von zugewiesenen Personen. UUIDs in List/Create/Update; vollständige Benutzerobjekte in Get a task und bei Kommentaren
team
Team. UUID in List/Create/Update; vollständiges Team-Objekt in Get a task und in comments
last_activity_at
Unix-Zeitstempel der letzten Aktivität. Nur enthalten in Aufgaben auflisten
Eine Aufgabe abrufen
GET /v1/tasks/:id
Rufen Sie eine einzelne Aufgabe anhand der ID ab. Gibt die Aufgabe mit allen Details zurück, einschließlich zugewiesener Personen und Team-Informationen.
Die zugewiesene Personen Array enthält vollständige Benutzerobjekte mit id, name, email, und avatar_url. Das team Das Objekt enthält vollständige Team-Informationen mit id, name, und Organisation.
Eine Aufgabe erstellen
POST /v1/tasks
Erstellen Sie eine neue Aufgabe. Aufgaben können eigenständig sein, Unterhaltungen sein oder innerhalb von Unterhaltungen erstellt werden.
Parameter
title*
Aufgabentitel (max. 1000 Zeichen)
„Pull Request überprüfen“
description
Aufgabenbeschreibung (max. 10.000 Zeichen)
„Bitte PR #123 prüfen“
state
Aufgabenstatus. Einer der folgenden: todo, in_progress, Erledigt
"in_progress"
Organisation
Organisations-ID-Zeichenfolge (erforderlich bei Verwendung von team, assignees oder add_users)
"0d9bab85-a74f-4ece-9142-0f9b9f36ff92"
team
Team-ID-Zeichenfolge (entweder Team oder zugewiesene Personen sind für eigenständige Aufgaben erforderlich)
"0e24f298-965d-4475-9220-b32636a1e2c3"
zugewiesene Personen
Array von Zeichenketten mit Benutzer-IDs (für eigenständige Aufgaben ist entweder Team oder zugewiesene Personen erforderlich)
["1ce8117e-ae42-4304-b953-c81656da4bd1"]
due_at
Unix-Zeitstempel für das Fälligkeitsdatum der Aufgabe
1692371867
Unteraufgabe
Boolescher Wert, der angibt, ob dies eine Unteraufgabe einer Unterhaltung ist
true
conversation
Zeichenfolge für die ID der übergeordneten Unterhaltung (erforderlich, wenn Unteraufgabe wahr ist)
"a5d2aa1c-3828-4f90-bbd8-3dffaadda97e"
references
Array von Zeichenfolgen zum Finden oder Erstellen der übergeordneten Unterhaltung (wird beim Erstellen einer Unteraufgabe verwendet)
["<some-reference-123>"]
conversation_subject
Betreff für die übergeordnete Unterhaltung beim Erstellen über Verweise
„Neue Funktionsanfrage“
Nutzer hinzufügen
Array von Benutzer-IDs zum Hinzufügen zur übergeordneten Unterhaltung (nur für Unteraufgaben)
["74f91030-39b8-4627-9835-9cfbce9d67c1"]
Zum Posteingang hinzufügen
Verschiebe die übergeordnete Unterhaltung für alle mit Zugriff in den Posteingang (nur für Unteraufgaben)
true
Eine Aufgabe aktualisieren
PATCH /v1/tasks/:id
Aktualisiert die Attribute einer vorhandenen Aufgabe.
Parameter
title
Aufgabentitel (max. 1000 Zeichen)
„Aktualisierter Aufgabentitel“
description
Aufgabenbeschreibung (max. 10.000 Zeichen)
„Neue Beschreibung“
state
Aufgabenstatus. Einer der folgenden: todo, in_progress, Erledigt
"in_progress"
zugewiesene Personen
Array von Benutzer-ID-Strings
["1ce8117e-ae42-4304-b953-c81656da4bd1"]
team
Team-ID-Zeichenkette
"0e24f298-965d-4475-9220-b32636a1e2c3"
due_at
Unix-Zeitstempel für das Fälligkeitsdatum der Aufgabe
1692371867
title
Der Titel der Aufgabe, der in der Aufgabenliste und in den Aufgabendetails angezeigt wird. Maximal 1.000 Zeichen.
description
Eine längere Beschreibung der Aufgabe, die zusätzlichen Kontext oder Details bietet. Die Beschreibung unterstützt Nur-Text und ist auf 10.000 Zeichen begrenzt.
state
Der aktuelle Status der Aufgabe. Kann einer der folgenden sein:
todo- Aufgabe ist ausstehend und muss bearbeitet werdenin_progress- Aufgabe wird derzeit bearbeitetErledigt- Aufgabe wurde abgeschlossen oder erledigt
Wenn nicht angegeben, erhalten neue Aufgaben standardmäßig den todo Status.
Organisation
Die Organisations-ID ist erforderlich, wenn Sie Aufgaben Teams oder Nutzern über team, zugewiesene Personen, oder Nutzer hinzufügen Parameter zuweisen. Dadurch wird sichergestellt, dass die Aufgabe im richtigen Organisationskontext erstellt wird.
team
Für eigenständige Aufgaben (keine Unteraufgaben) muss entweder team oder zugewiesene Personen angegeben werden. Wenn ein Team zugewiesen wird, haben alle Teammitglieder Zugriff auf die Aufgabe und sie erscheint in der Aufgabenliste des Teams.
zugewiesene Personen
Für eigenständige Aufgaben (keine Unteraufgaben) muss entweder team oder zugewiesene Personen angegeben werden. Wenn Nutzern Aufgaben zugewiesen werden, sind sie für das Erledigen der Aufgabe verantwortlich und sie erscheinen in ihren persönlichen Aufgabenlisten.
due_at
Legt für die Aufgabe mithilfe eines Unix-Zeitstempels ein Fälligkeitsdatum fest. Die Aufgabe wird als überfällig markiert, wenn sie bis zu diesem Datum nicht erledigt ist. Das Festlegen dieses Felds ist optional.
Unteraufgabe
Wenn true, gibt an, dass diese Aufgabe als Unteraufgabe innerhalb einer Unterhaltung erstellt werden soll. Unteraufgaben benötigen entweder eine conversation ID oder references um die übergeordnete Unterhaltung zu identifizieren.
conversation
Erforderlich beim Erstellen einer Unteraufgabe (subtask: true). Gibt die ID der vorhandenen Unterhaltung an, in der die Unteraufgabe erstellt werden soll.
references
Eine Alternative zu conversation beim Erstellen von Unteraufgaben. Ermöglicht es Ihnen, die übergeordnete Unterhaltung anhand von Nachrichtenreferenzen (wie E-Mail-Message-IDs) zu finden oder zu erstellen. Wenn mehrere Unterhaltungen mit den Referenzen übereinstimmen, wird die Aufgabe in der ersten passenden Unterhaltung erstellt.
conversation_subject
Beim Erstellen einer Unteraufgabe mit references und eine neue Unterhaltung erstellt werden muss, legt dieses Feld den Betreff dieser neuen Unterhaltung fest.
Nutzer hinzufügen
Beim Erstellen von Unteraufgaben ermöglicht Ihnen dieser Parameter, der übergeordneten Unterhaltung weitere Nutzer hinzuzufügen. Diese Nutzer haben Zugriff sowohl auf die Unterhaltung als auch auf die Unteraufgabe. Der Organisation Parameter ist erforderlich, wenn Sie Nutzer hinzufügen.
Zum Posteingang hinzufügen
Beim Erstellen von Unteraufgaben übergeben Sie add_to_inbox: true um die übergeordnete Unterhaltung für alle mit Zugriff in den Posteingang zu verschieben. Ohne dies erscheint die Unterhaltung infolge der Aufgabenerstellung in niemandes Posteingang.
Hooks
Beispielverwendung: Lösen Sie Workflows in externen Systemen automatisch aus, wenn neue Nachrichten eintreffen oder Kommentare hinzugefügt werden.
Webhook erstellen
POST /v1/hooks
Erstellen Sie ein Webhook-Abonnement, um Benachrichtigungen für bestimmte Ereignisse in Missive zu erhalten. Dieser Endpoint ermöglicht Integrationen mit Diensten wie Zapier, n8n und anderen oder kann direkt für benutzerdefinierte Integrationen verwendet werden. Im Hintergrund erstellt dieser Endpoint eine Missive-Regel mit einer Webhook-Aktion - Sie können diese Regeln später in Ihren Missive-Einstellungen unter Regeln ansehen und bearbeiten, genauso wie jede andere Regel, die Sie manuell erstellen.
Parameter
type *
Zu abonnierender Ereignistyp. Unterstützte Werte: incoming_email, incoming_sms_message, incoming_facebook_message, incoming_whatsapp_message, incoming_twilio_chat_message, new_comment
url *
Die Webhook-URL, die die Benachrichtigungen zu den Ereignissen empfängt
Organisation
null
Organisations-ID. Wenn nicht angegeben, wird ein persönliches Webhook-Abonnement erstellt
content_contains
null
Nur auslösen, wenn der Inhalt diesen Text enthält
content_starts_with
null
Nur auslösen, wenn der Inhalt mit diesem Text beginnt
content_ends_with
null
Nur auslösen, wenn der Inhalt mit diesem Text endet
Nur für new_comment:
is_task
false
Nur bei Kommentaren zu Aufgaben auslösen
author
null
Nur bei Kommentaren dieser Nutzer-ID auslösen
mention
null
Nur auslösen, wenn diese Nutzer-ID erwähnt wird
Nur für incoming_email:
from_eq
null
Nur für Nachrichten von genau dieser E-Mail-Adresse auslösen
subject_contains
null
Nur für Nachrichten mit diesem Text im Betreff auslösen
Webhook löschen
DELETE /v1/hooks/:id
Löschen Sie ein Webhook-Abonnement. Im Hintergrund wird die Regel gelöscht, die die Webhook-Aktion enthält.
Zuletzt aktualisiert am 18. September 2025
Benötigen Sie genauere Antworten?\\
Zuletzt aktualisiert