Import von SIP Benutzern und SIP Credentials mit XML

Copyright (c) 2005-2017 by Global IP Telecommunications | Phone +49 6445 2799710
Vorheriges Thema  Nächstes Thema 

Das Interface erlaubt den automatischen Import von SIP Benutzern und SIP Benutzerdaten per XML Schnittstelle (ab Version 2016.6.1 Build 22614).


Mittels HTTP POST senden Sie ein einfach strukturiertes XML an die Domain oder an die IP Adresse des Enterprise Provisionierungsservers.


Testseite zum Upload einer XML-Datei:

https://<;Ihre Domain>/ninjaautoprovwebservice/sendAccounts.aspx


Diese Seite erlaubt zu Testzwecken den Datenimport mit einer erstellten XML Datei.  Die Daten werden "real" importiert. Legen Sie dazu vorzugsweise ein Testschema an oder löschen ggf. die zu Testzwecken importierten Daten über die Enterprise Webmanagement Oberfläche.


HTTP POST Service URL für den LIVE Betrieb:

https://<;Ihre Domain>//ninjaautoprov/services.aspx?import_crm_accounts



Beispielaufbau eines XML Post:


<?xml version="1.0" encoding="utf-8" ?>

<Provisioning>

  <Tasks>

    <Task Type="3011" Description="Insert accounts">


      <Agents>

        <Agent>


          <LastModified>2016-06-22T16:26:00</LastModified>

          <SchemeGUID>12345eaeeaeeaeeae5103845e9dc2f7f</SchemeGUID>

          <GroupGUID></GroupGUID>

          <Active>0</Active>

          <CRMAgentGUID>5qvvjx8gb0pdhewr5zj3ea6z8kr4mjcf</CRMAgentGUID>

          <CRMSecurityToken><![CDATA[JP^*%$iQG!MnNvhPP!mhnFW&l%3LdlnN]]></CRMSecurityToken>

          <FirstName>Hlima</FirstName>

          <LastName>Saboundji</LastName>

          <PCProvisioningCriteria>1</PCProvisioningCriteria>

          <PCProvisioningAuth>PC-1025</PCProvisioningAuth>

          <IntUsername>HablaScan1025</IntUsername>

          <IntPassword><![CDATA[JNy@hB@TteYrv!db]]></IntPassword>

          <CostUnit></CostUnit>


          <SipAccounts>


            <SipAccount>


              <Index>0</Index>

              <DisplayName>Phillipa Bertger</DisplayName>

              <Username>112</Username>

              <Password><![CDATA[f&I8o1!BM&%FNUzy]]></Password>

              <AuthUsername>112</AuthUsername>


            </SipAccount>


            <SipAccount>


              <Index>1</Index>

              <DisplayName>Phillipa</DisplayName>

              <Username>355</Username>

              <Password><![CDATA[c5238v765sd]]></Password>

              <AuthUsername>355</AuthUsername>


            </SipAccount>


          </SipAccounts>

        </Agent>

       </Agents>

    </Task>

  </Tasks>

</Provisioning>



Der XML Header sowie die XML Elemente <Provisioning>, <Tasks> und <Task> sind feststehend. Individuelle Änderungen sind im Element <Agents> möglich, dass einzelne Attribute und Werte im Element <Agent> für Benutzerdaten umschließt. <Agent> umfasst Detailinformationen zu einem Benutzer inklusive dessen SIP Konten <SipAccounts><SipAccount>.




Benutzerattribute <Agent>


Definition und Erklärung der Attribute und Werte des XML Element <Agent>.

Attribut

Beschreibung

Format

LastModified

Zeitpunkt der letzten Modifikation. Jüngere als in der Provisioningdatenbank hinterlegte Datensätze werden mit den neueren Daten ersetzt (Format: 2016-06-22T16:26:00).

Date

SchemeGUID

GUID des Schemas an das die Daten übermittelt werden sollen (GUI kann im jeweiligen Schema abgerufen werden).

String
(32)

GroupGUID

GUID der angelegten Benutzergruppe innerhalb eines Konfigurationsschemas. Bei fehlendem Attribut der Benutzer in die Hauptgruppe gelegt (GUI kann in der jeweiligen Gruppe des Schema abgerufen werden).

String
(32)

Active

Kennzeichnet einen Benutzer mit 1 als aktiv, mit 0 inaktiv.

Integer
(0|1)

CRMAgentGUID

Eigene "unique GUID" z.B. aus 3rd Party CRM/ERP Anwendung

String
(32)

CRMAgentSecurityToken

Eigener "unique Security TOKEN" für ActionURL Aufrufe um ggf. damit gültige Sessions zu deklarieren - ActionURL aktuell noch nicht verfügbar

String
(32)

Firstname

