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": [
+        "BulkSMS"
+      ],
+      "summary": "Send Bulk SMS",
+      "description": "This request is used to send Bulk SMS messages to multiple customers. The max length of the array should equal 20. The API is hosted in FIRSTBANK and it is the HTTP wrapper for the real SMS sending interface.",
+      "operationId": "bulkSmsNotification",
+      "requestBody": {
+        "required": true,
+        "content": {
+          "application/json": {
+            "schema": {
+              "$ref": "../schemas/BulkSMSRequest.json"
+            }
+          },
+          "application/xml": {
+            "schema": {
+              "$ref": "../schemas/BulkSMSRequest.json"
+            }
+          },
+          "application/x-www-form-urlencoded": {
+            "schema": {
+              "$ref": "../schemas/BulkSMSRequest.json"
+            }
+          }
+        }
+      },
+      "responses": {
+        "200": {
+          "description": "Bulk SMS sent successfully",
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "../schemas/BulkSMSResponse.json"
+              }
+            },
+            "application/xml": {
+              "schema": {
+                "$ref": "../schemas/BulkSMSResponse.json"
+              }
+            }
+          }
+        },
+        "400": {
+          "description": "Unsuccessful Response with Client Error"
+        },
+        "500": {
+          "description": "Internal server error"
+        }
+      },
+      "security": [
+        {
+          "api_key": []
+        }
+      ]
+    }
+}