Report Service
Report web servisini kullanarak, belli kampanyalara ait raporları analiz etmek için kullanabilirsiniz.
Member web servisine ait aşağıdaki metodlar bulunmaktadır.
Metod | Açıklama |
---|---|
GetCampaignReport | Belirtilen tarihler arasındaki kampanya raporlarını listeler. |
GetCampaignReportWithCampID | Bir e-posta kampanyasının kampanyanın özet bilgi ve özelliklerini listeler. |
GetEmailCampaignDeliveryStatusReportBetweenTwoDatesViaFtp | Belirtilen kampanya ID’sine göre, kampanyaya ait ulaşım durumu raporunu gösterir. |
GetEmailCampaignLinks | Bir kampanyanın içinde yer alan linklerin özelliklerini listeler. |
GetEmailCampaignMemberLinkReportBetweenTwoDatesViaFtp | Bir kampanyada tıklama yapan kullanıcıların listesini döner. |
GetEmailUnsubscribeReportBetweenTwoDatesViaFtp | Ä°ki tarih aralığında üyelikten ayrılan kullanıcıların raporunu oluÅŸturur. |
GetFilteredMembers | Belli filtrelere göre hesabınızdaki üyeleri sorgulamanızı saÄŸlar. |
GetIncomingSmsMessages | Hesabınızda tanımlı olan kısa numaraya gönderilen SMS'leri listeler. |
GetListContent | Belirtilen listenin içeriÄŸindeki üyeleri listeler. |
GetMemberCampaignsWithEmailAddress | E-mail adresine gönderilen kampanya ÅŸablonlarını listeler. |
GetSmsCampaignDeliveryStatusReportBetweenTwoDatesViaFtp | Belirtilen SMS kampanya ID’sine göre, kampanyaya ait SMS lerin ulaşım durumu raporunu gösterir. |
GetSmsCampaignReport | Belirtilen tarihler arasında ki SMS kampanyalarının özelliklerini listeler. |
GetSmsCampaignReportWithCampID | Bir SMS kampanyasının özet bilgi ve özelliklerini listeler. |
GetUnsubscribeReportBetweenTwoDates | Ä°ki tarih aralığında üyelikten ayrılan kullanıcıları verir. |
QueryBulkFileProgress | Bir yükleme yada rapor isteÄŸinin durumunu sorgulamanızı saÄŸlar. |
QueryDataWarehouseUploadProgress | Bir data warehouse yüklemesinin durumunu sorgulamanızı saÄŸlar. |
QueryOngoingEmailStatus | E-Mail iÅŸlem kampanyası kapsamında gönderilen bir e-postanın ulaşım durumunu sorgular. |
QueryOngoingSmsStatus | SMS iÅŸlem kampanyası kapsamında gönderilen bir SMS’in ulaşım durumunu sorgular. |
QuerySendingPushMessageToMembers | Üyelere push bildirim gönderilmesini sorgular. |
GeliÅŸtiricinin her hangi bir web servis ile etkileÅŸime geçebilmesi için, öncelikle Login
metodunu kullanarak bir SERVICE TICKET alması gerekir. Diğer web servis ve metodlarına oluşturmuş olduğu bu değer ile istekte bulunabilir.
GetCampaignReport
URL | |
---|---|
Http verb | GET |
Parameters | BeginDate(string): The start date of time gap to get reports. (Format: dd.MM.yyyy) EndDate(string): The end date of time gap to get reports. (Format: dd.MM.yyyy) |
Header | Content-Type: application/json Authorization: The ticket given by the system after successful login |
Body | |
Sample Body | |
Sample Response | { "Campaigns": [ { "Name": "", "Subject": "", "CustomerTitle": "", "CreationDate": "31.07.2015 18:17:25", "DeliveryStart": "05.01.2016 11:04:10", "DeliveryFinish": "05.01.2016 11:06:20", "CampaignId": "", "TotalSent": "1", "TotalRead": "1", "HardBounce": "0", "SoftBounce": "0", "Other": "0", "UniqueRead": "1", "UniqueClick": "0", "TotalClick": "0", "ReadRatio": "100,00", "ClickRatio": "0,00", "HotmailJunkCount": "0", "YahooJunkCount": "0", "Lists": "", "Status": null, "Classification": [] } ], "Success": false, "Errors": [ { "Code": "", "Message": "" } ], "DetailedMessage": "" "TransactionId": "" } |
Successs Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code | 00, 01,99 |
GetCampaignDetailedMemberReport
URL | |
---|---|
Http verb | GET |
Parameters | CampaignId(string): id of campaign. ReportType(int): Read = 1, Clicked = 2, Unsubscribed = 3, MarkedSpam = 4, Bounced = 5 |
Header | Content-Type: application/json Authorization: The ticket given by the system after successful login |
Body | |
Sample Body | |
Sample Response | { "Members": [ "345678987654" ( MemberID) ], "Success": false, "Errors": [ { "Code": "", "Message": "" } ], "DetailedMessage": "" "TransactionId": "" } |
Successs Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code | 00, 01,76, 99 ,106 |
GetListContent
URL | LIVE: https://api.relateddigital.com/resta/api/report/GetListContent ECOMM: https://api.relateddigital.com/reste/api/report/GetListContent LIVEB: https://api.relateddigital.com/liveb_rest/api/report/GetListContent LIVEM: https://api.relateddigital.com/restm/api/report/GetListContent |
---|---|
Http verb | POST |
Parameters | |
Header | Content-Type: application/json Authorization: The ticket given by the system after successful login |
Body |
GroupName(string): list group name, ListName(string): list name under groupName. ListInsertionBeginDate(string): ListInsertionFinishDate(string): Map(string): ZipPassword(string): NotificationEmail(string): FtpDetails(FtpInfo): { ServerIp(string): Port(int): Username(string): Password(string): ChangeDir(string): Secure(bool): Key(string): }
|
Sample Body | { "GroupName": "Genel", "ListName": "E-Bülten", "ListInsertionBeginDate": "20150611 19:29:02", "ListInsertionFinishDate": "20170611 19:29:02", "Map": "COLUMN1=Adınız", "ZipPassword": "ZipPassword", "NotificationEmail": "testml@euromsg.com", "FtpDetails": { "ServerIp": "ServerIP", "Port": 0, "Username": "Username", "Password": "Password", "ChangeDir": "ChangeDir", "Secure": true, "Key": "Key" } } |
Sample Response | { "ConversationId": "B47188A576D045F1B5DFDA6E551466FA", "Success": true, "Errors": [], "DetailedMessage": "", "TransactionId": "3D6427135C344F0789B77D7C4FF5778F" } |
Successs Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code |
GetCampaignReportWithCampId
URL | |
---|---|
Http verb | GET |
Parameters | CampId (string): Id of campaign. |
Header | Content-Type: application/json Authorization: The ticket given by the system after successful login |
Body |
|
Sample Body | |
Sample Response | { "Campaign": { "Name": "test", "Subject": "test", "CustomerTitle": "Euro Message IT", "CreationDate": "10.10.2016 11:11:07", "DeliveryStart": "1.01.1900 00:00:00", "DeliveryFinish": "", "CampaignId": "F543F6FC509942BB9A722DE8A5FB0C89", "TotalSent": "0", "TotalRead": "0", "HardBounce": "0", "SoftBounce": "0", "Other": "0", "UniqueRead": "0", "UniqueClick": "0", "TotalClick": "0", "ReadRatio": "0,00", "ClickRatio": "0,00", "HotmailJunkCount": "0", "YahooJunkCount": "0", "Lists": "", "Status": "OFF", "FromAddress": "mert.gumus@euromsg.net", "Classification": [] }, "Success": true, "Errors": [], "DetailedMessage": "", "TransactionId": "3AF593203D844D76BA267ED72BD56782" } |
Successs Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code |
GetEmailCampaignLinks
URL | |
---|---|
Http verb | GET |
Parameters | CampaignId (string): Id of campaign. |
Header | Content-Type: application/json Authorization: The ticket given by the system after successful login |
Body |
|
Sample Body | |
Sample Response | { "Links": [ { "LinkID": "1BE3B616C73E4A31911D2EF6F8C0800E", "LinkName": "", "Link": "http://test.com", "LinkType": "T", "TotalClickCount": 1, "UniqueClickCount": 1 } ], "Success": true, "Errors": [], "DetailedMessage": "", "TransactionId": "DDE83BF1DA9848D2A32457F95FDF2F86" } |
Successs Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code |
GetEmailCampaignDeliveryStatusReportViaFtp
URL | LIVE: https://api.relateddigital.com/resta/api/report/GetEmailCampaignDeliveryStatusReportViaFtp ECOMM: https://api.relateddigital.com/reste/api/report/GetEmailCampaignDeliveryStatusReportViaFtp LIVEB: https://api.relateddigital.com/liveb_rest/api/report/GetEmailCampaignDeliveryStatusReportViaFtp LIVEM: https://api.relateddigital.com/restm/api/report/GetEmailCampaignDeliveryStatusReportViaFtp |
---|---|
Http verb | POST |
Parameters | |
Header | Content-Type: application/json Authorization: The ticket given by the system after successful login |
Body | CampaignId(string): Map(string): ZipPassword(string): NotificationEmail(string): FtpDetails(FtpInfo): { ServerIp(string): Port(int): Username(string): Password(string): ChangeDir(string): Secure(bool): Key(string): }
|
Sample Body | { "CampaignId": "F543F6FC509942BB9A722DE8A5FB0C89", "Map": "COLUMN1=Adınız", "ZipPassword": "ZipPassword", "NotificationEmail": "testml@euromsg.com", "FtpDetails": { "ServerIp": "ServerIP", "Port": 0, "Username": "Username", "Password": "Password", "ChangeDir": "ChangeDir", "Secure": true, "Key": "Key" } } |
Sample Response | { "ConversationId": "AB2DC9A16BEE453480F2EA3D30E2D6EC", "Success": true, "Errors": [], "DetailedMessage": "", "TransactionId": "DCA0127D81454B38A33362E27CF1BB48" } |
Successs Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code |
GetEmailCampaignDeliveryStatusReportBetweenTwoDatesViaFtp
URL | |
---|---|
Http verb | POST |
Parameters | |
Header | Content-Type: application/json Authorization: The ticket given by the system after successful login |
Body | CampaignId(string): Map(string): ZipPassword(string): NotificationEmail(string): BeginDate(string): EndDate(string): FtpDetails(FtpInfo): { ServerIp(string): Port(int): Username(string): Password(string): ChangeDir(string): Secure(bool): Key(string): }
|
Sample Body | { "CampaignId": "F543F6FC509942BB9A722DE8A5FB0C89", "Map": "COLUMN1=Adınız", "ZipPassword": "ZipPassword", "NotificationEmail": "testml@euromsg.com", "BeginDate":"20150611 19:29:02", "EndDate": "20170611 19:29:02", "FtpDetails": { "ServerIp": "ServerIP", "Port": 0, "Username": "Username", "Password": "Password", "ChangeDir": "ChangeDir", "Secure": true, "Key": "Key" } } |
Sample Response | { "ConversationId": "20DBFB98883D430D9F62BF5C95E3B0E6", "Success": true, "Errors": [], "DetailedMessage": "", "TransactionId": "4ED4315FF0A04D07841896D1B12370A8" } |
Successs Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code |
GetEmailCampaignMemberLinkReportViaFtp
URL | LIVE: https://api.relateddigital.com/resta/api/report/GetEmailCampaignMemberLinkReportViaFtp ECOMM: https://api.relateddigital.com/reste/api/report/GetEmailCampaignMemberLinkReportViaFtp LIVEB: https://api.relateddigital.com/liveb_rest/api/report/GetEmailCampaignMemberLinkReportViaFtp LIVEM: https://api.relateddigital.com/restm/api/report/GetEmailCampaignMemberLinkReportViaFtp |
---|---|
Http verb | POST |
Parameters | |
Header | Content-Type: application/json Authorization: The ticket given by the system after successful login |
Body | CampaignId(string): Map(string): ZipPassword(string): NotificationEmail(string): BeginDate(string): EndDate(string): FtpDetails(FtpInfo): { ServerIp(string): Port(int): Username(string): Password(string): ChangeDir(string): Secure(bool): Key(string): }
|
Sample Body | { "CampaignId": "F543F6FC509942BB9A722DE8A5FB0C89", "Map": "COLUMN1=Adınız", "ZipPassword": "ZipPassword", "NotificationEmail": "testml@euromsg.com", "BeginDate": "20150611 19:29:02", "EndDate": "20170611 19:29:02", "FtpDetails": { "ServerIp": "ServerIP", "Port": 0, "Username": "Username", "Password": "Password", "ChangeDir": "ChangeDir", "Secure": true, "Key": "Key" } } |
Sample Response | { "ConversationId": "F143017FCC9F4227B42BF9AC3A2F5230", "Success": true, "Errors": [], "DetailedMessage": "", "TransactionId": "A569399F80BD44FDADF54F610AF529C3" } |
Successs Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code |
GetEmailCampaignMemberLinkReportBetweenTwoDatesViaFtp
URL | |
---|---|
Http verb | POST |
Parameters | |
Header | Content-Type: application/json Authorization: The ticket given by the system after successful login |
Body | CampaignId(string): Map(string): ZipPassword(string): NotificationEmail(string): BeginDate(string): EndDate(string): FtpDetails(FtpInfo): { ServerIp(string): Port(int): Username(string): Password(string): ChangeDir(string): Secure(bool): Key(string): }
|
Sample Body | { "CampaignId": "F543F6FC509942BB9A722DE8A5FB0C89", "Map": "COLUMN1=Adınız", "ZipPassword": "ZipPassword", "NotificationEmail": "testml@euromsg.com", "BeginDate": "20150611 19:29:02", "EndDate": "20170611 19:29:02", "FtpDetails": { "ChangeDir" : "ChangeDir", "Key" : "Key", "Password" : "Password", "Port" : 0, "Secure" : true, "ServerIp" : "ServerIP", "Username" : "Username" } } |
Sample Response | { "ConversationId": "6FC190E2E5354411B00836315BA2CF39", "Success": true, "Errors": [], "DetailedMessage": "", "TransactionId": "2C4176BD815945F0B091844CE79302AA" } |
Successs Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code |
GetEmailCampaignMemberLinkReportBetweenTwoDates
URL | LIVE: https://api.relateddigital.com/resta/api/report/GetEmailCampaignMemberLinkReportBetweenTwoDates ECOMM: https://api.relateddigital.com/reste/api/report/GetEmailCampaignMemberLinkReportBetweenTwoDates LIVEB: https://api.relateddigital.com/liveb_rest/api/report/GetEmailCampaignMemberLinkReportBetweenTwoDates LIVEM: https://api.relateddigital.com/restm/api/report/GetEmailCampaignMemberLinkReportBetweenTwoDates |
---|---|
Http verb | POST |
Parameters | |
Header | Content-Type: application/json Authorization: The ticket given by the system after successful login |
Body | CampaignId(string): Map(string): BeginDate(string): EndDate(string):
|
Sample Body | { "CampaignId": "4741F11578F9460581931F571958B979", "Map": "COLUMN1=Adınız", "BeginDate": "20160629 10:31:18", "EndDate": "20160829 10:31:18" } |
Sample Response | { "Details": [ { "Adınız": "", "LINK_ID": "1BE3B616C73E4A31911D2EF6F8C0800E", "CLICK_COUNT": 1, "FIRST_CLICK_TIME": "2016-07-29T10:30:12.707", "LAST_CLICK_TIME": "2016-07-29T10:31:18.96" } ], "Success": true, "Errors": [], "DetailedMessage": "", "TransactionId": "442D28D0F13A42D1A4EC08147E0920B6" } |
Successs Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code |
GetEmailUnsubscribeReportViaFtp
URL | LIVE: https://api.relateddigital.com/resta/api/report/GetEmailUnsubscribeReportViaFtp ECOMM: https://api.relateddigital.com/reste/api/report/GetEmailUnsubscribeReportViaFtp LIVEB: https://api.relateddigital.com/liveb_rest/api/report/GetEmailUnsubscribeReportViaFtp LIVEM: https://api.relateddigital.com/restm/api/report/GetEmailUnsubscribeReportViaFtp |
---|---|
Http verb | POST |
Parameters | |
Header | Content-Type: application/json Authorization: The ticket given by the system after successful login |
Body | CampaignId(string): Map(string): ZipPassword(string): NotificationEmail(string): FtpDetails(FtpInfo): { ServerIp(string): Port(int): Username(string): Password(string): ChangeDir(string): Secure(bool): Key(string): }
|
Sample Body | { "CampaignId": "4741F11578F9460581931F571958B979", "Map":"COLUMN1=Adınız", "ZipPassword":"ZipPassword", "NotificationEmail":"testml@euromsg.com", "FtpDetails": { "ChangeDir" : "ChangeDir", "Key" : "Key", "Password" : "Password", "Port" : 0, "Secure" : true, "ServerIp" : "ServerIP", "Username" : "Username" } } |
Sample Response | { "ConversationId": "469C47B7D6BB4C6EA279B390FE9D924A", "Success": true, "Errors": [], "DetailedMessage": "", "TransactionId": "9FD1AE82AFC24CDA8A45D4F6847CBEC5" } |
Successs Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code |
GetEmailUnsubscribeReportBetweenTwoDatesViaFtp
URL | LIVE: https://api.relateddigital.com/resta/api/report/GetEmailUnsubscribeReportBetweenTwoDatesViaFtp ECOMM: https://api.relateddigital.com/reste/api/report/GetEmailUnsubscribeReportBetweenTwoDatesViaFtp LIVEB: https://api.relateddigital.com/liveb_rest/api/report/GetEmailUnsubscribeReportBetweenTwoDatesViaFtp LIVEM: https://api.relateddigital.com/restm/api/report/GetEmailUnsubscribeReportBetweenTwoDatesViaFtp |
---|---|
Http verb | POST |
Parameters | |
Header | Content-Type: application/json Authorization: The ticket given by the system after successful login |
Body | CampaignId(string): Map(string): ZipPassword(string): NotificationEmail(string): BeginDate(string): EndDate(string): FtpDetails(FtpInfo): { ServerIp(string): Port(int): Username(string): Password(string): ChangeDir(string): Secure(bool): Key(string): } |
Sample Body | { "CampaignId": "4741F11578F9460581931F571958B979", "Map":"COLUMN1=Adınız", "ZipPassword":"ZipPassword", "NotificationEmail":"testml@euromsg.com", "BeginDate":"20160629 10:31:18", "EndDate" : "20160829 10:31:18", "FtpDetails":
{ "ChangeDir" : "ChangeDir", "Key" : "Key", "Password" : "Password", "Port" : 0, "Secure" : true, "ServerIp" : "ServerIP", "Username" : "Username" } } |
Sample Response | { "ConversationId": "1C485EF85FF14129AF0669AFD781F61B", "Success": true, "Errors": [], "DetailedMessage": "", "TransactionId": "32120EF26C9F472B8C5103B649AF776E" } |
Successs Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code |
GetUnsubscribeReportBetweenTwoDates
URL | |
---|---|
Http verb | GET |
Parameters | BeginDate EndDate OnlyEmailUnsubscribes(boolean) |
Header | Content-Type: application/json Authorization: The ticket given by the system after successful login |
Body |
|
Sample Body | |
Sample Response | { "Unsubscribers": { "KeyId": null, "Email": null, "UnsubscribeTime": null, "Reason": null, "GsmNo": null, "EmailPermit": null, "GsmPermit": null, "Status": null } } |
Successs Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code |
GetFilteredMembers
URL | LIVE: https://api.relateddigital.com/resta/api/report/GetFilteredMembers ECOMM: https://api.relateddigital.com/reste/api/report/GetFilteredMembers LIVEB: https://api.relateddigital.com/liveb_rest/api/report/GetFilteredMembers LIVEM: ttps://api.relateddigital.com/restm/api/report/GetFilteredMembers |
---|---|
Http verb | POST |
Parameters | |
Header | Content-Type: application/json Authorization: The ticket given by the system after successful login |
Body | Map(string): ZipPassword(string): NotificationEmail(string): Filters(Filter[]): Filter array which includes key,value, operator. { Key(string): This field must contain the primary key column (EMAIL, KEY_ID) defined in the account. Value(string): This is the value of the Key Column, Operator(int): LessThan = 1, LessOrEqualThan = 2, GreaterThan = 3,GreaterOrEqualThan = 4,Equal = 5, NotEqual = 6, Like = 7, NotLike = 8 } FtpDetails(FtpInfo): { ServerIp(string): Port(int): Username(string): Password(string): ChangeDir(string): Secure(bool): Key(string): }
|
Sample Body | { "Map":"COLUMN1=Adınız;UNSUBSCRIBE_DATE=Tarih", "ZipPassword":"ZipPassword", "NotificationEmail":"testml@euromsg.com", "Filters":[{"Key":"EMAIL", "Value":"omer.yilmaz@euromsg.com","Operator":5}], "FtpDetails":
{ "ChangeDir" : "ChangeDir", "Key" : "Key", "Password" : "Password", "Port" : 0, "Secure" : true, "ServerIp" : "ServerIP", "Username" : "Username" } } |
Sample Response | { "ConversationId": "33498650693E45BEBAB3BF0DEEBAFE33", "Success": true, "Errors": [], "DetailedMessage": "", "TransactionId": "537C44B3B6C04D3B96D0412835F9CC40" } |
Successs Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code |
QueryBulkFileProgress
URL | |
---|---|
Http verb | GET |
Parameters | ConversationId(string) |
Header | Content-Type: application/json Authorization: The ticket given by the system after successful login |
Body |
|
Sample Body | |
Sample Response | { "ConversationId": "FFD0BE1ABF8B45C1891B7AF6ABE46B39", "ConversationStatus": "N", "TotalRowCountInConversation": 0, "ProcessedRowCountInConversation": 0, "Success": true, "Errors": [], "DetailedMessage": "", "TransactionId": "CA79752B6F7340339A64DB10B1629CA3" } |
Successs Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code |
RetryExportJob
URL | |
---|---|
Http verb | GET |
Parameters | ConversationId(string) |
Header | Content-Type: application/json Authorization: The ticket given by the system after successful login |
Body |
|
Sample Body | |
Sample Response | { "Success": true, "Errors": [], "DetailedMessage": "", "TransactionId": "07BA0487A2464900BE31640E63A8216C" } |
Successs Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code |
QueryOngoingEmailStatus
URL | |
---|---|
Http verb | GET |
Parameters | CampId(string) , MailId(string) |
Header | Content-Type: application/json Authorization: The ticket given by the system after successful login |
Body |
|
Sample Body | |
Sample Response | { "CampID": "33BDF09410374567A1D875AFE4B7982B", "TransacitonID": "33BDF09410374567A1D875AFE4B7982B", "RelayStatus": null, "DeliveryStatus": null, "ReadTime": null, "UndeliveryReason": null, "MarkedSpam": false, "Success": true, "Errors": [], "DetailedMessage": "", "TransactionId": "7775EBB310734EA4A811B27E38410024" } |
Successs Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code |
QueryOngoingSmsStatus
URL | |
---|---|
Http verb | GET |
Parameters | CampId(string),TransactionId(string) |
Header | Content-Type: application/json Authorization: The ticket given by the system after successful login |
Body |
|
Sample Body | |
Sample Response | { "DeliveryResult": { "GsmNumber": null, "DeliveryResult": null, "DeliveryDetail": null, "DeliveryTime": null, "DeliveredMessage": null, "PostType": null, "KeyID": null, "SendDate": null } } |
Successs Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code |
GetIncomingSmsMessages
URL | |
---|---|
Http verb | GET |
Parameters | BeginTime(string), EndTime(string) |
Header | Content-Type: application/json Authorization: The ticket given by the system after successful login |
Body |
|
Sample Body | |
Sample Response | { "SmsMessages": [], "Success": true, "Errors": [], "DetailedMessage": "", "TransactionId": "A9C4B0C7B90B46CEA0F40D12977E6A72" } |
Successs Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code |
GetSmsCampaignReport
URL | |
---|---|
Http verb | GET |
Parameters | BeginDate(string),EndDate(string) |
Header | Content-Type: application/json Authorization: The ticket given by the system after successful login |
Body |
|
Sample Body | |
Sample Response | { "Campaigns": [], "Success": true, "Errors": [], "DetailedMessage": "", "TransactionId": "7DF1992B97244CCF8C8C61C27FF62575" } |
Successs Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code |
GetSmsCampaignReportWithCampId
URL | |
---|---|
Http verb | GET |
Parameters | SmsCampId(string) |
Header | Content-Type: application/json Authorization: The ticket given by the system after successful login |
Body |
|
Sample Body | |
Sample Response | { "SmsCampaign": { "CampaignId": "FFBF4ACEF09E4A1CB67494C12CCC500C", "Name": "sms 2-2015-11-21T13:45", "Originator": "BRANDMAIL", "CreationDate": "21.11.2015 13:45:36", "DeliveryStart": "21.11.2015 13:45:36", "Status": "SENDING", "GsmColumn": "COLUMN6", "SmsMessage": "<##Adınız##>sdadsdsd<##Soyadınız##>sdadsad<##AFFILIATE_ID##> wdasdwsd sfsfsdf", "UniqueSms": "true", "TotalSmsCount": "22", "DuplicateSmsCount": "2", "PreparedSmsCount": "20", "TotalSent": "16", "Read": "0", "Waiting": "0", "Fail": "0", "Timeout": "0", "Lists": "" }, "Success": true, "Errors": [], "DetailedMessage": "", "TransactionId": "8C7A25EA57D44465819FE4E747C048BF" } |
Successs Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code |
GetSmsCampaignDeliveryStatusReportViaFtp
URL | LIVE: https://api.relateddigital.com/resta/api/report/GetSmsCampaignDeliveryStatusReportViaFtp ECOMM: https://api.relateddigital.com/reste/api/report/GetSmsCampaignDeliveryStatusReportViaFtp LIVEB: https://api.relateddigital.com/liveb_rest/api/report/GetSmsCampaignDeliveryStatusReportViaFtp LIVEM: https://api.relateddigital.com/restm/api/report/GetSmsCampaignDeliveryStatusReportViaFtp |
---|---|
Http verb | POST |
Parameters | |
Header | Content-Type: application/json Authorization: The ticket given by the system after successful login |
Body | CampaignId(string): Map(string): ZipPassword(string): NotificationEmail(string): FtpDetails(FtpInfo): { ServerIp(string): Port(int): Username(string): Password(string): ChangeDir(string): Secure(bool): Key(string): } |
Sample Body | { "CampaignId" : "FFBF4ACEF09E4A1CB67494C12CCC500C", "Map":"COLUMN1=Adınız", "ZipPassword":"ZipPassword", "NotificationEmail":"testml@euromsg.com", "FtpDetails": { "ChangeDir" : "ChangeDir", "Key" : "Key", "Password" : "Password", "Port" : 0, "Secure" : true, "ServerIp" : "ServerIP", "Username" : "Username" } } |
Sample Response | { "ConversationId": "D09F69318CEB4E3BA3B4A9F37A1C31FF", "Success": true, "Errors": [], "DetailedMessage": "", "TransactionId": "34F04557B207421B88725A8FD5E639F4" } |
Successs Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code |
GetSmsCampaignDeliveryStatusReportBetweenTwoDatesViaFtp
URL | |
---|---|
Http verb | POST |
Parameters | |
Header | Content-Type: application/json Authorization: The ticket given by the system after successful login |
Body | CampaignId(string): BeginDate(string): EndDate(string): Map(string): ZipPassword(string): NotificationEmail(string): FtpDetails(FtpInfo): { ServerIp(string): Port(int): Username(string): Password(string): ChangeDir(string): Secure(bool): Key(string): } |
Sample Body | { "CampaignId" : "FFBF4ACEF09E4A1CB67494C12CCC500C", "BeginDate" :"20151120 13:45:36", "EndDate" :"20151122 13:45:36", "Map" :"COLUMN1=Adınız", "ZipPassword":"ZipPassword", "NotificationEmail":"testml@euromsg.com", "FtpDetails": { "ChangeDir" : "ChangeDir", "Key" : "Key", "Password" : "Password", "Port" : 0, "Secure" : true, "ServerIp" : "ServerIP", "Username" : "Username" } } |
Sample Response | { "ConversationId": "0F38E03A93D74FE7B07BD929773030D0", "Success": true, "Errors": [], "DetailedMessage": "", "TransactionId": "3AB710F8ED2D4025A56ED5134D17FF64" } |
Successs Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code |
GetMemberCampaignsWithEmailAddress
URL | |
---|---|
Http verb | GET |
Parameters | Key --> EMAIL Value --> Email Address |
Header | Content-Type: application/json Authorization: The ticket given by the system after successful login |
Body |
|
Sample Body | |
Sample Response | "Id": "E9A729924680480F8ADDF4854C71629A", |
Successs Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code |
QuerySendingPushMessageToMembers
URL | |
---|---|
Http verb | POST |
Parameters | Key(string): Value(string): BeginDate(string): EndDate(string): PageSize(int): PageCount(int): |
Header | Content-Type: application/json Authorization: The ticket given by the system after successful login |
Body |
|
Sample Body | |
Sample Response | { "UnreadMessageCount": 0, "ReadMessageCount": 0, "PushReportList": [], "Success": true, "Errors": [], "DetailedMessage": "", "TransactionId": "89606E8C58594CE9B922A31EBDB821DC" } |
Successs Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code |
GetPushCampaignReport
URL | |
---|---|
Http verb | GET |
Parameters | BeginDate(string), EndDate(string) |
Header | Content-Type: application/json Authorization: The ticket given by the system after successful login |
Body |
|
Sample Body | |
Sample Response | { "CampaignResults": [ { "CampaignId": "28ACD1884841462C9CC424C40594D143", "CampaignName": "testset", "PushType": 2, "Status": "OFF", "TextMessage": "testset", "TargetUrl": "", "MediaUrl": "", "CustomParams": "", "DeliveryDate": "1900-01-01T00:00:00", "DeliveryExpireDate": "0001-01-01T00:00:00", "PushAppReports": [ { "AppAlias": "21313", "PushAppStats": { "TargetedCount": 0, "PreparedCount": 0, "ExcludedCount": 0, "RelayedCount": 0, "DeliveredCount": 0, "OpenedCount": 0, "TotalOpenedCount": 0, "BounceCount": 0, "SendErrorCount": 0 } } ] }, { "CampaignId": "A42D2F9913FC4EDAA4DD1D08764381AC", "CampaignName": "test", "PushType": 2, "Status": "OFF", "TextMessage": "test", "TargetUrl": "", "MediaUrl": "", "CustomParams": "", "DeliveryDate": "1900-01-01T00:00:00", "DeliveryExpireDate": "0001-01-01T00:00:00", "PushAppReports": [ { "AppAlias": "AndroidTest", "PushAppStats": { "TargetedCount": 0, "PreparedCount": 0, "ExcludedCount": 0, "RelayedCount": 0, "DeliveredCount": 0, "OpenedCount": 0, "TotalOpenedCount": 0, "BounceCount": 0, "SendErrorCount": 0 } }, { "AppAlias": "test2", "PushAppStats": { "TargetedCount": 0, "PreparedCount": 0, "ExcludedCount": 0, "RelayedCount": 0, "DeliveredCount": 0, "OpenedCount": 0, "TotalOpenedCount": 0, "BounceCount": 0, "SendErrorCount": 0 } } ] } ], "Success": true, "Errors": [], "DetailedMessage": "", "TransactionId": "A3D09744EA46451CA62E642A7C6C3AFD" } |
Successs Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code |
QueryDataWarehouseUploadProgress
URL | |
---|---|
Http verb | GET |
Parameters | FileName(string), BeginTime(string), EndTime(string) |
Header | Content-Type: application/json Authorization: The ticket given by the system after successful login |
Body |
|
Sample Body | |
Sample Response | { "DwTables": [ { "DwTableId": "C42470235AD6409E81CC8849C39693CC", "FileName": "rest-api2", "ZipFileName": "rest-api2", "Status": "E", "ErrorMessage": "Invalid ColumnName in header --> u-Stack Trace: at EuroFLManager.FlBulkFileUploadManager.ValidateC", "TotalRowCount": 0, "InvalidEmailCount": 0, "InvalidGsmCount": 0, "BlackListedEmailCount": 0, "BlackListedGsmCount": 0, "NewMemberCount": 0, "ProcessStartTime": "17.08.2016 10:38:05", "ProcessEndTime": "17.08.2016 10:38:06", "IsBase": true, "FileVersion": "" }, { "DwTableId": "A34CD55B5E12485F815F4EDC403B6B8D", "FileName": "rest-api2", "ZipFileName": "rest-api2", "Status": "E", "ErrorMessage": "Invalid ColumnName in header --> g-Stack Trace: at EuroFLManager.FlBulkFileUploadManager.ValidateC", "TotalRowCount": 0, "InvalidEmailCount": 0, "InvalidGsmCount": 0, "BlackListedEmailCount": 0, "BlackListedGsmCount": 0, "NewMemberCount": 0, "ProcessStartTime": "17.08.2016 10:35:19", "ProcessEndTime": "17.08.2016 10:35:19", "IsBase": true, "FileVersion": "" } ], "Success": true, "Errors": [], "DetailedMessage": "", "TransactionId": "F0A29588507449F8BCDD8EDDEC9DEFB9" } |
Successs Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code |
Ana Sayfa: RMC REST API
Copyright 2020 Related Digital