Merge branch 'master' of github.com:onlinecity/gatewayapi-docs

docs/legacy.rst

@@ -139,7 +139,7 @@ message. You can use this sessionid to track the message in your internal
 systems.
 
 When calling your service, we will perform a GET request, ie.
-https://example.com/callback?sessionid=4587654321:1234&statuscode=1
+``https://example.com/callback?sessionid=4587654321:1234&statuscode=1``
 
 Beware that if you specify any query params in your callbackurl they will not
 be returned to you, only the sessionid and statuscode params will be included.
@@ -158,7 +158,7 @@ in the SMS, known as the keyword. The SMS is then routed to the customer who
 has an active subscription for this keyword.
 
 We then send a HTTP GET request to the URL configured for that keyword, ie.
-https://example.com/mosms?sender=4512345678&smsc=unknown&sessionid=4512345678%3A9379401&appnr=1204&keyword=test
+``https://example.com/mosms?sender=4512345678&smsc=unknown&sessionid=4512345678%3A9379401&appnr=1204&keyword=test``
 
 You must respond with a very specific body, otherwise we'll treat your response
 as a failure and re-attempt delivery of the MO SMS. It's important that the

docs/rest.rst

@@ -1639,7 +1639,7 @@ using pip, simply do ``pip install requests_oauthlib``.
 
 
 .. _`OAuth 1.0a`: http://tools.ietf.org/html/rfc5849
-.. _`two-legged`: http://oauth.googlecode.com/svn/spec/ext/consumer_request/1.0/drafts/2/spec.html
+.. _`two-legged`: https://dzone.com/articles/2-legged-oauth-oauth-10-and-20
 .. _`HTTP Basic Auth`: http://tools.ietf.org/html/rfc1945#section-11.1
 .. _`OAuth Authorization header`: http://tools.ietf.org/html/rfc5849#section-3.5.1
 .. _`Requests-OAuthlib`: https://requests-oauthlib.readthedocs.org/

docs/smpp.rst

@@ -5,14 +5,14 @@ We offer SMPP connection for select customers. Contact [email protected] to g
 
 Connection
 ----------
-Use the following to connect
+Use the following to connect. We recommend to connect to two hosts. When we do scheduled maintainence, only one host is restarted at a time. By keeping a connection to two hosts, constant connectivity can be achieved.
 
 ================= =================================
-Host              smpp1.gatewayapi.com
-Port              7777
-Port TLS          7778
+Host              a.smpp.gatewayapi.com
+Host              b.smpp.gatewayapi.com
+Port              2775
+Port TLS          8775
 Bind type         Transceiver or transmitter and receiver.
-Maximum sessions  1 transceiver or 1 transmitter/receiver.
 ================= =================================
 
 Supported SMPP commands
@@ -39,20 +39,55 @@ enquire_link            0x00000015
 enquire_link_resp       0x80000015
 ======================  ==========
 
-bind_receiver, bind_transmitter, bind_transceiver
--------------------------------------------------
-Multiple sessions are supported but must be enabled in SMPP server.
-
-*Note* that only first active session binded as transceiver or receiver will receive delivery receipts.
-
-======== ================= ===================
-Type     Field             Description
-======== ================= ===================
-COctet   system_id         Account information
-COctet   password          Account information
-COctet   system_type       Empty or "EX"
-Integer  interface_version 0x33 or 0x34
-Integer  addr_ton          Ignored
-Integer  addr_npi          Ignored
-COctet   address_range     Ignored
-======== ================= ===================
+We currently do not support `Schedule Delivery Time` on `submit_sm`.
+
+Delivery reports
+----------------
+Connect with at least one transceiver or receiver to receive delivery reports. A maximum of 25.000 unacknowledged reports will be kept for 48 hours.
+
+The delivery report format is as follows:
+
+.. code-block:: none
+
+    id:{message_id} sub:{message_sub} dlvrd:{message_dlvrd}
+    submit date:{message_submit_date} done date:{message_done_date}
+    stat:{message_stat} err:{message_err}
+
+Following status types:
+
+* ENROUTE
+* DELIVRD
+* EXPIRED
+* UNDELIV
+* ACCEPTD
+* UNKNOWN
+* REJECTD
+
+
+Coding schemes
+----------------
+
+Following DCS values are supported
+
+===== ====================
+DCS   Encoding
+===== ====================
+0     IA5 / GSM7
+3     Latin1 / ISO-8859-1
+8     UCS2
+===== ====================
+
+
+TLV fields
+----------------
+
+We support the following common TLV fields for `submit_sm` as well as one our own custom for use with message classes.
+
+======== ======================= ============= ========================
+Tag      Name                    Size          Description
+======== ======================= ============= ========================
+0x0005   dest_addr_subunit       1 byte        For "flash" sms
+0x0204   user_message_reference  2 bytes       User assigned reference for delivery reports
+0x0424   message_payload         1 byte        For sending messages longer than 255 octets
+0x2900   message_class           octetstring   To send with a specific GatewayAPI messageclass
+======== ======================= ============= ========================