DOKUMENTACJA IMPLEMENTACJI MECHANIZMÓW OBSŁUGI AHMES SMS (soap) 2013-03-24



Podobne dokumenty
DOKUMENTACJA IMPLEMENTACJI MECHANIZMÓW OBSŁUGI AHMES SMS (html)

Dokumentacja API. SOAP - webservice v

3S TeleCloud - Aplikacje Instrukcja użytkowania usługi 3S SMS SYSTEM

Dokumentacja smsapi wersja 1.4

Specyfikacja HTTP API. Wersja 1.6

OPIS TECHNICZNY SYSTEM HOSTED SMS

Funkcje dodatkowe. Wersja 1.2.1

Baza numerów Wersja 1.1

Spis treści 1. Założenia ogólne 2. Wymagania 3. Typy SMSów 4. Statusy SMSów 5. Wysyłanie SMSów - Web API 6. Wysyłanie SMSów - 7.

Dokumentacja interfejsu HTTPD. Platforma BSMS.PL Instrukcja podłączenia po przez http

Aktualizacja SMSFall v Data publikacji:

Funkcje dodatkowe. Wersja 1.2.1

Specyfikacja sms-api.pl

apaczka Webservice API

Dokumentacja techniczna API systemu SimPay.pl

1. Wstęp 2. Adres usługi 3. Konfiguracja 4. Metody 5. Typy danych 6. Przykład wywołania metody przy użyciu php i biblioteki nusoap 7.

INSTRUKCJA OBSŁUGI APLIKACJI WEBFAX DLA UŻYTKOWNIKA

Dokumentacja interfejsu Webservices API. Wersja 2.0 [12 stycznia 2014]

INSTRUKCJA AKTYWACJI I OBSŁUGI BRAMKI SMS DLA FIRM. (Bramka SMS dla małych Firm, Bramka SMS Pro)

Dokumentacja interfejsu API

Specyfikacja Płatności CashBill. Instrukcja podłączenia płatności elektronicznych do typowych zastosowań.

Zadania semestralne. Programowanie obiektowe sem. II, lato 2014/2015

Specyfikacja instalacji usługi SMS Premium w Przelewy24.pl

SMS Kod Automatyczny

Dokumentacja serwera REST do obsługi rezerwacji w systemie SaNAtoRIUm.pro

SYSTEM ZARZĄDZANIA DANYMI OSOBOWYMI - INSTRUKCJA UŻYTKOWNIKA

Instrukcja założenia konta na epuap oraz złożenie wniosku o profil zaufany

Dokumentacja SMS przez FTP

,Aplikacja Okazje SMS

ELEKTRONICZNY NADAWCA. OPIS WebAPI Wersja 0.14, Opis WebAPI udostępnianego przez program Elektroniczny Nadawca

Komunikator podręcznik użytkownika podręcznik użytkownika

INSTRUKCJA OBSŁUGI APLIKACJI WEBFAX DLA UŻYTKOWNIKA

INSTRUKCJA OBSŁUGI APLIKACJI WEBFAX DLA

Dokumentacja API sender sms

Okno logowania. Okno aplikacji. 1. Logowanie i rejestracja

Dokumentacja SQL API 1

SYSTEMY ZABEZPIECZEŃ. Poradnik. Wirtualne sieci prywatne - VPN. Wymagania wstępne LAN. Internet VPN

Dokumentacja techniczna asendo API

Warszawa Specyfikacja techniczna. mprofi Interfejs API wersja 1.0.7

1. Pobieranie i instalacja FotoSendera

DOKUMENTACJA SOAP API. ver 2.0

Projekt z przedmiotu Projektowanie systemów teleinformatycznych

INSTRUKCJA OBSŁUGI PANELU WEBMAIL

Gatesms.eu Mobilne Rozwiązania dla biznesu

Świadczenie usługi hurtowej wysyłki wiadomości SMS dla Urzędu Miasta Torunia w latach

