Integration

Einleitung

BSG API koppelt Ihre Webseite oder Ihren App mit den Mobileanbieter in der ganzen Welt. Es werden XML-Dateien an einen Server gesendet (Beschreibung von XML-Dateien und deren Einsetzung sind unten angeführt) und dabei wird eine POST-Methode angewendet.
Titelzeile haben folgende Dateien zu enthalten:
Content-type: text/xml; charset=utf-8

Das Kodieren von XML Dateien UTF-8

SMS Versand

Notwendige Parameter:

Parameter Beschreibung
login value Login im System
password value Password im System
type Immer gleichwert “sms”
phone Mobilenummer an die SMS verschickt wird
client_id_sms ID SMS von Partner. Wenn im System eine gleiche SMS mit dem gleichen client_id_sms geben sollte, dann wird SMS nicht verschickt
number_sms Notwendige Parameter, Positionsnummer des Nutzer in einem XML Datei

Beispiel für das Absenden:
Url: http://app.bsg.hk/xml

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

<request>
<message type = „sms“>
<sender> sender </ sender>
<text> sms text </ text>
<abonent phone = „380631231233“ client_id_sms = „3431“ number_sms = „1“ />
<abonent phone = „380633213211“ client_id_sms = „3425“ number_sms = „2“ />
</ message>
<security>
<login value = „login“ />
<password value = „password“ />
</ security>
</ request>

Es kann eine von den unten angeführten XML-Dateien ergeben:

Im Falle einer aufgetretenen Fehler in der XML-Datei:

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

<? xml version = „1.0“ encoding = „utf-8“?>
<response>
< error> error </ error>
</ response>

error – Textfehler kann mit folgenden Angaben auftreten:

  • Falscher Format von XML Datei
  • Ihr Account ist gesperrt
  • Falscher Login oder Passwort
  • Keine POST-Dateien

Im Falle einer richtigen XML-Datei:

 

<? xml version = „1.0“ encoding = „utf-8“?>
<response>
<information number_sms = „1“ id_sms = „366“ id_turn = „1428476741“ parts = „1“> send </ information>
<information number_sms = „2“ id_sms = „367“ id_turn = „1428476741“ parts = „1“> send </ information>
</ response>

Parameter Beschreibung
number_sms Positionsnummer von SMS in einer XML-Ausgangsdatei
id_sms ID einer SMS. Wird für die Zustellungsberichte angewendet. Wenn es während des Absenden ein Fehler auftritt, dann bleibt id_sms leer.
id_turn ID Reihenfolge des Absenden
parts Teilmenge der SMS
information SMS-Status («send»), wenn eine SMS abgeschickt worden

Statusanfrage der SMS

Notwendige Parameter:

Parameter Beschreibung
login value Login im System
password value Passwort im System

Beispiel:

Url: http://app.bsg.hk/xml/stat


<? xml version = "1.0" encoding = "utf-8"?>
<request>
<get_state>
<id_sms> 202 </ id_sms>
<id_sms> 203 </ id_sms>
<id_sms> 204 </ id_sms>
</ get_state>
<security>
<login value = "login" />
<password value = "password" />
</ security>
</ request>

Im Falle einer auftretenden Fehler in der zugesendeten XML-Datei:


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

error – Textfehler kann mit folgenden Angaben auftreten:

  1. Falscher Format von XML Datei
  2. Ihr Account ist gesperrt
  3. Falscher Login oder Passwort
  4. Keine POST-Dateien

Beispiel einer Rückmeldung, wenn kein Fehler aufgetreten ist:


<? xml version = "1.0" encoding = "utf-8"?>
<response>
<state raw_value = "0" id_sms = "202" time = "">partly_deliver</state>
<state raw_value = "0" id_sms = "203" time = "">partly_deliver</state>
</response>

partly_deliver
partly_deliver

Parameter Beschreibung
raw_value SMS-Status mit einer Definition SMPP 3.4
id_sms ID SMS
time Statuszeit. In manchen Fällen kann leer sein
state Berichtstatus

  1. «send» – Berichtstatus ist nicht eingegangen. In dem Fall bleibt leer time (time=““).
  2. «not_deliver» – SMS wurde nicht zugestellt. Endstatus (mit der Zeit wird nicht geändert).
  3. «expired» – Der Mobilenutzer war nicht im Netz, als der Zustellungsversuch stattfand (mit der Zeit wird nicht geändert).
  4. «deliver» – Nachricht ist zugestellt worden. Endstatus (mit der Zeit wird nicht geändert).
  5. «partly_deliver» – Nachricht ist abgesendet worden, aber Berichtstatus ist nicht eingegangen. In dem Fall, man sollte sich mit dem Support in Verbindung setzen.

Abruf des Kontoguthabens

Notwendige Parameter:

Parameter Beschreibung
login value Login im System
password value Passwort im System

Beispiel:

