[ { "section": "SMS", "name": "Simple example", "label": "Send SMS › Send SMS using json › Simple example", "method": "POST", "url": "https://capi.mesergo.co.il/api/v2/SMS/SendSms", "headers": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Authorization", "value": "Your Base Credentials" } ], "bodyLang": "json", "body": "{\r\n \"Data\": {\r\n \"Message\": \"Hello world\",\r\n \"Recipients\": [\r\n {\r\n \"Phone\": \"0541234567\"\r\n }\r\n ],\r\n \"Settings\": {\r\n \"Sender\": \"MyBrand\"\r\n } \r\n}\r\n}", "desc": "Parameters\nRequired \\ Optional\nType\nValue\n\nMessage\nrequired\nstring\nSMS message that needs to be sent.\n\nPhone\nrequired\nstring\nThe recipient phone number.\n\nSender\nrequired\nstring\nThe ID that will be displayed in the recipient's phone as the sender. \nThe \"Sender\" field is restricted to a maximum of 11 characters (Consecutive characters, no spaces) or a Phone number that contains maximum 14 digits (no characters)that allowed in the white list in the system(to insert the phone to the white list go to the folder Whitelist - Sender ). You can also write an asterisk (*) at the beginning \nof the identifier.", "respCode": 200, "respExample": "{\n \"StatusId\": 1,\n \"StatusDescription\": \"Success\",\n \"DetailedDescription\": \"\",\n \"FunctionName\": \"api/v2/SMS/SendSms\",\n \"RequestId\": \"sFmbyVGdulmL1J3bm5WauEjMnR3ckV3bsNWPl1WYOR3cvhkJxETQzUSO1E0MlkDMrgTMtATMtEjMwITPw1WY0NVZtlGVmcjM4MDMwETPklkclNXV\",\n \"Data\": {\n \"Recipients\": 1,\n \"Errors\": null\n }\n}" }, { "section": "SMS", "name": "Advanced example", "label": "Send SMS › Send SMS using json › Advanced example", "method": "POST", "url": "https://capi.mesergo.co.il/api/v2/SMS/SendSms", "headers": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Authorization", "value": "Your Base Credentials" } ], "bodyLang": "json", "body": "{\r\n \"Data\": {\r\n \"Message\": \"Hello [#FirstName#] [#LastName#], reminder for meeting with [#Representative#]\",\r\n \r\n \"Recipients\": [\r\n {\r\n \"FirstName\": \"John\",\r\n \"LastName\": \"Smith\",\r\n \"Representative\": \"David\",\r\n \"CustomerMessageID\": \"33\",\r\n \"CustomerParameter\": \"44\",\r\n \"Phone\": \"0541234567\"\r\n },\r\n {\r\n \"FirstName\": \"Danni\",\r\n \"LastName\": \"levi\",\r\n \"Representative\": \"Mike\",\r\n \"CustomerMessageID\": \"55\",\r\n \"CustomerParameter\": \"66\",\r\n \"Phone\": \"0581234567\" \r\n }\r\n ],\r\n \"GroupNumbers\": [\r\n {\r\n \"GroupNumber\": 7\r\n }\r\n ],\r\n \"ExcludeGroupNumbers\": [\r\n {\r\n \"GroupNumber\": 29\r\n }\r\n ],\r\n \"Settings\": {\r\n \"Sender\": \"info\",\r\n \"CampaignName\": \"Advance sending\",\r\n \"TimeToSend\": \"2022-11-13 13:00:00\",\r\n \"DelayInSeconds\": 65,\r\n \"CustomerMessageID\": \"AF7864348\",\r\n \"CustomerParameter\": \"sms\",\r\n \"DeliveryNotificationUrl\": \"https://mysite.co.il/DeliveryNotification.aspx\",\r\n \"Priority\": 0,\r\n \"MaxSegments\": 0,\r\n \"IgnoreUnsubscribeCheck\": false,\r\n \"ExpireDate\": \"2022-11-13 13:00:00\",\r\n \"IgnorePossibleSendingTime\": false,\r\n \"CheckTimeRestiction\": false,\r\n \"ShortenUrlEnable\": true,\r\n \"AllowDuplicates\": false,\r\n \"TrackPurchaseTData\": true\r\n\r\n }\r\n }\r\n}", "desc": "Parameters\n\nParameters\n\nRequired\\Optional\n\nType\n\nValue\n\nMessage\n\nrequired\n\nstring\n\nSMS message that needs to be sent.\n\nSavedMessageId\n\nOptional\n\ninteger\n\nSend saved message in your account by id. (if you use this tag, don't use Message tag)\n\nRecipients\n\n \n\n array\n\nYou can send the message to multiple recipients in array.\nThe message can be sent to recipients or groups\n\nFirstName\n\nOptional\n\nstring\n\nThe first name of the customer(can be used for personalization in the sending SMS)\n\nLastName\n\nOptional\n\nstring\n\nThe last name of the customer(can be used for personalization in the sending SMS)\n\nRepresentative\n\nOptional\n\nstring\n\nYou can add custom fields for any recipients and use this fields in the SMS message\n\nPhone\n\nrequired\n\nstring\n\nThe recipient phone number.\n\nGroupNumbers\n\n \n\n array\n\n \n\nGroupNumber\n\nOptional\n\ninteger\n\nUse this parameter in order to send messages to a group according to\nthe group number defined in your account\n\nExcludeGroupNumbers\n\n \n\n array\n\n \n\nGroupNumber\n\nOptional\n\ninteger\n\nUse this parameter in order to exclude this group from all recipients you want to send the message to\n\nSettings\n\n \n\n \n\n \n\nSender\n\nrequired\n\nstring\n\nThe ID that will be displayed in the recipient's phone as the sender.\nThe \"Sender\" field is restricted to a maximum of 11 characters (Consecutive characters, no spaces) or a Phone number that contains maximum 14 digits (no characters)that allowed in the white list in the system(to insert the phone to the white list go to the folder Whitelist - Sender ). You can also write an asterisk (\\\\\\\\\\\\\\\\\\*) at the beginning\nof the identifier.\n\nCampaignName\n\nOptional\n\nstring\n\nThe campaign name which will appear in your campaign reports.\nThe messaged will be aggregate to this campaign\n\nTimeToSend\n\nOptional\n\ndate time\n\nDate and time on which the messages will be sent.\nPlease use the following format: yyyy-mm-dd hh:mm:ss. If left blank, the message will be sent\nimmediately.\n\nDelayInSeconds\n\nOptional\n\ninteger > 60\n\nNumber of seconds of delay from receiving the request in the system and up to\nsending the message (use this parameter as long as the TimeToSend parameter is not in use).\n\nCustomerMessageID\n\nOptional\n\nstring\n\nMessage ID on the client application. When confirmation on delivery is sent back to the client, the message ID is also sent for synchronization.\n\nCustomerParameter\n\nOptional\n\nstring\n\nParameter set by the client that can be seen in the detail message reports, later.\nCan be used to mark each message by activity segmentation, for example.\n\nDeliveryNotificationUrl\n\nOptional\n\nstring\n\nEnter the URL address to which the DLR will be sent via a POST request\n\nPriority\n\nOptional\n\nstring\n\nIn order to prioritize your messages, you can use the priority tag, when 0 means normal\npriority, -1 high priority (used only for a single message), and then 1,2 and so on. The higher the value,\nthe lower the priority.\n\nMaxSegments\n\nOptional\n\nstring\n\nWhen sending long messages, this parameter allows the client to set the\nmaximum number of segments per message. Value 0 means unlimited segments.\n\nIgnoreUnsubscribeCheck\n\nOptional\n\nboolean\n\nSet true for ignore blacklist check.\n\nExpireDate\n\nOptional\n\ndate time\n\nIn case of delay in sending the messages the cellular company will check if the date in this parameter has passed.\nIf the date has passed the message will not be sent.\n\nIgnorePossibleSendingTime\n\nOptional\n\nboolean\n\nSet true for ignore the time sending that you set in your account\n\nCheckTimeRestiction\n\nOptional\n\nboolean\n\nSet true to not send the message to recipient that already received a message in the last X days (default x is 14, you can change the number in your account)\n\nShortenUrlEnable\n\nOptional\n\nboolean\n\nSet true for replace the URL addresses in the message to shorten the URLs\n\nAllowDuplicates\n\nOptional\n\nboolean\n\nSet true to allow to send message to the same recipient in same request.\n\nTrackPurchaseTData\n\nOptional\n\nboolean\n\nSet true to associate purchasing with this campaign.\nIf you set true the CampaignName is required.\nThis function is paid extra", "respCode": 200, "respExample": "{\n \"StatusId\": 1,\n \"StatusDescription\": \"Success\",\n \"DetailedDescription\": \"\",\n \"FunctionName\": \"api/v2/SMS/SendSms\",\n \"RequestId\": \",,Abh5mclRnbp5Sdy9mZulmLkV3bsNWPl1WYOR3cvhkJyETQzUyN1E0MlATMrgTMtATMtEjMwITPw1WY0NVZtlGVmQDNyQDNwETPklkclNXV\",\n \"Data\": {\n \"Recipients\": 1,\n \"Errors\": null\n }\n} " }, { "section": "SMS", "name": "Send SMS + Voice failover", "label": "Send SMS › Send SMS + Voice failover › Send SMS + Voice failover", "method": "POST", "url": "https://cloud.mesergo.co.il/api/v2/Otp/Message/Send", "headers": [ { "key": "Authorization", "value": "Your Base Credentials" }, { "key": "Content-Type", "value": "application/json" } ], "bodyLang": "json", "body": "{\r\n \"Data\": {\r\n \"Channel\": \"SMS_WITH_VOICE_FAILOVER\",\r\n \"CampaignName\": \"OTP Test\",\r\n \"IgnorePossibleSendingTime\": false,\r\n \"IgnoreUnsubscribeCheck\": false,\r\n \"OtpCode\": \"123455\",\r\n \"Phone\": \"0509999999\",\r\n \"CustomerMessageID\": \"OTP-Test-001\",\r\n \"VoiceSettings\": {\r\n \"CampaignRefId\": 0,\r\n \"CallerId\": \"039415550\",\r\n \"Language\": \"he-male\",\r\n \"RequireDigitPress\": true,\r\n \"Digit\": \"1\",\r\n \"PreMessage\": \"נשלחה אליך הודעת OTP. לשמיעת ההודעה הקש {Digit}\",\r\n \"Message\": \"הקוד שלך הוא {OtpCode}\"\r\n },\r\n \"SMSSettings\": {\r\n \"Sender\": \"039415550\",\r\n \"Message\": \"הקוד שלך הוא {OtpCode}\"\r\n }\r\n }\r\n}", "desc": "This function sends a client-generated OTP message to a single recipient via SMS, Voice, or SMS with Voice failover.\n\nThe OTP code is generated by the client and must be provided in the request using the OtpCode parameter. The system does not generate the OTP code.\n\nWhen using SMS_WITH_VOICE_FAILOVER, the system sends the OTP via SMS when SMS delivery is available. If the recipient's number requires Voice delivery, such as a landline or kosher phone, the message is delivered as a Voice call instead.\n\nFor Voice delivery, the client can require the recipient to press a specified digit before the OTP code is played.\n\nOTP messages sent through this endpoint are prioritized by the system.\n\nThe client should perform an HTTPS POST request to the following URL using UTF-8 encoding.\n\nParameters\n\nParameter\nRequired\\Optional\nType\nValue\n\nChannel\nRequired\nstring\nDelivery channel. Supported values: SMS, VOICE, SMS_WITH_VOICE_FAILOVER\n\nCampaignName\nOptional\nstring\nCampaign name for identification and reporting\n\nIgnorePossibleSendingTime\nOptional\nbool\nfalse by default. Set to true to ignore sending-time limitations\n\nIgnoreUnsubscribeCheck\nOptional\nbool\nfalse by default. Set to true to ignore the recipient's subscription status\n\nOtpCode\nRequired\nstring\nOTP code generated by the client\n\nPhone\nRequired\nstring\nRecipient phone number. Only one recipient can be supplied per request\n\nCustomerMessageID\nOptional\nstring\nCustomer-defined message identifier\n\nVoiceSettings.CampaignRefId\nOptional\nstring / integer\nCustomer campaign reference identifier\n\nVoiceSettings.CallerId\nOptional\nstring\nCaller ID used for Voice delivery. Can also be PRIVATE\n\nVoiceSettings.Language\nOptional\nstring\nVoice language and gender, e.g. he-male, he-female, en-male, ru-female, ar-male\n\nVoiceSettings.RequireDigitPress\nOptional\nbool\nfalse by default. When true, the recipient must press the configured digit before the Voice OTP message is played. Ignored for SMS delivery\n\nVoiceSettings.Digit\nConditional\nstring\nDigit from 0 to 9. Required when RequireDigitPress is true\n\nVoiceSettings.PreMessage\nConditional\nstring\nMessage played before the OTP. Required when RequireDigitPress is true. Use {Digit} as the digit placeholder\n\nVoiceSettings.Message\nConditional\nstring\nVoice message content. Required for VOICE and SMS_WITH_VOICE_FAILOVER. Use {OtpCode} as the OTP placeholder\n\nSMSSettings.Sender\nOptional\nstring\nSender used for SMS delivery\n\nSMSSettings.Message\nConditional\nstring\nSMS message content. Required for SMS and SMS_WITH_VOICE_FAILOVER. Use {OtpCode} as the OTP placeholder\n\nRequired fields by Channel\n\nChannel\nRequired fields\n\nSMS\nPhone, OtpCode, SMSSettings.Message\n\nVOICE\nPhone, OtpCode, VoiceSettings.Message\n\nSMS_WITH_VOICE_FAILOVER\nPhone, OtpCode, SMSSettings.Message, VoiceSettings.Message\n\nWhen VoiceSettings.RequireDigitPress is true, VoiceSettings.Digit and VoiceSettings.PreMessage are also required.\n\nRequireDigitPress applies only to Voice delivery and does not affect SMS delivery.\n\nFor Voice delivery, the message content is taken from VoiceSettings.Message.\n\nFor SMS delivery, the message content is taken from SMSSettings.Message.", "respCode": "", "respExample": "{\r\n \"StatusId\": 1,\r\n \"StatusDescription\": \"Success\",\r\n \"DetailedDescription\": \"\",\r\n \"FunctionName\": \"api/v2/Otp/Message/Send\",\r\n \"RequestId\": \"sFmbyVGdulmL1J3bm5WauATMpBXYj1TZtFmT0N3bIZCOzE0MlcDNBNTJxEzK0ITL2ATL2IDMy0DctFGdTVWbpRlJzUjMwMTPklkclNXV\",\r\n \"Data\": {\r\n \"RecipientsSMS\": 1,\r\n \"RecipientsVoice\": 0,\r\n \"Errors\": null\r\n }\r\n}" }, { "section": "SMS", "name": "Send SMS using parameters", "label": "Send SMS › Send SMS Using Parameters › Send SMS using parameters", "method": "GET", "url": "https://api.mesergo.co.il/inforufrontend/WebInterface/SendMessageByNumber.aspx?UserName=string&ApiToken=string&SenderCellNumber=string&CellNumber=string&MessageString=string&IgnoreUnsubscribeCheck=boolean", "headers": [], "bodyLang": null, "body": "", "desc": "", "respCode": "", "respExample": "" }, { "section": "SMS", "name": "Pull DLR using json", "label": "Utilities › Delivery Notification › Pull option using json › Pull DLR using json", "method": "POST", "url": "https://capi.mesergo.co.il/api/v2/PullData", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Your Base Credentials" } ], "bodyLang": "json", "body": "{\r\n\"Data\": {\r\n \"Type\": \"DeliveryNotificationSMS\",\r\n \"BatchSize\": 500\r\n}\r\n}", "desc": "Parameters\n\nParameters\n\nRequired\\Optional\n\nType\n\nValue\n\nType\n\nrequired\n\nstring\n\nFor pull the Delivery Notification use Type:\nDeliveryNotificationSMS\n\nPhoneNumber\n\noptional\n\nstring\n\nFor pull the receiving messages of this phone number only\n\nBatchSize\n\noptional\n\nstring\n\nThe number of notifications transferred\n\nAn explanation of the return parameters:\n\n• PhoneNumber – The number of the recipient.\n• Network – The network of the recipient.\n• Status – The status of the message:\n(2) – Delivered.\n(-2) – Not delivered.\n(-4) – Blocked by MesserGo.\n(6) - Clicked\n(-107) - Convert to IVR\n• StatusDescription – If not delivered, contains the reason.\n• ProjectId – The project ID Below describes the user who sent the message.\n• CustomerMessageId – The client message ID.\n• CustomerParam – The client parameter.\n• SenderNumber – The ID of the sender who sent the message.\n• SegmentsNumber – The amount of segments in the message (See \"Message character length\").\n• SentMessage– The content of the sent message.\n• InsertDate – Time of receiving the notification from the cellular operator.\n\n• OperatorResultId - Represents the operator-specific result code for the message delivery.\nIn case of non-delivery, this field indicates the failure reason.", "respCode": 200, "respExample": "{\n \"StatusId\": 1,\n \"StatusDescription\": \"Success\",\n \"DetailedDescription\": \"\",\n \"FunctionName\": \"api/v2/PullData\",\n \"RequestId\": \",,Abh5mclRnbp5Sdy9mZulmLkV3bsNWPl1WYOR3cvhkJxITQzUyMxE0MlMTMrUTMtETMtEjMwITPw1WY0NVZtlGVmQDNyQDNwETPklkclNXV\",\n \"Data\": {\n \"Count\": 3,\n \"List\": [\n {\n \"PartnerId\": null,\n \"CustomerId\": null,\n \"ProjectId\": 1040177,\n \"UserId\": null,\n \"InsertDate\": \"2021-11-15T13:12:34.617\",\n \"PullDataType\": \"DeliveryNotificationSMS\",\n \"PullData\": {\n \"PhoneNumber\": \"0541234657\",\n \"Network\": \"053\",\n \"Status\": 2,\n \"StatusDescription\": \"Delivered\",\n \"OperatorResultId\": \"2\",\n \"CustomerMessageId\": 3,\n \"CustomerParam\": \"sms\",\n \"SenderNumber\": \"ar\",\n \"SegmentsNumber\": 1,\n \"SentMessage\": \"Hello this is send sms api https://zapier.com/app/zap/137759827/history\",\n \"NotificationDate\": \"2021-11-15T13:12:23\"\n }\n },\n {\n \"PartnerId\": null,\n \"CustomerId\": null,\n \"ProjectId\": 1040177,\n \"UserId\": null,\n \"InsertDate\": \"2021-11-15T13:12:35.15\",\n \"PullDataType\": \"DeliveryNotificationSMS\",\n \"PullData\": {\n \"PhoneNumber\": \"0541234567\",\n \"Network\": \"053\",\n \"Status\": 2,\n \"StatusDescription\": \"Delivered\",\n \"OperatorResultId\": \"2\",\n \"CustomerMessageId\": 3,\n \"CustomerParam\": \"sms\",\n \"SenderNumber\": \"ar\",\n \"SegmentsNumber\": 1,\n \"SentMessage\": \"Hello this is send sms api\",\n \"NotificationDate\": \"2021-11-15T13:12:25\"\n }\n },\n {\n \"PartnerId\": null,\n \"CustomerId\": null,\n \"ProjectId\": 1040177,\n \"UserId\": null,\n \"InsertDate\": \"2021-11-15T13:13:05.537\",\n \"PullDataType\": \"DeliveryNotificationSMS\",\n \"PullData\": {\n \"PhoneNumber\": \"0541234567\",\n \"Network\": \"053\",\n \"Status\": 2,\n \"StatusDescription\": \"Delivered\",\n \"OperatorResultId\": \"2\",\n \"CustomerMessageId\": 3,\n \"CustomerParam\": \"sms\",\n \"SenderNumber\": \"ar\",\n \"SegmentsNumber\": 1,\n \"SentMessage\": \"Hello this is send sms api \",\n \"NotificationDate\": \"2021-11-15T13:12:55\"\n }\n }\n ]\n }\n}" }, { "section": "SMS", "name": "Pull Receiving SMS using json", "label": "Utilities › Receiving SMS › Pull option using json › Pull Receiving SMS using json", "method": "POST", "url": "https://capi.mesergo.co.il/api/v2/PullData", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Your Base Credentials" } ], "bodyLang": "json", "body": "{\r\n\"Data\": {\r\n \"Type\": \"IncomingMessagesSMS\",\r\n \"BatchSize\": 500\r\n}\r\n}", "desc": "Parameters\n\nParameters\n\nRequired\\Optional\n\nType\n\nValue\n\nType\n\nrequired\n\nstring\n\nFor pull Incoming Messages use Type:\nIncomingMessagesSMS\n\nPhoneNumber\n\noptional\n\nstring\n\nFor pull the receiving messages of this phone number only\n\nBatchSize\n\noptional\n\nstring\n\nThe number of Messages transferred", "respCode": 200, "respExample": "{\n \"StatusId\": 1,\n \"StatusDescription\": \"Success\",\n \"DetailedDescription\": \"\",\n \"FunctionName\": \"api/v2/PullData\",\n \"RequestId\": \",wWYuJXZ05WauUncvZmbp5CZ19Gbj1TZtFmT0N3bIZyM0E0MlAzMBNTJ2EzK5ATLyATLyIDMy0DctFGdTVWbpRlJzUjMwMTPklkclNXV\",\n \"Data\": {\n \"Count\": 2,\n \"List\": [\n {\n \"PartnerId\": null,\n \"CustomerId\": null,\n \"ProjectId\": 25312,\n \"UserId\": null,\n \"InsertDate\": \"2026-02-09T16:28:14.837\",\n \"PullDataType\": \"incomingmessagessms\",\n \"PullData\": {\n \"PhoneNumber\": \"0521234567\",\n \"Network\": \"052\",\n \"Status\": \"\",\n \"StatusDescription\": \"\",\n \"OperatorResultId\": \"\",\n \"CustomerMessageId\": \"\",\n \"CustomerParam\": \"\",\n \"SenderNumber\": \"0521234567\",\n \"SegmentsNumber\": \"\",\n \"SentMessage\": \"T10\",\n \"NotificationDate\": \"2022-02-09T16:28:14\"\n }\n },\n {\n \"PartnerId\": null,\n \"CustomerId\": null,\n \"ProjectId\": 25312,\n \"UserId\": null,\n \"InsertDate\": \"2026-02-09T16:28:17.687\",\n \"PullDataType\": \"incomingmessagessms\",\n \"PullData\": {\n \"PhoneNumber\": \"0521234567\",\n \"Network\": \"052\",\n \"Status\": \"\",\n \"StatusDescription\": \"\",\n \"OperatorResultId\": \"\",\n \"CustomerMessageId\": \"\",\n \"CustomerParam\": \"\",\n \"SenderNumber\": \"0529999999\",\n \"SegmentsNumber\": \"\",\n \"SentMessage\": \"T10\",\n \"NotificationDate\": \"2022-02-09T16:28:17\"\n }\n }\n ]\n }\n}" }, { "section": "SMS", "name": "Delete Future Messages SMS", "label": "Utilities › Delete Future Messages › Delete Future Messages SMS", "method": "POST", "url": "https://capi.mesergo.co.il/api/v2/SMS/DeleteFutureMessages", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Your Base Credential" } ], "bodyLang": "json", "body": "{\r\n \"Data\": {\r\n \"PhoneNumber\": \"0549999999\",\r\n \"CustomerMessageID\": \"123456\",\r\n \"CustomerParameter\": \"123456\"\r\n }\r\n}", "desc": "This function deletes future messages by phone number or customer parameter or customer message id.\nOne of these fields must contain a value, the condition is AND, so if the request contains 2 or 3 parameters, so the message will be deleted only if when you send the message you provided same values in this parameters.\n\nParameters\nRequired\\Optional\nType\nValue\n\nPhoneNumber\nOptional\nstring\nThe phone number for which you want to delete future messages\n\nCustomerParameter\nOptional\nstring\nThe customer paramter that sent in the send sms request\n\nCustomerMessageID\nOptional\nstring\nThe customer message ID that sent in the send sms request\n\n*A single phone can also be deleted by sending the SMS message to many recipients at the same time, but in this case the quota will not be refunded.", "respCode": 200, "respExample": "{\n \"StatusId\": 1,\n \"StatusDescription\": \"Success\",\n \"DetailedDescription\": \"\",\n \"FunctionName\": \"api/v2/SMS/DeleteFutureMessages\",\n \"RequestId\": \",wWYuJXZ05WauUncvZmbp5CMykGchNWPl1WYOR3cvhkJzETQzUyN0E0MlQTMrITMtcDMtMjMwITPw1WY0NVZtlGVmQDNyQDNwETPklkclNXV\",\n \"Data\": {\n \"DeletedCount\": 1\n }\n}" }, { "section": "SMS", "name": "SenderIdIsAllowed using json", "label": "Utilities › Check if Sender allowed › SenderIdIsAllowed using json", "method": "POST", "url": "https://capi.mesergo.co.il/api/v2/SMS/Whitelist/SenderIdIsAllowed", "headers": [ { "key": "Authorization", "value": "Your Base Credentials" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "bodyLang": "json", "body": "{\r\n \"Data\": {\r\n \"SenderId\": \"0529999999\",\r\n \"CustomerId\": 123,\r\n \"Username\": \"user123\"\r\n }\r\n}", "desc": "This function checks if sender id is allowed to send SMS\n\nThe Authentication method is basic authentication link for explanation \n\nParameters\n\nParameters\nRequired\\Optional\nType\nValue\n\nSenderId\nRequired\nstring\nThe Sender id do you want to check\n\nCustomerId\nOptional\ninteger\nIf you want to check for another CustomerId under your account\n\nUsername\nOptional\nstring\nIf you want to check for another username under your account", "respCode": 200, "respExample": "{\n \"StatusId\": 1,\n \"StatusDescription\": \"Success\",\n \"DetailedDescription\": \"\",\n \"FunctionName\": \"api/v2/SMS/Whitelist/SenderIdIsAllowed\",\n \"RequestId\": \",,Abh5mclRnbp5Sdy9mZulmLkV3bsNWPl1WYOR3cvhkJzATQzUSOyE0MlQTMrUDMtITMtEjMwITPw1WY0NVZtlGVmQDNyQDNwETPklkclNXV\",\n \"Data\": {\n \"CustomerId\": 26745,\n \"SenderId\": \"0529999999\",\n \"IsAllowed\": false\n }\n}" }, { "section": "SMS", "name": "SendOtp", "label": "Utilities › Whitelist - Sender › Whitelist - Send OTP › SendOtp", "method": "POST", "url": "https://capi.mesergo.co.il/api/v2/SMS/Whitelist/SendOtp", "headers": [ { "key": "content-type", "value": "application/json" }, { "key": "Authorization", "value": "Your Base Credentials" } ], "bodyLang": "json", "body": "{\r\n \"Data\": {\r\n \"SenderId\":\"0529999999\",\r\n \"UserId\": \"12346\",\r\n \"Username\": \"Username\",\r\n \"OtpType\": \"SMS/VOICE/AUTO\"\r\n }\r\n}", "desc": "This function sends SMS/Call OTP for Submit a request to whitelist\nTo use this function contact our customer support.\n\nThe Authentication method is basic authentication link for explanation\n\nParameters\n\nParameter\nRequired\\Optional\nType\nValue\n\nSenderId\nRequired\nstring\nThe Sender id do you want to whiten\n\nUserId\nOptional\nstring\nIf you want to whiten for another UserId under your account\n\nUsername\nOptional\nstring\nIf you want to whiten for another username under your account.\n\nOtpType\nOptional\nstring\nAUTO/SMS/VOICE – If you do not provide this parameter the default setting \nwill be AUTO, meaning that if the Sender ID is a landline or a Kosher phone a Voice OTP will be sent, for \nall other phone types the OTP will be sent as text by SMS.", "respCode": 200, "respExample": "{\n \"StatusId\": 1,\n \"StatusDescription\": \"Success\",\n \"DetailedDescription\": \"\",\n \"FunctionName\": \"api/v2/SMS/Whitelist/SendOtp\",\n \"RequestId\": \",,Abh5mclRnbp5Sdy9mZulmLkV3bsNWPl1WYOR3cvhkJ3MTQzUSOzE0MlkDMrMTMtITMtEjMwITPw1WY0NVZtlGVmQDNyQDNwETPklkclNXV\",\n \"Data\": {\n \"Sent\": true,\n \"SenderId\": \"0529999999\",\n \"UserId\": 1044244\n }\n}" }, { "section": "SMS", "name": "AuthenticateOtp", "label": "Utilities › Whitelist - Sender › Whitelist – Authenticate OTP › AuthenticateOtp", "method": "POST", "url": "https://capi.mesergo.co.il/api/v2/SMS/Whitelist/AuthenticateOtp?", "headers": [ { "key": "content-type", "value": "application/json" }, { "key": "Authorization", "value": "Your Base Credentials" } ], "bodyLang": "json", "body": "{\r\n \"Data\": {\r\n \"SenderId\": \"0529999999\",\r\n \"OtpCode\": \"750930\",\r\n \"UserId\": \"12346\",\r\n \"Username\": \"Username\",\r\n \"Comments\": \"Comments\"\r\n }\r\n}", "desc": "This function Authenticate OTP and do whitelist\n\nThe Authentication method is basic authentication link for explanation\n\nParameters\n\nParameter\nRequired\\Optional\nType\nValue\n\nSenderId\nRequired\nstring\nThe Sender id do you want to whiten\n\nOtpCode\nRequired\nstring\nThe code you received on your device\n\nUserId\nOptional\nstring\nIf you want to whiten for another UserId under your account\n\nUsername\nOptional\nstring\nIf you want to whiten for another username under your account\n\nComments\nOptional\nstring\nIf you want to save Comment in our system", "respCode": 200, "respExample": "{\n \"StatusId\": 1,\n \"StatusDescription\": \"Success\",\n \"DetailedDescription\": \"\",\n \"FunctionName\": \"api/v2/SMS/Whitelist/AuthenticateOtp\",\n \"RequestId\": \",,Abh5mclRnbp5Sdy9mZulmLkV3bsNWPl1WYOR3cvhkJ0MTQzUCN0E0MlkDMrMTMtITMtEjMwITPw1WY0NVZtlGVmQDNyQDNwETPklkclNXV\",\n \"Data\": {\n \"SenderId\": \"0529999999\",\n \"CustomerId\": 26745\n }\n}" }, { "section": "SMS", "name": "Get Sent Messages", "label": "Utilities › Reports › Get Sent Messages › Get Sent Messages", "method": "POST", "url": "https://capi.mesergo.co.il/api/v2/SMS/GetSentMessages", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Your Base Credentials" } ], "bodyLang": "json", "body": "{\r\n \"Data\": {\r\n \"Phone\": \"0543266290\",\r\n \"FromDate\": \"2021-08-03\",\r\n \"ToDate\": \"2021-08-03\",\r\n \"Level\": \"User\"\r\n }\r\n}", "desc": "This function gets the sent messages report by phone number.\n\n*To use this function please contact to sales department\n\nParameters\nRequired\\Optional\nType\nValue\n\nPhone\nRequired\nstring\nThe phone number you want to receive the report on\n\nFromDate\nRequired\ndate\nStart report date (incloud this day)\n\nToDate\nRequired\ndate\nEnd report date (incloud this day)\n\nLevel\nRequired\nstring\nCustomer /Project /User\n\nIf you choose level \"customer\\Project\" then you will also receive in the report messages sent by other users in the same customer or project, provided you have the appropriate permissions.", "respCode": "", "respExample": "{\n \"StatusId\": 1,\n \"StatusDescription\": \"Success\",\n \"DetailedDescription\": \"\",\n \"FunctionName\": \"api/v2/SMS/GetSentMessages\",\n \"RequestId\": \",,Abh5mclRnbp5yZul2ZhR3cuEjMkV3bsN2Z0NXPl1WYOR3cvhkJ3QTQzUyNxE0MlUTMrITMtcDMtMjMwITPw1WY0NVZtlGVmQzM4QDMwETPklkclNXV\",\n \"Data\": {\n \"List\": [\n {\n \"CustomerId\": 3,\n \"ProjectId\": 24,\n \"UserId\": 1004834,\n \"TimeSent\": \"2021-08-03T13:53:43.31\",\n \"TimeOfConfirmation\": \"2021-08-03T13:53:44\",\n \"SenderId\": \"ariellevi\",\n \"DeliveryNotificationStatusId\": 2,\n \"DeliveryNotificationReasonName\": \"Delivered\",\n \"PhoneNumber\": \"0549999999\",\n \"ContactId\": 0,\n \"CustomerMessageId\": \"\",\n \"ContactFullName\": null,\n \"CustomerParameter\": \"\",\n \"InforuApplicationParameter\": \"9W0GJB6311K0KJCB\",\n \"Message\": \"This is a test SMS Message\",\n \"NumberOfSegments\": 1\n },\n {\n \"CustomerId\": 3,\n \"ProjectId\": 24,\n \"UserId\": 1004834,\n \"TimeSent\": \"2021-08-03T13:58:14.123\",\n \"TimeOfConfirmation\": \"2021-08-03T13:58:15\",\n \"SenderId\": \"ariellevi\",\n \"DeliveryNotificationStatusId\": 2,\n \"DeliveryNotificationReasonName\": \"Delivered\",\n \"PhoneNumber\": \"0549999999\",\n \"ContactId\": 0,\n \"CustomerMessageId\": \"\",\n \"ContactFullName\": null,\n \"CustomerParameter\": \"\",\n \"InforuApplicationParameter\": \"9W0GJB6311K0KJCB\",\n \"Message\": \"This is a test SMS Message \",\n \"NumberOfSegments\": 1\n }\n ],\n \"LastFetch\": {\n \"DateTime\": \"2021-08-03T13:58:14.123\",\n \"Id\": 10224\n }\n }\n}" }, { "section": "SMS", "name": "Get Unsubscribe Link", "label": "Utilities › Get Unsubscribe Link › Get Unsubscribe Link", "method": "POST", "url": "https://capi.mesergo.co.il/api/v2/Admin/GetBlockLink", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Your Base Credential" } ], "bodyLang": "json", "body": "{\r\n \"Data\": {\r\n \"Username\": \"Username\",\r\n \"WithPhoneNumber\": \"1\"\r\n }\r\n}", "desc": "StartFragment\n\nThis function gets the sms unsubscribe link\n\nStartFragment\n\nParameters\n\nEndFragment\n\nParameters\nRequired\\Optional\ntype\nValue\n\nUsername\nRequired\nstring\nEnter the username that you want to get his unsubscibe link\n\nWithphonenumber\noptional\nboolean\nSet true to \"_phnx\" will be added to the link. \n(This addition means that when sending the SMS, the system encodes the recipient's phone number at the end of the link so that he does not have to enter it.", "respCode": 200, "respExample": "{\n \"StatusId\": 1,\n \"StatusDescription\": \"Success\",\n \"DetailedDescription\": \"\",\n \"FunctionName\": \"api/v2/Admin/GetBlockLink\",\n \"RequestId\": \",wWYuJXZ05WauUncvZmbp5CMxkGchNWPl1WYOR3cvhkJ4ETQzUSNwE0MlcTMrMTMtcDMtMjMwITPw1WY0NVZtlGVmQDNyQDNwETPklkclNXV\",\n \"Data\": {\n \"BlockText\": \"להסרה https://l5k.me/Zh1ef_#phnx\",\n \"BlockLink\": \"https://l5k.me/Zh1ef\"\n }\n}" }, { "section": "Email", "name": "Simple example", "label": "Mail › Send Email › Send Existing Campaign › Simple example", "method": "POST", "url": "https://capi.mesergo.co.il/api/v2/Umail/Campaign/Send/", "headers": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Authorization", "value": "Your Base Credentials" } ], "bodyLang": "json", "body": "{\r\n \"Data\": {\r\n \"CampaignId\": \"57934763\",\r\n \"Duplicate\": 0,\r\n \"IncludeContacts\": [\r\n {\r\n \"FirstName\": \"string\",\r\n \"Email\": \"example1@example.com\"\r\n }\r\n ]\r\n }\r\n}", "desc": "You need to use this function when you want to send via API a predefined email template (optionally with placeholders) you created on MesserGo user interface.First, you need to create the email template on on MesserGo user interface, get a template Id and then use the API to send it.\n\nParameters\n\nRequired\\Optional\n\ntype\n\nValue\n\nCampaignId\n\nRequired\n\nstring\n\nThe NewsLetter ID in MesserGo system\n\nDuplicate\n\nRequired\n\nbool\n\nCreate a duplicate campaign.\n\nFirstName\n\nOptional\n\nstring\n\nThe first name of the contact\n\nEmail\n\nRequired\n\nstring\n\nThe email of the contact", "respCode": 200, "respExample": "{\n \"StatusId\": 1,\n \"StatusDescription\": \"Success\",\n \"CampaignId\": 57934763,\n \"Recipients\": 0,\n \"token\": \"5fyhqwlehsf9\"\n}" }, { "section": "Email", "name": "Advanced example", "label": "Mail › Send Email › Send Existing Campaign › Advanced example", "method": "POST", "url": "https://capi.mesergo.co.il/api/v2/Umail/Campaign/Send/", "headers": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Authorization", "value": "Your Base Credentials" } ], "bodyLang": "json", "body": "{\r\n\r\n \"Data\": {\r\n \"CampaignId\": \"43520719\",\r\n \"Duplicate\": 0,\r\n \"IgnoreUnsubscribeCheck\": 0,\r\n \"ScheduledSending\": \"_DATETIME_\",\r\n \"StringReplace\": [\r\n {\r\n \"Field\": \"CampaignName/Subject/Body\",\r\n \"Search\": \"_STRING_\",\r\n \"Replace\": \"_STRING_\"\r\n }\r\n ],\r\n \"AllowDuplicates\": \"_BOOL_\",\r\n \"UpdateContacts\": \"_BOOL_\",\r\n \"IncludeGroupNumbers\": [\r\n \"_INT_\"\r\n ],\r\n \"ExcludeGroupNumbers\": [\r\n \"_INT_\"\r\n ],\r\n \"IncludeGroupIds\": [\r\n \"_INT_\"\r\n ],\r\n \"ExcludeGroupIds\": [\r\n \"_INT_\"\r\n ],\r\n \"IncludeContacts\": [\r\n {\r\n \r\n \r\n \"FirstName\": \"string\",\r\n \"LastName\": \"string\",\r\n \"Email\": \"email@adress.com\",\r\n \"PhoneNumber\": \"string\",\r\n \"GenderId\": 1/2,\r\n \"BirthDate\": \"1980-07-23\",\r\n \"AdditionalDate\": \"2012-05-02\",\r\n \"Text1\": \"\",\r\n \"Text2\": \"\",\r\n \"Number1\": \"\",\r\n \"Number2\": \"\",\r\n \"Date1\": \"\",\r\n \"Date2\": \"\",\r\n \"Attachment\": \"\"\r\n },\r\n {\r\n \r\n \r\n \"FirstName\": \"string\",\r\n \"LastName\": \"string\",\r\n \"Email\": \"email@adress.com\",\r\n \"PhoneNumber\": \"string\",\r\n \"GenderId\": 1/2,\r\n \"BirthDate\": \"1980-07-23\",\r\n \"AdditionalDate\": \"2012-05-02\",\r\n \"Text1\": \"\",\r\n \"Text2\": \"\",\r\n \"Number1\": \"\",\r\n \"Number2\": \"\",\r\n \"Date1\": \"\",\r\n \"Date2\": \"\",\r\n \"Attachment\": \"\"\r\n }\r\n\t\t\t\r\n \r\n ],\r\n \"ExcludeContacts\": [\r\n {\r\n \r\n \"ContactRefId\": 100001,\r\n \"Email\": \"one@mesergo.co.il\",\r\n \"PhoneNumber\": \"0501234567\"\r\n }\r\n ],\r\n \"IgnorePossibleSendingTime\": \"_BOOL_\"\r\n }\r\n}", "desc": "To send an existing campaign to contacts/groups submit the following request.\n\nParameters\n\nRequired\\Optional\n\ntype\n\nValue\n\nCampaignId\n\nRequired\n\nstring\n\nThe NewsLetter ID in MesserGo system\n\nDuplicate\n\nRequired\n\nbool\n\nCreate a duplicate campaign.\n\nIgnoreUnsubscribeCheck\n\nOptional\n\nbool\n\nCheck if the contact id is in the unsubscribe list in MesserGo system.\nTrue or False\n\nDuplicateName\n\nOptional\n\nstring\n\nThe name of the duplicate campaign \n\nScheduledSending\n\nOptional\n\nDateTime\n\nIn order to send a future campaign\n\nStringReplace-Fields\n\nOptional\n\nstring\n\nThe object where you want to make the replacement -\nCampaignName/Subject/Body\n\\*The Duplicate field must to be true\n\nStringReplace-Search\n\nOptional\n\nstring\n\nThe current value you want to replace\n\nStringReplace-Replace\n\nOptional\n\nstring\n\nThe new value\n\nAllowDuplicates\n\nOptional\n\nbool\n\nAllow to send the newsletter multiple times to the same contact. if the contact exist few times in the contact list.\n\nUpdateContacts\n\nOptional\n\nbool\n\nTrue will update the contact fields in MesserGo system.\n\nIncludeGroupNumbers\n\nOptional\n\nint\n\nThe group numbers to send the newsletter\n\nExludeGroupNumbers\n\nOptional\n\nint\n\nThe group numbers to exclude the sending the newsletter\n\nIncludeGroupIds\n\nOptional\n\nint\n\nThe group ID to send the newsletter\n\nExludeGroupId\n\nOptional\n\nint\n\nThe group ID to exclude the sending the newsletter\n\nInclodeContacts\n\nOptional\n\nstring\n\nContacts parameters\n\nContactId\n\nOptional\n\nint\n\nThe Contact's unique ID in the MesserGo system.\n\nContactRefId\n\nOptional\n\nint\n\nThe Contact's unique ID in the calling system.\n\nFirstName\n\nOptional\n\nstring\n\nThe first name of the contact - You can inject this entry in the email (and so all contact fields)\n\nLastName\n\nOptional\n\nstring\n\nThe last name of the contact\n\nPhoneNumber\n\nOptional\n\nstring\n\nThe phone number of the contact\n\nEmail\n\nOptional\n\nstring\n\nThe email of the contact\n\nGenderId\n\nOptional\n\nint\n\n1=Male , 2 = Female\n\nBirthDate\n\nOptional\n\nDateTime\n\nThe BirthDay of the contact\n\nText1\n\nOptional\n\nsting\n\nYou can use 20 text fields (Text1 - Text20)\n\nNumber1\n\nOptional\n\nint\n\nYou can use 4 number fields (Number1 - Number4)\n\nDate1\n\nOptional\n\ndate\n\nYou can use 8 number fields (Date1- Date8)\n\nAttachment\n\nOptional\n\nsting\n\nThe URL address of the file. Only PDF files allowed, maximum number per campaign – 2, up to\n300K each.\n\nFor full JSON options please click on bellow link:\n\nhttps://capi.mesergo.co.il/api/v2/Umail/Campaign/Send?view=json\n\nNotes:\n1.In case of using String replace option the 3 parameters are required (Field, Search, Replace).\n2.It is no possible to send ContactId and ContactRefId together.\n3.If you send to contact Email address is required.", "respCode": 200, "respExample": "{\n \"StatusId\": 1,\n \"StatusDescription\": \"Success\",\n \"CampaignId\": 52765355,\n \"Recipients\": 0,\n \"token\": \"5fyhqwlehsf9\"\n}" }, { "section": "Email", "name": "Simple example", "label": "Mail › Send Email › Send New Campaign › Simple example", "method": "POST", "url": "https://capi.mesergo.co.il/api/v2/Umail/Message/Send", "headers": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Authorization", "value": "Your Base Credentials" } ], "bodyLang": "json", "body": "{\r\n \"Data\": {\r\n \"CampaignName\": \"My First Email\",\r\n \"CampaignRefId\": \"123456\",\r\n \"FromAddress\": \"ariel.l@mesergo.co.il\",\r\n \"ReplyAddress\": \"ariel@abc.co.il\",\r\n \"FromName\": \"Abc Company\",\r\n \"Subject\": \"Summer Sale\",\r\n \"Body\": \"test...\",\r\n \"IncludeContacts\": [\r\n {\r\n \"Email\": \"ohad@mesergo.co.il\"\r\n }\r\n ]\r\n }\r\n}", "desc": "You need to use this function if you want to control the email structure via API only and set the body and subject of the email without using a predefined template on the user interface.\n\nParameter\n\nRequired\\Optional\n\ntype\n\nValue\n\nCampaignName\n\nRequired\n\nstring\n\nThe campaign name that you want to the newsletter\n\nCampaignRefId\n\nOptional\n\nstring\n\nThe campaign unique ID.\nIf you want to aggregate data in the system reports on the same campaign number, send the same CampaignRefId.\nIf you do not send this parameter, the system will use default value and aggregate all the mails of that month in one campaign. (if it sent from same sender)\n\nFromAddress\n\nRequired\n\nstring\n\nThe mail address that you send from this address have to be in white list in the system\n\nSubject\n\nRequired\n\nstring\n\nThe email subject\n\nBody\n\nRequired\n\nstring\n\nThe email content\n\nIncludeContacts\n\nEmail\n\nRequired\n\nstring\n\nThe email of the contact", "respCode": 200, "respExample": "{\n \"StatusId\": 1,\n \"StatusDescription\": \"Success\",\n \"DetailedDescription\": \"\",\n \"FunctionName\": \"api/v2/Umail/Message/Send\",\n \"RequestId\": \"sFmbyVGdulmL1J3bm5WauEzMkV3bsNWPl1WYOR3cvhkJ1ETQzUiM1E0MlITMrAjMtYDMtIjMwITPw1WY0NVZtlGVmQDNyQDNwETPklkclNXV\",\n \"Data\": {\n \"Recipients\": 1,\n \"CampaignId\": 68111217,\n \"token\": \"56b2yu67qg5r\"\n }\n}" }, { "section": "Email", "name": "Advanced example", "label": "Mail › Send Email › Send New Campaign › Advanced example", "method": "POST", "url": "https://capi.mesergo.co.il/api/v2/Umail/Message/Send", "headers": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Authorization", "value": "Your Base Credentials" } ], "bodyLang": "json", "body": "{\r\n \"Data\": {\r\n \"CampaignName\": \"_STRING_\",\r\n \"CampaignRefId\": \"_STRING_\",\r\n \"FromAddress\": \"_STRING_\",\r\n \"FromName\": \"_STRING_\",\r\n \"IgnoreUnsubscribeCheck\": \"_BOOL_\",\r\n \"EmbeddedImages\": \"_BOOL_\",\r\n \"ScheduledSending\": \"_DATETIME_\",\r\n \"Subject\": \"_STRING_\",\r\n \"Body\": \"_STRING_\",\r\n \"Attachments\": [\r\n {\r\n \"Name\": \"_STRING_\",\r\n \"Url\": \"_STRING_\"\r\n }\r\n ],\r\n \"AllowDuplicates\": \"_BOOL_\",\r\n \"UpdateContacts\": \"_BOOL_\",\r\n \"IncludeGroupNumbers\": [\r\n \"_INT_\"\r\n ],\r\n \"IncludeContacts\": [\r\n {\r\n \"ContactId\": 100001,\r\n \"ContactRefId\": 100001,\r\n \"FirstName\": \"David\",\r\n \"LastName\": \"Levi\",\r\n \"Email\": \"one@mesergo.co.il\",\r\n \"PhoneNumber\": \"0501234567\",\r\n \"GenderId\": 1,\r\n \"BirthDate\": \"1980-07-23\",\r\n \"AdditionalDate\": \"2012-05-02\",\r\n \"Text1\": \"\",\r\n \"Number1\": \"\",\r\n \"Date1\": \"\"\r\n }\r\n ],\r\n \"IgnorePossibleSendingTime\": \"_BOOL_\",\r\n \"TrackPurchaseTData\": \"_BOOL_\"\r\n\r\n }\r\n}", "desc": "To send a new campaign to contacts\\groups submit the following request.\n\nParameter\n\nRequired\\Optional\n\ntype\n\nValue\n\nCampaignName\n\nRequired\n\nstring\n\nThe campaign name that you want to the newsletter\n\nCampaignRefId\n\nOptional\n\nstring\n\nThe campaign unique ID.\nIf you want to aggregate data in the system reports on the same campaign number, send the same CampaignRefId.\nIf you do not send this parameter, the system will use default value and aggregate all the mails of that month in one campaign. (if it sent from same sender)\n\nFromAddress\n\nRequired\n\nstring\n\nThe mail address that you send from this address have to be in white list in the system\n\nReplyAddress\n\nOptional\n\nstring\n\nThe mail address that the replay email will sent to.\nThe address have to be in white list in the system\n\nFromName\n\nRequired\n\nstring\n\nThe name that the sender (My Company)\n\nIgnoreUnsubscribeCheck\n\nOptional\n\nbool\n\nSet true for ignore blacklist check. (Contact customer support for this\noption).\n\nIgnorePossibleSendingTime\n\nOptional\n\nbool\n\nSet true for ignore the time sending that you set in your account\n\nTrackPurchaseTData\n\nOptional\n\nbool\n\nSet true to associate purchasing with this campaign.\nIf you set true the CampaignName is required.\nThis function is paid extra.\n\nEmbeddedImages\n\nOptional\n\nbool\n\nSet true if you want that the images in the mail will be embedded (for this function contact to our support )\n\nScheduledSending\n\nOptional\n\nDateTime\n\nIn order to send a future campaign\n\nSubject\n\nRequired\n\nstring\n\nThe email subject\n\nBody\n\nRequired\n\nstring\n\nThe email content\n\nAllowDuplicates\n\nOptional\n\nbool\n\nAllow to send the newsletter multiple times to the same contact if the contact exist few times in the contact list.\n\nUpdateContacts\n\nOptional\n\nbool\n\nTrue will update the contact fields in MesserGo system.\n\nAttachments\n\nName\n\nOptional\n\nstring\n\nThe attachments name\n\nUrl\n\nOptional\n\nstring\n\nThe link to the attachments\n\nContentType\n\nOptional\n\nstring\n\nThe Base64 file type\n\nFileData\n\nOptional\n\nstring\n\nThe file contents in Base64\n\nIncludeGroupNumbers\n\nOptional\n\nint\n\nThe group numbers to send the newsletter\n\nExludeGroupNumbers\n\nOptional\n\nint\n\nThe group numbers to exclude the sending the newsletter\n\nIncludeGroupIds\n\nOptional\n\nint\n\nThe group ID to send the newsletter\n\nExludeGroupId\n\nOptional\n\nint\n\nThe group ID to exclude the sending the newsletter\n\nIncludeContacts\n\nContacts parameters\n\nContactId\n\nOptional\n\nint\n\nThe Contact's unique ID in the MesserGo system.\n\nContactRefId\n\nOptional\n\nint\n\nThe Contact's unique ID in the calling system.\n\nEmail\n\nOptional\n\nstring\n\nThe email of the contact\n\nPhoneNumber\n\nOptional\n\nstring\n\nThe phone number of the contact\n\nGenderId\n\nOptional\n\nint\n\n1=Male , 2 = Female\n\nBirthDate\n\nOptional\n\nDate\n\nThe BirthDay of the contact\n\nText1\n\nOptional\n\nsting\n\nYou can use 20 text fields (Text1 - Text20)\n\nNumber1\n\nOptional\n\nint\n\nYou can use 4 number fields (Number1 - Number4)\n\nDate1\n\nOptional\n\ndate\n\nYou can use 8 number fields (Date1- Date8)\n\nFor full JSON options please click on bellow link:\n\nhttps://capi.mesergo.co.il/api/v2/Umail/Message/Send?view=json\n\nNotes:\n1.It is no possible to send ContactId and ContactRefId together.\n2.If you send to contact Email address is required.", "respCode": 200, "respExample": "{\n \"StatusId\": 1,\n \"StatusDescription\": \"Success\",\n \"CampaignId\": 52765355,\n \"Recipients\": 0,\n \"token\": \"5fyhqwlehsf9\"\n}" }, { "section": "Email", "name": "Example Base64 File attached", "label": "Mail › Send Email › Send New Campaign › Example Base64 File attached", "method": "POST", "url": "https://capi.mesergo.co.il/api/v2/Umail/Message/Send", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Your Base Credentials" } ], "bodyLang": "json", "body": "{\r\n \"Data\": {\r\n \"CampaignName\": \"_STRING_\",\r\n \"FromAddress\": \"_STRING_\",\r\n \"ReplyAddress\": \"_STRING_\",\r\n \"FromName\": \"_STRING_\",\r\n \"Subject\": \"_STRING_\",\r\n \"Body\": \"

Base64image

Base64image

\",\r\n \"Attachments\": [\r\n {\r\n \"Name\": \"file.pdf\",\r\n \"ContentType\": \"application/pdf\",\r\n \"FileData\": \"JVBERi0xLjQKJeLjz9MKMyAwIG9iago8PC9UeXBlIC9QYWdlCi9QYXJlbnQgMSAwIFIKL01lZGlhQm94IFswIDAgNTk1IDg0Ml0KL1Jlc291cmNlcyAyIDAgUgovQ29udGVudHMgNCAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwvTGVuZ3RoIDM1Pj4Kc3RyZWFtCkJUCi9GMSAyNCBUZgoxMDAgNzAwIFRkCihIZWxsbyBQREYpIFRqCkVUCmVuZHN0cmVhbQplbmRvYmoKMSAwIG9iago8PC9UeXBlIC9QYWdlcwovS2lkcyBbMyAwIFJdCi9Db3VudCAxCj4+CmVuZG9iagoyIDAgb2JqCjw8L0ZvbnQgPDwvRjEgPDwvVHlwZSAvRm9udAovU3VidHlwZSAvVHlwZTEKL0Jhc2VGb250IC9IZWx2ZXRpY2EKPj4+Pj4+CmVuZG9iago1IDAgb2JqCjw8L1R5cGUgL0NhdGFsb2cKL1BhZ2VzIDEgMCBSCj4+CmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYKMDAwMDAwMDIwMSA2NTUzNSBuCjAwMDAwMDAyNTAgNjU1MzUgbgowMDAwMDAwMDE1IDY1NTM1IG4KMDAwMDAwMDExMCA2NTUzNSBuCjAwMDAwMDAzMjMgNjU1MzUgbgp0cmFpbGVyCjw8L1NpemUgNgovUm9vdCA1IDAgUgo+PgpzdGFydHhyZWYKMzcwCiUlRU9G\"\r\n }\r\n ],\r\n \"IncludeContacts\": [\r\n {\r\n \"Email\": \"_STRING_\"\r\n }\r\n ]\r\n }\r\n}\r\n", "desc": "", "respCode": "", "respExample": "{\r\n \"StatusId\": 1,\r\n \"StatusDescription\": \"Success\",\r\n \"CampaignId\": 52765355,\r\n \"Recipients\": 0,\r\n \"token\": \"5fyhqwlehsf9\"\r\n}" }, { "section": "Email", "name": "Get Campaign List", "label": "Mail › Campaign › Get Campaign List", "method": "POST", "url": "https://capi.mesergo.co.il/api/v2/Umail/Campaign/List/", "headers": [ { "key": "Authorization", "value": "Your Base Credentials" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "bodyLang": "json", "body": "{\r\n \"Data\": {\r\n \"CampaignIds\": [\r\n \"30000810\", \"43561229\"\r\n ],\r\n \"StartDate\": \"2022-05-31\",\r\n \"EndDate\": \"2023-05-31\"\r\n }\r\n}", "desc": "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", "respCode": 200, "respExample": "{\n \"StatusId\": 1,\n \"StatusDescription\": \"Success\",\n \"DetailedDescription\": \"\",\n \"FunctionName\": \"api/v2/Umail/Campaign/List\",\n \"RequestId\": \",,Abh5mclRnbp5yZul2ZhR3cuEjMkV3bsN2Z0NXPl1WYOR3cvhkJwMTQzUSMzE0MlATMrEjMtYDMtIjMwITPw1WY0NVZtlGVmQzM4QDMwETPklkclNXV\",\n \"Data\": {\n \"List\": [\n {\n \"id\": 30000810,\n \"name\": \"בדיקה (8)\",\n \"created\": \"2022-05-31 15:33:41\",\n \"status\": \"completed\",\n \"sent\": 4,\n \"opened\": 3,\n \"clicks\": 2,\n \"returned\": \"0\",\n \"blocked\": \"0\",\n \"url\": \"https://uclicks.inforustg.com/?page=webview&show=body&message=%2CUTM4ADMwAzM\"\n }\n ]\n }\n}" }, { "section": "Email", "name": "Get Campaign", "label": "Mail › Campaign › Get Campaign", "method": "POST", "url": "https://capi.mesergo.co.il/api/v2/Umail/Campaign/Get/", "headers": [ { "key": "Authorization", "value": "Your Base Credentials" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "bodyLang": "json", "body": "{\r\n \"Data\": {\r\n \"CampaignId\": \r\n \"30000809\"\r\n }\r\n}", "desc": "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", "respCode": 200, "respExample": "{\n \"StatusId\": 1,\n \"StatusDescription\": \"Success\",\n \"DetailedDescription\": \"\",\n \"FunctionName\": \"api/v2/Umail/Campaign/Get\",\n \"RequestId\": \",,Abh5mclRnbp5yZul2ZhR3cuEjMkV3bsN2Z0NXPl1WYOR3cvhkJyATQzUyNzE0MlATMrEjMtYDMtIjMwITPw1WY0NVZtlGVmQzM4QDMwETPklkclNXV\",\n \"Data\": {\n \"id\": 30000809,\n \"name\": \"בדיקה (7)\",\n \"created\": \"2022-05-31 15:23:31\",\n \"status\": \"completed\",\n \"sent\": 4,\n \"opened\": 3,\n \"clicks\": 2,\n \"returned\": \"0\",\n \"blocked\": \"0\",\n \"url\": \"https://uclicks.inforustg.com/?page=webview&show=body&message=%2CQTM4ADMwAzM\"\n }\n}" }, { "section": "Email", "name": "Update Campaign", "label": "Mail › Campaign › Update Campaign", "method": "POST", "url": "https://capi.mesergo.co.il/api/v2/Umail/Campaign/Update", "headers": [ { "key": "Authorization", "value": "Your Base Credentials" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "bodyLang": "json", "body": "{\r\n \"Data\": {\r\n \"DuplicateFromCampaignId\": \"30000810\",\r\n\r\n \"StringReplace\": [\r\n {\r\n \"Field\": \"Subject\",\r\n \"Search\": \"param1\",\r\n \"Replace\": \"param2\"\r\n }\r\n ]\r\n }\r\n}", "desc": "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", "respCode": 200, "respExample": "{\n \"StatusId\": 1,\n \"StatusDescription\": \"Success\",\n \"DetailedDescription\": \"\",\n \"FunctionName\": \"api/v2/Umail/Campaign/Update\",\n \"RequestId\": \",,Abh5mclRnbp5yZul2ZhR3cuEjMkV3bsN2Z0NXPl1WYOR3cvhkJwITQzUCOwE0MlETMrEjMtYDMtIjMwITPw1WY0NVZtlGVmQzM4QDMwETPklkclNXV\",\n \"Data\": {\n \"StatusId\": 1,\n \"StatusDescription\": \"Success\",\n \"CampaignId\": 30000824\n }\n}" }, { "section": "Email", "name": "Get job status", "label": "Mail › Utilities › Get job status", "method": "POST", "url": "https://capi.mesergo.co.il/api/v2/Umail/Campaign/Job", "headers": [ { "key": "Authorization", "value": "Your Base Credentials" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "bodyLang": "json", "body": "{\r\n \"Data\": {\r\n \"JobToken\": \"715fzq90yzsi\"\r\n }\r\n}", "desc": "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", "respCode": 200, "respExample": "{\n \"StatusId\": 1,\n \"StatusDescription\": \"Success\",\n \"DetailedDescription\": \"\",\n \"FunctionName\": \"api/v2/Umail/Campaign/Job\",\n \"RequestId\": \",,Abh5mclRnbp5yZul2ZhR3cuEjMkV3bsN2Z0NXPl1WYOR3cvhkJ5QTQzUyMxE0MlETMrEjMtYDMtIjMwITPw1WY0NVZtlGVmQzM4QDMwETPklkclNXV\",\n \"Data\": {\n \"status\": \"pending\",\n \"description\": \"\"\n }\n}" }, { "section": "Email", "name": "Get Mail Notification", "label": "Mail › Utilities › Get Mail Notification", "method": "POST", "url": "https://capi.mesergo.co.il/api/v2/Umail/GetMailNotification", "headers": [ { "key": "Authorization", "value": "Your Base Credentials" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "bodyLang": "json", "body": "{\r\n \"Data\": {\r\n \"BatchSize\": \"200\"\r\n }\r\n}", "desc": "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", "respCode": 200, "respExample": "{\n \"StatusId\": 1,\n \"StatusDescription\": \"Success\",\n \"DetailedDescription\": \"\",\n \"FunctionName\": \"api/v2/Umail/GetMailNotification\",\n \"RequestId\": \",wWYuJXZ05WauUncvZmbp5CMxkGchNWPl1WYOR3cvhkJxUTQzUSOwE0MlUTMrYDMtcDMtIjMwITPw1WY0NVZtlGVmQDNyQDNwETPklkclNXV\",\n \"Data\": {\n \"List\": [\n {\n \"Datetime\": \"2022-07-04 09:35:47\",\n \"CampaignId\": 69042121,\n \"Email\": \"ariel.l@mesergo.co.il\",\n \"Action\": \"open\",\n \"Value\": \"desktop\",\n \"CustomerMessageId\": 1234\n },\n {\n \"Datetime\": \"2022-07-03 22:14:05\",\n \"CampaignId\": 69042121,\n \"Email\": \"ariel.l@mesergo.co.il\",\n \"Action\": \"dsn\",\n \"Value\": \"2.0.0\",\n \"MoreInfo\": \"sent\",\n \"AdditionalInformation\": \"250 2.0.0 OK 1656875494 \",\n \"CustomerMessageId\": 12345\n },\n {\n \"Datetime\": \"2022-07-03 22:11:39\",\n \"CampaignId\": 69042121,\n \"Email\": \"ariel.l@mesergo.co.il\",\n \"Action\": \"open\",\n \"Value\": \"desktop\",\n \"CustomerMessageId\": 12346\n }\n ]\n }\n}" }, { "section": "Email", "name": "Notification On Unsubscribe", "label": "Mail › Utilities › Notification On Unsubscribe", "method": "POST", "url": "http://www.clienturl.co.il/demo.aspx", "headers": [], "bodyLang": "xml", "body": "\r\n\r\n \r\n\r\n", "desc": "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.", "respCode": "", "respExample": "" }, { "section": "Email", "name": "Stop Future Campaign", "label": "Mail › Utilities › Stop Future Campaign", "method": "POST", "url": "https://capi.mesergo.co.il/api/v2/Umail/Campaign/Stop", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Your Base Credential" } ], "bodyLang": "json", "body": "{\r\n \"Data\": {\r\n \"CampaignId\": \"91619263\"\r\n }\r\n}", "desc": "The function stop future Campaign by Campaign ID\n\nParameter\nRequired\\Optional\ntype\nValue\n\nCampaignId\nRequired\nstring\nThe Campaign ID to stop. \nThe Campaign to stop should be future Campaign", "respCode": 200, "respExample": "{\n \"StatusId\": 1,\n \"StatusDescription\": \"Success\",\n \"DetailedDescription\": \"\",\n \"FunctionName\": \"api/v2/Umail/Campaign/Stop\",\n \"RequestId\": \",wWYuJXZ05WauUncvZmbp5CMykGchNWPl1WYOR3cvhkJ4ITQzUyM0E0MlATMrEjMtMDMtQjMwITPw1WY0NVZtlGVmQDNyQDNwETPklkclNXV\",\n \"Data\": null\n}" }, { "section": "Contacts", "name": "Create or Update Contact", "label": "Contacts Interface › Create or Update Contact", "method": "POST", "url": "https://capi.mesergo.co.il/api/v2/Contact/CreateOrUpdateContacts", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": " Basic USER:TOKEN (Encode Base64)" } ], "bodyLang": "json", "body": "{\r\n \"Data\": {\r\n \"List\": [\r\n {\r\n \"FirstName\": \"string\",\r\n \"LastName\": \"string\",\r\n \"PhoneNumber\": \"string\",\r\n \"Email\": \"string\",\r\n \"AddToGroupName\": \"string\"\r\n }\r\n ]\r\n }\r\n}", "desc": "This function creates or updates contacts.\nYou can send up to 5000 items per request. (If you send up to 10 items, the response is final,\nif you send more, for final response use \"Check Status Token\" function).\nThe key for update is Email address, or Phone number, or both.\nEmail or Phone is mandatory all other fields are optional.\n\nParameters\n\nKey\n\nRequired\\Optional\n\ntype\n\nValue\n\nFirstName\n\nOptional\n\nstring\n\nThe first name of the contact\n\nLastName\n\nOptional\n\nstring\n\nThe last name of the contact\n\nPhoneNumber\n\nRequired\n\nstring\n\nThe phone number of the contact\n\nEmail\n\nRequired\n\nstring\n\nThe email of the contact\n\nContactRefId\n\nOptional\n\nstring\n\nThe Contact's unique ID in the calling system.\n\nFirebaseToken\n\nOptional\n\nstring\n\nUse for sending notifications to Google devices and apple.\nIf you send only FirebaseToken without Email or Phone, you should also send ContactRefId.\n\nPlatform\n\nOptional\n\nstring\n\n\"ANDROID\" / \"IOS\", If you use FirebaseToken you should also send Platform\"ANDROID\" / \"IOS\", If you use FirebaseToken you should also send Platform\n\nDevice1StatusId\n\nOptional\n\nint\n\nUse for sending notifications to Google devices and apple.\nThe parameter can set with an active or inactive contact token\n1 = active\n-3 = inactive\n\nGenderId\n\nOptional\n\nint\n\n1=Male , 2 = Female\n\nAddToGroupName\n\nOptional\n\nstring\n\nAdd to group by name, if the group does not exist it will be created automatically\n\nRemoveFromGroupName\n\nOptional\n\nstring\n\nRemove from group by name\n\nRegistrationCampaign\n\nOptional\n\nstring\n\nAllows you to record where the contact came from.\nYou can enter a value in the field only when creating a new contact\n\nEmailSubscriberStatus\n\nOptional\n\nSubscribed / Unsubscribed\n\nAllows you to choose whether the contact's Email is added in a subscribed or unsubscribed state (default is subscribed)\n\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\*contact our support for configuration at support@mesergo.co.il\n\nPhoneSubscriberStatus\n\nOptional\n\nSubscribed / Unsubscribed\n\nAllows you to choose whether the contact's phone number is added in a subscribed or unsubscribed state\n(default is subscribed)\n\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\*contact our support for configuration at support@mesergo.co.il\n\nNote: To delete an existing means of contact (email or phone) you need to write \"delete\" in value.\n**\\\\\\\\\\\\\\\\* If you wish to use EmailSubscriberStatus or PhoneSubscriberStatus - please contact supprot@mesergo.co.il to configure before use. without configuration, existing status of a contact on your contacts list will remain the same regardless of what you pass in the parameters.\n\nAdvanced options\n\nhttps://capi.mesergo.co.il/api/v2/Contact/CreateOrUpdateContacts?view=json", "respCode": 200, "respExample": "{\n \"StatusId\": 1,\n \"StatusDescription\": \"Success\",\n \"DetailedDescription\": \"\",\n \"FunctionName\": \"api/v2/Contact/CreateOrUpdateContacts\",\n \"RequestId\": \",,Abh5mclRnbp5Sdy9mZulmLkV3bsNWPl1WYOR3cvhkJzETQzUyN1E0MlITMrETMtUDMtEjMwITPw1WY0NVZtlGVmQDNyQDNwETPklkclNXV\",\n \"Data\": {\n \"UploadToken\": \"BodyPart_a66bcef1-8b5a-4578-84ed-43bdb0a3402e\",\n \"Rows\": 1,\n \"ContactsUpdates\": 0,\n \"ContactsNew\": 0,\n \"ContactsExisting\": 1,\n \"RowsFailed\": 0,\n \"CountErrors\": 0,\n \"Errors\": []\n }\n}" }, { "section": "Contacts", "name": "Check Status Token", "label": "Contacts Interface › Check Status Token", "method": "POST", "url": "https://capi.mesergo.co.il/api/v2/Contact/CheckJobStatusByToken", "headers": [ { "key": "content-type", "value": " application/json" }, { "key": "Authorization", "value": " Basic USER:TOKEN (Encode Base64)" } ], "bodyLang": "json", "body": "{\r\n \"Data\": {\r\n \"RequestToken\": \"BodyPart_a90e0d80-5653-4c33-ba1a-41ca86bae650\"\r\n }\r\n}", "desc": "This function checks the final result received in answer to your request (in the case you have created more than 10 contacts).\n\nParameters\n\nKey\n\nRequired\\Optional\n\ntype\n\nValue\n\nRequestToken\n\nRequired\n\nstring\n\nupload token from the response of the create contact request", "respCode": 200, "respExample": "{\n \"StatusId\": 1,\n \"StatusDescription\": \"Success\",\n \"DetailedDescription\": \"\",\n \"FunctionName\": \"api/v2/Contact/CheckJobStatusByToken\",\n \"RequestId\": \",,Abh5mclRnbp5Sdy9mZulmLkV3bsNWPl1WYOR3cvhkJyUTQzUyNxE0MlETMrEzMtUDMtEjMwITPw1WY0NVZtlGVmQDNyQDNwETPklkclNXV\",\n \"Data\": {\n \"UploadToken\": \"BodyPart_a90e0d80-5653-4c33-ba1a-41ca86bae650\",\n \"Rows\": 1,\n \"ContactsUpdates\": 0,\n \"ContactsNew\": 0,\n \"ContactsExisting\": 1,\n \"RowsFailed\": 0,\n \"CountErrors\": 1,\n \"Errors\": [\n {\n \"RowNumber\": 1,\n \"ErrorCode\": -92,\n \"FieldName\": \"Email\",\n \"ActualFieldName\": \"Email\",\n \"ErrorValue\": \"Cohen@test \",\n \"ErrorMessage\": \"UploadError.InvalidValueForFieldEmail\"\n }\n ]\n }\n}" }, { "section": "Contacts", "name": "Delete Contact", "label": "Contacts Interface › Delete Contact", "method": "POST", "url": "https://capi.mesergo.co.il/api/v2/Contact/DeleteContacts", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": " Basic USER:TOKEN (Encode Base64)" } ], "bodyLang": "json", "body": "{\r\n \"Data\": {\r\n \"List\": [\r\n {\r\n \"Type\": \"Phone\",\r\n \"Value\": \"0541234567\"\r\n }\r\n ]\r\n }\r\n}", "desc": "This function deletes contacts by Phone/Email/ContactRefId/ContactId.\nThe contacts that t you delete removed from all groups.\nYou can send up to 100 items per request.\nThe request should be POST\n\nParameters\n\nKey\n\nRequired\\Optional\n\ntype\n\nValue\n\nType\n\nRequired\n\nstring\n\nPhone/ Email/ ContactRefId/ ContactId\n\nValue\n\nRequired\n\nstring\n\nThe value of the type\n\nAdvanced options\n\nhttps://capi.mesergo.co.il/api/v2/Contact/DeleteContacts?view=json", "respCode": 200, "respExample": "{\n \"StatusId\": 1,\n \"StatusDescription\": \"Success\",\n \"DetailedDescription\": \"\",\n \"FunctionName\": \"api/v2/Contact/DeleteContacts\",\n \"RequestId\": \",,Abh5mclRnbp5Sdy9mZulmLkV3bsNWPl1WYOR3cvhkJ0UTQzUCNzE0MlATMrEzMtUDMtEjMwITPw1WY0NVZtlGVmQDNyQDNwETPklkclNXV\",\n \"Data\": {\n \"DeletedCount\": 1\n }\n}" }, { "section": "Contacts", "name": "GetContact", "label": "Contacts Interface › GetContact", "method": "POST", "url": "https://capi.mesergo.co.il/api/v2/Contact/GetContact", "headers": [ { "key": "content-type", "value": "application/json" }, { "key": "Authorization", "value": "Basic USER:TOKEN (Encode Base64)" } ], "bodyLang": "json", "body": "{\r\n \"Data\": {\r\n \"Type\": \"Phone\",\r\n \"Value\": \"string\",\r\n \"Configuration\": \"WithoutGroups\"\r\n }\r\n}", "desc": "This function finds contacts by Phone/Email/ContactRefId/ContactId.\nYou can find more than one contact at a time if there is more than one contact based on your search.\nThe request should be POST\n\nParameters\n\nKey\n\nRequired\\Optional\n\ntype\n\nValue\n\nType\n\nRequired\n\nstring\n\nPhone/Email/ContactRefId/ContactId\n\nValue\n\nRequired\n\nstring\n\nValue of the type\n\nConfiguration\n\nRequired\n\nstring\n\nWithGroups/WithoutGroups\n\nResponse fieldes:\nContactId - (int) The system contact number.\nContactRefId - (string) The ID you provided for the contact (could be null).\nEmailStatusId / PhoneStatusId - (int) The Phone / Email status.\n• 1 - Active\n• -2 - Unsubscribe\n• 0 - WithOutStatus (if Email or Phone is empty)", "respCode": 200, "respExample": "{\n \"StatusId\": 1,\n \"StatusDescription\": \"Success\",\n \"DetailedDescription\": \"\",\n \"FunctionName\": \"api/v2/Contact/GetContact\",\n \"RequestId\": \",,Abh5mclRnbp5Sdy9mZulmLkV3bsNWPl1WYOR3cvhkJzATQzUCN1E0MlETMrEzMtUDMtEjMwITPw1WY0NVZtlGVmQDNyQDNwETPklkclNXV\",\n \"Data\": {\n \"Contacts\": {\n \"Count\": 1,\n \"List\": [\n {\n \"ContactId\": 585578002,\n \"ContactRefId\": \"\",\n \"Email\": \"cohen@test.com\",\n \"EmailStatusId\": 1,\n \"PhoneNumber\": \"0541234567\",\n \"PhoneStatusId\": 1,\n \"DateCreated\": \"2021-05-31 11:08:31\",\n \"UpdateDate\": \"2021-05-31 11:08:31\",\n \"FirstName\": \"David\",\n \"LastName\": \"Cohen\",\n \"GenderId\": null,\n \"BirthDate\": \"\",\n \"AdditionalDate\": \"\",\n \"Text1\": \"\",\n \"Text2\": \"\",\n \"Text3\": \"\",\n \"Text4\": \"\",\n \"Text5\": \"\",\n \"Text6\": \"\",\n \"Text7\": \"\",\n \"Text8\": \"\",\n \"Text9\": \"\",\n \"Text10\": \"\",\n \"Text11\": \"\",\n \"Text12\": \"\",\n \"Text13\": \"\",\n \"Text14\": \"\",\n \"Text15\": \"\",\n \"Text16\": \"\",\n \"Text17\": \"\",\n \"Text18\": \"\",\n \"Text19\": \"\",\n \"Text20\": \"\",\n \"Number1\": null,\n \"Number2\": null,\n \"Number3\": null,\n \"Number4\": null,\n \"Date1\": null,\n \"Date2\": null,\n \"Date3\": null,\n \"Date4\": null,\n \"Date5\": null,\n \"Date6\": null,\n \"Date7\": null,\n \"Date8\": null\n }\n ]\n }\n }\n}" }, { "section": "Contacts", "name": "Get contact list", "label": "Contacts Interface › Get contact list", "method": "POST", "url": "https://capi.mesergo.co.il/api/v2/Contact/GetContactList", "headers": [ { "key": "content-type", "value": "application/json" }, { "key": "Authorization", "value": "Basic USER:TOKEN (Encode Base64)" } ], "bodyLang": "json", "body": "{\r\n \"Data\": {\r\n \"FilterBy\": \"CreatedDate\",\r\n \"FromDate\": \"2021/05/15\",\r\n \"ToDate\": \"2021/05/30\",\r\n \"OnlyForGroupId\": \"300226604\",\r\n \"LastFetchedId\": 0\r\n }\r\n}", "desc": "This function Gets the list of contacts.\nThe request is to be by POST.\n\nParameters\n\nKey\n\nRequired\\Optional\n\ntype\n\nValue\n\nFilterBy\n\nRequired\n\nstring\n\nCreatedDate/UpdatedDate\n\nFromDate\n\nRequired\n\nDate\n\nFrom Date includes this date\n\nToDate\n\nRequired\n\nDate\n\nTo Date include this date\n\nOnlyForGroupId\n\nOptional\n\nint\n\nIf you want to get contacts on specific group\n\nLastFetchedId\n\nOptional\n\nint\n\nGet batch starting with ID larger than xxx(if a first request is made use 0 or null)", "respCode": 200, "respExample": "{\n \"StatusId\": 1,\n \"StatusDescription\": \"Success\",\n \"DetailedDescription\": \"\",\n \"FunctionName\": \"api/v2/Contact/GetContactList\",\n \"RequestId\": \",,Abh5mclRnbp5Sdy9mZulmLkV3bsNWPl1WYOR3cvhkJ1QTQzUCO0E0MlMTMrEzMtUDMtEjMwITPw1WY0NVZtlGVmQDNyQDNwETPklkclNXV\",\n \"Data\": {\n \"LastFetchedId\": 578674342,\n \"Count\": 1,\n \"List\": [\n {\n \"ContactId\": 578674342,\n \"ContactRefId\": null,\n \"Email\": null,\n \"EmailStatusId\": 0,\n \"PhoneNumber\": \"0732224536\",\n \"PhoneStatusId\": 1,\n \"DateCreated\": \"2021-05-18 09:25:55\",\n \"UpdateDate\": \"2021-05-24 09:48:03\",\n \"FirstName\": \"אריאל\",\n \"LastName\": \"Levi\",\n \"GenderId\": null,\n \"BirthDate\": \"\",\n \"AdditionalDate\": \"\",\n \"Text1\": \"\",\n \"Text2\": null,\n \"Text3\": null,\n \"Text4\": null,\n \"Text5\": null,\n \"Text6\": null,\n \"Text7\": null,\n \"Text8\": null,\n \"Text9\": null,\n \"Text10\": null,\n \"Text11\": null,\n \"Text12\": null,\n \"Text13\": null,\n \"Text14\": null,\n \"Text15\": null,\n \"Text16\": null,\n \"Text17\": null,\n \"Text18\": null,\n \"Text19\": null,\n \"Text20\": null,\n \"Number1\": null,\n \"Number2\": null,\n \"Number3\": null,\n \"Number4\": null,\n \"Date1\": null,\n \"Date2\": null,\n \"Date3\": null,\n \"Date4\": null,\n \"Date5\": null,\n \"Date6\": null,\n \"Date7\": null,\n \"Date8\": null\n }\n ]\n }\n}" }, { "section": "Contacts", "name": "Create or Update Group", "label": "Contacts Interface › Create or Update Group", "method": "POST", "url": "https://capi.mesergo.co.il/api/v2/Contact/CreateOrUpdateGroup", "headers": [ { "key": "content-type", "value": "application/json" }, { "key": "Authorization", "value": " Basic USER:TOKEN (Encode Base64)" } ], "bodyLang": "json", "body": "{\r\n \"Data\": {\r\n \"GroupName\": \"New Groupe\",\r\n \"GroupId\": 300230515\r\n }\r\n}", "desc": "This function creates or update group.\nThe request should be POST\n\nParameters\n\nKey\n\nRequired\\Optional\n\ntype\n\nValue\n\nGroupName\n\nRequired\n\nstring\n\nThe name of new/existing group\n\nGroupId\n\nRequired\n\nint\n\nuse 0 or null for new group,\nnumber for update exist group.\n\nAdvanced Options\n\nhttps://capi.mesergo.co.il/api/v2/Contact/CreateOrUpdateGroup?view=json", "respCode": 200, "respExample": "{\n \"StatusId\": 1,\n \"StatusDescription\": \"Success\",\n \"DetailedDescription\": \"\",\n \"FunctionName\": \"api/v2/Contact/CreateOrUpdateGroup\",\n \"RequestId\": \",,Abh5mclRnbp5Sdy9mZulmLkV3bsNWPl1WYOR3cvhkJwITQzUyN1E0MlQTMrEzMtUDMtEjMwITPw1WY0NVZtlGVmQDNyQDNwETPklkclNXV\",\n \"Data\": {\n \"GroupId\": 300230515,\n \"GroupTypeId\": 1,\n \"GroupNumber\": 15,\n \"GroupName\": \"New Groupe\",\n \"Description\": \"\",\n \"CountActiveContacts\": null,\n \"CountActiveContactsMail\": null,\n \"CountActiveContactsSms\": null,\n \"CountActiveContactsDevice1\": null,\n \"CountActiveContactsDevice2\": null,\n \"DateCreated\": \"2021-05-31 14:57:21\",\n \"UpdateDate\": \"2021-05-31 14:57:21\"\n }\n}" }, { "section": "Contacts", "name": "Delete Group", "label": "Contacts Interface › Delete Group", "method": "POST", "url": "https://capi.mesergo.co.il/api/v2/Contact/DeleteGroup", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Basic USER:TOKEN (Encode Base64)" } ], "bodyLang": "json", "body": "{\r\n \"Data\": {\r\n \"DeleteGroupBy\": \"GroupName\",\r\n \"Value\": \"group\",\r\n \"Configuration\": \"WithoutDeleteContacts\"\r\n }\r\n}", "desc": "This function delete group by name or id.\nIf you delete by name, multiple groups may be deleted\nThe request should be POST\n\nParameters\n\nKey\n\nRequired\\Optional\n\ntype\n\nValue\n\nDeleteGroupBy\n\nRequired\n\nstring\n\nGroupId /GroupNumber /GroupName\n\nValue\n\nRequired\n\nint\n\nThe value of the delete group by\n\nConfiguration\n\nOptional\n\nstring\n\nWithoutDeleteContacts/ WithDeleteContacts/ EmptyGroupOnly\n\nDeleteBy – key for delete group. (if you choose by GroupName, can delete Capel groups) .\n\nAdvanced Options\n\nhttps://capi.mesergo.co.il/api/v2/Contact/DeleteGroup?view=json", "respCode": 200, "respExample": "{\n \"StatusId\": 1,\n \"StatusDescription\": \"Success\",\n \"DetailedDescription\": \"\",\n \"FunctionName\": \"api/v2/Contact/DeleteGroup\",\n \"RequestId\": \",,Abh5mclRnbp5Sdy9mZulmLkV3bsNWPl1WYOR3cvhkJwMTQzUSOwE0MlATMrEDMtYDMtEjMwITPw1WY0NVZtlGVmQDNyQDNwETPklkclNXV\",\n \"Data\": {\n \"Count\": 1,\n \"Configuration\": \"WithoutDeleteContacts\",\n \"List\": [\n {\n \"GroupId\": 300230716,\n \"GroupNumber\": 16,\n \"GroupName\": \"group\"\n }\n ]\n }\n}" }, { "section": "Contacts", "name": "Get Group", "label": "Contacts Interface › Get Group", "method": "POST", "url": "https://capi.mesergo.co.il/api/v2/Contact/GetGroup", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Basic USER:TOKEN (Encode Base64)" } ], "bodyLang": "json", "body": "{\r\n \"Data\": {\r\n \"GetGroupBy\": \"GroupNumber\",\r\n \"Value\": \"7\"\r\n }\r\n}", "desc": "This function finds group by GroupId/GroupNumber/GroupName.\nYou can find more than one Group at a time if you use by GroupName.\nThe request should be POST\n\nParameters\n\nKey\n\nRequired\\Optional\n\ntype\n\nValue\n\nGetGroupBy\n\nRequired\n\nstring\n\nGroupId/GroupNumber/GroupName\n\nValue\n\nRequired\n\nint\n\nThe value of the get group by", "respCode": 200, "respExample": "{\n \"StatusId\": 1,\n \"StatusDescription\": \"Success\",\n \"DetailedDescription\": \"\",\n \"FunctionName\": \"api/v2/Contact/GetGroup\",\n \"RequestId\": \",,Abh5mclRnbp5Sdy9mZulmLkV3bsNWPl1WYOR3cvhkJ2UTQzUSNxE0MlATMrEDMtYDMtEjMwITPw1WY0NVZtlGVmQDNyQDNwETPklkclNXV\",\n \"Data\": {\n \"Count\": 1,\n \"List\": [\n {\n \"GroupId\": 300226604,\n \"GroupTypeId\": 1,\n \"GroupNumber\": 7,\n \"GroupName\": 1805,\n \"Description\": \"\",\n \"CountActiveContacts\": 1,\n \"CountActiveContactsMail\": 0,\n \"CountActiveContactsSms\": 1,\n \"CountActiveContactsDevice1\": 0,\n \"CountActiveContactsDevice2\": 0,\n \"DateCreated\": \"2021-05-18 09:25:37\",\n \"UpdateDate\": \"2021-05-18 09:29:48\"\n }\n ]\n }\n}" }, { "section": "Contacts", "name": "Get group list", "label": "Contacts Interface › Get group list", "method": "POST", "url": "https://capi.mesergo.co.il/api/v2/Contact/GetGroupList", "headers": [ { "key": "content-type", "value": "application/json" }, { "key": "Authorization", "value": "Basic USER:TOKEN (Encode Base64)" } ], "bodyLang": "json", "body": "{\r\n\"Data\": {\r\n}\r\n }", "desc": "This function Gets the list of Groups.\nThe request is to be by POST.\n\nParameters\n\nKey\n\nRequired\\Optional\n\ntype\n\nValue\n\nFromDate\n\nOptional\n\ndate\n\nFrom Date includes this date\n\nToDate\n\nOptional\n\ndate\n\nTo Date include this date\n\nType\n\nOptional\n\nstring\n\nCan be Regular/Dynamic/All\n\nLastFetchedId\n\nOptional\n\nint\n\nGet batch starting with ID larger than X (if a first request is made use 0 or null).\n\nAdvanced Options\n\nhttps://capi.mesergo.co.il/api/v2/Contact/GetGroupList?view=json", "respCode": 200, "respExample": "{\n \"StatusId\": 1,\n \"StatusDescription\": \"Success\",\n \"DetailedDescription\": \"\",\n \"FunctionName\": \"api/v2/Contact/GetGroupList\",\n \"RequestId\": \",,Abh5mclRnbp5Sdy9mZulmLkV3bsNWPl1WYOR3cvhkJwITQzUiNyE0MlATMrEDMtYDMtEjMwITPw1WY0NVZtlGVmQDNyQDNwETPklkclNXV\",\n \"Data\": {\n \"LastFetchedId\": 300230515,\n \"Count\": 7,\n \"List\": [\n {\n \"GroupId\": 300222716,\n \"GroupNumber\": 1,\n \"GroupName\": \"בדיקה\",\n \"GroupTypeId\": 1,\n \"Description\": \"\",\n \"CountActiveContactsMail\": 7,\n \"CountActiveContactsSms\": 7,\n \"CountActiveContactsDevice1\": 0,\n \"CountActiveContactsDevice2\": 0,\n \"DateCreated\": \"2021-05-03 10:40:03\",\n \"UpdateDate\": \"2021-05-10 10:33:24\"\n },\n {\n \"GroupId\": 300224145,\n \"GroupNumber\": 3,\n \"GroupName\": \"תמיכה\",\n \"GroupTypeId\": 1,\n \"Description\": null,\n \"CountActiveContactsMail\": 3,\n \"CountActiveContactsSms\": 3,\n \"CountActiveContactsDevice1\": 0,\n \"CountActiveContactsDevice2\": 0,\n \"DateCreated\": \"2021-05-09 10:09:19\",\n \"UpdateDate\": \"2021-05-09 10:09:19\"\n },\n {\n \"GroupId\": 300226604,\n \"GroupNumber\": 7,\n \"GroupName\": 1805,\n \"GroupTypeId\": 1,\n \"Description\": \"\",\n \"CountActiveContactsMail\": 0,\n \"CountActiveContactsSms\": 1,\n \"CountActiveContactsDevice1\": 0,\n \"CountActiveContactsDevice2\": 0,\n \"DateCreated\": \"2021-05-18 09:25:37\",\n \"UpdateDate\": \"2021-05-18 09:29:48\"\n },\n {\n \"GroupId\": 300228339,\n \"GroupNumber\": 11,\n \"GroupName\": \"TEST123456\",\n \"GroupTypeId\": 1,\n \"Description\": \"\",\n \"CountActiveContactsMail\": 29143,\n \"CountActiveContactsSms\": 0,\n \"CountActiveContactsDevice1\": 0,\n \"CountActiveContactsDevice2\": 0,\n \"DateCreated\": \"2021-05-24 10:37:09\",\n \"UpdateDate\": \"2021-05-24 10:37:09\"\n },\n {\n \"GroupId\": 300228432,\n \"GroupNumber\": 12,\n \"GroupName\": \"cxz\",\n \"GroupTypeId\": 1,\n \"Description\": \"\",\n \"CountActiveContactsMail\": 0,\n \"CountActiveContactsSms\": 0,\n \"CountActiveContactsDevice1\": 0,\n \"CountActiveContactsDevice2\": 0,\n \"DateCreated\": \"2021-05-24 12:03:20\",\n \"UpdateDate\": \"2021-05-24 12:03:20\"\n },\n {\n \"GroupId\": 300230511,\n \"GroupNumber\": 14,\n \"GroupName\": \"test\",\n \"GroupTypeId\": 1,\n \"Description\": null,\n \"CountActiveContactsMail\": 0,\n \"CountActiveContactsSms\": 0,\n \"CountActiveContactsDevice1\": 0,\n \"CountActiveContactsDevice2\": 0,\n \"DateCreated\": \"2021-05-31 14:42:02\",\n \"UpdateDate\": \"2021-05-31 14:42:02\"\n },\n {\n \"GroupId\": 300230515,\n \"GroupNumber\": 15,\n \"GroupName\": \"New Groupe\",\n \"GroupTypeId\": 1,\n \"Description\": null,\n \"CountActiveContactsMail\": 0,\n \"CountActiveContactsSms\": 0,\n \"CountActiveContactsDevice1\": 0,\n \"CountActiveContactsDevice2\": 0,\n \"DateCreated\": \"2021-05-31 14:57:21\",\n \"UpdateDate\": \"2021-05-31 14:57:21\"\n }\n ]\n }\n}" }, { "section": "Contacts", "name": "Unsubscribe", "label": "Contacts Interface › Unsubscribe", "method": "POST", "url": "https://capi.mesergo.co.il/api/V2/Contact/Unsubscribe", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Basic USER:TOKEN (Encode Base64)" } ], "bodyLang": "json", "body": "{\r\n \"Data\": {\r\n \"UnsubscribeReason\": \"Customer request\",\r\n \"List\": [\r\n {\r\n \"Type\": \"Phone\",\r\n \"Value\": \"0541234567\"\r\n }\r\n ]\r\n }\r\n}", "desc": "This function unsubscribes Phones and Emails.\nYou may send up to 100 communication items per request.\nThe request is to be by POST.\n\nParameters\n\nKey\n\nRequired\\Optional\n\ntype\n\nValue\n\nUnsubscribeReason\n\nRequired\n\nstring\n\nThe reason for which you request the communication items to be unsubscribed\n\nUnsubscribeName\n\nOptional\n\nstring\n\nThe system name which executes the request (optional - default API).\n\nType\n\nRequired\n\nstring\n\nCan be Email / Phone.\n\nValue\n\nRequired\n\nstring\n\nThe Email / Phone.\n\nAdvanced Options\n\nhttps://capi.mesergo.co.il/api/v2/Contact/Unsubscribe?view=json", "respCode": 200, "respExample": "{\n \"StatusId\": 1,\n \"StatusDescription\": \"Success\",\n \"DetailedDescription\": \"\",\n \"FunctionName\": \"api/V2/Contact/Unsubscribe\",\n \"RequestId\": \",,Abh5mclRnbp5Sdy9mZulmLkV3bsNWPl1WYOR3cvhkJzATQzUyM0E0MlATMrEDMtYDMtEjMwITPw1WY0NVZtlGVmQDNyQDNwETPklkclNXV\",\n \"Data\": {\n \"Success\": {\n \"Count\": 1\n },\n \"Failed\": {\n \"Count\": 0,\n \"List\": []\n }\n }\n}" }, { "section": "Contacts", "name": "Reactivate Unsubscribe", "label": "Contacts Interface › Reactivate Unsubscribe", "method": "POST", "url": "https://capi.mesergo.co.il/api/v2/Contact/ReactivateUnsubscribe", "headers": [ { "key": "content-type", "value": "application/json" }, { "key": "Authorization", "value": "Basic USER:TOKEN (Encode Base64)" } ], "bodyLang": "json", "body": "{\r\n \"Data\": {\r\n \"ReactivationReason\": \"Customer request\",\r\n \"List\": [\r\n {\r\n \"Type\": \"Phone\",\r\n \"Value\": \"0541234567\"\r\n }\r\n ]\r\n }\r\n}", "desc": "This function reactivates unsubscribed items.\nYou may send up to 100 items (Phones or Emails) per request.\nThe request is to by POST.\n\nParameters\n\nKey\n\nRequired\\Optional\n\ntype\n\nValue\n\nReactivationReason\n\nRequired\n\nstring\n\n– The reason for which you wish to reactivate the unsubscribed\n\nUnsubscribeName\n\nOptional\n\nstring\n\nThe system name which executes the request (optional - default API).\n\nType\n\nRequired\n\nstring\n\nCan be Email / Phone.\n\nValue\n\nRequired\n\nstring\n\nThe Email / Phone.\n\nAdvanced Options\n\nhttps://capi.mesergo.co.il/api/v2/Contact/ReactivateUnsubscribe?view=json", "respCode": 200, "respExample": "{\n \"StatusId\": 1,\n \"StatusDescription\": \"Success\",\n \"DetailedDescription\": \"\",\n \"FunctionName\": \"api/v2/Contact/ReactivateUnsubscribe\",\n \"RequestId\": \",,Abh5mclRnbp5Sdy9mZulmLkV3bsNWPl1WYOR3cvhkJ3ITQzUSOyE0MlQTMrEDMtYDMtEjMwITPw1WY0NVZtlGVmQDNyQDNwETPklkclNXV\",\n \"Data\": {\n \"Success\": {\n \"Count\": 1\n },\n \"Failed\": {\n \"Count\": 0,\n \"List\": []\n }\n }\n}" }, { "section": "Contacts", "name": "Get Unsubscribe List", "label": "Contacts Interface › Get Unsubscribe List", "method": "POST", "url": "https://capi.mesergo.co.il/api/v2/Contact/GetUnsubscribeList", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Basic USER:TOKEN (Encode Base64)" } ], "bodyLang": "json", "body": "{\"Data\"\r\n:{\"FromDate\":\"2021/06/01\",\r\n\"ToDate\": \"2021/06/01\",\"Type\": \"Phone\",\r\n\"LastFetchedId\": 0\r\n}\r\n }", "desc": "This function Gets the list of Unsubscribed.\nThe request is to be by POST.\n\nParameters\n\nKey\n\nRequired\\Optional\n\ntype\n\nValue\n\nFromDate\n\nRequired\n\ndate\n\nFrom Date includes this date\n\nToDate\n\nRequired\n\ndate\n\nTo Date include this date\n\nType\n\nRequired\n\nstring\n\nCan be Email / Phone.\n\nLastFetchedId\n\nOptional\n\nint\n\nGet batch starting with ID larger than X (if a first request is made use 0 or null).\n\nAdvanced Options\n\nhttps://capi.mesergo.co.il/api/v2/Contact/GetUnsubscribeList?view=json", "respCode": 200, "respExample": "{\n \"StatusId\": 1,\n \"StatusDescription\": \"Success\",\n \"DetailedDescription\": \"\",\n \"FunctionName\": \"api/v2/Contact/GetUnsubscribeList\",\n \"RequestId\": \",,Abh5mclRnbp5Sdy9mZulmLkV3bsNWPl1WYOR3cvhkJ5UTQzUCNzE0MlcTMrEDMtYDMtEjMwITPw1WY0NVZtlGVmQDNyQDNwETPklkclNXV\",\n \"Data\": {\n \"LastFetchedId\": 35709398,\n \"Count\": 1,\n \"List\": [\n {\n \"Type\": \"Phone\",\n \"Value\": \"0541234567\",\n \"UnsubscribeDatetime\": \"2021-06-01 17:34:38\"\n }\n ]\n }\n}" }, { "section": "Contacts", "name": "GetUnsubscribeHistory", "label": "Contacts Interface › GetUnsubscribeHistory", "method": "POST", "url": "https://capi.mesergo.co.il/api/v2/Contact/GetUnsubscribeHistory", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Basic USER:TOKEN (Encode Base64)" } ], "bodyLang": "json", "body": "{\r\n \"Data\": {\r\n \"Type\": \"Phone\",\r\n \"Value\": \"0541234567\"\r\n }\r\n}", "desc": "This function get unsubscribed or Reactivated history for Phone/Emails.\nThe request is to by POST.\n\nParameters\n\nKey\n\nRequired\\Optional\n\ntype\n\nValue\n\nType\n\nRequired\n\nstring\n\nPhone /Email /ContactRefId /ContactId\n\nValue\n\nRequired\n\nstring\n\nValue of the type", "respCode": 200, "respExample": "{\n \"StatusId\": 1,\n \"StatusDescription\": \"Success\",\n \"DetailedDescription\": \"\",\n \"FunctionName\": \"api/v2/Contact/GetUnsubscribeHistory\",\n \"RequestId\": \",,Abh5mclRnbp5Sdy9mZulmLkV3bsNWPl1WYOR3cvhkJwETQzUSNyE0MlETMrMDMtYDMtEjMwITPw1WY0NVZtlGVmQDNyQDNwETPklkclNXV\",\n \"Data\": {\n \"Count\": 10,\n \"List\": [\n {\n \"Type\": \"Phone\",\n \"Value\": \"0541234567\",\n \"Action\": \"Reactivate\",\n \"ActionDatetime\": \"2021-06-01 17:31:55\",\n \"ActionSource\": \"api\",\n \"ActionReason\": \"Customer request\",\n \"DoActionName\": \"API\"\n },\n {\n \"Type\": \"Phone\",\n \"Value\": \"0541234567\",\n \"Action\": \"Optout\",\n \"ActionDatetime\": \"2021-06-01 17:31:12\",\n \"ActionSource\": \"api\",\n \"ActionReason\": \"Customer request\",\n \"DoActionName\": \"API\"\n },\n {\n \"Type\": \"Phone\",\n \"Value\": \"0543266290\",\n \"Action\": \"Reactivate\",\n \"ActionDatetime\": \"2021-06-01 14:29:27\",\n \"ActionSource\": \"api\",\n \"ActionReason\": \"Customer request\",\n \"DoActionName\": \"API\"\n },\n {\n \"Type\": \"Phone\",\n \"Value\": \"0543266290\",\n \"Action\": \"Optout\",\n \"ActionDatetime\": \"2021-06-01 10:43:03\",\n \"ActionSource\": \"api\",\n \"ActionReason\": \"Customer request\",\n \"DoActionName\": \"API\"\n },\n {\n \"Type\": \"Phone\",\n \"Value\": \"0541234567\",\n \"Action\": \"Reactivate\",\n \"ActionDatetime\": \"2021-05-18 14:41:23\",\n \"ActionSource\": \"manual\",\n \"ActionReason\": \"test\",\n \"DoActionName\": \"ariel\"\n },\n {\n \"Type\": \"Phone\",\n \"Value\": \"0543266290\",\n \"Action\": \"Optout\",\n \"ActionDatetime\": \"2021-05-09 14:27:37\",\n \"ActionSource\": \"InforuContacts\",\n \"ActionReason\": \"test -\",\n \"DoActionName\": \"ariel\"\n },\n {\n \"Type\": \"Phone\",\n \"Value\": \"0543266290\",\n \"Action\": \"Reactivate\",\n \"ActionDatetime\": \"2021-05-09 14:23:03\",\n \"ActionSource\": \"api\",\n \"ActionReason\": \"Customer request\",\n \"DoActionName\": \"API\"\n },\n {\n \"Type\": \"Phone\",\n \"Value\": \"0543266290\",\n \"Action\": \"Optout\",\n \"ActionDatetime\": \"2021-05-09 14:22:07\",\n \"ActionSource\": \"api\",\n \"ActionReason\": \"Customer request\",\n \"DoActionName\": \"API\"\n },\n {\n \"Type\": \"Phone\",\n \"Value\": \"0543266290\",\n \"Action\": \"Reactivate\",\n \"ActionDatetime\": \"2021-05-09 14:21:01\",\n \"ActionSource\": \"manual\",\n \"ActionReason\": \"tesy\",\n \"DoActionName\": \"ariel\"\n },\n {\n \"Type\": \"Phone\",\n \"Value\": \"0543266290\",\n \"Action\": \"Optout\",\n \"ActionDatetime\": \"2021-05-09 14:20:36\",\n \"ActionSource\": \"api\",\n \"ActionReason\": \"Customer request\",\n \"DoActionName\": \"API\"\n }\n ]\n }\n}" }, { "section": "Contacts", "name": "Get Unsubscribe History List", "label": "Contacts Interface › Get Unsubscribe History List", "method": "POST", "url": "https://capi.mesergo.co.il/api/v2/Contact/GetUnsubscribeHistoryList", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Basic USER:TOKEN (Encode Base64)" } ], "bodyLang": "json", "body": "{\r\n \"Data\": {\r\n \"Type\": \"Phone\",\r\n \"FromDate\": \"2021/05/08\",\r\n \"ToDate\": \"2021/06/10\",\r\n \"Action\": \"All\",\r\n \"LastFetchedId\": 0\r\n }\r\n}", "desc": "This function get unsubscribed history List for all Phones / Emails.\nThe request is to by POST.\n\nParameters\n\nKey\n\nRequired\\Optional\n\ntype\n\nValue\n\nType\n\nRequired\n\nstring\n\nPhone/Email\n\nFromDate\n\nRequired\n\nDate\n\nFrom Date includes this date\n\nToDate\n\nRequired\n\nDate\n\nTo Date include this date\n\nAction\n\nRequired\n\nstring\n\nUnsubscribe/Reactivate/All\n\nLastFetchedId\n\nOptional\n\nint\n\nGet batch starting with ID larger than X", "respCode": 200, "respExample": "{\n \"StatusId\": 1,\n \"StatusDescription\": \"Success\",\n \"DetailedDescription\": \"\",\n \"FunctionName\": \"api/v2/Contact/GetUnsubscribeHistoryList\",\n \"RequestId\": \",,Abh5mclRnbp5Sdy9mZulmLkV3bsNWPl1WYOR3cvhkJ5MTQzUyMzE0MlkDMrIDMtYDMtEjMwITPw1WY0NVZtlGVmQDNyQDNwETPklkclNXV\",\n \"Data\": {\n \"LastFetchedId\": 94121250,\n \"Count\": 11,\n \"List\": [\n {\n \"Type\": \"Phone\",\n \"Value\": \"0543266290\",\n \"Action\": \"Unsubscribe\",\n \"ActionDateTime\": \"2021-05-09 14:20:36\",\n \"ActionSource\": \"api\",\n \"ActionReason\": \"Customer request\",\n \"DoActionName\": \"API\"\n },\n {\n \"Type\": \"Phone\",\n \"Value\": \"0543266290\",\n \"Action\": \"Reactivate\",\n \"ActionDateTime\": \"2021-05-09 14:21:01\",\n \"ActionSource\": \"manual\",\n \"ActionReason\": \"tesy\",\n \"DoActionName\": \"ariel\"\n },\n {\n \"Type\": \"Phone\",\n \"Value\": \"0543266290\",\n \"Action\": \"Unsubscribe\",\n \"ActionDateTime\": \"2021-05-09 14:22:07\",\n \"ActionSource\": \"api\",\n \"ActionReason\": \"Customer request\",\n \"DoActionName\": \"API\"\n },\n {\n \"Type\": \"Phone\",\n \"Value\": \"0543266290\",\n \"Action\": \"Reactivate\",\n \"ActionDateTime\": \"2021-05-09 14:23:03\",\n \"ActionSource\": \"api\",\n \"ActionReason\": \"Customer request\",\n \"DoActionName\": \"API\"\n },\n {\n \"Type\": \"Phone\",\n \"Value\": \"0543266290\",\n \"Action\": \"Unsubscribe\",\n \"ActionDateTime\": \"2021-05-09 14:27:37\",\n \"ActionSource\": \"InforuContacts\",\n \"ActionReason\": \"test -\",\n \"DoActionName\": \"ariel\"\n },\n {\n \"Type\": \"Phone\",\n \"Value\": \"0543266290\",\n \"Action\": \"Reactivate\",\n \"ActionDateTime\": \"2021-05-18 14:41:23\",\n \"ActionSource\": \"manual\",\n \"ActionReason\": \"test\",\n \"DoActionName\": \"ariel\"\n },\n {\n \"Type\": \"Phone\",\n \"Value\": \"0543266290\",\n \"Action\": \"Unsubscribe\",\n \"ActionDateTime\": \"2021-06-01 10:43:03\",\n \"ActionSource\": \"api\",\n \"ActionReason\": \"Customer request\",\n \"DoActionName\": \"API\"\n },\n {\n \"Type\": \"Phone\",\n \"Value\": \"0543266290\",\n \"Action\": \"Reactivate\",\n \"ActionDateTime\": \"2021-06-01 14:29:27\",\n \"ActionSource\": \"api\",\n \"ActionReason\": \"Customer request\",\n \"DoActionName\": \"API\"\n },\n {\n \"Type\": \"Phone\",\n \"Value\": \"0543266290\",\n \"Action\": \"Unsubscribe\",\n \"ActionDateTime\": \"2021-06-01 17:31:12\",\n \"ActionSource\": \"api\",\n \"ActionReason\": \"Customer request\",\n \"DoActionName\": \"API\"\n },\n {\n \"Type\": \"Phone\",\n \"Value\": \"0543266290\",\n \"Action\": \"Reactivate\",\n \"ActionDateTime\": \"2021-06-01 17:31:55\",\n \"ActionSource\": \"api\",\n \"ActionReason\": \"Customer request\",\n \"DoActionName\": \"API\"\n },\n {\n \"Type\": \"Phone\",\n \"Value\": \"0541234567\",\n \"Action\": \"Unsubscribe\",\n \"ActionDateTime\": \"2021-06-01 17:34:38\",\n \"ActionSource\": \"api\",\n \"ActionReason\": \"Customer request\",\n \"DoActionName\": \"API\"\n }\n ]\n }\n}" }, { "section": "Contacts", "name": "Check if Unsubscribed", "label": "Contacts Interface › Check if Unsubscribed", "method": "POST", "url": "https://capi.mesergo.co.il/api/v2/Contact/CheckIfUnsubscribe", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Basic USER:TOKEN (Encode Base64)" } ], "bodyLang": "json", "body": "{\r\n\"Data\": {\r\n\"List\": [\r\n {\r\n \"Type\": \"Phone\",\r\n \"Value\": \"0541234567\"\r\n }\r\n]\r\n }\r\n }", "desc": "This function checks if list is Unsubscribe.\nYou can send up to 100 items per request.\nThe request is to be by POST.\n\nParameters\n\nKey\n\nRequired\\Optional\n\ntype\n\nValue\n\nType\n\nRequired\n\nstring\n\nPhone /Email/ ContactRefId/ ContactId\n\nValue\n\nRequired\n\nstring\n\nthe value of the type", "respCode": 200, "respExample": "{\n \"StatusId\": 1,\n \"StatusDescription\": \"Success\",\n \"DetailedDescription\": \"\",\n \"FunctionName\": \"api/v2/Contact/CheckIfUnsubscribe\",\n \"RequestId\": \",,Abh5mclRnbp5Sdy9mZulmLkV3bsNWPl1WYOR3cvhkJ1QTQzUiM1E0MlITMrcDMtYDMtEjMwITPw1WY0NVZtlGVmQDNyQDNwETPklkclNXV\",\n \"Data\": {\n \"Unsubscribe\": {\n \"Count\": 0,\n \"List\": []\n },\n \"NotUnsubscribe\": {\n \"Count\": 1,\n \"List\": [\n {\n \"Type\": \"Phone\",\n \"Value\": \"0541234567\"\n }\n ]\n }\n }\n}" }, { "section": "Contacts", "name": "Get Fields", "label": "Contacts Interface › Get Fields", "method": "POST", "url": "https://capi.mesergo.co.il/api/v2/Contact/GetFields/", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Your Base Credentials" } ], "bodyLang": "json", "body": "{}", "desc": "This function Gets the list of contact fields\nThe request is to be by POST\n\nResponse Parameters\n\nParameter\n\ntype\n\nDescription\n\nFieldId\n\nint\n\nThe filed ID in MesserGo system\n\nActualFieldName\n\nstring\n\nThe API Filed Name\n\nCaption\n\nstring\n\nThe filed name in MesserGo system\n\nFieldType\n\nstring\n\nThe filed type", "respCode": 200, "respExample": "{\n \"StatusId\": 1,\n \"StatusDescription\": \"Success\",\n \"DetailedDescription\": \"\",\n \"FunctionName\": \"api/v2/Contact/GetFields\",\n \"RequestId\": \",wWYuJXZ05WauUncvZmbp5CMykGchNWPl1WYOR3cvhkJwATQzUyNzE0MlkDMrAzMtcDMtQjMwITPw1WY0NVZtlGVmcjNzQjNwETPklkclNXV\",\n \"Data\": {\n \"Count\": 21,\n \"List\": [\n {\n \"FieldId\": 1,\n \"ActualFieldName\": \"FirstName\",\n \"Caption\": \"שם פרטי\",\n \"FieldType\": \"string\"\n },\n {\n \"FieldId\": 2,\n \"ActualFieldName\": \"LastName\",\n \"Caption\": \"שם משפחה\",\n \"FieldType\": \"string\"\n },\n {\n \"FieldId\": 3,\n \"ActualFieldName\": \"PhoneNumber\",\n \"Caption\": \"טלפון\",\n \"FieldType\": \"string\"\n },\n {\n \"FieldId\": 5,\n \"ActualFieldName\": \"Email\",\n \"Caption\": \"אימייל\",\n \"FieldType\": \"string\"\n },\n {\n \"FieldId\": 42,\n \"ActualFieldName\": \"BirthDate\",\n \"Caption\": \"תאריך לידה\",\n \"FieldType\": \"date\"\n },\n {\n \"FieldId\": 46,\n \"ActualFieldName\": \"GenderId\",\n \"Caption\": \"מגדר\",\n \"FieldType\": \"gender\"\n },\n {\n \"FieldId\": 48,\n \"ActualFieldName\": \"AdditionalDate\",\n \"Caption\": \"תאריך נוסף\",\n \"FieldType\": \"date\"\n },\n {\n \"FieldId\": 153,\n \"ActualFieldName\": \"ContactRefId\",\n \"Caption\": \"מספר אסמכתא\",\n \"FieldType\": \"string\"\n },\n {\n \"FieldId\": 162,\n \"ActualFieldName\": \"Device1Id\",\n \"Caption\": \"מזהה מכשיר 1\",\n \"FieldType\": \"string\"\n },\n {\n \"FieldId\": 164,\n \"ActualFieldName\": \"Device2Id\",\n \"Caption\": \"מזהה מכשיר 2\",\n \"FieldType\": \"string\"\n },\n {\n \"FieldId\": 166,\n \"ActualFieldName\": \"Device1Type\",\n \"Caption\": \"סוג מכשיר 1\",\n \"FieldType\": \"string\"\n },\n {\n \"FieldId\": 168,\n \"ActualFieldName\": \"Device2Type\",\n \"Caption\": \"סוג מכשיר 2\",\n \"FieldType\": \"string\"\n },\n {\n \"FieldId\": 170,\n \"ActualFieldName\": \"Device1StatusId\",\n \"Caption\": \"סטטוס מכשיר 1\",\n \"FieldType\": \"int\"\n },\n {\n \"FieldId\": 172,\n \"ActualFieldName\": \"Device2StatusId\",\n \"Caption\": \"סטטוס מכשיר 2\",\n \"FieldType\": \"int\"\n },\n {\n \"FieldId\": 183,\n \"ActualFieldName\": \"ContactScoring\",\n \"Caption\": \"דירוג\",\n \"FieldType\": \"int\"\n },\n {\n \"FieldId\": 16522,\n \"ActualFieldName\": \"Text1\",\n \"Caption\": \"קישור\",\n \"FieldType\": \"string\"\n },\n {\n \"FieldId\": 16907,\n \"ActualFieldName\": \"Text25\",\n \"Caption\": \"טקסט חדש\",\n \"FieldType\": \"string\"\n },\n {\n \"FieldId\": 16908,\n \"ActualFieldName\": \"Text26\",\n \"Caption\": \"מספר חדש\",\n \"FieldType\": \"string\"\n },\n {\n \"FieldId\": 16909,\n \"ActualFieldName\": \"Text27\",\n \"Caption\": \"תאריך חדש\",\n \"FieldType\": \"string\"\n },\n {\n \"FieldId\": 16910,\n \"ActualFieldName\": \"Date25\",\n \"Caption\": \"תאריך\",\n \"FieldType\": \"date\"\n },\n {\n \"FieldId\": 17765,\n \"ActualFieldName\": \"Number25\",\n \"Caption\": \"מספרי\",\n \"FieldType\": \"int\"\n }\n ]\n }\n}" } ]