Instrukcja dodawania danych pojedynczej osoby, dla której ośrodek egzaminacyjny jest organizatorem egzaminu potwierdzającego kwalifikacje w zawodzie

FedEx efaktura Instrukcja Użytkownika

Dokumentacja techniczna KIP S.A. ul. Św. Marcin 73/ Poznań.

DOKUMENTACJA TECHNICZNA SMS API MT

Wszystkie dane powinny być przekazane za pomocą metody POST, zakodowane za pomocą funkcji urlencode().

Wprowadzenie... 2 Komunikaty ogólne... 3 Wysyłanie wiadomości SMS o jednakowej treści... 7 Wysyłanie spersonalizowanych wiadomości SMS...

Dokumentacja SMPP API

- 1 Laboratorium fotografii cyfrowej Foto Video Hennig

DHL EXPRESS. 1 DHL IntraShip Przewodnik

ING BusinessOnLine FAQ. systemu bankowości internetowej dla firm

Dokumentacja WebApi FurgonetkaBiznes

Dokumentacja REST API v 3.0

Dokumentacja REST API v 3.0. Kraków, 7 marca FreshMail, ul. Fabryczna 20a, Kraków tel , freshmail.

E-administracja. Korzystanie z Elektronicznej Platformy Usług Administracji Publicznej

Dokumentacja 2SMS

INSTRUKCJA REJESTRACJI ORGANIZACJI W GENERATORZE WNIOSKÓW APLIKACYJNYCH SI NAWIKUS

Dokumentacja API. wersja 1.1

Aby pobrać program FotoSender naleŝy na stronę lub i kliknąć na link Program do wysyłki zdjęć Internetem.

Dokumentacja systemu erecepcja.com SYSTEM REJESTRACJI KLIENTÓW PRZEZ INTERNET

JEDEN NUMER. Instrukcja

Instrukcja użytkownika. Aplikacja dla Comarch Optima

Specyfikacja techniczna. mprofi Interfejs API

Listonosz XL by CTI. Instrukcja

Instrukcja użytkownika. Aplikacja dla Magento

BRAMKA HTTP SMS XML Dokumentacja techniczna. wersja 3.32

Instrukcja obsługi programu FotoSender

Dokumentacja Techniczna SMS MO

Spis treści INTERFEJS (WEBSERVICES) - DOKUMENTACJA TECHNICZNA 1

Biznesowe przypadki użycia SOS

Przelewy24 Wirtualny Koszyk

Instrukcja wypełniania wniosku on-line - konkurs grantowy Na dobry początek!

Infolinia pomocy SIOEPKZ, telefon: godziny pracy: dni robocze od 7:30 do 17:30 lub 24h w dni określone w komunikacie dyrektora CKE

ELEKTRONICZNY NADAWCA. OPIS WebAPI Wersja 0.20, Opis WebAPI udostępnianego przez program Elektroniczny Nadawca

Spis treści DOKUMENTACJA TECHNICZNA. STS API wersja 1.1

JPK VAT wysyłka za pośrednictwem profilu zaufanego z systemu epuap

WayBillsWebService. identyfikator kontrahenta, jeśli wartość zwracana jest mniejsza od zera to numer błędu.

Integracja z pocztą Gmail. Integracja Poczta Google. Wersja 1.0 SPIS TREŚCI

Instrukcja rejestracji organizacji w podsystemie. Generator Wniosków Aplikacyjnych (GWA) Systemu Informatycznego NAWIKUS

Przychodnia 0. Stwórz projekt aplikacja konsolowa lub WPF (przemyśl wybór, bo zmiana może być czasochłonna). 1. Stwórz abstrakcyjną klasę Osoba.

Kandydat na studia I, II lub III stopnia w Akademii Wychowania Fizycznego we Wrocławiu wnosi jedną opłatę w wysokości 85 zł.

Instrukcja korzystania z usługi 2SMS. Wersja 2.0 [12 stycznia 2014] bramka@gsmservice.pl

