{ "openapi": "3.0.1", "info": { "title": "API Docs", "version": "v1" }, "paths": { "/api/v2/Balance": { "get": { "tags": [ "Credit" ], "parameters": [ { "name": "ApiKey", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "ClientId", "in": "query", "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ResponseBalanceModelListResponseModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ResponseBalanceModelListResponseModel" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ResponseBalanceModelListResponseModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBalanceModelListResponseModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResponseBalanceModelListResponseModel" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/v2/Group": { "get": { "tags": [ "Group" ], "parameters": [ { "name": "ApiKey", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "ClientId", "in": "query", "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GroupDataModelIEnumerableResponseModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GroupDataModelIEnumerableResponseModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GroupDataModelIEnumerableResponseModel" } } } } } }, "post": { "tags": [ "Group" ], "requestBody": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/GroupAPIModel" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/GroupAPIModel" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/GroupAPIModel" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/GroupAPIModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GroupAPIModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GroupAPIModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GroupAPIModel" } } } }, "responses": { "200": { "description": "Success" } } }, "put": { "tags": [ "Group" ], "parameters": [ { "name": "id", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/GroupAPIModel" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/GroupAPIModel" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/GroupAPIModel" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/GroupAPIModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GroupAPIModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GroupAPIModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GroupAPIModel" } } } }, "responses": { "200": { "description": "Success" } } }, "delete": { "tags": [ "Group" ], "parameters": [ { "name": "ApiKey", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "ClientId", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "id", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/v2/GetSMS": { "get": { "tags": [ "SMS" ], "parameters": [ { "name": "ApiKey", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "ClientId", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "start", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "length", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "fromdate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "enddate", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } } } } } } }, "/api/v2/SMS/Status": { "get": { "tags": [ "SMS" ], "parameters": [ { "name": "ApiKey", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "ClientId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "days", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } } } } } } }, "/api/v2/MessageStatus": { "get": { "tags": [ "SMS" ], "parameters": [ { "name": "ApiKey", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "ClientId", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "MessageId", "in": "query", "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } } } } } } }, "/api/v2/SendSMS": { "get": { "tags": [ "SMS" ], "parameters": [ { "name": "SenderId", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "Is_Unicode", "in": "query", "schema": { "type": "boolean" } }, { "name": "Is_Flash", "in": "query", "schema": { "type": "boolean" } }, { "name": "IsRegisteredForDelivery", "in": "query", "schema": { "type": "boolean" } }, { "name": "ValidityPeriod", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "DataCoding", "in": "query", "schema": { "$ref": "#/components/schemas/DataCodingScheme" } }, { "name": "SchedTime", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "GroupId", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "Message", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "MobileNumbers", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "ServiceId", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "CoRelator", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "LinkId", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "PrincipleEntityId", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "TemplateId", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "ApiKey", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "ClientId", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } } } } } }, "post": { "tags": [ "SMS" ], "requestBody": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/SingleSmsApiModel" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SingleSmsApiModel" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/SingleSmsApiModel" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SingleSmsApiModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SingleSmsApiModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SingleSmsApiModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SingleSmsApiModel" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } } } } } } }, "/api/v2/SendBulkSMS": { "post": { "tags": [ "SMS" ], "requestBody": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/BulkSmsApiModel" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BulkSmsApiModel" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/BulkSmsApiModel" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BulkSmsApiModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BulkSmsApiModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BulkSmsApiModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BulkSmsApiModel" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } } } } } }, "get": { "tags": [ "SMS" ], "parameters": [ { "name": "SenderId", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "IsUnicode", "in": "query", "schema": { "type": "boolean" } }, { "name": "IsFlash", "in": "query", "schema": { "type": "boolean" } }, { "name": "DataCoding", "in": "query", "schema": { "$ref": "#/components/schemas/DataCodingScheme" } }, { "name": "IsRegisteredForDelivery", "in": "query", "schema": { "type": "boolean" } }, { "name": "ValidityPeriod", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "ScheduleDateTime", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "MobileNumber_Message", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "ServiceId", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "CoRelator", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "LinkId", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "GroupId", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "PrincipleEntityId", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "TemplateId", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "ApiKey", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "ClientId", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } } } } } } }, "/api/v2/ReportSummary": { "get": { "tags": [ "SMS" ], "parameters": [ { "name": "ApiKey", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "ClientId", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "fromdate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "enddate", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } } } } } } }, "/api/v3/SendSMS": { "post": { "tags": [ "SMS" ], "requestBody": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/SingleSmsApiModel" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SingleSmsApiModel" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/SingleSmsApiModel" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SingleSmsApiModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SingleSmsApiModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SingleSmsApiModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SingleSmsApiModel" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } } } } } } }, "/api/v3/SendBulkSMS": { "post": { "tags": [ "SMS" ], "requestBody": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/BulkSmsApiModel" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BulkSmsApiModel" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/BulkSmsApiModel" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BulkSmsApiModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BulkSmsApiModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BulkSmsApiModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BulkSmsApiModel" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } } } } } } }, "/api/v2/SenderId": { "get": { "tags": [ "SenderId" ], "parameters": [ { "name": "ApiKey", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "ClientId", "in": "query", "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ResponseSenderIdModelListResponseModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ResponseSenderIdModelListResponseModel" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ResponseSenderIdModelListResponseModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ResponseSenderIdModelListResponseModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResponseSenderIdModelListResponseModel" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } }, "post": { "tags": [ "SenderId" ], "requestBody": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/SenderIdAPIModel" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SenderIdAPIModel" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/SenderIdAPIModel" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SenderIdAPIModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SenderIdAPIModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SenderIdAPIModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SenderIdAPIModel" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ResponseSenderIdModelListResponseModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ResponseSenderIdModelListResponseModel" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ResponseSenderIdModelListResponseModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ResponseSenderIdModelListResponseModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResponseSenderIdModelListResponseModel" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } }, "put": { "tags": [ "SenderId" ], "parameters": [ { "name": "id", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/SenderIdAPIModel" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SenderIdAPIModel" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/SenderIdAPIModel" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SenderIdAPIModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SenderIdAPIModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SenderIdAPIModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SenderIdAPIModel" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } }, "delete": { "tags": [ "SenderId" ], "parameters": [ { "name": "ApiKey", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "ClientId", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "id", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/v2/Template": { "get": { "tags": [ "Template" ], "parameters": [ { "name": "ApiKey", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "ClientId", "in": "query", "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ResponseTemplateModelListResponseModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ResponseTemplateModelListResponseModel" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ResponseTemplateModelListResponseModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ResponseTemplateModelListResponseModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResponseTemplateModelListResponseModel" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } }, "post": { "tags": [ "Template" ], "requestBody": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/TemplateAPIModel" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/TemplateAPIModel" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/TemplateAPIModel" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/TemplateAPIModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TemplateAPIModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TemplateAPIModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TemplateAPIModel" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } }, "put": { "tags": [ "Template" ], "parameters": [ { "name": "id", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/TemplateAPIModel" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/TemplateAPIModel" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/TemplateAPIModel" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/TemplateAPIModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TemplateAPIModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TemplateAPIModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TemplateAPIModel" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } }, "delete": { "tags": [ "Template" ], "parameters": [ { "name": "ApiKey", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "ClientId", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "id", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringResponseModel" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } } }, "components": { "schemas": { "ResponseBalanceModel": { "type": "object", "properties": { "currencySymbol": { "type": "string", "nullable": true }, "productType": { "type": "integer", "format": "int32" }, "productTypeName": { "type": "string", "nullable": true, "readOnly": true }, "credits": { "type": "number", "format": "double" }, "totalCredits": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "ResponseBalanceModelListResponseModel": { "type": "object", "properties": { "errorCode": { "type": "integer", "format": "int32" }, "errorDescription": { "type": "string", "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ResponseBalanceModel" }, "nullable": true } }, "additionalProperties": false }, "GroupDataModel": { "type": "object", "properties": { "groupId": { "type": "integer", "format": "int32" }, "groupName": { "type": "string", "nullable": true }, "contactCount": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "GroupDataModelIEnumerableResponseModel": { "type": "object", "properties": { "errorCode": { "type": "integer", "format": "int32" }, "errorDescription": { "type": "string", "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/GroupDataModel" }, "nullable": true } }, "additionalProperties": false }, "GroupAPIModel": { "required": [ "apiKey", "clientId" ], "type": "object", "properties": { "groupName": { "type": "string", "nullable": true }, "apiKey": { "type": "string" }, "clientId": { "type": "string" } }, "additionalProperties": false }, "StringResponseModel": { "type": "object", "properties": { "errorCode": { "type": "integer", "format": "int32" }, "errorDescription": { "type": "string", "nullable": true }, "data": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DataCodingScheme": { "enum": [ 0, 3, 8 ], "type": "integer", "format": "int32" }, "SingleSmsApiModel": { "required": [ "apiKey", "clientId" ], "type": "object", "properties": { "senderId": { "type": "string", "nullable": true }, "is_Unicode": { "type": "boolean" }, "is_Flash": { "type": "boolean" }, "isRegisteredForDelivery": { "type": "boolean" }, "validityPeriod": { "type": "string", "nullable": true }, "dataCoding": { "$ref": "#/components/schemas/DataCodingScheme" }, "schedTime": { "type": "string", "nullable": true }, "groupId": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "mobileNumbers": { "type": "string", "nullable": true }, "serviceId": { "type": "string", "nullable": true }, "coRelator": { "type": "string", "nullable": true }, "linkId": { "type": "string", "nullable": true }, "principleEntityId": { "type": "string", "nullable": true }, "templateId": { "type": "string", "nullable": true }, "apiKey": { "type": "string" }, "clientId": { "type": "string" } }, "additionalProperties": false }, "MessageParameters": { "type": "object", "properties": { "number": { "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true }, "serviceId": { "type": "string", "nullable": true }, "coRelator": { "type": "string", "nullable": true }, "linkId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BulkSmsApiModel": { "required": [ "apiKey", "clientId" ], "type": "object", "properties": { "senderId": { "type": "string", "nullable": true }, "isUnicode": { "type": "boolean" }, "isFlash": { "type": "boolean" }, "isRegisteredForDelivery": { "type": "boolean" }, "validityPeriod": { "type": "string", "nullable": true }, "dataCoding": { "$ref": "#/components/schemas/DataCodingScheme" }, "scheduleDateTime": { "type": "string", "nullable": true }, "principleEntityId": { "type": "string", "nullable": true }, "templateId": { "type": "string", "nullable": true }, "messageParameters": { "type": "array", "items": { "$ref": "#/components/schemas/MessageParameters" }, "nullable": true }, "apiKey": { "type": "string" }, "clientId": { "type": "string" } }, "additionalProperties": false }, "ResponseSenderIdModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "companyId": { "type": "integer", "format": "int64" }, "senderId": { "type": "string", "nullable": true }, "productName": { "type": "string", "nullable": true }, "purpose": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "createDate": { "type": "string", "format": "date-time" }, "createDateString": { "type": "string", "nullable": true, "readOnly": true }, "approveStatus": { "type": "integer", "format": "int32" }, "isApproved": { "type": "string", "nullable": true, "readOnly": true }, "approvedDate": { "type": "string", "format": "date-time", "nullable": true }, "approvedDateString": { "type": "string", "nullable": true, "readOnly": true }, "isDefault": { "type": "boolean" }, "senderIdType": { "type": "integer", "format": "int32" }, "type": { "type": "string", "nullable": true, "readOnly": true }, "jobApprovalId": { "type": "integer", "format": "int32" }, "jobStatus": { "type": "integer", "format": "int32" }, "requestId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ResponseSenderIdModelListResponseModel": { "type": "object", "properties": { "errorCode": { "type": "integer", "format": "int32" }, "errorDescription": { "type": "string", "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ResponseSenderIdModel" }, "nullable": true } }, "additionalProperties": false }, "SenderIdAPIModel": { "required": [ "apiKey", "clientId", "purpose", "senderId" ], "type": "object", "properties": { "siteUserId": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int64" }, "senderId": { "type": "string" }, "purpose": { "type": "string" }, "productId": { "type": "integer", "format": "int32" }, "isActive": { "type": "boolean" }, "isApproved": { "type": "integer", "format": "int32" }, "apiKey": { "type": "string" }, "clientId": { "type": "string" } }, "additionalProperties": false }, "ResponseTemplateModel": { "type": "object", "properties": { "templateId": { "type": "integer", "format": "int64" }, "companyId": { "type": "integer", "format": "int64" }, "templateName": { "type": "string", "nullable": true }, "messageTemplate": { "type": "string", "nullable": true }, "isApproved": { "type": "boolean" }, "isActive": { "type": "boolean" }, "productName": { "type": "string", "nullable": true }, "createDate": { "type": "string", "format": "date-time" }, "createDateString": { "type": "string", "nullable": true }, "approvedDate": { "type": "string", "format": "date-time", "nullable": true }, "approvedDateString": { "type": "string", "nullable": true, "readOnly": true }, "dltTemplateId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ResponseTemplateModelListResponseModel": { "type": "object", "properties": { "errorCode": { "type": "integer", "format": "int32" }, "errorDescription": { "type": "string", "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ResponseTemplateModel" }, "nullable": true } }, "additionalProperties": false }, "TemplateAPIModel": { "required": [ "apiKey", "clientId", "messageTemplate", "templateName" ], "type": "object", "properties": { "templateName": { "type": "string" }, "messageTemplate": { "type": "string" }, "templateId": { "type": "string", "nullable": true }, "apiKey": { "type": "string" }, "clientId": { "type": "string" } }, "additionalProperties": false } } } }