SOAP API
Περιεχόμενα
HTTP SOAP API v. 1.1 - τεκμηρίωση και παραδείγματα
Το smsme HTTP SOAP API έχει ως στόχο να δώσει στους προγραμματιστές ένα εύκολο και γρήγορο τρόπο να αποκτήσουν πρόσβαση στην πλατφόρμα του smsme μέσα από τις δικές τους εφαρμογές.
WSDL Υπηρεσίας https://webservice.smsme.gr/smsme.asmx?WSDL
Σε κάθε λειτουργία ελέγχονται τα στοιχεία εισόδου Usename και Password. Εάν δημιουργήσατε το account σας μέσο του https://www.smsme.gr τότε το Username σας είναι το email που μας έχετε δηλώσει. Οι λειτουργίες που υποστηρίζει το HTTP SOAP API είναι οι παρακάτω:
Υπόλοιπο Λογαριασμού
https://webservice.smsme.gr/smsme.asmx/Login
Μεταβλητές : Username, Password
Υποχρεωτικά Πεδία: Username, Password
Επιστρέφει: Υπόλοιπο Λογαριασμού σε ευρώ με 3 δεκαδικά ψηφία
Μηνύματα Λάθους:
BAD USER (δεν βρέθηκε ο χρήστης με το συγκεκριμένο username και password) ERROR PASSWORD (δεν δόθηκε password) ERROR USERNAME (δεν δόθηκε username)
Παράδειγμα:
Request
POST /smsme.asmx HTTP/1.1 Host: webservice.smsme.gr Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "https://webservice.smsme.gr/Login" <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="https://www.w3.org/2001/XMLSchema" xmlns:soap="https://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <Login xmlns="https://webservice.smsme.gr/"> <Username>string</Username> <Password>string</Password> </Login> </soap:Body> </soap:Envelope>
Response
<?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="https://www.w3.org/2001/XMLSchema" xmlns:soap="https://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <LoginResponse xmlns="https://webservice.smsme.gr/"> <LoginResult> <xsd:schema>schema</xsd:schema>xml</LoginResult> </LoginResponse> </soap:Body> </soap:Envelope>
Τιμοκατάλογος
https://webservice.smsme.gr/smsme.asmx/PriceList
Μεταβλητές : Username, Password
Υποχρεωτικά Πεδία: Username, Password
Επιστρέφει: Πίνακες με τις τιμές σε ευρώ για τις χώρες που παρέχουμε στο χρήστη
Μηνύματα Λάθους:
BAD USER (δεν βρέθηκε ο χρήστης με το συγκεκριμένο username και password) ERROR PASSWORD (δεν δόθηκε password) ERROR USERNAME (δεν δόθηκε username)
Παράδειγμα:
Request
POST /smsme.asmx HTTP/1.1 Host: webservice.smsme.gr Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "https://webservice.smsme.gr/PriceList" <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="https://www.w3.org/2001/XMLSchema" xmlns:soap="https://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <PriceList xmlns="https://webservice.smsme.gr/"> <Username>string</Username> <Password>string</Password> </PriceList> </soap:Body> </soap:Envelope>
Response
<?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="https://www.w3.org/2001/XMLSchema" xmlns:soap="https://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <PriceListResponse xmlns="https://webservice.smsme.gr/"> <PriceListResult> <xsd:schema>schema</xsd:schema>xml</PriceListResult> </PriceListResponse> </soap:Body> </soap:Envelope>
Αναφορές Παράδοσης
Μεταβλητές: Username, Password, Sdate, Edate, Originator, Mobile
Sdate: Ημερομηνία από την οποία θα ξεκινήσουν οι αναφορές – START DATE (yyyy-MM-dd HH:mm:ss)
Edate: Ημερομηνία στην οποία θα τελειώσουν οι αναφορές – END DATE (yyyy-MM-dd HH:mm:ss)
Originator: O αποστολέας του μηνύματος (αλφαριθμητικό μέχρι 11 χαρακτήρες)
Mobile: O παραλήπτης του μηνύματος (αριθμητικό υποχρεωτικά με πρόθεμα χώρας )
ReportID : Ο κωδικός αναφοράς που προήλθε από απλή η μαζική αποστολή sms
Υποχρεωτικά Πεδία: Username, Password, Sdate, Edate
Προαιρετικά Πεδία: Originator, Mobile
Επιστρέφει: Πίνακα ( DataTable ) με τις αναφορές από τις αποστολές που πραγματοποίησε ο πελάτης για ένα συγκεκριμένο χρονικό διάστημα
Μηνύματα Λάθους:
BAD USER (δεν βρέθηκε ο χρήστης με το συγκεκριμένο username και password) ERROR PASSWORD (δεν δόθηκε password) ERROR USERNAME (δεν δόθηκε username) ERROR START DATE (δεν δόθηκε ημερομηνία από την οποία θα ξεκινήσουν οι αναφορές) ERROR END DATE (δεν δόθηκε ημερομηνία στην οποία θα τελειώσουν οι αναφορές) ERROR DATE FORMAT (μία ή και οι δύο ημερομηνίες που δόθηκαν στα πεδία Sdate,Edate δεν έχει τη σωστή μορφή - yyyy-mm-dd HH:mm:ss) ERROR Mobile (Η μεταβλητή Mobile - παραλήπτης είτε δεν είναι αριθμητική είτε έχει μικρό σύνολο χαρακτήρων)
Παράδειγμα:
Request
POST /smsme.asmx HTTP/1.1 Host: webservice.smsme.gr Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "https://webservice.smsme.gr/Reports" <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="https://www.w3.org/2001/XMLSchema" xmlns:soap="https://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <Reports xmlns="https://webservice.smsme.gr/"> <Username>string</Username> <Password>string</Password> <Sdate>string</Sdate> <Edate>string</Edate> <Originator>string</Originator> <Mobile>string</Mobile> <ReportID>int</ReportID> </Reports> </soap:Body> </soap:Envelope>
Response
<?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="https://www.w3.org/2001/XMLSchema" xmlns:soap="https://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ReportsResponse xmlns="https://webservice.smsme.gr/"> <ReportsResult> <xsd:schema>schema</xsd:schema>xml</ReportsResult> </ReportsResponse> </soap:Body> </soap:Envelope>
Αποστολή SMS
Μεταβλητές: Username, Password, Originator, Mobile, Body, smsDate
Originator: O αποστολέας του μηνύματος (αλφαριθμητικό μέχρι 11 χαρακτήρες)
Mobile: Oι παραλήπτες του μηνύματος (αριθμητικό υποχρεωτικά με πρόθεμα χώρας π.χ. 30 για Ελλάδα ) *οι παραλήπτες θα πρέπει να είναι χωρισμένοι με κόμμα (,)
Body: To μήνυμα (μέχρι 160 χαρακτήρες)
smsDate : Ημερομηνία και ώρα αποστολής του μηνύματος. - σε περίπτωση που δεν σταλεί η μεταβλητή το μήνυμα θα αποστολή άμεσα. - yyyy-mm-dd HH:mm:ss)
Υποχρεωτικά Πεδία: Username, Password, Originator, Mobile, Body
Προαιρετικά Πεδία: smsDate
Επιστρέφει: λίστα με τον παραλήπτη και τον κωδικό αναφοράς για κάθε SMS
Μηνύματα Λάθους:
BAD USER (δεν βρέθηκε ο χρήστης με το συγκεκριμένο username και password) ERROR PASSWORD (δεν δόθηκε password) ERROR USERNAME (δεν δόθηκε username) ERROR ORIGINATOR (δεν δόθηκε αποστολές μηνύματος) ERROR Mobile (δεν δόθηκε παραλήπτης) ERROR BODY (δεν δόθηκε περιεχόμενο μηνύματος) NOT ENOUGH CREDITS (Ο πελάτης δεν έχει αρκετά χρήματα στο λογαριασμό του) EXEPTION ERROR (παρουσιάστηκε πρόβλημα κατά την αποστολή παρακαλώ δοκιμάστε ξανά.) WRONG NUMBER (Ο αριθμός παραλήπτη που δόθηκε δεν ήταν σωστός) NO CREDITS (Ο πελάτης δεν έχει χρήματα στο λογαριασμό του) BAD ORIGINATOR (ο αποστολές δεν είναι σωστός - πάνω απο 11 χαρακτήρες) BAD DATE (η ημερομηνία που δόθηκε στο πεδίο smsDate δεν έχει τη σωστή μορφή - yyyy-mm-dd HH:mm:ss)
Παράδειγμα:
Request
POST /smsme.asmx HTTP/1.1 Host: webservice.smsme.gr Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "https://webservice.smsme.gr/SendSms" <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="https://www.w3.org/2001/XMLSchema" xmlns:soap="https://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <SendSms xmlns="https://webservice.smsme.gr/"> <Username>string</Username> <Password>string</Password> <Originator>string</Originator> <Mobiles>string</Mobiles> <Body>string</Body> <smsDate>string</smsDate> </SendSms> </soap:Body> </soap:Envelope>
Response
<?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="https://www.w3.org/2001/XMLSchema" xmlns:soap="https://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <SendSmsResponse xmlns="https://webservice.smsme.gr/"> <SendSmsResult> <xsd:schema>schema</xsd:schema>xml</SendSmsResult> </SendSmsResponse> </soap:Body> </soap:Envelope>
