Page tree
Skip to end of metadata
Go to start of metadata

API-Messages Klasse und deren Funktionen können nur mit TecArt-System Version >= 3.4 genutzt werden

1. Methods

1.1. write

Syntax:

boolean write(int $to_userid, string $message, int $ext_id = 0)

Beschreibung:

Sende eine Nachricht an einen Benutzer.

Gibt true beim Erfolg zurück. Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen.

to_userid 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:

<?php
 
try { 
    $crmapi_messages = crmapi::messages();
 
    // Send an message to user with ID 4:
    $result = $crmapi_messages->write(4, 'This is a test message to user ID 4');
 
    if ($result) {
		echo 'Message successfully sent';
	}
    else {
		echo 'Message send failed!';
	}
}
catch (CRMException $e) {
    echo $e->getMessage();
}



1.2. write_all

Syntax:

void write_all(string $message, int $from_userid = 0, int $ext_id = 0)

Beschreibung:

Sende eine Nachricht an alle aktiven Benutzern im System. Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen.

message ist der Inhalt der Nachricht.

Wenn from_userid gesetzt ist, wird die Nachricht von dem Benutzer gesendet. Wenn nicht wird die von den authentifizierten Benutzer gesendet.

Mittels ext_id kann eine Nachrichten-ID einer externen Anwendung gespeichert werden. Der Parameter ist optional. ( ab Version 4.2 )

Beispiel:

<?php
 
try { 
    $crmapi_messages = crmapi::messages();
 
    // Send an message to all users from an user with ID 4:
    $crmapi_messages->write_all('This is a test message to all from user ID 4', 4);
}
catch (CRMException $e) {
    echo $e->getMessage();
}



1.3. write_admins

Syntax:

void write_admins(string $message, int $from_userid = 0, int $ext_id = 0)

Beschreibung:

Sende eine Nachricht an alle aktiven Admin-Benutzern. Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen.

message ist der Inhalt der Nachricht.

Wenn from_userid gesetzt ist, wird die Nachricht von dem Benutzer gesendet. Wenn nicht wird die von den authentifizierten Benutzer gesendet.

Mittels ext_id kann eine Nachrichten-ID einer externen Anwendung gespeichert werden. Der Parameter ist optional. ( ab Version 4.2 )

Beispiel:

<?php
 
try { 
    $crmapi_messages = crmapi::messages();
 
    // Send an message to all users from an user with ID 4:
    $crmapi_messages->write_admins('This is a test message to admin from user ID 4', 4);
}
catch (CRMException $e) {
    echo $e->getMessage();
}



1.4. get_outgoing

Syntax:

array get_outgoing(int $timestamp, int $count = 0, int $offset = 0)

Beschreibung:

Gibt ein Array mit Nachrichten zurück, die seit timestamp von dem authentifizierten Benutzer gesendet wurden.

Ergebnis wird von count und offset limitiert, wenn die gesetzt werden.

Eigenschaft von zurückgegebenen Array:

Type(Length)EigenschaftBeschreibung
intuidfromBenutzer-ID des Absenders
intuidtoBenutzer-ID des Empfängers ( der authentifizierter Benutzer )
stringuserfromName des Absenders
stringusertoName des Empfängers ( der authentifizierter Benutzer )
stringmessageInhalt der Nachricht
intext_idExterne ID ( ab Version 4.2 )
intreadUnixtime des gelesen Zeitpunktes
intcreatetimeUnixtime des erstellten Zeitpunktes


Beispiel:

<?php
 
try { 
    $crmapi_messages = crmapi::messages();
 
    // Get all messages, which sent by authenticated user and since 11.06.2012 - 12:16:21
    $result = $crmapi_messages->get_outgoing(1339409781);
}
catch (CRMException $e) {
    echo $e->getMessage();
}
 
foreach ($result as $message) {
    foreach ($message as $key => $val) {
        echo $key. ' => '. $val .'';
    }
 
    echo '<br>';
}



1.5. get_incoming

Syntax:

array get_incoming(int $timestamp, int $count = 0, int $offset = 0)

Beschreibung:

Gibt ein Array mit Nachrichten zurück, die seit timestamp an den authentifizierten Benutzer gesendet wurden.

Ergebnis wird von count und offset limitiert, wenn die gesetzt werden.

Eigenschaft von zurückgegebenen Array:

die selben wie für get_outgoing

Beispiel:

<?php
 
try { 
    $crmapi_messages = crmapi::messages();
 
    // Get all messages, which sent to the authenticated user since 11.06.2012 - 12:16:21
    $result = $crmapi_messages->get_incoming(1339409781);
}
catch (CRMException $e) {
    echo $e->getMessage();
}
 
foreach ($result as $message) {
    foreach ($message as $key => $val) {
        echo $key. ' => '. $val .'';
    }
 
    echo '<br>';
}



1.6. get_thread

Syntax:

array get_thread(int $timestamp, int $count = 0, int $offset = 0)

Beschreibung:

Gibt ein Array mit Nachrichten zurück, die seit timestamp an oder von dem authentifizierten Benutzer gesendet wurden.

Ergebnis wird von count und offset limitiert, wenn die gesetzt werden.

Eigenschaft von zurückgegebenen Array:

die selben wie für get_outgoing

Beispiel:

<?php
 
try { 
    $crmapi_messages = crmapi::messages();
 
    // Get all messages of authenticated user since 11.06.2012 - 12:16:21
    $result = $crmapi_messages->get_thread(1339409781);
}
catch (CRMException $e) {
    echo $e->getMessage();
}
 
foreach ($result as $message) {
    foreach ($message as $key => $val) {
        echo $key. ' => '. $val .'';
    }
 
    echo '<br>';
}



1.7. getIdByExtId

(Version >= 4.2)

Syntax:

array getIdByExtId( string $external_id )

Beschreibung

Liefert interne ID(s) von Nachrichten mit der übergebenen externen ID zurück.

Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen.

Eigenschaften des zurückgegebenen message ids array:

Type(Length)            Eigenschaft                  Beschreibung
---------------------------------------------------------------------------------------------
int			$id			      Message-Id 

Beispiel:

<?php
 
try {   
    $crmapi_messages	= crmapi::messages();   
    $result				= $crmapi_messages->getIdByExtId(12345);
}
catch (CRMException $e) {
    echo $e->getMessage();
}
 
foreach($result as $id) {
   
    echo $id."<br>  ";
}



1.8. getAllExtIds

(Version >= 4.2)

Syntax:

array getAllExtIds()

Beschreibung

Liefert eine Liste aller externen IDs in Nachrichten zurück.

Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen.

Eigenschaften des zurückgegebenen message ids array:

Type(Length)            Eigenschaft                  Beschreibung
---------------------------------------------------------------------------------------------
int			            $id			                 externe Message-Id 

Beispiel:

<?php
 
try {   
    $crmapi_messages	= crmapi::messages();   
    $result				= $crmapi_messages->getAllExtIds();
}
catch (CRMException $e) {
    echo $e->getMessage();
}
 
foreach($result as $id) {   
    echo $id."<br>  ";
}
  • No labels