Vorname des Benutzers

String
(127)

Lastname

Nachname des Benutzers

String
(127)

PCProvisioningCriteria

Deklaration des Authentifizierungsmerkmals anhand dessen ein Benutzer erkannt werden soll.

0 = Deaktiviert

1 = Windows Benutzername

2 = Windows Arbeitsgruppenbezeichnung

3 = Windows Domain

4 = Windows Computername

5 = IP Addresse des Computers

Integer
(0-5)

PCProvisioningAUTH

Wert des zu überprüfenden Kriteriums, z.B: IP

String
(255)

IntUsername

"Over the TOP" Authentifizierung die mittels Anmeldedialog beim Telefonstart erfragt wird, z.B. "Annemarie"

String
(255)

IntPassword

Kennwort für die "Over the TOP" Authentifizierung.

String
(255)

CostUnit

Wert zur Angabe einer Kostenstellen - wird nur projektbasierend genutzt.

String
(255)




Benutzerattribute <SipAccount>


Definition und Erklärung der Attribute und Werte des XML Element <SIPAccount>.

Funktion

Beschreibung


Index

Es können insgesamt 10 SIP Konten unter Angabe eines Zahlenwertes zwischen 0 und 9 eingerichtet werden.

Integer

DisplayName

Angezeigte Bezeichnung im Telefondisplay (üblicherweise frei wählbar)

String

Username

SIP Benutzername (siehe SIP Credential Vorgaben)


Password

SIP Kennwort (siehe SIP Credential Vorgaben)

String

AuthUsername

SIP AUTH Benutzername für zusätzliche Sicherheitsüberprüfung über den Standardbenutzernamen hinaus (wenn SIP Anlage es fordert)

String



Beispielaufbau des RESPONSE zu einem XML Post: 


Das RESPONSE umfasst die Anzahl der erfolgreichen Importvorgänge (Gruppen, Accounts, SIP Accounts).


<?xml version="1.0" encoding="utf-16"?>

<XmlAccountsImporter_Response xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

    <CountInsertsGroups>0</CountInsertsGroups>

    <CountInsertsAccounts>2</CountInsertsAccounts>

    <CountInsertsAccountCredentials>3</CountInsertsAccountCredentials>

    <Exceptions />

    <Skips />

</XmlAccountsImporter_Response>


Systemfehler und fehlgeschlagene Importvorgänge werden in den Elementen <Exceptions> und <Skips> dargestellt. Exception sind grundliegende Fehler im Aufbau oder an der Serviceschnittstelle. Skips definieren Fehler die durch angegebene Attributwerte ausgelöst werden.



Mögliche Fehlermeldungen in der Rückgabe


Code

Meldung

Beschreibung

500

InternalServerError

Serverfehler an der Serviceschnittstelle

1011

ReadXmlException

Fehler in der XML Struktur

2001

EmptySchemeGUID

Schemen GUID ist fehlt

3011

SchemeNotFound

Schema kann nicht gefunden werden

3013

GroupNotFound

Gruppe nicht gefunden (Zuweisung in Hauptgruppe wenn das Attribut enthalten aber ohne Wert ist)




Mögliche Verarbeitungsfehler in der Rückgabe


Code

Meldung

Beschreibung

2011

TimeStampSkip

Agent wird nicht übernommen, weil das angegebene LastModification Datum <RoboTimeStamp> jünger ist oder dem gleichen Datum entspricht das bereits in der Datenbank hinterlegten wurde.

9013

CRMAgentGUID_Empty

CRMAgentGUID enthält keinen Wert

9015

CRMAgentGUID_ValueTooLong

CRMAgentGUID ist zu lang (max. 32 Zeichen)

9017

CRMSecurityToken_ValueTooLong

CRMSecurityToken ist zu lange (max. 32 Zeichen)

9021

Firstname_ValueTooLong

Wert ist zu lang (max. 127 Zeichen)

9023

Lastname_ValueTooLong

Wert ist zu lang (max. 127 Zeichen)

9025

IntUsername_ValueTooLong

Wert ist zu lang (max. 255 Zeichen)

9027

IntPassword_ValueTooLong

Wert ist zu lang (max. 255 Zeichen)

9041

SipAccountIndex_Value_shoul_be_between_0_and_9

Der angegebene SIP Account Index muss zwischen 0 und 9 liegen

9043

SipAccount_DisplayName_ValueTooLong

Wert ist zu lang (max. 255 Zeichen)

9045

SipAccount_Username_ValueTooLong

Wert ist zu lang (max. 255 Zeichen)

9047

SipAccount_AuthUsername_ValueTooLong

Wert ist zu lang (max. 255 Zeichen)

9049

SipAccount_Password_ValueTooLong

Wert ist zu lang (max. 255 Zeichen)