Url: http://app.bsg.hk/xml/balance

XML-Datei:


<? xml version = "1.0" encoding = "utf-8"?>
<request>
<security>
<login value = "username" />
<password value = "password" />
</ security>
</ request>

Es kann eine von den unten angeführten XML-Dateien ergeben:

Im Falle einer aufgetretenen Fehler in der XML-Datei:


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

error – Textfehler kann mit folgenden Angaben auftreten:

  • Falscher Format von XML Datei
  • Falscher Format von XML Datei
  • Keine POST-Dateien

Im Falle einer richtigen XML-Datei:


<? xml version = "1.0" encoding = "utf-8"?>
<response>
<money> 150 </ money>
</ response>>

Parameter Beschreibung
Geld Fondsguthaben

Statusabruf einer Mobilenummer:

Notwendige Parameter:

Parameter Beschreibung
login value Login im System
password value Passwort im System
phone Handynummer

Beispliel:

Url: http://app.bsg.hk/xml/def

XML-Datei:


<? xml version = "1.0" encoding = "utf-8"?>
<request>
<security>
<login value = "username" />
<password value = "password" />
</ security>
<phones>
<phone> 79612242243 </ phone>
<phone> 79612242244 </ phone>
</ phones>
</ request>

 

Bei einer Rückmeldung kann einer der unten angeführten XML-Dateien eingeblendet werden:

Im Falle eines Fehler in der abgesendeten XML-Datei:


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

error– Textfehler kann mit folgenden Angaben auftreten:

  • Falscher Format von XML Datei
  • Falscher Format von XML Datei
  • Keine POST-Dateien

Im Falle einer richtigen XML-Datei:


<? xml version = "1.0" encoding = "utf-8"?>
<response>
<phone operator = "beeline" country = "ru"> 79612242243 </ phone>
<phone operator = "beeline" country = "ru"> 79612242244 </ phone>
</ response>

Parameter Beschreibung
operator Mobilefunkanbieter
country Zweibuchstabige Ländercode
phone Handynummer

Einleitung

BSG API koppelt Ihre Webseite oder Ihren App mit den Mobileanbieter in der ganzen welt. HTTP- Bericht für die Übertragung des Hypertextes, der in sich eine Titelzeile und ein Abrufkern hat, die mit einer leeren Zeile abgetrennt.
Abrufkern kann leer sein. Ein Durchgang in diesem Bericht wird anhand einer durchprogrammierten TCP – Anbindung mit dem Server und eine Abgabe des HTTP-Abrufes durchgeführt.
Nach dem Bearbeiten dieses Abrufes bekommt der Kunde eine HTTP-Rückmeldung. Meistens wird ein GET-Verfahren für den HTTP-Befehl angewendet. Nämlich GET-Abrufe werden für das Einsenden und Empfangen von SMS angewendet.
Dateien werden an die folgende Webadresse abgeschickt. http://app.bsg.hk/sendsms

SMS Versand

Es werden nächste Variable angewendet:

user Benutzer
pwd Passwort
sadr Absenderadresse
text SMS Text
dadr Empfängeradresse (mehrere Adressen durch Komma getrennt)

Als eine Rückmeldung wird ID SMS angezeigt (wenn es mehrere Telefonnummer durch Komma angegeben worden, so werden ID bei einer Rückmeldung auch durch Kommas ankommen)

http://app.bsg.hk/sendsms?
user=логин&pwd=пароль&sadr=tот

правитель&dadr=номер_абонента&t

ext=Nachrichtentext

Beispiel an PHP:
$login = ‘xxxxx‘;
$password = ‘xxxxxx‘;
$srcaddr = urlencode(‘alphaname’);
$text = urlencode(‘SMS Text’);
$num = ‘Mobilenummer des Empfänger‘;
$ch = curl_init();
$data = ‘http://app.bsg.hk/sendsms?
user=’.$login.’&pwd=’.
$password.’&sadr=’.$srcaddr.’&text=’.
$text.’&dadr=’.$num;
$urlData = urlencode( $data );
curl_setopt( $ch, CURLOPT_URL, $data );
curl_setopt( $ch,
CURLOPT_RETURNTRANSFER, true );
$out = curl_exec( $ch );
echo $out;
curl_close( $ch );

Statusüberprüfung

Es werden nächste Variable angewendet:

user Benutzer
pwd Password
smsid ID SMS

Bei einer Rückmeldung werden nächste Abrufstatus angezeigt:

  • deliver (Zugestellt)
  • not_deliver (nicht Zugestellt);
  • expired (ungültig);

Abrufstatus kann leer sein, wenn eine Nachricht noch bei einem Wartevorgang ist.

Fehler

Zulässige Fehler während des Abrufes

invalid_login_passw ord falscher Login oder Password
account_blocked Account ist gesperrt
invalid_request falscher Abruf (z.B. fehlender Parameter)