Updated Docs

2025-03-26 14:48:32 +01:00
parent 9ed359d307
commit 183c1bf46f
59 changed files with 2513 additions and 390 deletions
@@ -0,0 +1,58 @@
+{
+    "post": {
+      "tags": [
+        "SMS"
+      ],
+      "summary": "Send Single SMS",
+      "description": "This request is used to send a single SMS message to a customer. The API is hosted in FIRSTBANK and it is the HTTP wrapper for the real SMS sending interface.",
+      "operationId": "smsNotification",
+      "requestBody": {
+        "required": true,
+        "content": {
+          "application/json": {
+            "schema": {
+              "$ref": "../schemas/SMSRequest.json"
+            }
+          },
+          "application/xml": {
+            "schema": {
+              "$ref": "../schemas/SMSRequest.json"
+            }
+          },
+          "application/x-www-form-urlencoded": {
+            "schema": {
+              "$ref": "../schemas/SMSRequest.json"
+            }
+          }
+        }
+      },
+      "responses": {
+        "200": {
+          "description": "SMS sent successfully",
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "../schemas/SMSResponse.json"
+              }
+            },
+            "application/xml": {
+              "schema": {
+                "$ref": "../schemas/SMSResponse.json"
+              }
+            }
+          }
+        },
+        "400": {
+          "description": "Unsuccessful Response with Client Error"
+        },
+        "500": {
+          "description": "Internal server error"
+        }
+      },
+      "security": [
+        {
+          "api_key": []
+        }
+      ]
+    }
+}