Campaign Service
Dakikada gönderilebilecek en fazla istek sayısı 1000'dir.
Metod | Açıklama |
|---|---|
Spesifik bir kampanyaya liste ekler. (MSCRM entegrasyonu için). | |
Gönderimi henüz tamamlanmamış bir kampanyayı iptal etmeyi sağlar. | |
Bir e-posta kampanyası oluşturmak için kullanılır. | |
Bir Push kampanyası oluşturur veya varolan bir push kampanyasını günceller. | |
Bir Web Push kampanyası oluşturur veya varolan bir web push kampanyasını günceller. | |
Bir SMS kampanya oluşturmayı sağlar. | |
Gönderime hazır olan bir kampanyayı duraklatır. | |
Mevcut bir kampanyanın parametrelerini listeler. | |
Varolan bir SMS Kampanyasının parametrelerini listeler. | |
Belli bir tarih aralığında iptal edilen kampanyaları listeler. | |
MemberID'ye göre kampanya durumunu özetler. | |
Belirli bir gün aralığındaki kampanyaları seçmek için kullanılır. | |
Belli bir tarih aralığında oluşturulmuş işlem kampanyalarını listeler. | |
Belirli bir gün aralığında zamanlanmış email kampanyaları ve durumlarını seçer. | |
Belli bir tarih aralığında test gönderimi yapılmış kampanyaları listeler. | |
Bir e-posta kampanyası göndermek için kullanılır. | |
Bir Push kampanyası göndermek için kullanılır. | |
Harici seçeneklerle birlikte email kampanyası gönderimi için kullanılır. | |
Bir SMS kampanyası göndermek için kullanılır. | |
Gönderimi durdurulmuş bir e-posta kampanyasını yeniden başlatır. | |
Gönderimde olan email kampanyasını duraklatmak için kullanılır. | |
Bir email kampanyasının test gönderimini sağlar. | |
Bir sms kampanyasının test gönderimini sağlar. | |
Gönderime hazır kampanyaları aktif duruma getirir. | |
Taslak olarak yer alan bir e-posta kampanyasını güncellemek için kullanılır. | |
SMS kampanyasını günceller. Eğer kampanya yok ise yeni bir kampanya oluşturur. | |
Gönderimde olan bir SMS kampanyasını iptal eder. | |
Gönderimde olan bir Push kampanyasını iptal eder. | |
Gönderimde olan Push kampanyasını duraklatmak için kullanılır. | |
Önceden durdurulmuş bir Push kampanyasını tekrardan gönderime başlatır. | |
Gönderimde olan bir Web Push kampanyasını iptal eder. | |
Gönderimde olan Web Push kampanyasını duraklatmak için kullanılır. | |
Önceden durdurulmuş bir Web Push kampanyasını tekrardan gönderime başlatır. |
CreateEmailCampaign
URL | LIVE: https://api.relateddigital.com/resta/api/campaign/CreateEmailCampaign ECOMM: https://api.relateddigital.com/reste/api/campaign/CreateEmailCampaign LIVEB: https://api.relateddigital.com/liveb_rest/api/campaign/CreateEmailCampaign LIVEM: https://api.relateddigital.com/restm/api/campaign/CreateEmailCampaign |
|---|---|
Http verb | POST |
Parameters |
|
Header | Content-Type: application/json Authorization: Login aksiyonundan sonra alınan Service Ticket değeri. |
Body | Name(string): Maks. 100 karakterlik kampanya adı, Subject(string []): Konu dizisi. Optimizasyon için, en fazla 3 konu sağlayın., CampaignId(string): 32byte guid. FromName(string): Hesabınızda tanımlanmış geçerli bir gönderici ismi, CampaignType(int): 1: SingleShot(Auto:N), 2: Template(Auto:O), 3: Automatic(Auto:Y) Single Shot: Bir kampanya, bırak ve gönder Template: Online kampanya. bırak & kaydet ve tetikle. Automatic: Periyodik kampanyalar. Ayrıntılar için lütfen hesap yöneticilerine danışınız. FromAddress(string): hesabınızda tanımlanmış geçerli bir gönderici adresi, ReplyAddress(string): cevap e-postası, geçerli bir email adresi. HtmlMessage(string): kampanyanın html içeriği, PreHeaderText(string): kampanyanın ön metni, Locked(bool): Opsiyonel parametre., ReadFlag(bool): Opsiyonel parametre., ClickThroughFlag(bool): Opsiyonel parametre., ShareThisFlag(bool): Opsiyonel parametre., UniqueEmailFlag(bool): Opsiyonel parametre.. Make target list e-mail unique, RateFlag(bool): Opsiyonel parametre. Oylama değerlendirmesi, OmnitureFlag(bool): Opsiyonel parametre., GoogleAnalytics(bool): Opsiyonel parametre., GoogleUtmSource(string): Opsiyonel parametre., GoogleUtmMedium(string): Opsiyonel parametre., GoogleUtmTerm(string): Opsiyonel parametre., GoogleUtmContent(string): Opsiyonel parametre., GoogleUtmCampaign(string): Opsiyonel parametre., Speed(int): Opsiyonel parametre.(1-5 arasında olmalı), ExpireDate(string): Opsiyonel parametre.. (Kampanya bitiş tarihi) FL_ID(string): Opsiyonel parametre. (Kampanyada hedeflenen veri ambarı tablosuna ait ID değeri. Örnek: "1234567890123456789011231313132") |
9:Sample Body | { "Name": "", "Subject": ["",""], "CampaignId": "", "FromName" :" ", "CampaignType":"", "FromAddress":"", "ReplyAddress":"", "HtmlMessage":"", "PreHeaderText":"", “Locked” :false, “ReadFlag”:false, “ClickThroughFlag”:false, “ShareThisFlag”:false, “UniqueEmailFlag”:false, “RateFlag”:false, “OmnitureFlag”:false, “GoogleAnalytics”:false, “GoogleUtmSource”:””, “GoogleUtmMedium“:””, “GoogleUtmTerm”:””, “GoogleUtmContent”:””, “GoogleUtmCampaign”:””, “Speed”:1, “ExpireDate”:””, "FL_ID": "" } |
Sample Response | { "Success": false, "Errors": [ { "Code": "", "Message": "" } ], "DetailedMessage": "" "TransactionId": "" } |
Success Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code |
CreatePushCampaign
URL | LIVE: https://api.relateddigital.com/resta/api/campaign/CreatePushCampaign ECOMM: https://api.relateddigital.com/reste/api/campaign/CreatePushCampaign LIVEB: https://api.relateddigital.com/liveb_rest/api/campaign/CreatePushCampaign LIVEM: https://api.relateddigital.com/restm/api/campaign/CreatePushCampaign |
|---|---|
Http verb | POST |
Parameters |
|
Header | Content-Type: application/json Authorization: Login aksiyonundan sonra alınan Service Ticket değeri. |
Body | Name(string): Maks. 100 karakterlik kampanya adı, CampaignId(string): 32byte guid , Type(int):Image - 0, Video - 1, Text - 2 , Settings - 3, Survey - 4 TextMessage(string): Kampanya içeriği AlternateTextMessage(string): A/B Test alternatif mesaj içeriği, TargetUrl(string): Kampanya hedef url AlternateTargetUrl(string): A/B Test alternatif hedef url MediaUrl(string): Opsiyonel parametre., AlternateMediaUrl(string): Opsiyonel parametre., CustomParams(string): Opsiyonel parametre., AlternateCustomParams(string): Opsiyonel parametre, ReportAdmins(string): Opsiyonel parametre. , FastListId(string): Dosya ID'si, SpeedLimitation(int): Opsiyonel parametre., DailyLimit(int): Opsiyonel parametre., AbCustomization(string): Opsiyonel parametre. AB test için Y (Evet), N(Hayır) DeliveryDate(string): Kampanya ulaşma zamanı DeliveryExpireDate(string): Kampanya bitiş zamanı Application(Aplication): { Name(string): Uygulama adı. Type(string): Uygulama türü I = iOS A = Android }
|
Sample Body | { "CampaignId": string, "Name": string, "Type": string, "TextMessage": string, "AlternateTextMessage": string, "TargetUrl": string, "AlternateTargetUrl": string, "MediaUrl": "", "AlternateMediaUrl": "", "CustomParams": "", "AlternateCustomParams": "", "ReportAdmins": "false", "DeliveryDate": "2030-01-01 00:00:00", "DeliveryExpireDate": "2030-01-01 20:00", "ReportExpireDate": "2030-01-01 20:00", "SpeedLimitation": 16, "DailyLimit": 17, "AbCustomization": "", "Application": { "Name": "Test2018", "Type": "A" }, "Classification1": { "ClassificationLabel": "", "ClassificationValue": "" }, "IsBadge": true, "IsMutableContent": false }
|
Sample Response | { "Errors": [], "DetailedMessage": "", "TransactionId": null }
|
Success Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code |
CreateWebPushCampaign
URL | LIVE: https://api.relateddigital.com/resta/api/campaign/CreateWebPushCampaign ECOMM: https://api.relateddigital.com/reste/api/campaign/CreateWebPushCampaign LIVEB: https://api.relateddigital.com/liveb_rest/api/campaign/CreateWebPushCampaign LIVEM: https://api.relateddigital.com/restm/api/campaign/CreateWebPushCampaign |
|---|---|
Http verb | POST |
Parameters |
|
Header | Content-Type: application/json Authorization: Login aksiyonundan sonra alınan Service Ticket değeri. |
Body | Name(string): Maks. 100 karakterlik kampanya adı., CampaignId(string): 32byte guid., Type(int):Görüntü - 1,Video - 2,Metin -3 , Ayarlar - 4, Anket -5., TextMessage(string): Kampanya içeriği., AlternateTextMessage(string): A/B Test alternatif mesaj içeriği., TargetUrl(string): Kampanya hedef url., AlternateTargetUrl(string): A/B Test alternatif hedef url MediaUrl(string): Opsiyonel parametre., AlternateMediaUrl(string): Opsiyonel parametre., CustomParams(string): Opsiyonel parametre., AlternateCustomParams(string): Opsiyonel parametre, ReportAdmins(string): Opsiyonel parametre. , FastListId(string): Dosya ID'si, SpeedLimitation(int): Opsiyonel parametre., DailyLimit(int): Opsiyonel parametre., AbCustomization(string): Opsiyonel parametre. AB test için Y (Evet), N(Hayır) DeliveryDate(string): Kampanya ulaşma zamanı DeliveryExpireDate(string): Kampanya bitiş zamanı Application(Aplication):
|
Sample Body | { "Name": "", "Type": "1", "TextMessage": "", "AlternateTextMessage": "", "TargetUrl": "", "ReportAdmins": "", "DeliveryDate": "YYYY-DD-MM HH:MM:SS", "DeliveryExpireDate": "YYYY-DD-MM HH:MM", "ReportExpireDate": "YYYY-DD-MM HH:MM", "IsMutableContent": true, "Applications": "", "MultipleApplications": [ { "Type": "W" } ] }
|
Sample Response | { "Errors": [], "DetailedMessage": "", "TransactionId": null } |
Success Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request |