SMS Versenden.

Request

POST https://mapi.moreify.com/api/v1/sendSms

Parameter Typ Info Beschreibung
project string required Der Projekt-Identifier des Projektes, für das Sie eine Nachricht versenden wollen. Diesen Identifier können Sie in den Projekteinstellungen konfigurieren.
password string required Der zum Projekt zugehörige Token. Sie finden diesen in den Projekteinstellungen.
phonenumber string required Telefonnummer des Empfängers der Nachricht. Diese muss im internationalen Format angegeben sein, z.B. +43 oder 0043 für Österreich, oder +1 für USA.
message string required Der Text der Nachricht. Falls der Text länger als 160 Zeichen ist, wird die Nachricht automatisch in mehrere Teile aufgeteilt. Jeder Nachrichten-Teil wird separat übermittelt. UTF-8 Kodierung ist möglich, kann jedoch darin resultieren, dass die Nachricht aufgeteilt wird.
verifycode string optional 4 Ziffern Der 4 Ziffern-Code für die Verifizierung.
tag string optional max. 50 Zeichen Eine Zeichenkette mit der Sie diese Nachricht markieren können.
Z.B. ein eindeutiger Identifier aus Ihrem System oder eine Art Gruppierungs-Information, wie eine Promotion-ID, Name etc.
Dieser Identifier wird in der Response wieder an Sie übermittelt.
group string optional Identifier der Gruppe des Addressbuchs.
Falls Sie dies angeben, wird die Nachricht an alle Empfänger der Gruppe zugestellt.

Response

Die Response wird in JSON Format gesendet!
 
Parameter Typ Info Beschreibung
success boolean true|false Je nachdem ob die Nachricht erfolgreich verarbeitet wurde oder nicht.
message-identifier string 40 Zeichen Eine eindeutige ID für jede Nachricht, die von moreify vergeben wird.
tag string optional Wird rückübermittelt, wenn Sie diesen Identifier beim Versand angegeben haben.
messages array optional Falls Sie die Nachricht an eine Gruppe gesendet haben, enthält dieser Parameter den message-identifier und das Resultat für jede Einzelnachricht.

Examples


<?php

$apiUrl = "https://mapi.moreify.com/api/v1/sendSms";
$postParams = array(
	'project' =>        'your_project_identifier',
	'password' =>       'your_token',
	'phonenumber' =>    '00436641234567',
	'message' =>        'Your message text comes here',
	'tag' =>            'MyTag'
);

$curl = curl_init($apiUrl);
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, $postParams);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, 2);
$response = curl_exec($curl);

use LWP::UserAgent;

my $ua  = LWP::UserAgent->new();
my $url = "https://mapi.moreify.com/api/v1/sendSms";
my $response = $ua->post( $url, [
	"project" =>        "your_project_identifier",
	"password" =>       "your_token",
	"phonenumber" =>    "00436641234567",
	"message" =>        "Your message text comes here",
	"tag" =>            "MyTag"
] );

String data = String.format("project=%s&"
	+ "password=%s&"
	+ "phonenumber=%s&"
	+ "message=%s&"
	+ "tag=%s",
	URLEncoder.encode("your_project_identifier", "UTF-8"),
	URLEncoder.encode("your_token", "UTF-8"),
	URLEncoder.encode("00436641234567", "UTF-8"),
	URLEncoder.encode("Your message text comes here", "UTF-8"),
	URLEncoder.encode("MyTag", "UTF-8")
);

URL url = new URL("https://mapi.moreify.com/api/v1/sendSms");
HttpURLConnection connection = HttpURLConnection.class.cast(url.openConnection());
connection.setRequestMethod("POST");

connection.setDoInput(true);
connection.setDoOutput(true);

DataOutputStream os = new DataOutputStream(connection.getOutputStream());
os.writeBytes(data);
os.close();

InputStream in = connection.getInputStream();
// read response...

require 'uri'
require 'net/http'

uri = URI("https://mapi.moreify.com/api/v1/sendSms")
response = Net::HTTP.post_form(uri,
	'project' =>        'your_project_identifier',
	'password' =>       'your_token',
	'phonenumber' =>    '00436641234567',
	'message' =>        'Your message text comes here',
	'tag' =>            'MyTag'
)

