Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

Beide Seiten der vorigen Revision Vorhergehende Überarbeitung
webservices:soap_webservices:messages [2017/02/07 17:03]
127.0.0.1 Externe Bearbeitung
webservices:soap_webservices:messages [2020/05/06 14:08] (aktuell)
d0dge
Zeile 1: Zeile 1:
 ====== Messages ====== ====== Messages ======
  
- +Bitte besuchen Sie unsere neue Entwickler-Dokumentation unter [[https://docs.tecart.de/display/public/WIKI/Messages+SOAP]]
- +
-===== WSDL-URI ====== +
- +
- +
-<​code>​http://​hostname/​dirname/​soap/​index.php?​op=messages&​wsdl</​code>​ +
- +
-z.B. [[https://test.tecart-system.de/soap/index.php?​op=messages&​wsdl|https:​//test.tecart-system.de/​soap/​index.php?​op=messages&​wsdl]] +
- +
- +
-===== Hinweis ====== +
- +
- +
-SOAP-Messages Klasse und deren Funktionen können nur mit der TecArt-System Version >= **3.4** genutzt werden +
- +
- +
-===== Methoden ====== +
- +
- +
- +
-==== crmWrite ===== +
- +
-**Syntax**:​ +
-  int crmWrite( string $session_id,​ int $to, string $message, int $ext_id ) +
- +
-**Beschreibung**:​ +
- +
-Sende eine Nachricht an einen Benutzer. +
- +
- +
-Gibt //1// beim Erfolg zurück. +
- +
- +
-//to// ist der Benutzer-ID,​ an den die Nachricht gesendet wird. +
- +
- +
-//message// ist der Inhalt der Nachricht. +
- +
- +
-Mittels ext_id kann eine Nachrichten-ID einer externen Anwendung gespeichert werden. Der Parameter ist optional. ( ab Version 4.2 ) +
- +
- +
-**Beispiel**:​ +
-<sxh php> +
- +
-<?php +
- +
-ini_set("​soap.wsdl_cache_enabled",​ "​0"​);​ +
- +
-try { +
-  $client_logon = new SOAPClient("​https://​test.tecart-system.de/​soap/​index.php?​op=logon&​wsdl"​);​ +
-     ​$session_id = $client_logon->​crmLogin('​test',​ '​test'​);​ +
-     if (!$session_id) die("​invalid login"​);​ +
- +
-   ​$client_messages = new SOAPClient("​https://​test.tecart-system.de/​soap/​index.php?​op=messages&​wsdl"​);​ +
- +
-   // Send an message to user with ID 4: +
-   ​$result = $client_messages->​crmWrite($session_id,​ 4, 'This is a test message to user ID 4'); +
- +
-   if ($result == 1)  echo '​Message successfully sent';​ +
-   ​else ​              echo '​Message send failed!';​ +
-+
-catch (SOAPFault $f) { +
-  print $f->​faultstring;​ +
-+
- +
-?> +
- +
-</​sxh>​ +
- +
----- +
- +
- +
-==== crmWriteAll ===== +
- +
-**Syntax**:​ +
-  int crmWriteAll( string $session_id,​ string $message, int $ext_id ) +
- +
-**Beschreibung**:​ +
- +
-Sende eine Nachricht an alle aktiven Benutzern im System. +
- +
- +
-Gibt //1// beim Erfolg zurück. +
- +
- +
-//message// ist der Inhalt der Nachricht. +
- +
- +
-Mittels ext_id kann eine Nachrichten-ID einer externen Anwendung gespeichert werden. Der Parameter ist optional. ( ab Version 4.2 ) +
- +
- +
-**Beispiel**:​ +
-<sxh php> +
- +
-<?php +
- +
-ini_set("​soap.wsdl_cache_enabled",​ "​0"​);​ +
- +
-try { +
- +
-   // Send an message to user with ID 4: +
-   ​$result = $client_messages->​crmWriteAll($session_id,​ 'This is a test message to all'​);​ +
- +
-   if ($result == 1)  echo '​Message successfully sent';​ +
-   ​else ​              echo '​Message send failed!';​ +
-+
-catch (SOAPFault $f) { +
-  print $f->​faultstring;​ +
-+
- +
-?> +
- +
-</​sxh>​ +
- +
----- +
- +
- +
-==== crmWriteAdmins ===== +
- +
-**Syntax**:​ +
-  int crmWriteAdmins( string $session_id,​ string $message, int $ext_id = 0 ) +
- +
-**Beschreibung**:​ +
- +
-Sende eine Nachricht an alle aktiven Admin-Benutzern. +
- +
- +
-Gibt //1// beim Erfolg zurück. +
- +
- +
-//message// ist der Inhalt der Nachricht. +
- +
- +
-Mittels ext_id kann eine Nachrichten-ID einer externen Anwendung gespeichert werden. Der Parameter ist optional. ( ab Version 4.2 ) +
- +
- +
-**Beispiel**:​ +
-<sxh php> +
- +
-<?php +
- +
-ini_set("​soap.wsdl_cache_enabled",​ "​0"​);​ +
- +
-try { +
- +
-   // Send an message to user with ID 4: +
-   ​$result = $client_messages->​crmWriteAdmins($session_id,​ 'This is a test message to all admins'​);​ +
- +
-   if ($result == 1)  echo '​Message successfully sent';​ +
-   ​else ​              echo '​Message send failed!';​ +
-+
-catch (SOAPFault $f) { +
-  print $f->​faultstring;​ +
-+
- +
-?> +
- +
-</​sxh>​ +
- +
----- +
- +
- +
-==== crmgetOutgoing ===== +
- +
-**Syntax**:​ +
-  array crmgetOutgoing( array(string $session_id,​ int $timestamp, int $count, int $offset) ) +
- +
-**Beschreibung**:​ +
- +
-Gibt ein Array mit Nachricht-Objekten zurück, die seit //​timestamp//​ von dem authentifizierten Benutzer ​ gesendet wurden. +
- +
- +
-Ergebnis wird von //count// und //offset// limitiert. +
- +
- +
-**Eigenschaften**:​ +
- +
-^ Type(Length)^ Eigenschaft^ Beschreibung | +
-| int| uidfrom| Benutzer-ID des Absenders | +
-| int| uidto| Benutzer-ID des Empfängers ( der authentifizierter Benutzer ) | +
-| string| userfrom| Name des Absenders | +
-| string| userto| Name des Empfängers ( der authentifizierter Benutzer ) | +
-| string| message| Inhalt der Nachricht | +
-| int| ext_id| Externe ID ( ab Version 4.2 ) | +
-| int| read| Unixtime des //gelesen// Zeitpunktes | +
-| int| createtime| Unixtime des //​erstellten//​ Zeitpunktes | +
- +
- +
-**Beispiel**:​ +
-<sxh php> +
- +
-<?php +
- +
-ini_set("​soap.wsdl_cache_enabled",​ "​0"​);​ +
- +
-try { +
-  // Get all messages, which sent by authenticated user and since 11.06.2012 - 12:16:21 +
-     ​$result = $client_messages->​crmgetOutgoing( array('​session_id'​ => $session_id,​ '​timestamp'​ => 1339409781, '​count'​ => 0, '​offset'​ => 0) ); +
- +
-   ​foreach ($result as $message) { +
-       ​foreach ($message as $key => $val) { +
-           echo $key. ' => '. $val .' +
-'; +
-       } +
- +
-       echo ' +
- +
-'; +
-   } +
-+
-catch (SOAPFault $f) { +
-  print $f->​faultstring;​ +
-+
- +
-?> +
- +
-</​sxh>​ +
--------- +
- +
- +
-==== crmgetIncoming ===== +
- +
-**Syntax**:​ +
-  array crmgetIncoming( array(string $session_id,​ int $timestamp, int $count, int $offset) ) +
- +
-**Beschreibung**:​ +
- +
-Gibt ein Array mit Nachricht-Objekten zurück, die seit //​timestamp//​ an den authentifizierten Benutzer ​ gesendet wurden. +
- +
- +
-Ergebnis wird von //count// und //offset// limitiert. +
- +
- +
-**Eigenschaften**:​ +
- +
-die selben wie für **[[#​crmgetOutgoing]]** +
- +
-**Beispiel**:​ +
-<sxh php> +
- +
-<?php +
- +
-try { +
- +
-   // Get all messages, which sent to authenticated user and since 11.06.2012 - 12:16:21 +
-   ​$result = $client_messages->​crmgetIncoming( array('​session_id'​ => $session_id,​ '​timestamp'​ => 1339409781, '​count'​ => 0, '​offset'​ => 0) ); +
- +
-   ​foreach ($result as $message) { +
-       ​foreach ($message as $key => $val) { +
-           echo $key. ' => '. $val .' +
-'; +
-       } +
- +
-       echo ' +
- +
-'; +
-   } +
-+
-catch (SOAPFault $f) { +
-  print $f->​faultstring;​ +
-+
- +
-?> +
- +
-</​sxh>​ +
--------- +
- +
- +
-==== crmgetThread ===== +
- +
-**Syntax**:​ +
-  array crmgetThread( array(string $session_id,​ int $timestamp, int $count, int $offset) ) +
- +
-**Beschreibung**:​ +
- +
-Gibt ein Array mit Nachricht-Objekten zurück, die seit //​timestamp//​ an oder von dem authentifizierten Benutzer ​ gesendet wurden. +
- +
- +
-Ergebnis wird von //count// und //offset// limitiert. +
- +
- +
-message ist der Inhalt der Nachricht. +
- +
-crmgetThread ein Array mit Nachricht-Objekten zurück, die seit //​timestamp//​ an den authentifizierten Benutzer ​ gesendet wurden. +
- +
- +
-Ergebnis wird von //count// und //offset// limitiert. +
- +
- +
-**Eigenschaften**:​ +
- +
-die selben wie für **[[#​crmgetOutgoing]]** +
- +
-**Beispiel**:​ +
-<sxh php> +
- +
-<?php +
- +
-try { +
- +
-   // Get all messages, which sent to or sent from the authenticated user and since 11.06.2012 - 12:16:21 +
-   ​$result = $client_messages->​crmgetThread( array('​session_id'​ => $session_id,​ '​timestamp'​ => 1339409781, '​count'​ => 0, '​offset'​ => 0) ); +
- +
-   ​foreach ($result as $message) { +
-       ​foreach ($message as $key => $val) { +
-           echo $key. ' => '. $val .' +
-'; +
-       } +
- +
-       echo ' +
- +
-'; +
-   } +
-+
-catch (SOAPFault $f) { +
-  print $f->​faultstring;​ +
-+
- +
-?> +
- +
-</​sxh>​ +
- +
--------- +
- +
- +
-==== crmgetIdByExtId ===== +
- +
- +
-(Version >= 4.2) +
- +
-**Syntax:​** +
- +
- array crmgetIdByExtId( string $session_id,​ string $external_id )   +
- +
-**Beschreibung** +
- +
-Liefert interne ID(s) von Nachrichten mit der übergebenen externen ID zurück. +
- +
- +
-**Eigenschaften der zurückgegebenen ****//​message Objekte//​**:​ +
-   +
-  Type(Length) ​           Eigenschaft ​                 Beschreibung +
-  --------------------------------------------------------------------------------------------- +
-  int $id  ​     Message-Id +
- +
- +
-**Beispiel:​** +
-<sxh php> +
- +
-<?php +
- +
-try { +
-  $result = $client_messages->​crmgetIdByExtId($session_id,​ 12345); +
-+
-catch (SOAPFault $f) { +
-  print $f->​faultstring;​ +
-+
- +
-foreach($result as $id) { +
-   +
-     echo $id."<​br> ​ "; +
-+
- +
-?> +
- +
-</​sxh>​ +
- +
-------- +
- +
- +
-==== crmgetAllExtIds ===== +
- +
- +
-(Version >= 4.2) +
- +
-**Syntax:​** +
- +
- array crmgetAllExtIds( string $session_id )   +
- +
-**Beschreibung** +
- +
-Liefert eine Liste aller externen IDs in Nachrichten zurück. +
- +
- +
-**Eigenschaften der zurückgegebenen ****//​message Objekte//​**:​ +
-   +
-  Type(Length) ​           Eigenschaft ​                 Beschreibung +
-  --------------------------------------------------------------------------------------------- +
-  int $id  ​     externe Message-Id +
- +
- +
-**Beispiel:​** +
-<sxh php> +
- +
-<?php +
- +
-try {  +
-  $result = $client_messages->​crmgetAllExtIds($session_id);​ +
-+
-catch (SOAPFault $f) { +
-  print $f->​faultstring;​ +
-+
- +
-foreach($result as $id) { +
-   +
-     echo $id."<​br> ​ "; +
-+
- +
-?> +
- +
-</​sxh>​ +
- +
-------- +