SendList web servisini kullanarak, toplu veri aktarımı, gönderim listesi yaratabilir veya mevcut gönderim listelerini hesabınızdan silebilirsiniz.
SendList Web Service Methods
Note |
---|
|
Hesabınızdan üye silerken dikkatli olmanız gerekir. 2015 Mayıs ayında çıkan yasa gereği, üye geçmiş bilgilerini en az 1 yıl saklamanız gerekmektedir. |
Warning |
---|
|
To interact with any Web Services, developers must first use the Login method to create a Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | Service Ticket |
---|
| . Developers can send requests to other Web Service and methods using this Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | Service Ticket |
---|
| . |
CreateSendList
Anchor |
---|
| createsendlist |
---|
| createsendlist |
---|
|
Back to Top ^
<CreateSendList> |
---|
Creates an empty Send List. |
Parameters
Parameter | Value | |
---|
ServiceTicket | ServiceTicket obtained through Login | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ListGroup | Group Name of the List | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ListName | Name of the list | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<CreateSendList xmlns="http://ws.euromsg.com/sendlist">
<ServiceTicket>string</ServiceTicket>
<ListGroup>string</ListGroup>
<ListName>string</ListName>
</CreateSendList>
</soap:Body>
</soap:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<CreateSendListResponse xmlns="http://ws.euromsg.com/sendlist">
<CreateSendListResult>
<Code>00</Code>
<Message />
<DetailedMessage />
<CreatedListID>1686794</CreatedListID>
</CreateSendListResult>
</CreateSendListResponse>
</soap:Body>
</soap:Envelope> |
Tip |
---|
If the request was successful, the Status |
---|
subtle | true |
---|
colour | Red |
---|
title | Code |
---|
| parameter will return Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
| as a response. In addition to that, the ID of the created list Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | CreatedListID |
---|
| is returned. |
Error Parameters
Code | Error Message | Description |
---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
AddBulk
Back to Top ^
<AddBulk> |
---|
Bulk adds to a Send List. |
Parameters
Parameter | Value | |
---|
ServiceTicket | ServiceTicket obtained through Login | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ListGroup | Group name of the List to add | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ListName | Name of the List | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Key | Reference Key Name. Member adding and updating will be done based on this field. Reference Key value must be specified in the DemograficData field | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
DemograficData | ArrayOfEmKeyValue string defines the fields for the member | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ForceInsert | If the member exists in the system and the value is true , the existing member is updated. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Note |
---|
Fields like First Name and Last Name are set through the Related Marketing Cloud platform. |
Static Fields
Field Name | Description |
---|
EMAIL | Email adresi |
STATUS | Üye durumu. A : Aktif, P : Pasif |
EMAIL_PERMIT | Email izin durumu. Y : Evet, N : Hayır |
GSM_PERMIT | SMS izin durumu. Y : Evet, N : Hayır |
FAX_PERMIT | FAX izin durumu. Y : Evet, N : Hayır |
CALL_PERMIT | Call Center izin durumu. Y : Evet, N : Hayır |
PRINT_PERMIT | Print izin durumu. Y : Evet, N : Hayır |
REFERRAL | Referans adresi |
REFERRAL_DOMAIN | Referans domain |
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<AddBulk
xmlns="http://ws.euromsg.com/sendlist">
<ServiceTicket>string</ServiceTicket>
<ListGroup>string</ListGroup>
<ListName>string</ListName>
<Key>string</Key>
<DemograficData>
<ArrayOfEmKeyValue>
<EmKeyValue>
<Key>string</Key>
<Value>string</Value>
</EmKeyValue>
<EmKeyValue>
<Key>string</Key>
<Value>string</Value>
</EmKeyValue>
</ArrayOfEmKeyValue>
<ArrayOfEmKeyValue>
<EmKeyValue>
<Key>string</Key>
<Value>string</Value>
</EmKeyValue>
<EmKeyValue>
<Key>string</Key>
<Value>string</Value>
</EmKeyValue>
</ArrayOfEmKeyValue>
</DemograficData>
<ForceInsert>boolean</ForceInsert>
</AddBulk>
</soap:Body>
</soap:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<AddBulkResponse
xmlns="http://ws.euromsg.com/sendlist">
<AddBulkResult>
<Code>00</Code>
<Message />
<DetailedMessage />
<CreatedListID>0</CreatedListID>
</AddBulkResult>
<DetailsResult>
<BulkDetailedResult>
<Key>test1@sampledomain.com</Key>
<Code>00</Code>
<Message />
<DetailedMessage />
</BulkDetailedResult>
<BulkDetailedResult>
<Key>test2@sampledomain.com</Key>
<Code>00</Code>
<Message />
<DetailedMessage />
</BulkDetailedResult>
</DetailsResult>
</AddBulkResponse>
</soap:Body>
</soap:Envelope> |
Tip |
---|
If the request was successful, the Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | Code |
---|
| parameter will return Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
| as a response. |
Error Parameters
Code | Error Message | Description |
---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
99 | No such list! | The specified List cannot be found. |
99 | Member is new. No update! | If ForceInsert is false and the user does not exist in the system, this error is given. The member is not added. To add the new member in the system the value of the ForceInsertparameter must be true. |
AddBulkFile
Back to Top ^
<AddBulkFile> |
---|
Allows you to add all the members listed in a file to your RMC account in bulk. |
Parameters
Parameter | Value | |
---|
ServiceTicket | ServiceTicket obtained through Login | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ListGroup | Group name of the List to add | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ListName | Name of the List | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Key | Reference Key Name. Member adding and updating shall be done based on this field. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Map | Maps the fields in the file with the system fields. E.g. EMAIL=email; COLUMN1=NameSurname; COLUMN2=KeyID | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
File | Yüklenecek dosya. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
FileType | Dosya türü. zip veya csv olmalı. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
NotificationEmail | Yükleme işlemi bittiğinde, burada belirtilen email adresine bilgilendirme emaili gönderilir. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<AddBulkFile
xmlns="http://ws.euromsg.com/sendlist">
<ServiceTicket>string</ServiceTicket>
<ListGroup>string</ListGroup>
<ListName>string</ListName>
<Key>string</Key>
<Map>string</Map>
<File>base64Binary</File>
<FileType>string</FileType>
<NotificationEmail>string</NotificationEmail>
</AddBulkFile>
</soap:Body>
</soap:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<AddBulkFileResponse
xmlns="http://ws.euromsg.com/sendlist">
<AddBulkFileResult>
<Code>00</Code>
<Message />
<DetailedMessage />
<ConversationID>EEFF123AE537442BBF9AD3231F812684</ConversationID>
<CreatedListID>0</CreatedListID>
</AddBulkFileResult>
</AddBulkFileResponse>
</soap:Body>
</soap:Envelope> |
Tip |
---|
If the request was successful, the Status |
---|
subtle | true |
---|
colour | Red |
---|
title | Code |
---|
| parameter will return Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
| as a response. In addition to that, the ID of the created list Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | CreatedListID |
---|
| is returned. |
Error Parameters
Code | Error Message | Description |
---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
99 | Not a valid file type. It must be ZIP or CSV or TXT. | |
QuerySendListMemberCount
Anchor |
---|
| querymemcount |
---|
| querymemcount |
---|
|
Back to Top ^
<QuerySendListMemberCount> |
---|
Gönderim listesindeki kişi sayısını gösterir. |
Parameters
Parameter | Value | |
---|
ServiceTicket | ServiceTicket obtained through Login | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ListID | List ID | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<QuerySendListMemberCount
xmlns="http://ws.euromsg.com/sendlist">
<ServiceTicket>string</ServiceTicket>
<ListID>int</ListID>
</QuerySendListMemberCount>
</soap:Body>
</soap:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<QuerySendListMemberCountResponse xmlns="http://ws.euromsg.com/sendlist">
<QuerySendListMemberCountResult>
<Code>00</Code>
<Message />
<DetailedMessage />
<CreatedListID>0</CreatedListID>
</QuerySendListMemberCountResult>
<MemberCount>0</MemberCount>
</QuerySendListMemberCountResponse>
</soap:Body>
</soap:Envelope> |
Tip |
---|
If the request was successful, the Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | Code |
---|
| parameter will return Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
| as a response. |
Error Parameters
Code | Error Message | Description |
---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
RemoveBulkFile
Anchor |
---|
| removebulkfile |
---|
| removebulkfile |
---|
|
Back to Top ^
<RemoveBulkFile> |
---|
Bir dosyada yer alan üyelerin seçilerek Related Marketing Cloud hesabınızdan silinmesini sağlar. |
Parametreler
Parameter | Value | |
---|
ServiceTicket | ServiceTicket obtained through Login | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ListGroup | Liste grup adı. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ListName | Listenin adı. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Key | Referans Key Adı. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Map | Dosyada ki alanların sistem alanları ile eşleştirilmesini yapar. Örn. EMAIL=email;COLUMN1=NameSurname;COLUMN2=KeyID. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
File | Yüklenecek dosya. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
FileType | Dosya türü. zip veya csv olmalı. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
NotificationEmail | Yükleme işlemi bittiğinde, burada belirtilen email adresine bilgilendirme emaili gönderilir. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
DeleteIfInNoList | Eğer üye hiç bir listede yer almıyorsa, true gönderilmesi durumunda, kullanıcıyı tamamen siler. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<RemoveBulkFile xmlns="http://ws.euromsg.com/sendlist">
<ServiceTicket>string</ServiceTicket>
<ListGroup>string</ListGroup>
<ListName>string</ListName>
<Key>string</Key>
<Map>string</Map>
<File>base64Binary</File>
<FileType>string</FileType>
<NotificationEmail>string</NotificationEmail>
<DeleteIfInNoList>boolean</DeleteIfInNoList>
</RemoveBulkFile>
</soap:Body>
</soap:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<RemoveBulkFileResponse xmlns="http://ws.euromsg.com/sendlist">
<RemoveBulkFileResult>
<Code>00</Code>
<Message />
<DetailedMessage />
<ConversationID>EEFF123AE537442BBF9AD3231F812684</ConversationID>
<CreatedListID>0</CreatedListID>
</RemoveBulkFileResult>
</RemoveBulkFileResponse >
</soap:Body>
</soap:Envelope> |
Tip |
---|
If the request was successful, the Status |
---|
subtle | true |
---|
colour | Red |
---|
title | Code |
---|
| parameter will return Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
| as a response. In addition to that, the ID of the created list Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | CreatedListID |
---|
| is returned. |
Error Parameters
Code | Error Message | Description |
---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |
RemoveSendList
Anchor |
---|
| removesendlist |
---|
| removesendlist |
---|
|
Back to Top ^
<RemoveSendList> |
---|
Bir gönderim listesini siler. |
Parameters
Parameter | Value | |
---|
ServiceTicket | ServiceTicket obtained through Login | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ListGroup | Listenin grup adı. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
ListName | Listenin adı. | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<RemoveSendList xmlns="http://ws.euromsg.com/sendlist">
<ServiceTicket>string</ServiceTicket>
<ListGroup>string</ListGroup>
<ListName>string</ListName>
</RemoveSendList>
</soap:Body>
</soap:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<RemoveSendListResponse
xmlns="http://ws.euromsg.com/sendlist">
<RemoveSendListResult>
<Code>00</Code>
<Message />
<DetailedMessage />
<CreatedListID>0</CreatedListID>
</RemoveSendListResult>
</RemoveSendListResponse>
</soap:Body>
</soap:Envelope> |
Tip |
---|
If the request was successful, the Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | Code |
---|
| parameter will return Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
| as a response. Aside from that, the returned Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | 99 |
---|
| values indicate errors. |
Error Parameters
Code | Error Message | Description |
---|
9998 | No session. Please try re-logon. | No active sessions found. Try login again. |