# first make sure you have the "requests" package installed (see python-requests.org)
import requests

postParams = {
	'project':      'your_project_identifier',
	'password':     'your_token',
	'phonenumber':  '00436641234567',
	'message':      'Your message text comes here',
	'tag':          'MyTag'
}
response = requests.post("https://mapi.moreify.com/api/v1/sendSms", data=postParams)

define command {
    command_name    notify-service-by-moreify
    command_line    /usr/bin/curl -X POST https://mapi.moreify.com/api/v1/sendSms \
                                  -d project=your_project_identifier \
                                  -d password=your_token \
                                  -d phonenumber=$CONTACTPAGER$ \
                                  -d message="Service: $SERVICEDESC$%0aHost: $HOSTALIAS$%0aState: $SERVICESTATE$%0a%0a$SERVICEOUTPUT$"
}

define command {
    command_name    notify-host-by-moreify
    command_line    /usr/bin/curl -X POST https://mapi.moreify.com/api/v1/sendSms \
                                  -d project=your_project_identifier \
                                  -d password=your_token \
                                  -d phonenumber=$CONTACTPAGER$ \
                                  -d message="Host: $HOSTNAME$%0aState: $HOSTSTATE$%0a%0a$HOSTOUTPUT$"
}

define contact {
    contact_name                   moreify-template
    name                           moreify-template
    alias                          Moreify contact template

    service_notification_period    24x7
    host_notification_period       24x7
    service_notification_options   w,u,c,r
    host_notification_options      d,r
    service_notification_commands  notify-service-by-moreify
    host_notification_commands     notify-host-by-moreify

    register                       0
}

define contact {
    use                            moreify-template
    contact_name                   cpt_uptime
    pager                          +436641234567
}

define contactgroup {
    contactgroup_name              oncall
    members                        cpt_uptime
}

define service {
  name                             important_service
  contact_groups                   oncall
}

Anruf mit 4 Ziffern Verifizierungs-Code.

Request

POST https://mapi.moreify.com/api/v1/sendCall

Parameter Typ Info Beschreibung
project string required Der Projekt-Identifier des Projektes, für das Sie eine Nachricht versenden wollen. Diesen Identifier können Sie in der Projekt-Einstellungen konfigurieren.
password string required Der zum Projekt zugehörige Token. Sie finden diesen in den Projekteinstellungen.
phonenumber string required Telefonnummer, zu der der Anruf aufgebaut wird. Diese muss im internationalen Format angegeben sein, z.B. +43 oder 0043 für Österreich, oder +1 für USA.
language string required 2 Zeichen Die Sprache, in der die Ansage gesprochen werden soll. Verfügbare Sprachen: de (Deutsch), en (Englisch), fr (Französisch), tr (Türkisch), nl (Holländisch), es (Spanisch), hu (Ungarisch).
verifycode string required 4 Ziffern Der 4 Ziffern-Code für die Verifizierung.
tag string optional max. 50 Zeichen Eine Zeichenkette mit der Sie diese Nachricht markieren können. Z.B. ein eindeutiger Identifier aus Ihrem System oder eine Art Gruppierungs-Information, wie eine Promotion-ID, Name etc. Dieser Identifier wird in der Response wieder an Sie übermittelt.

Response

Die Response wird in JSON Format gesendet!
 
Parameter Typ Info Beschreibung
success boolean true|false Je nachdem ob der Anruf erfolgreich durchgeführt wurde oder nicht.
message-identifier string 40 characters Eine eindeutige ID für jede Nachricht, die von moreify vergeben wird.
tag string optional Wird rückübermittelt, wenn Sie diesen Identifier beim Request angegeben haben.

Examples


<?php

$apiUrl = "https://mapi.moreify.com/api/v1/sendCall";
$postParams = array(
	'project' =>        'your_project_identifier',
	'password' =>       'your_token',
	'phonenumber' =>    '00436641234567',
	'language' =>       'en',
	'verifycode' =>     '1234',
	'tag' =>            'MyTag'
);

$curl = curl_init($apiUrl);
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, $postParams);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, 2);
$response = curl_exec($curl);


use LWP::UserAgent;