Implementacja mechanizmu SkyCashClick Wersja 0.1

SKRÓCONA INSTRUKCJA OBSŁUGI POCZTY ELEKTRONICZNEJ ZIMBRA WEBMAIL

System epon Dokumentacja użytkownika

Dokumentacja Api do aplikacji skanujfakture.pl

PRZEWODNIK UŻYTKOWNIKA SERWISU. PRZESYŁKI KURIERSKIE ONLINE

Instrukcja korzystania z systemu poczty NetMail (wersja skrócona)

ESDI. WebService. Wersja 1.2. Strona 1

Sprawdzenie stanu opłacenia pakietu Zlecenie sprawdzenia stanu opłacenia... 23

Przewodnik. Rejestracja/logowanie

Instrukcja użytkownika

Płatności CashBill - Kody

Ministerstwo Finansów

JAK ZAMÓWIĆ ZDJĘCIA PRZEZ PROGRAM FOTOSENDER? 1. POBIERANIE I INSTALACJA PROGRAMU FOTOSENDER

Dokumentacja systemu SODE.pl Data dokumentu: Wersja: 2.4.4

Transkrypt:

Ahmes Sp. z o.o. ul. Lewicka 13/15 02-547 Warszawa tel: (22) 113 10 00, fax: (22) 203 63 21, e-mail: biuro@ahmes.pl, http://www.ahmes.pl DOKUMENTACJA IMPLEMENTACJI MECHANIZMÓW OBSŁUGI AHMES SMS (soap) 2013-03-24

SPIS TREŚCI WPROWADZENIE... 3 WYSYŁANIE SMS ów... 4 Parametry obowiązkowe do wstawienia... 4 Parametry opcjonalne... 4 KSIĄŻKA ADRESOWA... 5 Parametry... 5 Dodanie grupy numerów... 5 Usunięcie grupy numerów... 5 Dodanie numeru do grupy numerów... 6 Usunięcie numeru z grupy numerów... 6 Pobranie listy grup numerów... 6 Pobranie listy numerów przypisanych do danej grupy... 7 RAPORTY SMS... 7 Parametry obowiązkowe... 8 Parametry do filtrowania... 8 Parametry dodatkowe... 8 USUWANIE ZAPLANOWANYCH SMSÓW... 8 Parametry obowiązkowe... 9 Parametr opcjonalny... 9 2

WPROWADZENIE Dokumentacja pokazuje dostęp do usługi przy pomocy webserwisu SOAP. Do każdego wywołania usługi są potrzebne parametry username i userpassword odzwierciedlające dane potrzebne do uwierzytelnienia na witrynie usług: http://partners.ahmes.pl Adres webserwisu: https://partners.ahmes.pl/ahmessmsservice.svc 3

WYSYŁANIE SMS ów Do wysyłania sms ów służy metoda SendSms Parametry obowiązkowe do wstawienia username - nazwa klienta userpassword hasło zakodowane MD5 message treść wiadomości odbiorca: to numer telefonu odbiorcy w formacie 48XXXXXXXXX lub XXXXXXXXX(może być podana tablica numerów w formacie XXXXXXXXX,XXXXXXXXX,XXXXXXXXX itd. dla większej ilości odbiorców) lub groupname grupa kontaktów z książki adresowej(opis edycji książki adresowej w punkcie II. Książka adresowa) Przykład użycia metody w języku C#: SendSmsStatus status = new SendSmsStatus(); client.sendsms("login", "PASSWORD", null, "test", null, "123456789", null, DateTime.Now, null, out status); Parametry opcjonalne messagetype 1 wiadomość sms, 0- powiadomienie flash(domyślnie 1) senddate - data wysłania wiadomości. Jeżeli termin będzie późniejszy od obecnej daty to zostanie wysłana wiadomość w terminie nie wcześniejszym niż podany w parametrze, jeżeli nie, zostanie wysłana natychmiast. testmode - pozwala na testowanie komunikacji z interfejsem. W tym trybie testowana jest poprawność przekazanych parametrów oraz zwracane są losowo komunikaty błędów lub poprawności przetworzenia wiadomości, ale nie są one wysyłane do bramy SMS. 4

