{ "openapi": "3.0.1", "info": { "title": "Omni smsbat Client API", "version": "v1" }, "paths": { "/api/AlphaName/sms/status": { "get": { "tags": [ "AlphaName" ], "parameters": [ { "name": "dateFrom", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "dateTo", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "alphaName", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/AlphaName/sms/application": { "post": { "tags": [ "AlphaName" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ExternalCreateAlphaNameApplicationDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ExternalCreateAlphaNameApplicationDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExternalCreateAlphaNameApplicationDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ExternalCreateAlphaNameApplicationDto" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/AlphaName/wallet/info": { "get": { "tags": [ "AlphaName" ], "parameters": [ { "name": "ExternalAlphaName", "in": "query", "schema": { "type": "string" } }, { "name": "TransactionTypes", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SmsWalletHistoryDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SmsWalletHistoryDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SmsWalletHistoryDto" } } } } } } }, "/api/auth": { "post": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/GetTokenRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetTokenRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetTokenRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GetTokenRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/bots/application": { "post": { "tags": [ "Bots" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/NewExternalBotApplication" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NewExternalBotApplication" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NewExternalBotApplication" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NewExternalBotApplication" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/CascadeMessage/send_message": { "post": { "tags": [ "CascadeMessage" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LegacyMessageDataDTO" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LegacyMessageDataDTO" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LegacyMessageDataDTO" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LegacyMessageDataDTO" } } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/CascadeMessage/{referralGuid}/send_message": { "post": { "tags": [ "CascadeMessage" ], "parameters": [ { "name": "referralGuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LegacyMessageDataDTO" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LegacyMessageDataDTO" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LegacyMessageDataDTO" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LegacyMessageDataDTO" } } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/CascadeMessage/send_message_async": { "post": { "tags": [ "CascadeMessage" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LegacyMessageDataDTO" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LegacyMessageDataDTO" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LegacyMessageDataDTO" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LegacyMessageDataDTO" } } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/CascadeMessage/{referralGuid}/send_message_async": { "post": { "tags": [ "CascadeMessage" ], "parameters": [ { "name": "referralGuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LegacyMessageDataDTO" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LegacyMessageDataDTO" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LegacyMessageDataDTO" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LegacyMessageDataDTO" } } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/CascadeMessage/send_message/omni-smsbat/tg-viber/async": { "post": { "tags": [ "CascadeMessage" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LegacyMessageDataDTO" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LegacyMessageDataDTO" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LegacyMessageDataDTO" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LegacyMessageDataDTO" } } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/CascadeMessage/{referralGuid}/send_message/omni-smsbat/tg-viber/async": { "post": { "tags": [ "CascadeMessage" ], "parameters": [ { "name": "referralGuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LegacyMessageDataDTO" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LegacyMessageDataDTO" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LegacyMessageDataDTO" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LegacyMessageDataDTO" } } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/CascadeMessage/status_guid/{guid}": { "get": { "tags": [ "CascadeMessage" ], "parameters": [ { "name": "guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/CascadeMessage/status_id/{id}": { "get": { "tags": [ "CascadeMessage" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/CascadeMessage/broadcast": { "post": { "tags": [ "CascadeMessage" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BroadcastCreateDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BroadcastCreateDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BroadcastCreateDTO" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BroadcastCreateDTO" } } } }, "responses": { "200": { "description": "Success" } } } }, "/chat_bot/bot_receiver/phone": { "put": { "tags": [ "ChatBot" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateBotReceiverPhone" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateBotReceiverPhone" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateBotReceiverPhone" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateBotReceiverPhone" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/client/provision": { "post": { "tags": [ "Client" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateExternalClientDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateExternalClientDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateExternalClientDTO" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateExternalClientDTO" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/client/{referralId}": { "post": { "tags": [ "Client" ], "parameters": [ { "name": "referralId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ReferralClientDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReferralClientDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReferralClientDTO" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReferralClientDTO" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/client/organization": { "post": { "tags": [ "Client" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AddOrganizationWithTokenDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AddOrganizationWithTokenDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddOrganizationWithTokenDTO" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AddOrganizationWithTokenDTO" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OrganizationDataDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationDataDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrganizationDataDTO" } } } } } } }, "/api/clientsenders": { "get": { "tags": [ "ClientSenders" ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ClientSenderResp" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ClientSenderResp" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ClientSenderResp" } } } } } } }, "/api/Costs/bots": { "get": { "tags": [ "Costs" ], "parameters": [ { "name": "date", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "date-time" } } }, { "name": "bot_name", "in": "query", "schema": { "type": "string", "default": "" } }, { "name": "country", "in": "query", "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ViberBotStatisticDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ViberBotStatisticDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ViberBotStatisticDTO" } } } } } } }, "/api/external-data/user-bonuses": { "post": { "tags": [ "Data" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserBonusDataDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserBonusDataDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserBonusDataDto" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserBonusDataDto" } } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/external-data/user-bonuses/{phoneNumber}": { "post": { "tags": [ "Data" ], "parameters": [ { "name": "phoneNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/email/send": { "post": { "tags": [ "Email" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SendEmailRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SendEmailRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SendEmailRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SendEmailRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/GMSMessage/send_message/v1": { "post": { "tags": [ "GMSMessage" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/GMSSendMessageReq" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GMSSendMessageReq" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GMSSendMessageReq" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GMSSendMessageReq" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GMSSendMessageResp" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GMSSendMessageResp" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GMSSendMessageResp" } } } } } } }, "/api/GMSMessage/send_message": { "post": { "tags": [ "GMSMessage" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/GMSSendMessageReq" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GMSSendMessageReq" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GMSSendMessageReq" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GMSSendMessageReq" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GMSSendMessageResp" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GMSSendMessageResp" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GMSSendMessageResp" } } } } } } }, "/ip2sms": { "post": { "tags": [ "IpToSms" ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SendMessageResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SendMessageResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SendMessageResponse" } } } } } } }, "/ip2sms/viber_mess": { "post": { "tags": [ "IpToSms" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ViberMessageDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ViberMessageDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ViberMessageDTO" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ViberMessageDTO" } } } }, "responses": { "200": { "description": "Success" } } } }, "/meta/add-token": { "get": { "tags": [ "MetaCallback" ], "parameters": [ { "name": "code", "in": "query", "schema": { "type": "string" } }, { "name": "state", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/meta/deauthorize": { "post": { "tags": [ "MetaCallback" ], "responses": { "200": { "description": "Success" } } } }, "/meta": { "get": { "tags": [ "MetaCallback" ], "parameters": [ { "name": "hub.mode", "in": "query", "schema": { "type": "string" } }, { "name": "hub.verify_token", "in": "query", "schema": { "type": "string" } }, { "name": "hub.challenge", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } }, "post": { "tags": [ "MetaCallback" ], "responses": { "200": { "description": "Success" } } } }, "/meta-graph/{apiVersion}/{path}": { "get": { "tags": [ "MetaGraph" ], "parameters": [ { "name": "apiVersion", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "path", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } }, "post": { "tags": [ "MetaGraph" ], "parameters": [ { "name": "apiVersion", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "path", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/myCodeBot/sendChatMessage": { "post": { "tags": [ "MyCodeBot" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/MyCodeBotViberRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MyCodeBotViberRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MyCodeBotViberRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MyCodeBotViberRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/olx/callback": { "get": { "tags": [ "Olx" ], "parameters": [ { "name": "code", "in": "query", "schema": { "type": "string" } }, { "name": "state", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/omni-callback": { "post": { "tags": [ "OmnicellCallback" ], "responses": { "200": { "description": "Success" } } } }, "/organizations": { "post": { "tags": [ "Organizations" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AddOrganizationDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AddOrganizationDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddOrganizationDTO" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AddOrganizationDTO" } } } }, "responses": { "200": { "description": "Success" } } }, "get": { "tags": [ "Organizations" ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationNameSync" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationNameSync" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationNameSync" } } } } } } } }, "/organizations/{id}/operators": { "post": { "tags": [ "Organizations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AddOperatorDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AddOperatorDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddOperatorDTO" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AddOperatorDTO" } } } }, "responses": { "200": { "description": "Success" } } } }, "/organizations/{id}/operators/{operatorId}/credentials": { "put": { "tags": [ "Organizations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "operatorId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AddOperatorDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AddOperatorDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddOperatorDTO" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AddOperatorDTO" } } } }, "responses": { "200": { "description": "Success" } } } }, "/organizations/alpha_name": { "post": { "tags": [ "Organizations" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AddExternalAlphaNameDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AddExternalAlphaNameDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddExternalAlphaNameDTO" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AddExternalAlphaNameDTO" } } } }, "responses": { "200": { "description": "Success" } } } }, "/organizations/alpha_name/list": { "get": { "tags": [ "Organizations" ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AlphaNameWithStatusDTO" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AlphaNameWithStatusDTO" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AlphaNameWithStatusDTO" } } } } } } } }, "/organizations/auth_token": { "post": { "tags": [ "Organizations" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/NewOrganizationAuthToken" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NewOrganizationAuthToken" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NewOrganizationAuthToken" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NewOrganizationAuthToken" } } } }, "responses": { "200": { "description": "Success" } } } }, "/organizations/auth_token/{id}": { "delete": { "tags": [ "Organizations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" } } } }, "/organizations/callback_urls": { "get": { "tags": [ "Organizations" ], "parameters": [ { "name": "source", "in": "query", "schema": { "$ref": "#/components/schemas/SendingSourceCallback" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CallbackUrlResponseDTO" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CallbackUrlResponseDTO" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CallbackUrlResponseDTO" } } } } } } }, "post": { "tags": [ "Organizations" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CallbackUrlRequestDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CallbackUrlRequestDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CallbackUrlRequestDTO" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CallbackUrlRequestDTO" } } } }, "responses": { "200": { "description": "Success" } } } }, "/organizations/callback_urls/{id}": { "get": { "tags": [ "Organizations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CallbackUrlResponseDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CallbackUrlResponseDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CallbackUrlResponseDTO" } } } } } }, "put": { "tags": [ "Organizations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CallbackUrlRequestDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CallbackUrlRequestDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CallbackUrlRequestDTO" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CallbackUrlRequestDTO" } } } }, "responses": { "200": { "description": "Success" } } }, "delete": { "tags": [ "Organizations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" } } } }, "/organizations/contacts": { "get": { "tags": [ "Organizations" ], "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "perPage", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 10 } }, { "name": "includeWithoutPhone", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "date", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "date-time" } } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ContactReceiverDTOPaginationDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ContactReceiverDTOPaginationDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContactReceiverDTOPaginationDTO" } } } } } } }, "/api/push/registerInstallation": { "post": { "tags": [ "Push" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PushRegisterInstallationRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PushRegisterInstallationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PushRegisterInstallationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PushRegisterInstallationRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/push/unregisterInstallation": { "post": { "tags": [ "Push" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PushUnregisterInstallationRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PushUnregisterInstallationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PushUnregisterInstallationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PushUnregisterInstallationRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/push/notifications/{id}/status": { "post": { "tags": [ "Push" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PushNotificationStatusRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PushNotificationStatusRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PushNotificationStatusRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PushNotificationStatusRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/push/notifications": { "get": { "tags": [ "Push" ], "parameters": [ { "name": "externalUserId", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "status", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/rozetka-callback": { "post": { "tags": [ "RozetkaCallback" ], "responses": { "200": { "description": "Success" } } } }, "/api/SendMessage": { "post": { "tags": [ "SendMessage" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "sending_method": { "type": "string" }, "from": { "type": "string" }, "user": { "type": "string" }, "txt": { "type": "string" }, "phone": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "sign": { "type": "string" }, "image_link": { "type": "string" }, "p_transaction_id": { "type": "string" }, "label": { "type": "string" }, "charset": { "type": "string" }, "dlr": { "type": "integer", "format": "int32" }, "dlr_timeout": { "type": "integer", "format": "int32" }, "expiry_txt": { "type": "string" }, "media_type": { "type": "string" }, "media_url": { "type": "string" }, "media_filename": { "type": "string" }, "button_text": { "type": "string" }, "button_link": { "type": "string" }, "video.url": { "type": "string" }, "video.thumbnail": { "type": "string" }, "video.size_mb": { "type": "number", "format": "double" }, "video.size_bytes": { "type": "integer", "format": "int64" }, "video.duration_sec": { "type": "number", "format": "double" }, "template.id": { "type": "string" }, "template.lang": { "type": "string" }, "template.params": { "type": "object", "additionalProperties": { "type": "string" } }, "carousel": { "type": "array", "items": { "$ref": "#/components/schemas/CarouselItemDTO" } }, "survey_options": { "type": "array", "items": { "type": "string" } }, "option_type": { "$ref": "#/components/schemas/SurveyListMessageUIType" }, "tracking_data": { "type": "string" } } }, "encoding": { "sending_method": { "style": "form" }, "from": { "style": "form" }, "user": { "style": "form" }, "txt": { "style": "form" }, "phone": { "style": "form" }, "sign": { "style": "form" }, "image_link": { "style": "form" }, "p_transaction_id": { "style": "form" }, "label": { "style": "form" }, "charset": { "style": "form" }, "dlr": { "style": "form" }, "dlr_timeout": { "style": "form" }, "expiry_txt": { "style": "form" }, "media_type": { "style": "form" }, "media_url": { "style": "form" }, "media_filename": { "style": "form" }, "button_text": { "style": "form" }, "button_link": { "style": "form" }, "video.url": { "style": "form" }, "video.thumbnail": { "style": "form" }, "video.size_mb": { "style": "form" }, "video.size_bytes": { "style": "form" }, "video.duration_sec": { "style": "form" }, "template.id": { "style": "form" }, "template.lang": { "style": "form" }, "template.params": { "style": "form" }, "carousel": { "style": "form" }, "survey_options": { "style": "form" }, "option_type": { "style": "form" }, "tracking_data": { "style": "form" } } } } }, "responses": { "200": { "description": "Success" } } }, "get": { "tags": [ "SendMessage" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "sending_method": { "type": "string" }, "from": { "type": "string" }, "user": { "type": "string" }, "txt": { "type": "string" }, "phone": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "sign": { "type": "string" }, "image_link": { "type": "string" }, "p_transaction_id": { "type": "string" }, "label": { "type": "string" }, "charset": { "type": "string" }, "dlr": { "type": "integer", "format": "int32" }, "dlr_timeout": { "type": "integer", "format": "int32" }, "expiry_txt": { "type": "string" }, "media_type": { "type": "string" }, "media_url": { "type": "string" }, "media_filename": { "type": "string" }, "button_text": { "type": "string" }, "button_link": { "type": "string" }, "video.url": { "type": "string" }, "video.thumbnail": { "type": "string" }, "video.size_mb": { "type": "number", "format": "double" }, "video.size_bytes": { "type": "integer", "format": "int64" }, "video.duration_sec": { "type": "number", "format": "double" }, "template.id": { "type": "string" }, "template.lang": { "type": "string" }, "template.params": { "type": "object", "additionalProperties": { "type": "string" } }, "carousel": { "type": "array", "items": { "$ref": "#/components/schemas/CarouselItemDTO" } }, "survey_options": { "type": "array", "items": { "type": "string" } }, "option_type": { "$ref": "#/components/schemas/SurveyListMessageUIType" }, "tracking_data": { "type": "string" } } }, "encoding": { "sending_method": { "style": "form" }, "from": { "style": "form" }, "user": { "style": "form" }, "txt": { "style": "form" }, "phone": { "style": "form" }, "sign": { "style": "form" }, "image_link": { "style": "form" }, "p_transaction_id": { "style": "form" }, "label": { "style": "form" }, "charset": { "style": "form" }, "dlr": { "style": "form" }, "dlr_timeout": { "style": "form" }, "expiry_txt": { "style": "form" }, "media_type": { "style": "form" }, "media_url": { "style": "form" }, "media_filename": { "style": "form" }, "button_text": { "style": "form" }, "button_link": { "style": "form" }, "video.url": { "style": "form" }, "video.thumbnail": { "style": "form" }, "video.size_mb": { "style": "form" }, "video.size_bytes": { "style": "form" }, "video.duration_sec": { "style": "form" }, "template.id": { "style": "form" }, "template.lang": { "style": "form" }, "template.params": { "style": "form" }, "carousel": { "style": "form" }, "survey_options": { "style": "form" }, "option_type": { "style": "form" }, "tracking_data": { "style": "form" } } } } }, "responses": { "200": { "description": "Success" } } } }, "/bat/messagelist": { "post": { "tags": [ "SMSBat" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SMSBatMessageRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SMSBatMessageRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SMSBatMessageRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SMSBatMessageRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SMSBatMessageResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SMSBatMessageResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SMSBatMessageResponse" } } } } } } }, "/bat/{referralGuid}/messagelist": { "post": { "tags": [ "SMSBat" ], "parameters": [ { "name": "referralGuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SMSBatMessageRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SMSBatMessageRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SMSBatMessageRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SMSBatMessageRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SMSBatMessageResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SMSBatMessageResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SMSBatMessageResponse" } } } } } } }, "/bat/message/{messageListId}/{messageId}": { "get": { "tags": [ "SMSBat" ], "parameters": [ { "name": "messageListId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "messageId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SMSBatMessageStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SMSBatMessageStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SMSBatMessageStatus" } } } } } } }, "/bat/message/{messageId}": { "get": { "tags": [ "SMSBat" ], "parameters": [ { "name": "messageId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SMSBatMessageStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SMSBatMessageStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SMSBatMessageStatus" } } } } } } }, "/api/stripe/webhook": { "post": { "tags": [ "Stripe" ], "responses": { "200": { "description": "Success" } } } }, "/api/stripe-proxy/webhook": { "post": { "tags": [ "StripeProxy" ], "responses": { "200": { "description": "Success" } } } }, "/api/templates": { "post": { "tags": [ "Templates" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AddTemplateRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AddTemplateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddTemplateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AddTemplateRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AddTemplateResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AddTemplateResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddTemplateResponse" } } } } } }, "get": { "tags": [ "Templates" ], "parameters": [ { "name": "sender_name", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetTempResp" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetTempResp" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetTempResp" } } } } } } }, "/api/templates/status_callback": { "post": { "tags": [ "Templates" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ViberTemplateStatusCallbackRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ViberTemplateStatusCallbackRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ViberTemplateStatusCallbackRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ViberTemplateStatusCallbackRequestDto" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/templates/{id}": { "get": { "tags": [ "Templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetTempResp" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetTempResp" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetTempResp" } } } } } }, "delete": { "tags": [ "Templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AddTemplateResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AddTemplateResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddTemplateResponse" } } } } } } }, "/api/templates/{templateUuid}": { "get": { "tags": [ "Templates" ], "parameters": [ { "name": "templateUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetTempResp" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetTempResp" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetTempResp" } } } } } }, "delete": { "tags": [ "Templates" ], "parameters": [ { "name": "templateUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AddTemplateResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AddTemplateResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddTemplateResponse" } } } } } } }, "/api/templates/transactional": { "post": { "tags": [ "Templates" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/TransactionalTemplateRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TransactionalTemplateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TransactionalTemplateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TransactionalTemplateRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TransactionalTemplateResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TransactionalTemplateResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TransactionalTemplateResponse" } } } } } }, "get": { "tags": [ "Templates" ], "parameters": [ { "name": "sender_name", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetTransactionalTemplatesResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetTransactionalTemplatesResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetTransactionalTemplatesResponse" } } } } } } }, "/api/templates/transactional/{id}": { "get": { "tags": [ "Templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetTransactionalTemplatesResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetTransactionalTemplatesResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetTransactionalTemplatesResponse" } } } } } } }, "/api/tg_bot/{token}": { "put": { "tags": [ "TgBot" ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpsertExternalTgBotDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpsertExternalTgBotDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpsertExternalTgBotDTO" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpsertExternalTgBotDTO" } } } }, "responses": { "200": { "description": "Success" } } }, "delete": { "tags": [ "TgBot" ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" } } }, "post": { "tags": [ "TgBot" ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AddTgUserDTO" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AddTgUserDTO" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AddTgUserDTO" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AddTgUserDTO" } } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/tg_bot/{token}/set_webhook": { "post": { "tags": [ "TgBot" ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/tg_bot/by-organization/{organizationId}": { "get": { "tags": [ "TgBot" ], "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 10 } }, { "name": "show_all", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetTgBotShortDTOPaginationDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetTgBotShortDTOPaginationDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetTgBotShortDTOPaginationDTO" } } } } } } }, "/api/tg_bot/{id}/paginated-users": { "get": { "tags": [ "TgBot" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 10 } }, { "name": "show_all", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TgBotUserSyncDTOPaginationDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TgBotUserSyncDTOPaginationDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TgBotUserSyncDTOPaginationDTO" } } } } } } }, "/api/tg_bot/paginated-users/by-token/{token}": { "get": { "tags": [ "TgBot" ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 10 } }, { "name": "show_all", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TgBotUserSyncDTOPaginationDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TgBotUserSyncDTOPaginationDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TgBotUserSyncDTOPaginationDTO" } } } } } } }, "/api/tg_bot/{id}/users": { "post": { "tags": [ "TgBot" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UpsertTgUserSyncDTO" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UpsertTgUserSyncDTO" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UpsertTgUserSyncDTO" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UpsertTgUserSyncDTO" } } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/tsms/chat/send": { "post": { "tags": [ "TurboSmsChat" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/TurboSmsChatSendRequestDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TurboSmsChatSendRequestDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TurboSmsChatSendRequestDTO" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TurboSmsChatSendRequestDTO" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TurboSmsChatSendResponseDTOTurboSmsResponseDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TurboSmsChatSendResponseDTOTurboSmsResponseDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TurboSmsChatSendResponseDTOTurboSmsResponseDTO" } } } } } } }, "/api/tsms/chat/recipients": { "post": { "tags": [ "TurboSmsChat" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/TurboSmsChatRecipientsRequestDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TurboSmsChatRecipientsRequestDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TurboSmsChatRecipientsRequestDTO" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TurboSmsChatRecipientsRequestDTO" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TurboSmsChatRecipientDTOListTurboSmsResponseDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TurboSmsChatRecipientDTOListTurboSmsResponseDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TurboSmsChatRecipientDTOListTurboSmsResponseDTO" } } } } } } }, "/api/tsms/file": { "post": { "tags": [ "TurboSmsFile" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/TurboSmsFileUploadRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TurboSmsFileUploadRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TurboSmsFileUploadRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TurboSmsFileUploadRequestDto" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TurboSmsFileDTOTurboSmsResponseDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TurboSmsFileDTOTurboSmsResponseDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TurboSmsFileDTOTurboSmsResponseDTO" } } } } } } }, "/api/tsms/file/{id}": { "get": { "tags": [ "TurboSmsFile" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/tsms/message/ping": { "get": { "tags": [ "TurboSmsMessage" ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/tsms/message/send": { "post": { "tags": [ "TurboSmsMessage" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/TurboSmsMessageSendRequestDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TurboSmsMessageSendRequestDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TurboSmsMessageSendRequestDTO" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TurboSmsMessageSendRequestDTO" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TurboSmsMessageSendResponseDTOListTurboSmsResponseDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TurboSmsMessageSendResponseDTOListTurboSmsResponseDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TurboSmsMessageSendResponseDTOListTurboSmsResponseDTO" } } } } } } }, "/api/tsms/message/sendmulti": { "post": { "tags": [ "TurboSmsMessage" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/TurboSmsMessageSendRequestDTO" } } }, "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/TurboSmsMessageSendRequestDTO" } } }, "text/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/TurboSmsMessageSendRequestDTO" } } }, "application/*+json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/TurboSmsMessageSendRequestDTO" } } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringTurboSmsMessageSendResponseDTOListTurboSmsResponseDTODictionaryTurboSmsResponseDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringTurboSmsMessageSendResponseDTOListTurboSmsResponseDTODictionaryTurboSmsResponseDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringTurboSmsMessageSendResponseDTOListTurboSmsResponseDTODictionaryTurboSmsResponseDTO" } } } } } } }, "/api/tsms/message/status": { "post": { "tags": [ "TurboSmsMessage" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/TurboSmsMessageStatusRequestDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TurboSmsMessageStatusRequestDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TurboSmsMessageStatusRequestDTO" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TurboSmsMessageStatusRequestDTO" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TurboSmsMessageStatusResponseDTOListTurboSmsResponseDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TurboSmsMessageStatusResponseDTOListTurboSmsResponseDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TurboSmsMessageStatusResponseDTOListTurboSmsResponseDTO" } } } } } } }, "/api/tsms/message/details": { "post": { "tags": [ "TurboSmsMessage" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/TurboSmsMessageStatusRequestDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TurboSmsMessageStatusRequestDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TurboSmsMessageStatusRequestDTO" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TurboSmsMessageStatusRequestDTO" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TurboSmsMessageDetailsResponseDTOListTurboSmsResponseDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TurboSmsMessageDetailsResponseDTOListTurboSmsResponseDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TurboSmsMessageDetailsResponseDTOListTurboSmsResponseDTO" } } } } } } }, "/api/VertexSmsCallback/message-callback": { "post": { "tags": [ "VertexSmsCallback" ], "responses": { "200": { "description": "Success" } } } }, "/api/VertexSmsCallback/sender-status": { "post": { "tags": [ "VertexSmsCallback" ], "responses": { "200": { "description": "Success" } } } }, "/api/viber_bm/send_message": { "post": { "tags": [ "ViberBM" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SendViberBMDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SendViberBMDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SendViberBMDTO" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SendViberBMDTO" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/viber_bot/{token}": { "post": { "tags": [ "ViberBot" ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AddViberBotUserDTO" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AddViberBotUserDTO" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AddViberBotUserDTO" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AddViberBotUserDTO" } } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/viber_bot/by-organization/{organizationId}": { "get": { "tags": [ "ViberBot" ], "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 10 } }, { "name": "show_all", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ShortBotInfoPage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ShortBotInfoPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ShortBotInfoPage" } } } } } } }, "/api/viber_bot/{id}/paginated-users": { "get": { "tags": [ "ViberBot" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 10 } }, { "name": "show_all", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ViberBotUserSyncDTOPaginationDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ViberBotUserSyncDTOPaginationDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ViberBotUserSyncDTOPaginationDTO" } } } } } } }, "/api/viber_bot/paginated-users/by-token/{token}": { "get": { "tags": [ "ViberBot" ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 10 } }, { "name": "show_all", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ViberBotUserSyncDTOPaginationDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ViberBotUserSyncDTOPaginationDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ViberBotUserSyncDTOPaginationDTO" } } } } } } }, "/api/viber_bot/{id}/users": { "post": { "tags": [ "ViberBot" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UpsertViberBotUser" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UpsertViberBotUser" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UpsertViberBotUser" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UpsertViberBotUser" } } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/viber_bot/create-survey": { "post": { "tags": [ "ViberBot" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateViberSurveyRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateViberSurveyRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateViberSurveyRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateViberSurveyRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/viber_bot_callback/{token}": { "post": { "tags": [ "ViberBotCallback" ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ViberBotWebhookReq" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ViberBotWebhookReq" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ViberBotWebhookReq" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ViberBotWebhookReq" } } } }, "responses": { "200": { "description": "Success" } } } }, "/viber_bot_callback/{token}/chat": { "post": { "tags": [ "ViberBotCallback" ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/pa/send_message": { "post": { "tags": [ "ViberBotProxy" ], "responses": { "200": { "description": "Success" } } } }, "/pa/set_webhook": { "post": { "tags": [ "ViberBotProxy" ], "responses": { "200": { "description": "Success" } } } }, "/pa/get_account_info": { "post": { "tags": [ "ViberBotProxy" ], "responses": { "200": { "description": "Success" } } } }, "/pa/get_online": { "post": { "tags": [ "ViberBotProxy" ], "responses": { "200": { "description": "Success" } } } }, "/pa/get_user_details": { "post": { "tags": [ "ViberBotProxy" ], "responses": { "200": { "description": "Success" } } } }, "/pa/broadcast_message": { "post": { "tags": [ "ViberBotProxy" ], "responses": { "200": { "description": "Success" } } } }, "/viber/bm_account": { "post": { "tags": [ "ViberBusinessAccount" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ViberBusinessAccount" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ViberBusinessAccount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ViberBusinessAccount" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ViberBusinessAccount" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CreateBMAccountResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateBMAccountResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateBMAccountResponse" } } } } } }, "put": { "tags": [ "ViberBusinessAccount" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateBuisnessAccount" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateBuisnessAccount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateBuisnessAccount" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateBuisnessAccount" } } } }, "responses": { "200": { "description": "Success" } } } }, "/viber/bm_account/{id}/status": { "get": { "tags": [ "ViberBusinessAccount" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuisnessAccountStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuisnessAccountStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuisnessAccountStatus" } } } } } } }, "/viber/bm_account/status": { "put": { "tags": [ "ViberBusinessAccount" ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuisnessAccountStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuisnessAccountStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuisnessAccountStatus" } } } } } } }, "/viber/bm_account/images": { "post": { "tags": [ "ViberBusinessAccount" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AddImagesExternalDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AddImagesExternalDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddImagesExternalDTO" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AddImagesExternalDTO" } } } }, "responses": { "200": { "description": "Success" } } } }, "/viber/bm_account/warranty_letter": { "post": { "tags": [ "ViberBusinessAccount" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AddFileExternalDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AddFileExternalDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddFileExternalDTO" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AddFileExternalDTO" } } } }, "responses": { "200": { "description": "Success" } } } }, "/viber/bm_account/{phone}/reader_status": { "get": { "tags": [ "ViberBusinessAccount" ], "parameters": [ { "name": "phone", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PhoneReaderStatusDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PhoneReaderStatusDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PhoneReaderStatusDTO" } } } } } } }, "/viber-callback/test/calback": { "get": { "tags": [ "ViberCallback" ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Dict" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Dict" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Dict" } } } } } } } }, "/viber-callback": { "post": { "tags": [ "ViberCallback" ], "responses": { "200": { "description": "Success" } } } }, "/viber-callback/test": { "post": { "tags": [ "ViberCallback" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ViberWebhookRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ViberWebhookRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ViberWebhookRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ViberWebhookRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/viber-callback/message": { "post": { "tags": [ "ViberCallback" ], "responses": { "200": { "description": "Success" } } } }, "/viber-callback/message/test": { "post": { "tags": [ "ViberCallback" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ViberWebhookRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ViberWebhookRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ViberWebhookRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ViberWebhookRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/ViberTemplate/template-callback": { "post": { "tags": [ "ViberTemplate" ], "responses": { "200": { "description": "Success" } } } }, "/api/ViberTemplate/transactional-status-callback": { "post": { "tags": [ "ViberTemplate" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ViberTransactionalTemplateCallbackDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ViberTransactionalTemplateCallbackDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ViberTransactionalTemplateCallbackDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ViberTransactionalTemplateCallbackDto" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/ViberTemplate": { "put": { "tags": [ "ViberTemplate" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/TemplateUpdateDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TemplateUpdateDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TemplateUpdateDTO" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TemplateUpdateDTO" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/ViberTemplate/{id}": { "delete": { "tags": [ "ViberTemplate" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/ViberTemplate/check": { "get": { "tags": [ "ViberTemplate" ], "parameters": [ { "name": "id", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" } } } } }, "components": { "schemas": { "AddExternalAlphaNameDTO": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "companyCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AddFileExternalDTO": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "file": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AddImagesExternalDTO": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "images": { "type": "array", "items": { "$ref": "#/components/schemas/ImageDTO" }, "nullable": true } }, "additionalProperties": false }, "AddOperatorDTO": { "required": [ "login", "name", "password" ], "type": "object", "properties": { "name": { "type": "string" }, "login": { "type": "string" }, "password": { "type": "string" }, "languageCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AddOrganizationDTO": { "required": [ "clientId", "nameLocal" ], "type": "object", "properties": { "clientId": { "type": "integer", "format": "int32" }, "nameLocal": { "type": "string" } }, "additionalProperties": false }, "AddOrganizationWithTokenDTO": { "type": "object", "properties": { "authToken": { "$ref": "#/components/schemas/NewOrganizationAuthToken" }, "nameLocal": { "type": "string", "nullable": true }, "nameEn": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "organizationType": { "type": "integer", "format": "int32", "nullable": true }, "phone": { "type": "string", "nullable": true }, "authorizedPersonDocument": { "type": "string", "nullable": true }, "authorizedPersonName": { "type": "string", "nullable": true }, "authorizedPersonPosition": { "type": "string", "nullable": true }, "bankAccount": { "type": "string", "nullable": true }, "bankName": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "fullLegalName": { "type": "string", "nullable": true }, "shortLegalName": { "type": "string", "nullable": true }, "isTaxPayer": { "type": "boolean", "nullable": true }, "passportIssuedDate": { "type": "string", "format": "date-time", "nullable": true }, "passportNumber": { "type": "string", "nullable": true }, "unzr": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AddTemplateRequest": { "type": "object", "properties": { "project_id": { "type": "string", "nullable": true }, "contents": { "$ref": "#/components/schemas/Contents" } }, "additionalProperties": false }, "AddTemplateResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "template_uuid": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "project_id": { "type": "string", "nullable": true }, "contents": { "$ref": "#/components/schemas/Contents" } }, "additionalProperties": false }, "AddTgUserDTO": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "userName": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "languageCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AddViberBotUserDTO": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "language": { "type": "string", "nullable": true }, "avatar": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AlphaNameWithStatusDTO": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "statusCode": { "type": "string", "nullable": true }, "statusUpdateDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "BroadcastChannelDTO": { "type": "object", "properties": { "channelType": { "$ref": "#/components/schemas/BroadcastChannelType" }, "fallbackOrder": { "type": "integer", "format": "int32" }, "botId": { "type": "integer", "format": "int32", "nullable": true }, "tgBotId": { "type": "integer", "format": "int32", "nullable": true }, "messageText": { "type": "string", "nullable": true }, "buttonText": { "type": "string", "nullable": true }, "buttonAction": { "type": "string", "nullable": true }, "imageUrl": { "type": "string", "nullable": true }, "videoUrl": { "type": "string", "nullable": true }, "videoThumbnailUrl": { "type": "string", "nullable": true }, "videoSizeBytes": { "type": "integer", "format": "int64", "nullable": true }, "videoDurationSec": { "type": "integer", "format": "int32", "nullable": true }, "videoFileId": { "type": "integer", "format": "int32", "nullable": true }, "thumbnailFileId": { "type": "integer", "format": "int32", "nullable": true }, "organizationAlphaNameId": { "type": "integer", "format": "int32", "nullable": true }, "surveyOptions": { "type": "array", "items": { "type": "string" }, "nullable": true }, "carouselItems": { "type": "array", "items": { "$ref": "#/components/schemas/CarouselItemDTO" }, "nullable": true }, "richMedia": { "type": "string", "nullable": true }, "rcsCarouselCards": { "type": "array", "items": { "$ref": "#/components/schemas/RcsCarouselCardDTO" }, "nullable": true } }, "additionalProperties": false }, "BroadcastChannelType": { "enum": [ 1, 2, 3, 4, 5, 6, 7, 8 ], "type": "integer", "format": "int32" }, "BroadcastCreateDTO": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "organizationId": { "type": "integer", "format": "int32" }, "description": { "type": "string", "nullable": true }, "plannedAt": { "type": "string", "format": "date-time", "nullable": true }, "ttl": { "type": "integer", "format": "int32", "nullable": true }, "channels": { "type": "array", "items": { "$ref": "#/components/schemas/BroadcastChannelDTO" }, "nullable": true }, "sendToAllContacts": { "type": "boolean" }, "tags": { "$ref": "#/components/schemas/ItemDTO" }, "tagIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "contactIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "contacts": { "$ref": "#/components/schemas/ItemDTO" }, "manualPhones": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "BroadcastLinkShorteningMode": { "enum": [ 1, 2 ], "type": "integer", "format": "int32" }, "BuisnessAccountStatus": { "type": "object", "properties": { "caStatus": { "type": "string", "nullable": true }, "bmStatus": { "type": "string", "nullable": true }, "bmID": { "type": "integer", "format": "int32", "nullable": true }, "id": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "CallbackUrlRequestDTO": { "type": "object", "properties": { "url": { "type": "string", "nullable": true }, "source": { "$ref": "#/components/schemas/SendingSourceCallback" }, "headerName": { "type": "string", "nullable": true }, "headerValue": { "type": "string", "nullable": true }, "channelType": { "$ref": "#/components/schemas/ChatSource" }, "channelEntityId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "CallbackUrlResponseDTO": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "url": { "type": "string", "nullable": true }, "source": { "$ref": "#/components/schemas/SendingSourceCallback" }, "headerName": { "type": "string", "nullable": true }, "headerValue": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "channelType": { "$ref": "#/components/schemas/ChatSource" }, "channelEntityId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "CarouselButton": { "type": "object", "properties": { "label": { "type": "string", "nullable": true }, "actionUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CarouselData": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CarouselItem" }, "nullable": true } }, "additionalProperties": false }, "CarouselItem": { "type": "object", "properties": { "title": { "type": "string", "nullable": true }, "imageUrl": { "type": "string", "nullable": true }, "primaryButton": { "$ref": "#/components/schemas/CarouselButton" }, "secondaryButton": { "$ref": "#/components/schemas/CarouselButton" } }, "additionalProperties": false }, "CarouselItemDTO": { "type": "object", "properties": { "title": { "type": "string", "nullable": true }, "image_url": { "type": "string", "nullable": true }, "primary_label": { "type": "string", "nullable": true }, "primary_url": { "type": "string", "nullable": true }, "shorten_primary_url": { "type": "boolean" }, "primary_url_shortening_mode": { "$ref": "#/components/schemas/BroadcastLinkShorteningMode" }, "secondary_label": { "type": "string", "nullable": true }, "secondary_url": { "type": "string", "nullable": true }, "shorten_secondary_url": { "type": "boolean" }, "secondary_url_shortening_mode": { "$ref": "#/components/schemas/BroadcastLinkShorteningMode" } }, "additionalProperties": false }, "ChannelOptions": { "type": "object", "properties": { "push": { "$ref": "#/components/schemas/PushOptions" }, "viber": { "$ref": "#/components/schemas/ViberOptions" }, "sms": { "$ref": "#/components/schemas/SmsOptions" } }, "additionalProperties": false }, "ChatSource": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 ], "type": "integer", "format": "int32" }, "ClientAddress": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "title": { "type": "string", "nullable": true }, "address": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ClientSender": { "type": "object", "properties": { "sender_name": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "name_en": { "type": "string", "nullable": true }, "project_id": { "type": "string", "nullable": true }, "channel": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "sender_direction": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "ClientSenderResp": { "type": "object", "properties": { "Body": { "type": "array", "items": { "$ref": "#/components/schemas/ClientSender" }, "nullable": true } }, "additionalProperties": false }, "ContactDetailsDto": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "position": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ContactReceiverDTO": { "type": "object", "properties": { "phone": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "viberBotReceivers": { "type": "array", "items": { "$ref": "#/components/schemas/ViberReceiverDTO" }, "nullable": true }, "telegramBotReceivers": { "type": "array", "items": { "$ref": "#/components/schemas/TelegramReceiverDTO" }, "nullable": true } }, "additionalProperties": false }, "ContactReceiverDTOPaginationDTO": { "type": "object", "properties": { "total": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ContactReceiverDTO" }, "nullable": true } }, "additionalProperties": false }, "Content": { "type": "object", "properties": { "sender_name": { "type": "string", "nullable": true }, "language": { "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true }, "text_example": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Contents": { "type": "object", "properties": { "viber": { "$ref": "#/components/schemas/Content" } }, "additionalProperties": false }, "CreateBMAccountResponse": { "type": "object", "properties": { "status": { "type": "string", "nullable": true }, "id": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "CreateExternalClientDTO": { "required": [ "login", "name", "organizationTypeId", "password", "referralId", "typeId" ], "type": "object", "properties": { "name": { "type": "string" }, "login": { "type": "string" }, "password": { "type": "string" }, "typeId": { "type": "integer", "format": "int32" }, "organizationTypeId": { "type": "integer", "format": "int32" }, "referralId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "CreateViberSurveyRequest": { "type": "object", "properties": { "form": { "$ref": "#/components/schemas/ExternalFormWithQuestionsDTO" }, "dateRanges": { "type": "array", "items": { "$ref": "#/components/schemas/SurveyDateRange" }, "nullable": true }, "phoneNumbers": { "type": "array", "items": { "type": "string" }, "nullable": true }, "alphaNameId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Detail": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "state": { "$ref": "#/components/schemas/State" } }, "additionalProperties": false }, "Dict": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "code": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ExternalAnswerDTO": { "type": "object", "properties": { "answerText": { "type": "string", "nullable": true }, "nextQuestion": { "$ref": "#/components/schemas/ExternalQuestionDTO" } }, "additionalProperties": false }, "ExternalCreateAlphaNameApplicationDto": { "type": "object", "properties": { "organizationId": { "type": "string", "format": "uuid" }, "alphaNameIn": { "type": "string", "nullable": true }, "edrpou": { "type": "string", "nullable": true }, "companyDetails": { "type": "string", "nullable": true }, "companyWebsite": { "type": "string", "nullable": true }, "messageExample": { "type": "string", "nullable": true }, "countries": { "type": "array", "items": { "type": "string" }, "nullable": true }, "callbackUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ExternalFormWithQuestionsDTO": { "type": "object", "properties": { "formName": { "type": "string", "nullable": true }, "questions": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalQuestionDTO" }, "nullable": true } }, "additionalProperties": false }, "ExternalQuestionDTO": { "type": "object", "properties": { "questionText": { "type": "string", "nullable": true }, "answers": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalAnswerDTO" }, "nullable": true } }, "additionalProperties": false }, "ExternalTgBotTriggerDTO": { "required": [ "text" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/TypeChatTrigger" }, "text": { "type": "string" } }, "additionalProperties": false }, "GetTempResp": { "type": "object", "properties": { "Body": { "type": "array", "items": { "$ref": "#/components/schemas/AddTemplateResponse" }, "nullable": true } }, "additionalProperties": false }, "GetTgBotShortDTO": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "token": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GetTgBotShortDTOPaginationDTO": { "type": "object", "properties": { "total": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/GetTgBotShortDTO" }, "nullable": true } }, "additionalProperties": false }, "GetTokenRequest": { "required": [ "login", "password" ], "type": "object", "properties": { "login": { "type": "string" }, "password": { "type": "string" } }, "additionalProperties": false }, "GetTransactionalTemplatesResponse": { "type": "object", "properties": { "Body": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionalTemplateResponse" }, "nullable": true } }, "additionalProperties": false }, "GMSSendMessageReq": { "type": "object", "properties": { "phone_number": { "type": "string", "nullable": true }, "extra_id": { "type": "string", "nullable": true }, "callback_url": { "type": "string", "nullable": true }, "start_time": { "type": "string", "format": "date-time", "nullable": true }, "tag": { "type": "string", "nullable": true }, "division_code": { "type": "string", "nullable": true }, "channels": { "type": "array", "items": { "type": "string" }, "nullable": true }, "channel_options": { "$ref": "#/components/schemas/ChannelOptions" } }, "additionalProperties": false }, "GMSSendMessageResp": { "type": "object", "properties": { "messageId": { "type": "string", "format": "uuid" }, "errorCode": { "type": "integer", "format": "int32", "nullable": true }, "errorText": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ImageDTO": { "type": "object", "properties": { "link": { "type": "string", "nullable": true }, "width": { "type": "integer", "format": "int32" }, "height": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ItemDTO": { "type": "object", "properties": { "search": { "type": "string", "nullable": true }, "allItems": { "type": "boolean" }, "itemIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "excludedIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "LegacyContact": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LegacyEmailAttachment": { "type": "object", "properties": { "fileName": { "type": "string", "nullable": true }, "base64Data": { "type": "string", "nullable": true }, "contentId": { "type": "string", "nullable": true }, "disposition": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LegacyEmailMessage": { "type": "object", "properties": { "to": { "type": "string", "nullable": true }, "fromName": { "type": "string", "nullable": true }, "subject": { "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true }, "html": { "type": "string", "nullable": true }, "ttl": { "type": "integer", "format": "int32", "nullable": true }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/LegacyEmailAttachment" }, "nullable": true } }, "additionalProperties": false }, "LegacyFallbackDTO": { "type": "object", "properties": { "video": { "type": "string", "nullable": true }, "toPhone": { "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true }, "messageType": { "type": "string", "nullable": true }, "ttl": { "type": "integer", "format": "int32", "nullable": true }, "fromName": { "type": "string", "nullable": true }, "media": { "type": "string", "nullable": true }, "contact": { "$ref": "#/components/schemas/LegacyContact" }, "location": { "$ref": "#/components/schemas/LegacyLocation" }, "thumbnail": { "type": "string", "nullable": true }, "size": { "type": "integer", "format": "int32", "nullable": true }, "duration": { "type": "integer", "format": "int32", "nullable": true }, "fileName": { "type": "string", "nullable": true }, "buttonText": { "type": "string", "nullable": true }, "buttonAction": { "type": "string", "nullable": true }, "emailMessage": { "$ref": "#/components/schemas/LegacyEmailMessage" }, "pushMessage": { "$ref": "#/components/schemas/LegacyPushMessage" } }, "additionalProperties": false }, "LegacyLocation": { "type": "object", "properties": { "lat": { "type": "string", "nullable": true }, "lon": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LegacyMessageDataDTO": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "fromName": { "type": "string", "nullable": true }, "toPhone": { "type": "string", "nullable": true }, "flashcallText": { "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true }, "messageType": { "type": "string", "nullable": true }, "ttl": { "type": "integer", "format": "int32", "nullable": true }, "sheduledSent": { "type": "string", "format": "date-time", "nullable": true }, "buttonText": { "type": "string", "nullable": true }, "buttonAction": { "type": "string", "nullable": true }, "wheterCheckSession": { "type": "boolean" }, "viberMessage": { "$ref": "#/components/schemas/LegacyViberMessage" }, "emailMessage": { "$ref": "#/components/schemas/LegacyEmailMessage" }, "pushMessage": { "$ref": "#/components/schemas/LegacyPushMessage" }, "smsMessage": { "$ref": "#/components/schemas/LegacySmsMessage" }, "whatsAppMessage": { "$ref": "#/components/schemas/WhatsAppMessageRequest" }, "fallbacks": { "type": "array", "items": { "$ref": "#/components/schemas/LegacyMessageDataDTO" }, "nullable": true }, "tgMessage": { "$ref": "#/components/schemas/LegacyTelegramMessageData" }, "customerData": { "nullable": true }, "guid": { "type": "string", "format": "uuid", "nullable": true }, "callbackUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LegacyPushMessage": { "type": "object", "properties": { "externalUserId": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "body": { "type": "string", "nullable": true }, "subtitle": { "type": "string", "nullable": true }, "sound": { "type": "string", "nullable": true }, "badge": { "type": "integer", "format": "int32", "nullable": true }, "data": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "ttl": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "LegacySender": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "avatar": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LegacySmsMessage": { "type": "object", "properties": { "text": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LegacyTelegramButton": { "type": "object", "properties": { "action": { "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LegacyTelegramMessageData": { "type": "object", "properties": { "text": { "type": "string", "nullable": true }, "photoUrl": { "type": "string", "nullable": true }, "photoBase64": { "type": "string", "nullable": true }, "videoUrl": { "type": "string", "nullable": true }, "chatId": { "type": "integer", "format": "int64" }, "buttons": { "type": "array", "items": { "$ref": "#/components/schemas/LegacyTelegramButton" }, "nullable": true } }, "additionalProperties": false }, "LegacyViberMessage": { "type": "object", "properties": { "receiver": { "nullable": true }, "minApiVersion": { "type": "integer", "format": "int32" }, "type": { "type": "string", "nullable": true }, "sender": { "$ref": "#/components/schemas/LegacySender" }, "text": { "maxLength": 7000, "type": "string", "nullable": true }, "media": { "type": "string", "nullable": true }, "trackingData": { "type": "string", "nullable": true }, "video": { "type": "string", "nullable": true }, "thumbnail": { "type": "string", "nullable": true }, "size": { "type": "integer", "format": "int32", "nullable": true }, "duration": { "type": "integer", "format": "int32", "nullable": true }, "fileName": { "type": "string", "nullable": true }, "contact": { "$ref": "#/components/schemas/LegacyContact" }, "location": { "$ref": "#/components/schemas/LegacyLocation" }, "stickerId": { "type": "integer", "format": "int32", "nullable": true }, "fallbackText": { "type": "string", "nullable": true }, "fallbacks": { "type": "array", "items": { "$ref": "#/components/schemas/LegacyFallbackDTO" }, "nullable": true }, "keyboard": { "nullable": true }, "survey": { "$ref": "#/components/schemas/SurveyData" }, "carousel": { "$ref": "#/components/schemas/CarouselData" } }, "additionalProperties": false }, "Message": { "type": "object", "properties": { "from": { "type": "string", "nullable": true }, "to": { "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "customerMessageId": { "type": "string", "nullable": true }, "source": { "$ref": "#/components/schemas/MessSource" }, "dtSend": { "type": "string", "format": "date-time", "nullable": true }, "dtExpire": { "type": "string", "format": "date-time", "nullable": true }, "ttl": { "type": "integer", "format": "int32", "nullable": true }, "messageData": { "$ref": "#/components/schemas/MessageData" }, "whatsAppMessage": { "$ref": "#/components/schemas/WhatsAppMessageRequest" }, "whatsAppBusinessAccountId": { "type": "integer", "format": "int32", "nullable": true }, "cascadeMessageGuid": { "type": "string", "format": "uuid", "nullable": true }, "contactMessageId": { "type": "integer", "format": "int32", "nullable": true }, "directCascade": { "type": "boolean" }, "fallbacks": { "type": "array", "items": { "$ref": "#/components/schemas/Message" }, "nullable": true } }, "additionalProperties": false }, "MessageData": { "type": "object", "properties": { "img": { "type": "string", "nullable": true }, "video": { "type": "string", "nullable": true }, "thumbnail": { "type": "string", "nullable": true }, "fileSize": { "type": "integer", "format": "int64", "nullable": true }, "duration": { "type": "integer", "format": "int32", "nullable": true }, "buttonText": { "type": "string", "nullable": true }, "buttonAction": { "type": "string", "nullable": true }, "fileUrl": { "type": "string", "nullable": true }, "fileName": { "type": "string", "nullable": true }, "fileType": { "type": "string", "nullable": true }, "survey": { "$ref": "#/components/schemas/SurveyData" }, "carousel": { "$ref": "#/components/schemas/CarouselData" }, "emailSubject": { "type": "string", "nullable": true }, "emailHtml": { "type": "string", "nullable": true }, "emailAttachmentKeys": { "type": "array", "items": { "type": "string" }, "nullable": true }, "pushExternalUserId": { "type": "string", "nullable": true }, "pushTitle": { "type": "string", "nullable": true }, "pushBody": { "type": "string", "nullable": true }, "pushSubtitle": { "type": "string", "nullable": true }, "pushSound": { "type": "string", "nullable": true }, "pushBadge": { "type": "integer", "format": "int32", "nullable": true }, "pushData": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "pushFirebaseAppId": { "type": "integer", "format": "int32", "nullable": true }, "pushExternalId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MessageResponse": { "type": "object", "properties": { "messageId": { "type": "string", "nullable": true }, "from": { "type": "string", "nullable": true }, "to": { "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true }, "dtExpire": { "type": "string", "format": "date-time", "nullable": true }, "customerMessageId": { "type": "string", "nullable": true }, "partsCount": { "type": "integer", "format": "int32" }, "type": { "type": "string", "nullable": true }, "error": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MessSource": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8 ], "type": "integer", "format": "int32" }, "MyCodeBotViberMessageRequest": { "type": "object", "properties": { "text": { "type": "string", "nullable": true }, "surveyOptions": { "type": "array", "items": { "type": "string" }, "nullable": true }, "optionType": { "$ref": "#/components/schemas/SurveyListMessageUIType" }, "trackingData": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MyCodeBotViberRequest": { "required": [ "messageRequest" ], "type": "object", "properties": { "source": { "$ref": "#/components/schemas/MessSource" }, "phone": { "type": "string", "nullable": true }, "messageRequest": { "$ref": "#/components/schemas/MyCodeBotViberMessageRequest" }, "serviceId": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" }, "messageId": { "type": "string", "nullable": true }, "seq": { "type": "string", "nullable": true } }, "additionalProperties": false }, "NewExternalBotApplication": { "type": "object", "properties": { "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "countryCode": { "type": "string", "nullable": true }, "companyName": { "type": "string", "nullable": true }, "companyWebsite": { "type": "string", "nullable": true }, "isBuisnessAccount": { "type": "boolean" }, "organizationTypeId": { "type": "integer", "format": "int32" }, "inquiry": { "type": "string", "nullable": true }, "bmId": { "type": "integer", "format": "int32" }, "phone": { "type": "string", "nullable": true }, "launchDate": { "type": "string", "format": "date-time", "nullable": true }, "desiredURI": { "type": "string", "nullable": true } }, "additionalProperties": false }, "NewOrganizationAuthToken": { "type": "object", "properties": { "organizationId": { "type": "integer", "format": "int32" }, "name": { "maxLength": 255, "type": "string", "nullable": true }, "description": { "maxLength": 1000, "type": "string", "nullable": true }, "expireDate": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "OrganizationDataDTO": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "contractNumber": { "type": "string", "nullable": true }, "authToken": { "type": "string", "nullable": true }, "nameLocal": { "type": "string", "nullable": true }, "nameEn": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "organizationType": { "type": "integer", "format": "int32", "nullable": true }, "phone": { "type": "string", "nullable": true }, "authorizedPersonDocument": { "type": "string", "nullable": true }, "authorizedPersonName": { "type": "string", "nullable": true }, "authorizedPersonPosition": { "type": "string", "nullable": true }, "bankAccount": { "type": "string", "nullable": true }, "bankName": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "fullLegalName": { "type": "string", "nullable": true }, "shortLegalName": { "type": "string", "nullable": true }, "isTaxPayer": { "type": "boolean", "nullable": true }, "passportIssuedDate": { "type": "string", "format": "date-time", "nullable": true }, "passportNumber": { "type": "string", "nullable": true }, "unzr": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OrganizationNameSync": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PhoneNumber": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "title": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PhoneReaderStatusDTO": { "type": "object", "properties": { "phoneNumber": { "type": "string", "nullable": true }, "countUnread": { "type": "integer", "format": "int32" }, "status": { "type": "string", "nullable": true }, "previousStatus": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PushNotificationStatusRequest": { "type": "object", "properties": { "status": { "type": "string", "nullable": true }, "occurredAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "PushOptions": { "type": "object", "properties": { "text": { "type": "string", "nullable": true }, "ttl": { "type": "integer", "format": "int32" }, "title": { "type": "string", "nullable": true }, "img": { "type": "string", "nullable": true }, "caption": { "type": "string", "nullable": true }, "action": { "type": "string", "nullable": true }, "ctr": { "type": "boolean" } }, "additionalProperties": false }, "PushRegisterInstallationRequest": { "type": "object", "properties": { "fcmToken": { "type": "string", "nullable": true }, "firebaseInstallationId": { "type": "string", "nullable": true }, "platform": { "type": "string", "nullable": true }, "externalUserId": { "type": "string", "nullable": true }, "notificationsEnabled": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "PushUnregisterInstallationRequest": { "type": "object", "properties": { "fcmToken": { "type": "string", "nullable": true }, "firebaseInstallationId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RcsCarouselCardDTO": { "required": [ "messageText" ], "type": "object", "properties": { "title": { "type": "string", "nullable": true }, "messageText": { "type": "string" }, "imageUrl": { "type": "string", "nullable": true }, "suggestions": { "type": "array", "items": { "$ref": "#/components/schemas/RcsSuggestionDTO" }, "nullable": true } }, "additionalProperties": false }, "RcsSuggestionDTO": { "required": [ "text" ], "type": "object", "properties": { "text": { "maxLength": 25, "type": "string" }, "url": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ReferralClientDTO": { "type": "object", "properties": { "tenantId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SendEmailRequest": { "required": [ "recipients", "subject" ], "type": "object", "properties": { "recipients": { "type": "array", "items": { "type": "string" } }, "subject": { "type": "string" }, "text": { "type": "string", "nullable": true }, "html": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SendingSourceCallback": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ], "type": "integer", "format": "int32" }, "SendMessageResponse": { "type": "object", "properties": { "state": { "$ref": "#/components/schemas/State" }, "total": { "type": "string", "nullable": true }, "queued": { "type": "string", "nullable": true }, "accepted": { "type": "string", "nullable": true }, "enroute": { "type": "string", "nullable": true }, "delivered": { "type": "string", "nullable": true }, "expired": { "type": "string", "nullable": true }, "undeliverable": { "type": "string", "nullable": true }, "unknown": { "type": "string", "nullable": true }, "date": { "type": "string", "nullable": true }, "reports": { "type": "string", "nullable": true }, "detail": { "type": "array", "items": { "$ref": "#/components/schemas/Detail" }, "nullable": true }, "execTime": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SendViberBMDTO": { "type": "object", "properties": { "from": { "type": "integer", "format": "int32" }, "ttl": { "type": "integer", "format": "int32" }, "text": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "buttonText": { "type": "string", "nullable": true }, "buttonLink": { "type": "string", "nullable": true }, "imageLink": { "type": "string", "nullable": true }, "video": { "$ref": "#/components/schemas/VideoDto" }, "template": { "$ref": "#/components/schemas/TemplateDto" } }, "additionalProperties": false }, "ShortBotInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "token": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ShortBotInfoPage": { "type": "object", "properties": { "countRecorded": { "type": "integer", "format": "int32" }, "botInfos": { "type": "array", "items": { "$ref": "#/components/schemas/ShortBotInfo" }, "nullable": true } }, "additionalProperties": false }, "SMSBatMessageRequest": { "type": "object", "properties": { "messages": { "type": "array", "items": { "$ref": "#/components/schemas/Message" }, "nullable": true }, "callbackUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SMSBatMessageResponse": { "type": "object", "properties": { "messagelistId": { "type": "string", "format": "uuid" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/MessageResponse" }, "nullable": true } }, "additionalProperties": false }, "SMSBatMessageStatus": { "type": "object", "properties": { "messagelistId": { "type": "string", "nullable": true }, "messageId": { "type": "string", "nullable": true }, "deliverystatus": { "type": "string", "nullable": true }, "partscount": { "type": "integer", "format": "int32", "nullable": true }, "error": { "type": "string", "nullable": true }, "statusExtended": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SmsOptions": { "type": "object", "properties": { "text": { "type": "string", "nullable": true }, "alpha_name": { "type": "string", "nullable": true }, "ttl": { "type": "integer", "format": "int32" }, "ctr": { "type": "boolean" } }, "additionalProperties": false }, "SmsWalletHistoryDto": { "type": "object", "properties": { "externalAlphaName": { "type": "string", "nullable": true }, "balance": { "$ref": "#/components/schemas/WalletBalanceDto" }, "transactions": { "$ref": "#/components/schemas/SmsWalletTransactionDtoPaginationDTO" } }, "additionalProperties": false }, "SmsWalletTransactionDto": { "type": "object", "properties": { "occurredAt": { "type": "string", "format": "date-time" }, "type": { "type": "string", "nullable": true }, "amount": { "type": "number", "format": "double" }, "currency": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SmsWalletTransactionDtoPaginationDTO": { "type": "object", "properties": { "total": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/SmsWalletTransactionDto" }, "nullable": true } }, "additionalProperties": false }, "State": { "type": "object", "properties": { "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "StringTurboSmsMessageSendResponseDTOListTurboSmsResponseDTODictionaryTurboSmsResponseDTO": { "type": "object", "properties": { "response_code": { "type": "integer", "format": "int32" }, "response_status": { "type": "string", "nullable": true }, "response_result": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/TurboSmsMessageSendResponseDTOListTurboSmsResponseDTO" }, "nullable": true } }, "additionalProperties": false }, "SurveyData": { "type": "object", "properties": { "list_message_ui_type": { "$ref": "#/components/schemas/SurveyListMessageUIType" }, "options": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "SurveyDateRange": { "type": "object", "properties": { "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "SurveyListMessageUIType": { "enum": [ 1, 2 ], "type": "integer", "format": "int32" }, "TelegramReceiverDTO": { "type": "object", "properties": { "botUri": { "type": "string", "nullable": true }, "userId": { "type": "integer", "format": "int64" }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "TemplateDto": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "lang": { "type": "string", "nullable": true }, "params": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "TemplateStatusName": { "enum": [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ], "type": "integer", "format": "int32" }, "TemplateUpdateDTO": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "templateId": { "type": "string", "nullable": true }, "regexMessage": { "type": "string", "nullable": true }, "exampleMessage": { "type": "string", "nullable": true }, "comment": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/TemplateStatusName" } }, "additionalProperties": false }, "TgBotUserSyncDTO": { "type": "object", "properties": { "userId": { "type": "integer", "format": "int64" }, "userName": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TgBotUserSyncDTOPaginationDTO": { "type": "object", "properties": { "total": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/TgBotUserSyncDTO" }, "nullable": true } }, "additionalProperties": false }, "TransactionalContent": { "required": [ "category", "language", "sender_name" ], "type": "object", "properties": { "sender_name": { "type": "string" }, "category": { "pattern": "^(OTP|Banking|Delivery|Booking|Transactional)$", "type": "string" }, "language": { "pattern": "^(ar|id|hy|it|be|ja|bs|ne|bg|no|my|fa|zh-Hans|pl|zh-Hant|pt_BR|hr|pt_PT|cs|ro|da|ru|nl|sr|en|sk|fi|sl|fr_FR|es_ES|ka|sv|de|th|el|tr|he|uk|hu|vi)$", "type": "string" }, "text": { "type": "string", "nullable": true }, "params": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionalParamDto" }, "nullable": true } }, "additionalProperties": false }, "TransactionalContents": { "type": "object", "properties": { "viber": { "$ref": "#/components/schemas/TransactionalContent" } }, "additionalProperties": false }, "TransactionalParamDto": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "exampleValue": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TransactionalTemplateRequest": { "type": "object", "properties": { "project_id": { "type": "string", "nullable": true }, "contents": { "$ref": "#/components/schemas/TransactionalContents" } }, "additionalProperties": false }, "TransactionalTemplateResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "template_uuid": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "project_id": { "type": "string", "nullable": true }, "contents": { "$ref": "#/components/schemas/TransactionalContents" } }, "additionalProperties": false }, "TurboSmsCarouselItemDTO": { "type": "object", "properties": { "title": { "type": "string", "nullable": true }, "image_url": { "type": "string", "nullable": true }, "file_id": { "type": "integer", "format": "int32", "nullable": true }, "button_caption": { "type": "string", "nullable": true }, "button_url": { "type": "string", "nullable": true }, "link_caption": { "type": "string", "nullable": true }, "link_url": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TurboSmsChatRecipientDTO": { "type": "object", "properties": { "chat_id": { "type": "integer", "format": "int32" }, "number": { "type": "string", "nullable": true }, "contact_id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "total_messages": { "type": "integer", "format": "int32" }, "unread_messages": { "type": "integer", "format": "int32" }, "last_message_date": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TurboSmsChatRecipientDTOListTurboSmsResponseDTO": { "type": "object", "properties": { "response_code": { "type": "integer", "format": "int32" }, "response_status": { "type": "string", "nullable": true }, "response_result": { "type": "array", "items": { "$ref": "#/components/schemas/TurboSmsChatRecipientDTO" }, "nullable": true } }, "additionalProperties": false }, "TurboSmsChatRecipientsRequestDTO": { "type": "object", "properties": { "sender_id": { "type": "integer", "format": "int32", "nullable": true }, "sender": { "type": "string", "nullable": true }, "page": { "type": "integer", "format": "int32", "nullable": true }, "rows": { "type": "integer", "format": "int32", "nullable": true }, "new_only": { "type": "integer", "format": "int32", "nullable": true }, "recipients": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "TurboSmsChatSendRequestDTO": { "type": "object", "properties": { "chat_id": { "type": "integer", "format": "int32", "nullable": true }, "sender_id": { "type": "integer", "format": "int32", "nullable": true }, "sender": { "type": "string", "nullable": true }, "recipient": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "file_name": { "type": "string", "nullable": true }, "file_data": { "type": "string", "nullable": true }, "file_url": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TurboSmsChatSendResponseDTO": { "type": "object", "properties": { "message_id": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "TurboSmsChatSendResponseDTOTurboSmsResponseDTO": { "type": "object", "properties": { "response_code": { "type": "integer", "format": "int32" }, "response_status": { "type": "string", "nullable": true }, "response_result": { "$ref": "#/components/schemas/TurboSmsChatSendResponseDTO" } }, "additionalProperties": false }, "TurboSmsDetailsDTO": { "type": "object", "properties": { "added": { "type": "string", "format": "date-time" }, "start": { "type": "string", "format": "date-time", "nullable": true }, "sent": { "type": "string", "format": "date-time", "nullable": true }, "updated": { "type": "string", "format": "date-time", "nullable": true }, "sender": { "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true }, "recipient": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "price": { "type": "number", "format": "double", "nullable": true }, "segments": { "type": "integer", "format": "int32" }, "ttl": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "TurboSmsFileDTO": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "size": { "type": "integer", "format": "int64" }, "link": { "type": "string", "nullable": true }, "source": { "type": "string", "nullable": true }, "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "TurboSmsFileDTOTurboSmsResponseDTO": { "type": "object", "properties": { "response_code": { "type": "integer", "format": "int32" }, "response_status": { "type": "string", "nullable": true }, "response_result": { "$ref": "#/components/schemas/TurboSmsFileDTO" } }, "additionalProperties": false }, "TurboSmsFileUploadRequestDto": { "type": "object", "properties": { "url": { "type": "string", "nullable": true }, "data": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TurboSmsMessageDetailsResponseDTO": { "type": "object", "properties": { "message_id": { "type": "string", "nullable": true }, "sms": { "$ref": "#/components/schemas/TurboSmsDetailsDTO" }, "viber": { "$ref": "#/components/schemas/TurboViberDetailsDTO" }, "response_code": { "type": "integer", "format": "int32" }, "response_status": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TurboSmsMessageDetailsResponseDTOListTurboSmsResponseDTO": { "type": "object", "properties": { "response_code": { "type": "integer", "format": "int32" }, "response_status": { "type": "string", "nullable": true }, "response_result": { "type": "array", "items": { "$ref": "#/components/schemas/TurboSmsMessageDetailsResponseDTO" }, "nullable": true } }, "additionalProperties": false }, "TurboSmsMessageSendRequestDTO": { "required": [ "recipients" ], "type": "object", "properties": { "referral_guid": { "type": "string", "format": "uuid", "nullable": true }, "sender": { "type": "string", "nullable": true }, "start_time": { "type": "string", "format": "date-time", "nullable": true }, "start_date": { "type": "string", "format": "date-time", "nullable": true }, "text": { "type": "string", "nullable": true }, "recipients": { "type": "array", "items": { "type": "string" } }, "sequence_id": { "type": "string", "nullable": true }, "viber": { "$ref": "#/components/schemas/TurboSmsViberParametersDTO" }, "sms": { "$ref": "#/components/schemas/TurboSmsSmsParametersDTO" } }, "additionalProperties": false }, "TurboSmsMessageSendResponseDTO": { "type": "object", "properties": { "phone": { "type": "string", "nullable": true }, "response_code": { "type": "integer", "format": "int32" }, "message_id": { "type": "string", "nullable": true }, "response_status": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TurboSmsMessageSendResponseDTOListTurboSmsResponseDTO": { "type": "object", "properties": { "response_code": { "type": "integer", "format": "int32" }, "response_status": { "type": "string", "nullable": true }, "response_result": { "type": "array", "items": { "$ref": "#/components/schemas/TurboSmsMessageSendResponseDTO" }, "nullable": true } }, "additionalProperties": false }, "TurboSmsMessageStatusRequestDTO": { "type": "object", "properties": { "messages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "TurboSmsMessageStatusResponseDTO": { "type": "object", "properties": { "message_id": { "type": "string", "nullable": true }, "response_code": { "type": "integer", "format": "int32" }, "response_status": { "type": "string", "nullable": true }, "recipient": { "type": "string", "nullable": true }, "sent": { "type": "string", "format": "date-time", "nullable": true }, "updated": { "type": "string", "format": "date-time", "nullable": true }, "status": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "rejected_status": { "type": "string", "nullable": true }, "click_time": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "TurboSmsMessageStatusResponseDTOListTurboSmsResponseDTO": { "type": "object", "properties": { "response_code": { "type": "integer", "format": "int32" }, "response_status": { "type": "string", "nullable": true }, "response_result": { "type": "array", "items": { "$ref": "#/components/schemas/TurboSmsMessageStatusResponseDTO" }, "nullable": true } }, "additionalProperties": false }, "TurboSmsSmsParametersDTO": { "type": "object", "properties": { "sender": { "type": "string", "nullable": true }, "start_time": { "type": "string", "format": "date-time", "nullable": true }, "start_date": { "type": "string", "format": "date-time", "nullable": true }, "text": { "type": "string", "nullable": true }, "is_flash": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "TurboSmsViberParametersDTO": { "type": "object", "properties": { "sender": { "type": "string", "nullable": true }, "start_time": { "type": "string", "format": "date-time", "nullable": true }, "start_date": { "type": "string", "format": "date-time", "nullable": true }, "text": { "type": "string", "nullable": true }, "ttl": { "type": "integer", "format": "int32", "nullable": true }, "image_url": { "type": "string", "nullable": true }, "caption": { "type": "string", "nullable": true }, "action": { "type": "string", "nullable": true }, "file_id": { "type": "integer", "format": "int32", "nullable": true }, "count_clicks": { "type": "boolean", "nullable": true }, "is_transactional": { "type": "boolean", "nullable": true }, "carousel": { "type": "array", "items": { "$ref": "#/components/schemas/TurboSmsCarouselItemDTO" }, "nullable": true }, "survey": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "TurboViberDetailsDTO": { "type": "object", "properties": { "added": { "type": "string", "format": "date-time" }, "start": { "type": "string", "format": "date-time", "nullable": true }, "sent": { "type": "string", "format": "date-time", "nullable": true }, "updated": { "type": "string", "format": "date-time", "nullable": true }, "sender": { "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true }, "recipient": { "type": "string", "nullable": true }, "message_type": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "rejected_status": { "type": "string", "nullable": true }, "price": { "type": "number", "format": "double", "nullable": true }, "ttl": { "type": "integer", "format": "int32", "nullable": true }, "caption": { "type": "string", "nullable": true }, "action": { "type": "string", "nullable": true }, "file_id": { "type": "integer", "format": "int32", "nullable": true }, "click_time": { "type": "string", "format": "date-time", "nullable": true }, "is_transactional": { "type": "integer", "format": "int32", "nullable": true }, "carousel": { "type": "array", "items": { "$ref": "#/components/schemas/TurboSmsCarouselItemDTO" }, "nullable": true }, "survey": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "TypeChatTrigger": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "UpdateBotReceiverPhone": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "phone": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateBuisnessAccount": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "about": { "type": "string", "nullable": true }, "website": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "restrictionAgeId": { "type": "integer", "format": "int32", "nullable": true }, "customAutoReply": { "type": "boolean", "nullable": true }, "autoReplyMessage": { "type": "string", "nullable": true }, "businessName": { "type": "string", "nullable": true }, "source": { "type": "integer", "format": "int32", "nullable": true }, "businessRegisteredCountry": { "type": "string", "nullable": true }, "bmChatDescription": { "type": "string", "nullable": true }, "businessLaunchDate": { "type": "string", "format": "date-time", "nullable": true }, "destinationCountries": { "type": "array", "items": { "type": "string" }, "nullable": true }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/ClientAddress" }, "nullable": true }, "phones": { "type": "array", "items": { "$ref": "#/components/schemas/PhoneNumber" }, "nullable": true }, "categories": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "contactDetails": { "$ref": "#/components/schemas/ContactDetailsDto" } }, "additionalProperties": false }, "UpsertExternalTgBotDTO": { "required": [ "callbackUrl", "name", "organizationId", "typeCode" ], "type": "object", "properties": { "organizationId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "typeCode": { "type": "string" }, "isChating": { "type": "boolean" }, "triggers": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalTgBotTriggerDTO" }, "nullable": true }, "callbackUrl": { "type": "string" } }, "additionalProperties": false }, "UpsertTgUserSyncDTO": { "type": "object", "properties": { "userId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpsertViberBotUser": { "type": "object", "properties": { "userId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UserBonusDataDto": { "required": [ "phone", "totalBonuses" ], "type": "object", "properties": { "phone": { "maxLength": 22, "minLength": 7, "type": "string", "format": "tel" }, "totalBonuses": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" }, "period": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "ViberBotCallbackMessage": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true }, "media": { "type": "string", "nullable": true }, "location": { "$ref": "#/components/schemas/ViberLocation" }, "tracking_data": { "type": "string", "nullable": true }, "contact": { "$ref": "#/components/schemas/ViberContact" }, "file_name": { "type": "string", "nullable": true }, "file_size": { "type": "integer", "format": "int64", "nullable": true }, "duration": { "type": "integer", "format": "int64", "nullable": true }, "sticker_id": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "ViberBotDetailsStatisticDTO": { "type": "object", "properties": { "date": { "type": "string", "nullable": true }, "bot_uri": { "type": "string", "nullable": true }, "bot_name": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "rate_type": { "type": "string", "nullable": true }, "rate": { "type": "number", "format": "double" }, "attempts": { "type": "integer", "format": "int32" }, "sent": { "type": "integer", "format": "int32" }, "delivered": { "type": "integer", "format": "int32" }, "billed": { "type": "integer", "format": "int32" }, "charged": { "type": "number", "format": "double" } }, "additionalProperties": false }, "ViberBotStatisticDTO": { "type": "object", "properties": { "count_recorded": { "type": "integer", "format": "int32" }, "total_charged": { "type": "number", "format": "double" }, "count_billed": { "type": "integer", "format": "int32" }, "count_delivered": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ViberBotDetailsStatisticDTO" }, "nullable": true } }, "additionalProperties": false }, "ViberBotUserSyncDTO": { "type": "object", "properties": { "viberId": { "type": "string", "nullable": true }, "userName": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ViberBotUserSyncDTOPaginationDTO": { "type": "object", "properties": { "total": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ViberBotUserSyncDTO" }, "nullable": true } }, "additionalProperties": false }, "ViberBotWebhookReq": { "type": "object", "properties": { "event": { "type": "string", "nullable": true }, "timestamp": { "type": "integer", "format": "int64", "nullable": true }, "user": { "$ref": "#/components/schemas/ViberUser" }, "message_token": { "type": "integer", "format": "int64", "nullable": true }, "chat_hostname": { "type": "string", "nullable": true }, "user_id": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "context": { "type": "string", "nullable": true }, "subscribed": { "type": "boolean", "nullable": true }, "desc": { "type": "string", "nullable": true }, "sender": { "$ref": "#/components/schemas/ViberUser" }, "message": { "$ref": "#/components/schemas/ViberBotCallbackMessage" }, "silent": { "type": "boolean" } }, "additionalProperties": false }, "ViberBusinessAccount": { "type": "object", "properties": { "projectId": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "about": { "type": "string", "nullable": true }, "website": { "type": "string", "nullable": true }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/ClientAddress" }, "nullable": true }, "phones": { "type": "array", "items": { "$ref": "#/components/schemas/PhoneNumber" }, "nullable": true }, "restrictionAgeId": { "type": "integer", "format": "int32" }, "categories": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "source": { "type": "integer", "format": "int32", "nullable": true }, "businessRegisteredCountry": { "type": "string", "nullable": true }, "destinationCountries": { "type": "array", "items": { "type": "string" }, "nullable": true }, "launchDate": { "type": "string", "format": "date-time", "nullable": true }, "legalName": { "type": "string", "nullable": true }, "beneficialOwner": { "type": "string", "nullable": true }, "contactDetails": { "$ref": "#/components/schemas/ContactDetailsDto" } }, "additionalProperties": false }, "ViberCarouselItem": { "type": "object", "properties": { "title": { "type": "string", "nullable": true }, "image_url": { "type": "string", "nullable": true }, "primary_label": { "type": "string", "nullable": true }, "primary_url": { "type": "string", "nullable": true }, "secondary_label": { "type": "string", "nullable": true }, "secondary_url": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ViberContact": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "phone_number": { "type": "string", "nullable": true }, "avatar": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ViberLocation": { "type": "object", "properties": { "lat": { "type": "number", "format": "double" }, "lon": { "type": "number", "format": "double" } }, "additionalProperties": false }, "ViberMessageDTO": { "type": "object", "properties": { "phone": { "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true }, "alphaName": { "type": "string", "nullable": true }, "serviceId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ViberOptions": { "type": "object", "properties": { "text": { "type": "string", "nullable": true }, "ttl": { "type": "integer", "format": "int32", "nullable": true }, "device": { "type": "string", "nullable": true }, "img": { "type": "string", "nullable": true }, "caption": { "type": "string", "nullable": true }, "action": { "type": "string", "nullable": true }, "ctr": { "type": "boolean", "nullable": true }, "alpha_name": { "type": "string", "nullable": true }, "file_name": { "type": "string", "nullable": true }, "thumbnail": { "type": "string", "nullable": true }, "file_size": { "type": "integer", "format": "int32", "nullable": true }, "duration": { "type": "integer", "format": "int32", "nullable": true }, "survey_options": { "type": "array", "items": { "type": "string" }, "nullable": true }, "carousel_items": { "type": "array", "items": { "$ref": "#/components/schemas/ViberCarouselItem" }, "nullable": true } }, "additionalProperties": false }, "ViberReceiverDTO": { "type": "object", "properties": { "botUri": { "type": "string", "nullable": true }, "viberId": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "ViberTemplateStatusCallbackRequestDto": { "type": "object", "properties": { "url": { "type": "string", "nullable": true }, "header_name": { "type": "string", "nullable": true }, "header_value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ViberTransactionalTemplateCallbackDataDto": { "required": [ "template_id" ], "type": "object", "properties": { "template_id": { "type": "string" }, "service_id": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ViberTransactionalTemplateCallbackDto": { "required": [ "data", "token" ], "type": "object", "properties": { "token": { "type": "string" }, "type": { "type": "integer", "format": "int32" }, "timestamp": { "type": "integer", "format": "int64" }, "data": { "$ref": "#/components/schemas/ViberTransactionalTemplateCallbackDataDto" } }, "additionalProperties": false }, "ViberUser": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "avatar": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "language": { "type": "string", "nullable": true }, "api_version": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ViberUserMessage": { "type": "object", "properties": { "text": { "type": "string", "nullable": true }, "media": { "type": "string", "nullable": true }, "tracking_data": { "type": "string", "nullable": true }, "file_name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ViberWebhookRequest": { "type": "object", "properties": { "message_token": { "type": "string", "nullable": true }, "message_status": { "type": "integer", "format": "int32", "nullable": true }, "message_time": { "type": "integer", "format": "int64", "nullable": true }, "phone_number": { "type": "string", "nullable": true }, "service_id": { "type": "integer", "format": "int32", "nullable": true }, "time": { "type": "integer", "format": "int64", "nullable": true }, "message": { "$ref": "#/components/schemas/ViberUserMessage" } }, "additionalProperties": false }, "VideoDto": { "type": "object", "properties": { "url": { "type": "string", "nullable": true }, "thumbnail": { "type": "string", "nullable": true }, "sizeMb": { "type": "number", "format": "double" }, "sizeBytes": { "type": "integer", "format": "int64", "nullable": true }, "durationSec": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "WalletBalanceDto": { "type": "object", "properties": { "amount": { "type": "number", "format": "double" }, "currency": { "type": "string", "nullable": true }, "lastTransactionAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "WhatsAppContactAddressDto": { "type": "object", "properties": { "street": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "zip": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "country_code": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true } }, "additionalProperties": false }, "WhatsAppContactDto": { "type": "object", "properties": { "name": { "$ref": "#/components/schemas/WhatsAppContactNameDto" }, "emails": { "type": "array", "items": { "$ref": "#/components/schemas/WhatsAppContactEmailDto" }, "nullable": true }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/WhatsAppContactAddressDto" }, "nullable": true }, "urls": { "type": "array", "items": { "$ref": "#/components/schemas/WhatsAppContactUrlDto" }, "nullable": true }, "org": { "$ref": "#/components/schemas/WhatsAppContactOrganizationDto" }, "birthday": { "type": "string", "nullable": true }, "phones": { "type": "array", "items": { "$ref": "#/components/schemas/WhatsAppContactPhoneDto" }, "nullable": true } }, "additionalProperties": false }, "WhatsAppContactEmailDto": { "type": "object", "properties": { "email": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true } }, "additionalProperties": false }, "WhatsAppContactNameDto": { "type": "object", "properties": { "formatted_name": { "type": "string", "nullable": true }, "first_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "WhatsAppContactOrganizationDto": { "type": "object", "properties": { "company": { "type": "string", "nullable": true }, "department": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true } }, "additionalProperties": false }, "WhatsAppContactPhoneDto": { "type": "object", "properties": { "phone": { "type": "string", "nullable": true }, "wa_id": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true } }, "additionalProperties": false }, "WhatsAppContactUrlDto": { "type": "object", "properties": { "url": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true } }, "additionalProperties": false }, "WhatsAppInteractiveActionDto": { "type": "object", "properties": { "button": { "type": "string", "nullable": true }, "buttons": { "type": "array", "items": { "$ref": "#/components/schemas/WhatsAppInteractiveButtonDto" }, "nullable": true }, "sections": { "type": "array", "items": { "$ref": "#/components/schemas/WhatsAppInteractiveSectionDto" }, "nullable": true } }, "additionalProperties": false }, "WhatsAppInteractiveBodyDto": { "type": "object", "properties": { "text": { "type": "string", "nullable": true } }, "additionalProperties": false }, "WhatsAppInteractiveButtonDto": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "reply": { "$ref": "#/components/schemas/WhatsAppInteractiveRowDto" } }, "additionalProperties": false }, "WhatsAppInteractiveDto": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "body": { "$ref": "#/components/schemas/WhatsAppInteractiveBodyDto" }, "header": { "$ref": "#/components/schemas/WhatsAppInteractiveHeaderDto" }, "footer": { "$ref": "#/components/schemas/WhatsAppInteractiveBodyDto" }, "action": { "$ref": "#/components/schemas/WhatsAppInteractiveActionDto" } }, "additionalProperties": false }, "WhatsAppInteractiveHeaderDto": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true } }, "additionalProperties": false }, "WhatsAppInteractiveRowDto": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "WhatsAppInteractiveSectionDto": { "type": "object", "properties": { "title": { "type": "string", "nullable": true }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/WhatsAppInteractiveRowDto" }, "nullable": true } }, "additionalProperties": false }, "WhatsAppLocationDto": { "type": "object", "properties": { "latitude": { "type": "number", "format": "double", "nullable": true }, "longitude": { "type": "number", "format": "double", "nullable": true }, "name": { "type": "string", "nullable": true }, "address": { "type": "string", "nullable": true } }, "additionalProperties": false }, "WhatsAppMessageRequest": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true }, "media": { "$ref": "#/components/schemas/WhatsAppRequestMediaDto" }, "template": { "$ref": "#/components/schemas/WhatsAppRequestTemplateDto" }, "location": { "$ref": "#/components/schemas/WhatsAppLocationDto" }, "contact": { "$ref": "#/components/schemas/WhatsAppContactDto" }, "interactive": { "$ref": "#/components/schemas/WhatsAppInteractiveDto" } }, "additionalProperties": false }, "WhatsAppRequestMediaDto": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "filename": { "type": "string", "nullable": true }, "caption": { "type": "string", "nullable": true } }, "additionalProperties": false }, "WhatsAppRequestTemplateBodyDto": { "type": "object", "properties": { "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/WhatsAppRequestTemplateBodyParameterDto" }, "nullable": true } }, "additionalProperties": false }, "WhatsAppRequestTemplateBodyParameterDto": { "type": "object", "properties": { "text": { "type": "string", "nullable": true } }, "additionalProperties": false }, "WhatsAppRequestTemplateButtonDto": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "index": { "type": "integer", "format": "int32", "nullable": true }, "quick_reply_payload": { "type": "string", "nullable": true }, "url_parameter": { "type": "string", "nullable": true } }, "additionalProperties": false }, "WhatsAppRequestTemplateDto": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "language": { "type": "string", "nullable": true }, "header": { "$ref": "#/components/schemas/WhatsAppRequestTemplateHeaderDto" }, "body": { "$ref": "#/components/schemas/WhatsAppRequestTemplateBodyDto" }, "buttons": { "type": "array", "items": { "$ref": "#/components/schemas/WhatsAppRequestTemplateButtonDto" }, "nullable": true } }, "additionalProperties": false }, "WhatsAppRequestTemplateHeaderDto": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true }, "image": { "$ref": "#/components/schemas/WhatsAppRequestMediaDto" }, "video": { "$ref": "#/components/schemas/WhatsAppRequestMediaDto" }, "document": { "$ref": "#/components/schemas/WhatsAppRequestMediaDto" } }, "additionalProperties": false } }, "securitySchemes": { "Bearer": { "type": "http", "description": "Please enter token", "scheme": "bearer", "bearerFormat": "JWT" }, "basic": { "type": "http", "description": "Basic Auth using username and password", "scheme": "basic" }, "XAuth": { "type": "apiKey", "description": "X-Authorization-Key header authentication", "name": "X-Authorization-Key", "in": "header" } } }, "security": [ { "Bearer": [ ] }, { "basic": [ ] }, { "XAuth": [ ] } ] }