Omnicom.gr - Multi-Channel Platform (SMS, Viber, Messenger, Email)
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
API
README.md

README.md

#omnicom.gr

  1. API Documentation To HTTP API του Omnicom.gr επιτρέπει σε developers την αποστολή μηνυμάτων SMS & Viber. Μπορεί να χρησιμοποιηθεί για μικρές η μεγάλες αποστολές μηνυμάτων.

1.1. SMS API Για να κάνετε χρήση του API θα πρέπει να έχετε λογαριασμό στο Omnicom.gr με την επιλογή του API ενεργοποιημένη. Τις ρυθμίσεις του API μπορείτε να τις δείτε στη σελίδα «Ρυθμίσεις Λογαριασμού». To API επιτρέπει την αποστολή μηνυμάτων με τις μεθόδους GET ή POST HTTP.

1.2. Μεταβλητές

To HTTP API χρησιμοποιεί μεταβλητές τις οποίες πρέπει να γνωρίζετε (Από τη σελίδα «Ρυθμίσεις Λογαριασμού ή να τις ζητήσετε με email από το info@omnicom.gr

Variable Description Default value or sample
POST_URL To URL στο οποίο κατευθύνονται όλες οι αιτήσεις. https://omnicom.gr/api/do
username user@youremail.com user@youremail.com
api_password Κωδικός API Π.χ. 123456
api_token Secure token Π.χ. 654321
to Αριθμός κινητού (Απλός αριθμός με τη χρήση Προθέματος ( 30 ) αλλά χωρίς το “+”) 3069NNNNNNNN
bulklist Λίστα αρθιμών κινητών (Αριθμοί με χρήση προθέματος ( 30 ) αλλά χωρίς το “+”) 3069NNNNNNNN,3069NNNNNNNN
from           Sender_id. Μπορει να ειναι κενο αλλά θα χρησιμοποιηθεί αυτό που έχετε στην εφαρμογή   omnicom.gr
is_long 0 ή 1, απλό η μεγάλο (>160 χαρακτηρες) 0
unicode 0 ή 1, αν το μήνυμα είναι Unicode (χρήση πεζών ελληνικών αλλά με 70 χαρακτήρες/μήνυμα) 0
message “urlencoded” SMS μήνυμα κειμένου ΜΗΝYΜΑ ΑΠΟ ΤΟ Omnicom.gr

1.3. Πως μπορώ να στείλω μηνύματα?

Για την αποστολή απλού μηνύματος SMS κάντε χρήση ενός απλού HTTP GET ή POST.

Δείτε παράδειγμα παρακάτω:

https://omnicom.gr/api/do?username=&api_password=<api_password>&api_token=<api_token>&to=3069NNNNNNNN&message=<urlencoded_message>

Σημειώσεις:

  1. Με τη χρήση της μεθόδου GET πρέπει να έχετε «&» μεταξύ των παραμέτρων.
  2. Χωρίς τη χρήση αγκυλών, απλά χρησιμοποιήστε τις μεταβλητές εδώ.

1.4. Πως μπορώ να λάβω αναφορά παράδοσης μηνύματος?

Δείτε παράδειγμα παρακάτω:

https://omnicom.gr/index.php/api/status?username=&api_password=<api_password>&token=

1.5. Πως μπορώ να δω το υπόλοιπο των μηνυμάτων μου?

Δείτε παράδειγμα παρακάτω:

https://omnicom.gr /index.php/api/credits?username=&api_password=<api_password>

1.6. Πως μπορώ να στείλω μαζική αποστολή μηνυμάτων SMS ( Bulk SMS ) ?

Για τη μαζική αποστολή μηνυμάτων SMS κάντε χρήση ενός απλού HTTP GET ή POST.

https://omnicom.gr/api/do?username=&api_password=<api_password>

&api_token=<api_token>&bulklist=3069NNNNNNNN,3069NNNNNNN&message=<urlencoded_message>
Σημειώσεις:

  1. Με τη χρήση της μεθόδου GET πρέπει να έχετε «&» μεταξύ των παραμέτρων.
  2. Χωρίς χρήση των αγκυλών, απλά χρησιμοποιήστε τις μεταβλητές εδώ.

1.7. Πως μπορώ να λάβω αναφορά παράδοσης της λίστας των μηνυμάτων?

Δείτε παράδειγμα παρακάτω:

https://omnicom.gr/api/bulkstatus?username=&api_password=<api_password> &token=<list_token>

Οι απαντήσεις που θα λάβετε από τη λίστα θα περιέχουν ορισμένες μεταβλητές. Με κατάσταση 1 (status=1) σημαίνει ότι ο παραλήπτης το έλαβε, με κατάσταση 0 (status=0) ότι δε το έλαβε.

Σημειώσεις: 3. Με τη χρήση της μεθόδου GET πρέπει να έχετε «&» μεταξύ των παραμέτρων. 4. Χωρίς χρήση των αγκυλών, απλά χρησιμοποιήστε τις μεταβλητές εδώ.

1.8. Μηνύματα Σφάλματος

Μετά απο κάθε HTTP POST ή GET γίνεται επιστροφή ειδικών κωδικών για την κατάσταση του μηνύματος. Δείτε το παρακάτω πίνακα.

Error code Description
“message submitted” Το μήνυμα παραδόθηκε στο Omnicom.gr με επιτυχία
Error: 1101 Λάθος username
Error: 1102 Λάθος API password
Error: 1103 Λάθος API token
Error: 1104 Η αποστολή απο την IP αυτή δεν έγινε δεκτή
Error: 1201 Χωρίς αριθμό κινητού
Error: 1202 Δεν υπάρχει κείμενο στο SMS
Error: 1203 Πρέπει να παρέχετε τις παραμέτρους “to” or “bulklist” όχι και τις 2

1.9. PHP sample

<?php

$url='https://omnicom.gr/index.php/api/do';

$username='sampleaccount@omnicom.gr’';

$api_token='sampleAPItoken';

$api_password='sampleapipassword';

$to='3069NNNNNNNN';

$from='sms.net.gr';

$message='This is test message from Omnicom.gr';

$is_long='0';

$unicode='0';

$fields = array(

  'username'=>urlencode($username),

  'api_password'=>urlencode($api_password),

  'api_token'=>urlencode($api_token),

  'to'=>urlencode($to),

  'from'=>urlencode($from),

  'message'=>urlencode($message),

  'is_long'=>urlencode($is_long),

  'unicode'=>urlencode($unicode)

);

foreach($fields as $key=>$value) { 
  $fields_string .= $key.'='.$value.'&'; 
}

rtrim($fields_string,'&');

$ch = curl_init();  //open connection

curl_setopt($ch,CURLOPT_URL,$url.'?'.$fields_string); //set the url, number of POST vars, POST data

$result = curl_exec($ch);

curl_close($ch); //close connection

?>

2.1 Viber API Για να κάνετε χρήση του API θα πρέπει να έχετε λογαριασμό στο Omnicom.gr με την επιλογή του API ενεργοποιημένη. Τις ρυθμίσεις του API μπορείτε να τις δείτε στη σελίδα «Ρυθμίσεις Λογαριασμού». To API επιτρέπει την αποστολή μηνυμάτων με τις μεθόδους GET ή POST HTTP.

2.2. Μεταβλητές To HTTP API χρησιμοποιεί μεταβλητές τις οποίες πρέπει να γνωρίζετε (Από τη σελίδα «Ρυθμίσεις Λογαριασμού ή να τις ζητήσετε με email από το info@omnicom.gr

Variable Description Default value or sample
POST_URL To URL στο οποίο κατευθύνονται όλες οι αιτήσεις. https://omnicom.gr/api/do
username user@youremail.com user@youremail.com
api_password Κωδικός API Π.χ. 123456
api_token Secure token Π.χ. 654321
to Αριθμός κινητού (Απλός αριθμός με τη χρήση Προθέματος ( 30 ) αλλά χωρίς το “+”) 3069NNNNNNNN
bulklist Λίστα αρθιμών κινητών (Αριθμοί με χρήση προθέματος ( 30 ) αλλά χωρίς το “+”) 3069NNNNNNNN,3069NNNNNNNN
promotional 0 ή 1, αν το μήνυμα είναι Προωθητικό 0
image_url URL εικόνας (url encoded) www.omnicom.com/img.png
action_title Τίτλος ενέργειας ΔΕΙΤΕ ΤΟ
action_url URL ενέργειας (url encoded) www.omnicom.com/
message user@youremail.com ΜΗΝYΜΑ ΑΠΟ ΤΟ Omnicom.gr

2.3. Πως μπορώ να στείλω μηνύματα?

Για την αποστολή απλού μηνύματος IM κάντε χρήση ενός απλού HTTP GET ή POST.

Δείτε παράδειγμα παρακάτω:

https://omnicom.gr/api_viber/do?username=&api_password=<api_password>&api_token=<api_token>&to=3069NNNNNNNN&message=<message_text>

Σημειώσεις:

  1. Με τη χρήση της μεθόδου GET πρέπει να έχετε «&» μεταξύ των παραμέτρων.
  2. Χωρίς τη χρήση αγκυλών, απλά χρησιμοποιήστε τις μεταβλητές εδώ.
  3. Επιπλέον παράμετροι (προαιρετικές) δεν εμφανίζονται εδώ.

2.4. Πως μπορώ να λάβω αναφορά παράδοσης μηνύματος?

Δείτε παράδειγμα παρακάτω:

https://omnicom.gr/api_viber/status?username=&api_password=<api_password>&token=

2.5. Πως μπορώ να δω το υπόλοιπο των μηνυμάτων μου?

Δείτε παράδειγμα παρακάτω:

https://omnicom.gr /index.php/api/credits?username=&api_password=<api_password>

2.6. Πως μπορώ να στείλω μαζική αποστολή μηνυμάτων IM ( Bulk IM ) ?

Για τη μαζική αποστολή μηνυμάτων IM κάντε χρήση ενός απλού HTTP GET ή POST.

https://omnicom.gr/api_viber/do?username=&api_password=<api_password>

&api_token=<api_token>&bulklist=3069NNNNNNNN,3069NNNNNNN&message=<message_text>
Σημειώσεις:

  1. Με τη χρήση της μεθόδου GET πρέπει να έχετε «&» μεταξύ των παραμέτρων.
  2. Χωρίς χρήση των αγκυλών, απλά χρησιμοποιήστε τις μεταβλητές εδώ.

2.7. Πως μπορώ να λάβω αναφορά παράδοσης της λίστας των μηνυμάτων?

Δείτε παράδειγμα παρακάτω:

https://omnicom.gr/api_viber/bulkstatus?username=&api_password=<api_password> &token=<list_token>

2.8. Μηνύματα Σφάλματος

Μετά απο κάθε HTTP POST ή GET γίνεται επιστροφή ειδικών κωδικών για την κατάσταση του μηνύματος. Δείτε το παρακάτω πίνακα.

Error code Description
“message submitted” Το μήνυμα παραδόθηκε στο Omnicom.gr με επιτυχία
Error: 1101 Λάθος username
Error: 1102 Λάθος API password
Error: 1103 Λάθος API token
Error: 1104 Η αποστολή απο την IP αυτή δεν έγινε δεκτή
Error: 1201 Χωρίς αριθμό κινητού
Error: 1202 Δεν υπάρχει κείμενο στο SMS
Error: 1203 Πρέπει να παρέχετε τις παραμέτρους “to” or “bulklist” όχι και τις 2

2.9. PHP sample

<?php

$url='https://omnicom.gr/index.php/api_viber/do';

$username='sampleaccount@domain.gr’';

$api_token='sampleAPItoken';

$api_password='sampleapipassword';

$to='3069NNNNNNNN';

$from='omnicom;

$message='This is test message from Omnicom.gr';

$fields = array(

  'username'=>urlencode($username),

  'api_password'=>urlencode($api_password),

  'api_token'=>urlencode($api_token),

  'to'=>urlencode($to),

  'from'=>urlencode($from),

  'message'=>urlencode($message)
);

//url-ify the data for the POST

foreach($fields as $key=>$value) { 
  $fields_string .= $key.'='.$value.'&'; 
}

rtrim($fields_string,'&');

$ch = curl_init();//open connection

curl_setopt($ch,CURLOPT_URL,$url.'?'.$fields_string); //set the url, number of POST vars, POST data

$result = curl_exec($ch); //execute post

curl_close($ch);	//close connection

?>