Webservice msg

• WSDL Datei

Die zur Nutzung der infra-struktur Message Webservices notwendige WSDL-Datei finden Sie unter:

http://instanzname.infra-struktur.de/webservice/wsdl/wsdl.php?message

Beachten Sie, dass der Webserver für die Verwendung der Webservices Schreibrechte auf das Verzeichnis „WEBROOT/webservice/wsdl“ benötigt.

• Example

Diese in PHP geschrieben Beispielapplikation dient als leichter Einstieg in die infra-struktur Webservices

  <?php
  //Einen neuen SoapClient erstellen und Verbindung mit der infra-struktur WSDL Datei aufnehmen
  $client = new SoapClient("http://instanzname.infra-struktur.de/webservice/wsdl/wsdl.php?ido",array('exceptions'=>false));
  
  //Authentifizierung am Webservice mit den infra-struktur Benutzerdaten
  $token = $client->__soapCall("authenticate",array("http://instanzname.infra-struktur.de","benutzername","passwort"));
  
  //Der User mit der ID1 schickt eine Message an den User mit der ID2
  $MessageID = $client->__soapCall("createNewMessage",array(1,"Das ist ein Test",array(2),null,$token));
  ?>

• Funktionsübersicht

Authenticate

Authentifiziert einen Benutzer am Webservice

Parameter	Datentyp	Beschreibung
instanceName	String	Vollständiger Pfad der Instanz
userName	String	infra-struktur Benutzername
password	String	infra-struktur Passwort
Rückgabewert
token	String	Authentifizierungstoken für weitere Anfragen am Webservice

getMessageReadStatus

Liefert den gelesen-Status der Message zurück

Parameter	Datentyp	Beschreibung
MessageID	String	ID der Message
ReceiverID	Integer	UserID des Empfängers
Token	String	Authentifizierungstoken
Rückgabewert
Status	Boolean	Gelesen oder nicht

setMessageReadStatus

Markiert eine Message als gelesen

Parameter	Datentyp	Beschreibung
MessageID	Integer	ID der Message
ReceiverID	Integer	UserID des Benutzers
ReadStatus	Boolean	Boolean
Token	String	Authentifizierungstoken

createNewMessage

Erstellt und versendet eine Message

Parameter	Datentyp	Beschreibung
SenderID	Integer	UserID des Absenders
MessageText	String	Text der Message
ReceiverIDArray	Array	UserIDs der Empfänger
MessageSendTime	Integer	Timestamp des Sendezeitpunkts (default: aktuelle Zeit)
Token	String	Authentifizierungstoken
Rückgabewert
MessageID	Integer	ID der gesendeten Message

Hauptkapitel

• Webservice Dokumentation

Verwandte Themen

• Webservice_calendar
• Webservice_contacts
• Webservice_dms
• Webservice_ido
• Webservice_msg
• Webservice_user