my $ua  = LWP::UserAgent->new();
my $url = "https://mapi.moreify.com/api/v1/sendCall";
my $response = $ua->post( $url, [
	"project" =>        "your_project_identifier",
	"password" =>       "your_token",
	"phonenumber" =>    "00436641234567",
	"language" =>       "en",
	"verifycode" =>     "1234",
	"tag" =>            "MyTag"
] );

String data = String.format("project=%s&"
	+ "password=%s&"
	+ "phonenumber=%s&"
	+ "language=%s&"
	+ "verifycode=%s&"
	+ "tag=%s",
	URLEncoder.encode("your_project_identifier", "UTF-8"),
	URLEncoder.encode("your_token", "UTF-8"),
	URLEncoder.encode("00436641234567", "UTF-8"),
	URLEncoder.encode("de", "UTF-8"),
	URLEncoder.encode("1234", "UTF-8"),
	URLEncoder.encode("MyTag", "UTF-8")
);


URL url = new URL("https://mapi.moreify.com/api/v1/sendCall");
HttpURLConnection connection = HttpURLConnection.class.cast(url.openConnection());
connection.setRequestMethod("POST");

connection.setDoInput(true);
connection.setDoOutput(true);

DataOutputStream os = new DataOutputStream(connection.getOutputStream());
os.writeBytes(data);
os.close();

InputStream in = connection.getInputStream();
// read response...

require 'uri'
require 'net/http'

uri = URI("https://mapi.moreify.com/api/v1/sendCall")
response = Net::HTTP.post_form(uri,
	'project' =>        'your_project_identifier',
	'password' =>       'your_token',
	'phonenumber' =>    '00436641234567',
	'language' =>       'en',
	'verifycode' =>     '1234',
	'tag' =>            'MyTag'
)

# first make sure you have the "requests" package installed (see python-requests.org)
import requests

postParams = {
	'project':      'your_project_identifier',
	'password':     'your_token',
	'phonenumber':  '00436641234567',
	'language':     'en',
	'verifycode':   '1234',
	'tag':          'MyTag'
}
response = requests.post("https://mapi.moreify.com/api/v1/sendCall", data=postParams)

Exceptions.

Eine Liste der möglichen Exceptions

Fehler Code Fehler Nachricht Status Code Beschreibung
1000 Internal error 500 Ein interner Fehler in moreify ist aufgetreten. Bitte probieren Sie es nochmals oder kontaktieren Sie unseren Support.
1001 Internal error 500 Ein interner Fehler in moreify ist aufgetreten. Bitte probieren Sie es nochmals oder kontaktieren Sie unseren Support.
1002 Internal error 500 Ein interner Fehler in moreify ist aufgetreten. Bitte probieren Sie es nochmals oder kontaktieren Sie unseren Support.
1100 Insufficient balance on the user account 400 Sie haben nicht genügend Guthaben auf Ihrem Benutzer-Konto. Bitte laden Sie dieses auf.
1101 Invalid/Unknown authentication token 400 Ungültige Projekt-Identifier/Passwort Kombination. Bitte überprüfen Sie die Authentifizierungsdaten mit den Projekteinstellungen.
1102 User is disabled 400 Benutzer ist deaktiviert. Bitte kontaktieren Sie unseren Support für weitere Informationen.
1103 Missing Permission 400 Ihr Benutzer-Konto ist nicht berechtigt diese Operation auszuführen.
1201 The message body is empty 400 Der übermittelte Nachrichten-Text ist leer.
1202 No phone number given 400 Der Request enthält keine Telefonnummer.
1203 Given phone number is invalid 400 Die übermittelte Telefonnnummer ist ungültig.
1204 The passed language is invalid 400 Der übermittelte Sprachcode ist ungültig bzw. existiert nicht.
1205 The passed verification code is invalid 400 Der übermittelte Verifizierungscode ist ungültig. Der Code muss exakt 4 Stellen lang sein und nur aus Ziffern (0-9) bestehen.
1206 The message was invalid or to long. 400 Die übermittelte Nachricht enthält ungültige Zeichen oder ist zu lange.
1207 The group identifier was not found. 400 Der group Parameter Wert ist ungültig.
1208 The send-at timestamp is invalid 400 Ungültiger UNIX Zeitstampel übergeben!
1209 URLs within the message are not approved for your account yet 400 Der Versand von URLs innerhalb der Nachricht wurde für Sie noch nicht freigeschaltet!