KSIĄŻKA ADRESOWA Do edycji książki adresowej służy metoda AddressBook. Parametry username - nazwa klienta userpassword hasło zakodowane MD5 groupname nazwa grupy numerów operationid id operacji na książce adresowej number numer telefonu(opcjonalnie, w zależności od operacji) Dodanie grupy numerów Do dodania grupy kontaktów należy użyć parametru operationid z wartością 1 i podać nazwę danej grupy w parametrze groupname. 1, "test", null, out addressbookcollection, out AddressBookNumberCollection); Usunięcie grupy numerów Do usunięcia grupy numerów należy użyć parametru operationid z wartością 2 podać nazwę danej grupy do usunięcia w parametrze groupname. i 2, "test", null, out addressbookcollection, out AddressBookNumberCollection); 5

Dodanie numeru do grupy numerów Do dodania numeru do grupy numerów należy użyć parametru operationid z wartością 3, podać nazwę grupy, do jakiej chcemy dodać numer w parametrze groupname i podać numer, jaki chcemy dodać w parametrze number. 3, "test", "test", out addressbookcollection, out AddressBookNumberCollection); Usunięcie numeru z grupy numerów Do usunięcia numeru z grupy numerów należy użyć parametru operationid z wartością 4, podać nazwę grupy, jaką chcemy usunąć w parametrze groupname i podać numer, jaki chcemy usunąć w parametrze number. 4, "test", "test", out addressbookcollection, out AddressBookNumberCollection); Pobranie listy grup numerów Do pobrania listy grup numerów należy użyć parametru operationid z wartością 5. Przykład użycia: 5, null, null, out addressbookcollection, out AddressBookNumberCollection); 6

Pobranie listy numerów przypisanych do danej grupy Do pobrania listy przypisanych do danej grupy numerów należy użyć parametru operationid z wartością 6, a także podać nazwę danej grupy w parametrze groupname. Przykład użycia: 6, "test", null, out addressbookcollection, out AddressBookNumberCollection); 7

RAPORTY SMS Do pobrania raportów SMS służy metoda GetSendSmsCollection Parametry obowiązkowe username - nazwa klienta userpassword hasło zakodowane MD5 Parametry do filtrowania startdate - data od jakiej mają zostać pobrane raporty w formacie RRRR-MM-DD GG:MM enddate - data do jakiej mają zostać pobrane raporty w formacie RRRR-MM-DD GG:MM pageindex - numer strony jaka ma być wyświetlona pagecount - rozmiar strony do wyświetlenia Parametry dodatkowe messageid - parametr potrzebny do pobrania pojedynczego raportu, id uzyskane podczas wysłania wiadomości List<SendSms> collection = new List<SendSms>(); SendSmsFilter filter = new SendSmsFilter(); filter.issend = true; client.getsendsmscollection("login", "PASSWORD", filter, null, null, null, out collection); 8

USUWANIE ZAPLANOWANYCH SMSÓW Do pobrania usuwanie zaplanowanych smsów służy metoda RemovePlanedSms Parametry obowiązkowe username - nazwa klienta userpassword hasło zakodowane MD5 smsgroupid id grupy odbiorców(guid), które otrzymujemy podczas wysyłania smów. Parametr opcjonalny receiver - jest to numer odbiorcy(msisdn). Jeżeli go wstawimy zostanie usunięty jedynie podany odbiorca wiadomości z zaplanowanego sms u. List<SendSms> collection = new List<SendSms>(); SendSmsFilter filter = new SendSmsFilter(); filter.issend = false; client.removeplannedsms("login", "PASSWORD", Guid.Parse("A97D12B8-B6C9-4E7E-B4E7-7A7A29281780"), null); 9