Courier company · Settings

İYS integration

Connecting your Message Management System (İYS) account; reporting commercial message consents and opt-outs to İYS automatically, pulling opt-outs from İYS, the initial sync and the error queue.

İYS (İleti Yönetim Sistemi, Turkey's Message Management System) is the official system where consents for commercial electronic messages (campaign SMS, campaign email) are recorded. By law, a company that sends commercial messages must report the consents and opt-outs it collects to İYS. This page is under Administration › Settings › İYS and only people with the Company owner role can open it.

When you turn the integration on:

• When commercial message consent is turned on or off on the customer card or in the portal, it is reported to İYS automatically.
• When a customer presses the opt-out link, an opt-out is reported to İYS.
• If a customer opts out in İYS, their consent is turned off here as well (checked once an hour).
• Bulk commercial messages are not sent to people who opted out in İYS.

While İYS is off, none of this happens; recording consents in İYS is your responsibility.

Before you start

• Your company must be registered with İYS (iys.org.tr). Registration and brand setup are done on the İYS site; KOS cannot do this for you.
• Create an API user in your İYS panel. You get a username and password.
• Note your İYS number and brand code; both are shown in your İYS panel.

Step by step: connecting İYS

1. In the left menu click Administration › Settings.
2. Choose the İYS tab at the top.
3. In Environment, first choose Test (sandbox). Once everything works, switch to Live.
4. Fill in İYS number and Brand code.
5. Choose the Recipient type: Individual if your customers are mostly people, Merchant (company) if they are companies.
6. Enter the details you got from İYS in API username and API password.
7. In Source of consent entered in the panel, choose how your staff usually get consent from customers (e.g. Call centre / phone if you get it by phone).
8. Turn on İYS integration enabled.
9. Click Save.
10. Click Test connection. You should see "Connection successful." If you get an error, check the details.
11. Finally, start Initial sync once (see below).

Initial sync

Customers who consented before you turned the integration on are not sent to İYS automatically. You need to send them once in bulk.

1. On the Sync status card click Initial sync.
2. Read the dialog and click OK only if you really obtained these customers' consent.
3. The number of queued records is shown. Phone and email are counted separately (one customer can be 2 records).
4. Records are sent in the background in batches; you can follow them in the Report queue.

• Customers already reported to İYS or waiting in the queue are skipped; pressing the button again does no harm.
• The send date is reported as the consent date. Keep your old consent documents (forms, recordings) yourself.

Pull now

KOS pulls changes from İYS automatically once an hour. If you don't want to wait, click Pull now; it updates within a few minutes.

• If a customer opted out in İYS, their commercial message consent here is turned off. The customer card shows the source İYS (opt-out pulled).
• A consent in İYS does not turn consent on here; you must get it from the customer separately.
• If the customer gave consent here again after the opt-out, it is left alone.

Sync status and the report queue

The Sync status card shows:

• Pending: Records not yet sent to İYS.
• Failed: Records İYS did not accept.
• Sent (30 days): Records sent in the last 30 days.
• Recipients opted out in İYS: Number of phones and emails with an opt-out in İYS.
• The Last send, Last pull of changes and Initial sync times and, if any, the Last error.

In the Report queue table each record is one row: customer, channel (SMS / email), masked recipient, action (Consent / Opt-out), status, attempts and error. Use the list at the top to filter by status. Superseded means a newer change arrived for the same person and only the newest was sent.

After fixing the cause of failed records (e.g. after updating the password), click Retry failed.

Consent source

On the customer card, the Source label under the commercial message consent shows where the consent was last changed:

• Panel (staff): Your staff changed it on the customer card.
• Customer portal: The customer changed it in the portal.
• Mobile app: The customer changed it in the mobile app.
• Opt-out link: The customer pressed the opt-out link in a message.
• İYS (opt-out pulled): The customer opted out in İYS, and consent was turned off here too.
• Personal data erasure: The customer's personal data was erased.

İYS in bulk messages

While İYS is on, a commercial message goes only to customers who have consented here and have no opt-out in İYS. After Calculate recipients you see the line "… customers were excluded because they opted out in İYS." Information messages are not affected. Details: Bulk messages.

Good to know

• The İYS account belongs to your company; the platform has no shared İYS account.
• KOS has a single commercial message consent. An SMS or email opt-out from İYS turns off the whole consent.
• When a customer's phone or email changes, nothing is re-reported to İYS; only consent changes are reported.
• Phones and emails of customer contacts are not sent to İYS.
• During a support session the İYS account details cannot be changed and the initial sync cannot be started.

Having trouble?

• Test connection gives an error: Check the username, password and İYS number. Make sure you are not trying a test account in the Live environment (or the other way round).
• Test connection button is disabled: Click Save first; without a saved password the test cannot run.
• Last error shows an authorisation error: Your İYS password may have changed. Enter the new password and save, then click Retry failed. After an authorisation error sending pauses for 15 minutes.
• Initial sync button is disabled: Turn on İYS integration enabled and save first.
• Records stay "Pending": Sending runs every minute; wait a few minutes. After errors the wait gets longer.
• I can't see the İYS tab: This tab is open only to the company owner.