Base64image
Base64image
", "Attachments": [ { "Name": "file.pdf", "ContentType": "application/pdf", "FileData": "JVBERi0xLjQKJeLjz9MKMyAwIG9iago8PC9UeXBlIC9QYWdlCi9QYXJlbnQgMSAwIFIKL01lZGlhQm94IFswIDAgNTk1IDg0Ml0KL1Jlc291cmNlcyAyIDAgUgovQ29udGVudHMgNCAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwvTGVuZ3RoIDM1Pj4Kc3RyZWFtCkJUCi9GMSAyNCBUZgoxMDAgNzAwIFRkCihIZWxsbyBQREYpIFRqCkVUCmVuZHN0cmVhbQplbmRvYmoKMSAwIG9iago8PC9UeXBlIC9QYWdlcwovS2lkcyBbMyAwIFJdCi9Db3VudCAxCj4+CmVuZG9iagoyIDAgb2JqCjw8L0ZvbnQgPDwvRjEgPDwvVHlwZSAvRm9udAovU3VidHlwZSAvVHlwZTEKL0Jhc2VGb250IC9IZWx2ZXRpY2EKPj4+Pj4+CmVuZG9iago1IDAgb2JqCjw8L1R5cGUgL0NhdGFsb2cKL1BhZ2VzIDEgMCBSCj4+CmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYKMDAwMDAwMDIwMSA2NTUzNSBuCjAwMDAwMDAyNTAgNjU1MzUgbgowMDAwMDAwMDE1IDY1NTM1IG4KMDAwMDAwMDExMCA2NTUzNSBuCjAwMDAwMDAzMjMgNjU1MzUgbgp0cmFpbGVyCjw8L1NpemUgNgovUm9vdCA1IDAgUgo+PgpzdGFydHhyZWYKMzcwCiUlRU9G" } ], "IncludeContacts": [ { "Email": "_STRING_" } ] } } } } } } } } }, "/api/v2/Umail/Campaign/List/": { "post": { "tags": [ "מיילים (Email)" ], "summary": "Mail › Campaign › Get Campaign List", "description": "The function retrieve a list of all the campaigns details under your account.\n\nParameter\nRequired\\Optional\nType\nValue\n\nCampaignIds\nOptional\nint\nFor get details about couple campaigns enter array with the Campaign Ids\n\nStartDate\nOptional\ndate\nFor filter the campaigns by date enter start date\n\nEndDate\nOptional\ndate\nFor filter the campaigns by date enter end date", "security": [ { "basicAuth": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "StatusId": 1, "StatusDescription": "Success", "DetailedDescription": "", "FunctionName": "api/v2/Umail/Campaign/List", "RequestId": ",,Abh5mclRnbp5yZul2ZhR3cuEjMkV3bsN2Z0NXPl1WYOR3cvhkJwMTQzUSMzE0MlATMrEjMtYDMtIjMwITPw1WY0NVZtlGVmQzM4QDMwETPklkclNXV", "Data": { "List": [ { "id": 30000810, "name": "בדיקה (8)", "created": "2022-05-31 15:33:41", "status": "completed", "sent": 4, "opened": 3, "clicks": 2, "returned": "0", "blocked": "0", "url": "https://uclicks.inforustg.com/?page=webview&show=body&message=%2CUTM4ADMwAzM" } ] } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "examples": { "Get Campaign List": { "value": { "Data": { "CampaignIds": [ "30000810", "43561229" ], "StartDate": "2022-05-31", "EndDate": "2023-05-31" } } } } } } } } }, "/api/v2/Umail/Campaign/Get/": { "post": { "tags": [ "מיילים (Email)" ], "summary": "Mail › Campaign › Get Campaign", "description": "The function retrieve a specific campaign details under your account.\n\nParameter\nRequired\\Optional\nType\nValue\n\nCampaignId\nRequired\nint\nThe Campaign Id that you want get details about", "security": [ { "basicAuth": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "StatusId": 1, "StatusDescription": "Success", "DetailedDescription": "", "FunctionName": "api/v2/Umail/Campaign/Get", "RequestId": ",,Abh5mclRnbp5yZul2ZhR3cuEjMkV3bsN2Z0NXPl1WYOR3cvhkJyATQzUyNzE0MlATMrEjMtYDMtIjMwITPw1WY0NVZtlGVmQzM4QDMwETPklkclNXV", "Data": { "id": 30000809, "name": "בדיקה (7)", "created": "2022-05-31 15:23:31", "status": "completed", "sent": 4, "opened": 3, "clicks": 2, "returned": "0", "blocked": "0", "url": "https://uclicks.inforustg.com/?page=webview&show=body&message=%2CQTM4ADMwAzM" } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "examples": { "Get Campaign": { "value": { "Data": { "CampaignId": "30000809" } } } } } } } } }, "/api/v2/Umail/Campaign/Update": { "post": { "tags": [ "מיילים (Email)" ], "summary": "Mail › Campaign › Update Campaign", "description": "The function use for duplicate and update an existing Campaign\n\nParameterRequired\\OptionaltypeValue\nDuplicateFromCampaignIdRequiredintcampaignId that will serve as a template for creating a new campaign in draft mode\nCampaignNameRequiredstringThe name of the new campaign\nFromAddressRequiredboolThe mail address that you send from this address have to be in white list in the system\nSubjectRequiredstringThe email subject\nBodyRequiredstringThe email content\nStringReplace-FieldsOptionalstringThe object where you want to make the replacement -\nSubject/Body\nStringReplace-SearchOptionalstringThe current value you want to replace\nStringReplace-ReplaceOptionalstringThe new value", "security": [ { "basicAuth": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "StatusId": 1, "StatusDescription": "Success", "DetailedDescription": "", "FunctionName": "api/v2/Umail/Campaign/Update", "RequestId": ",,Abh5mclRnbp5yZul2ZhR3cuEjMkV3bsN2Z0NXPl1WYOR3cvhkJwITQzUCOwE0MlETMrEjMtYDMtIjMwITPw1WY0NVZtlGVmQzM4QDMwETPklkclNXV", "Data": { "StatusId": 1, "StatusDescription": "Success", "CampaignId": 30000824 } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "examples": { "Update Campaign": { "value": { "Data": { "DuplicateFromCampaignId": "30000810", "StringReplace": [ { "Field": "Subject", "Search": "param1", "Replace": "param2" } ] } } } } } } } } }, "/api/v2/Umail/Campaign/Job": { "post": { "tags": [ "מיילים (Email)" ], "summary": "Mail › Utilities › Get job status", "description": "The function return the campaign status after sending a campaign\nThe optional statuses are: New, Pending, Ready , Progress, Success, Failed.\n\nParameter\nRequired\\Optional\ntype\nValue\n\nJobToken\nRequired\nstring\nThe token from the campaign sending response\n\nResponse Parameter\n\nAction:\nDsn\nOpen\nClick\nReturn\nUnsubscribe\n\nValues\n2.0.0/4.0.0/ 5.0.0\ndesktop / mobile\nhttp://www.example.com/\nCustomer Request \n24/06/2015 14:54\nrequest\n\nMoreInfo\nMoreInfo Sent/ deferred", "security": [ { "basicAuth": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "StatusId": 1, "StatusDescription": "Success", "DetailedDescription": "", "FunctionName": "api/v2/Umail/Campaign/Job", "RequestId": ",,Abh5mclRnbp5yZul2ZhR3cuEjMkV3bsN2Z0NXPl1WYOR3cvhkJ5QTQzUyMxE0MlETMrEjMtYDMtIjMwITPw1WY0NVZtlGVmQzM4QDMwETPklkclNXV", "Data": { "status": "pending", "description": "" } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "examples": { "Get job status": { "value": { "Data": { "JobToken": "715fzq90yzsi" } } } } } } } } }, "/api/v2/Umail/GetMailNotification": { "post": { "tags": [ "מיילים (Email)" ], "summary": "Mail › Utilities › Get Mail Notification", "description": "This function is used to receive information about recipients that received/not recived the email (DSN) and the recipients that opened / clicked on the email.\nrequired to pre-set the settings in the system to store the data.\nAfter pulling the data they are deleted from the queue.\n\nParameter\nRequired\\Optional\nType\nValue\n\nBatchSize\nRequired\nstring\nThe number of Messages transferred\n\nResponse Parameter\n\nAction\nDsn\nOpen\nClick\nReturn\nUnsubscribe\nCustomerMessageId\n\nValues\n2.0.0/4.0.0/5.0.0\ndesktop \\mobile\nhttp://www.example.com\nCustomer Request 24/06/2015 14:54\nrequest\nCan be displayd if the parmeter sent in the sent email reques and the mail bodu conatin this parameter \n[#CustomerMessageId#]\n\nMoreInfo\nSent/ deferred", "security": [ { "basicAuth": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "StatusId": 1, "StatusDescription": "Success", "DetailedDescription": "", "FunctionName": "api/v2/Umail/GetMailNotification", "RequestId": ",wWYuJXZ05WauUncvZmbp5CMxkGchNWPl1WYOR3cvhkJxUTQzUSOwE0MlUTMrYDMtcDMtIjMwITPw1WY0NVZtlGVmQDNyQDNwETPklkclNXV", "Data": { "List": [ { "Datetime": "2022-07-04 09:35:47", "CampaignId": 69042121, "Email": "ariel.l@mesergo.co.il", "Action": "open", "Value": "desktop", "CustomerMessageId": 1234 }, { "Datetime": "2022-07-03 22:14:05", "CampaignId": 69042121, "Email": "ariel.l@mesergo.co.il", "Action": "dsn", "Value": "2.0.0", "MoreInfo": "sent", "AdditionalInformation": "250 2.0.0 OK 1656875494 ", "CustomerMessageId": 12345 }, { "Datetime": "2022-07-03 22:11:39", "CampaignId": 69042121, "Email": "ariel.l@mesergo.co.il", "Action": "open", "Value": "desktop", "CustomerMessageId": 12346 } ] } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "examples": { "Get Mail Notification": { "value": { "Data": { "BatchSize": "200" } } } } } } } } }, "/demo.aspx": { "post": { "tags": [ "מיילים (Email)" ], "summary": "Mail › Utilities › Notification On Unsubscribe", "description": "If you are interested to receiving an update at the time of Unsubscribe of the recipient, please contact our customer\nservice and provide us the URL It sends an update.", "security": [ { "basicAuth": [] } ], "responses": { "200": { "description": "OK" } }, "servers": [ { "url": "http://www.clienturl.co.il" } ], "requestBody": { "required": true, "content": { "application/json": { "examples": { "Notification On Unsubscribe": { "value": "