Apa itu Track API Interakt?

Berikut adalah dokumen referensi untuk menghubungkan ke API kami. Lihat kami Koleksi Tukang Pos & SDK Python.

Pengantar API Interakt

Titik akhir Interakt Track API memungkinkan Anda memicu data tertentu ke Interakt. Titik akhir API ini dapat digunakan untuk menambahkan pengguna dan acara mereka ke akun Interakt Anda, yang kemudian tersedia untuk membangun lebih banyak konteks saat mengobrol dengan pelanggan Anda, dan menyiapkan notifikasi yang dipersonalisasi dan relevan dalam skala besar. Anda dapat memanggil API ini segera setelah pengguna baru dibuat di situs web atau aplikasi Anda atau bahkan setelahnya sesuai keinginan Anda. Ada dua API yang tersedia:Kami akan kembali.

• API pelacakan pengguna: untuk membuat pengguna baru dan memasukkan ciri-ciri mereka ke dasbor Interakt Anda dan
• API jalur peristiwa: untuk merekam peristiwa apa pun untuk pengguna tersebut di dasbor Interakt Anda

Ada perbedaan antara 'sifat' yang dikirim ke titik akhir pengguna, dibandingkan dengan 'sifat' yang dikirim ke titik akhir peristiwa:
• Titik akhir pengguna: Untuk sifat yang sama, jika Anda mengirimkan nilai baru, nilai tersebut akan menggantikan nilai saat ini.
• Titik akhir peristiwa: Peristiwa yang sama yang dikirim pada titik waktu yang berbeda direpresentasikan dalam garis waktu dan tidak saling menggantikan.

Ilustrasi

1. Misalkan Anda mengirim sebuah acara bernama 'Orde Baru' untuk pengguna Anda dengan ciri-ciri 'Nomor Pesanan' & 'Jumlah Pesanan', setiap kali pengguna melakukan pemesanan di situs web Anda. Setiap kali peristiwa 'Orde Baru' diterima di titik akhir Jalur Peristiwa kami, peristiwa itu dicatat dalam garis waktu acara untuk pengguna seperti yang ditunjukkan di bawah ini.

2. Di sisi lain, katakanlah Anda ingin merekam 'jumlah total pesanan' hingga saat ini untuk pengguna. Untuk itu, Anda bisa mengirimkan sifat tersebut 'jumlah' ke titik akhir Jalur Pengguna, yang kemudian ditampilkan di Kartu Detail Pribadi, seperti yang ditunjukkan di bawah ini. Berbeda dengan titik akhir peristiwa, nilai sifat lama yang dikirim ke titik akhir pengguna akan digantikan dengan nilai baru. Di sini, sifat 'jumlah' awalnya menunjukkan nilai 2000. Setelah mengirimkan 7000 sebagai nilai baru, nilai lama diganti, seperti yang ditunjukkan di bawah ini.

Otentikasi: Anda dapat mengautentikasi dengan Interakt Track API dengan mengirimkan Kunci API beserta data permintaannya. Mekanisme otentikasi menggunakan Otentikasi Dasar HTTP yang mengharuskan Anda mengirim kode base64 'nama pengguna: kata sandi' diawali dengan 'Dasar' String.
Kami akan kembali.
Kunci API = dikodekan base64 'nama pengguna: kata sandi'
Kami akan kembali.
Nilai ini diteruskan di header di bawah 'Otorisasi' dan pasangan kunci header akan terlihat seperti 'Otorisasi: DasarKunci API>'.
Kami akan kembali.
Harap dicatat: Anda dapat menemukan Kunci API di dasbor Anda. Buka Pengaturan > Pengaturan Pengembang > Kunci Rahasia.
Kami akan kembali.

Jenis konten: Anda harus menyetel header tipe konten ke 'application/json' agar dapat mengirim data ke titik akhir HTTP API kami.

Kesalahan: Titik akhir API kami akan mengembalikan 200 kode status untuk semua permintaan yang berhasil. Jika permintaannya besar, Anda mungkin mendapatkan 400 kode status.
Kami akan kembali.
Catatan: Jika suatu sifat mengandung salah satu hal berikut, panggilan API akan mengembalikan 400 kode status:
Kami akan kembali.'Baris Baru / Tab / Lebih dari 2 spasi berturut-turut'

• Batas Tarif: Ada batasan per menit untuk jumlah permintaan API, tergantung pada Paket Langganan Anda. Jika batas kecepatan terlampaui, kesalahan akan ditampilkan (Kode Status: 429 & Pesan Kesalahan: Batas kecepatan terlampaui untuk sumber daya ini).

• Rencana Pertumbuhan – 300 permintaan per menit

• Paket Lanjutan – 600 permintaan per menit

• Paket Enterprise – Dapat dikonfigurasi sesuai batas kecepatan yang diizinkan Meta

(Catatan – API Publik tidak dapat diakses pada Paket Pemula)



Ukuran Permintaan Maks: Ukuran permintaan maksimum adalah 32KB per permintaan. Jika angka ini terlampaui, API akan merespons dengan 400 Permintaan Buruk.

API Pelacakan Pengguna

Cara menambah/memperbarui Detail Pengguna di Interakt melalui API jalur pengguna

API pelacakan pengguna memungkinkan pelanggan mencatat atribut khusus pengguna. Mereka dapat mencatat properti pengguna (atribut) tertentu seperti id pengguna, id email, nomor telepon, nama, dll. Pelanggan dapat memanggil API pelacakan pengguna ketika akun pengguna baru dibuat di situs web/aplikasi/CRM mereka. Misalnya:

Untuk menambahkan pengguna baru ke dasbor Interakt Anda, payload berikut dapat dikirim dalam panggilan API:

POSTING https://api.interakt.ai/v1/public/track/users/
Kami akan kembali.
{

“Id pengguna”: “0123abc45d”,
“Nomor Telepon”: “9967536783”,
“Kode Negara”: “+91”,
"sifat-sifat": {
“nama”: “Gavin Roberts”,
"surel": "[email dilindungi]",
"dob": "1996-12-01",
“Contoh sifat a”: “nilai y”

}

}

Atribut (sifat) pengguna yang berbeda dapat berupa tipe data berikut: String, Numbers, Boolean, Datetime, List. Lihat berbagai opsi filter yang tersedia di Interakt, untuk berbagai jenis sifat – link.
Kami akan kembali.
Catatan**: Menentukan salah satu identitas pengguna or nomor telepon (dengan kode negara) is wajib
Kami akan kembali.
Panggilan API di atas mencatat “userId” atau “phoneNumber” (dengan “countryCode”) sebagai pengidentifikasi unik untuk pengguna dan juga menambahkan atribut seperti nama, email, dob.

Kami akan kembali.


Untuk memperbarui atribut bagi pengguna di atas, payload berikut dapat dikirim dalam panggilan API: (misalkan atribut “dob” perlu diubah menjadi “1997-12-01”).
Kami akan kembali.
POSTING https://api.interakt.ai/v1/public/track/users/
Kami akan kembali.
{
“Id pengguna”: “0123abc45d”,
“Nomor Telepon”: “9967536783”,
“Kode Negara”: “+91”,
"sifat-sifat": {
“dob”: “1997-12-01”
}
}
Kami akan kembali.
Untuk menambahkan atribut baru untuk pengguna di atas, payload berikut dapat dikirim dalam panggilan API: (misalkan atribut “kode pin” perlu ditambahkan).
Kami akan kembali.
POSTING https://api.interakt.ai/v1/public/track/users/
Kami akan kembali.
{

“Id pengguna”: “0123abc45d”,
“Nomor Telepon”: “9967536783”,
“Kode Negara”: “+91”,
"sifat-sifat": {
“Kode PIN”: “400001”
}
}
Kami akan kembali.

Anda sekarang dapat menambahkan tag pada pelanggan Anda di Interakt melalui API.

Cukup sertakan kunci untuk “tag” dalam panggilan API Track Pengguna.

Contoh Muatan:

{

“Nomor Telepon”: “9967536783”,

“Kode Negara”: “+91”,

"sifat-sifat": {

“nama”: “Gavin Roberts”,

"surel": "[email dilindungi]"

},

“tag”: [“pelanggan baru”, “calon prospek”]

}

Kami akan kembali.

• Anda dapat menambahkan beberapa tag.

• Anda hanya dapat menambahkan tag baru. Anda tidak dapat menghapus tag yang ada.

• Penambahan tag tidak membedakan huruf besar/kecil yaitu jika Anda menambahkan tag 'pelanggan baru' pada Pelanggan A & tag 'Pelanggan Baru' sudah ada pada Pelanggan A, tidak ada tag baru yang akan ditambahkan pada Pelanggan A.

Bagaimana hal ini berguna khususnya untuk klien yang memiliki daftar pengguna panjang yang tidak difilter berdasarkan sifat pengguna khusus?

• Jika klien ingin memfilter daftar penggunanya untuk mengirimkan kampanye sekali pakai, dia menghadapi masalah jika memfilter menggunakan sifat khusus.

• Misalkan sifat khusus yang dia gunakan adalah 'Kota' dan kondisi filternya adalah 'Kota' = 'Kolkata'

• Sekarang, alih-alih menambahkan ciri khusus untuk 'Kota = Kolkata', dia dapat menambahkan tag 'Kolkata' untuk pengguna

• Kemudian dia dapat memfilter daftar pengguna berdasarkan tag ini dan mengirimkan kampanye

Kami akan kembali.

Penafian penting: Disarankan bagi pengguna untuk tidak menambahkan lebih dari 50 tag untuk satu pelanggan

Catatan:

1. Jika pengguna di atas awalnya ditambahkan melalui dasbor Interakt (dan bukan dengan memanggil User Track API), maka, tidak akan ada userId untuk pengguna tersebut. Dalam hal ini, Anda dapat:
• Memanggil User Track API tanpa menentukan “userId” (dan hanya menentukan “phoneNumber” & “countryCode”), atau,
• Sertakan userId dalam panggilan API, yang kemudian akan ditambahkan untuk pengguna tersebut, dan Anda dapat menggunakan userId tersebut untuk mereferensikan pengguna tersebut dalam panggilan API berikutnya.*
Kami akan kembali.
2. Saat ini, kami tidak menyediakan opsi untuk menghapus atribut pengguna/user apa pun.

*Harap pastikan userId yang ditambahkan bukan milik pengguna yang sudah ada di akun Interakt Anda, jika tidak, API akan menimbulkan kesalahan.

Di mana Anda dapat melihat Pengguna yang ditambahkan di dasbor Interakt Anda?

Setelah pembuatan pengguna dengan memanggil User Track API, pengguna (bersama dengan ciri-cirinya) kemudian akan terlihat di bagian dasbor Interakt berikut:

• Pengguna baru akan terdaftar di Halaman 'Pengguna':

Kami akan kembali.
• Ciri-ciri pengguna akan terlihat di Kartu 'Detail Pribadi' – kartu ini terlihat di 2 tempat: 1) Di kotak masuk obrolan dengan pengguna tertentu; 2) di bagian detail pengguna (setelah mengklik entri pengguna).

Kami akan kembali.
• Selain itu, Anda sekarang dapat memfilter daftar pengguna Anda dengan ciri-ciri ini (opsi filter tersedia di halaman Pengguna & di halaman Pemberitahuan, saat Anda membuat Kampanye Baru) – Anda selanjutnya dapat menemukan di sini opsi filter yang berbeda, sesuai dengan tipe data sifat.

Menetapkan Kampanye untuk Pengguna yang ditambahkan berdasarkan kondisi Sifat Pengguna:
Kami akan kembali.
• Kampanye Satu Kali: Kampanye ini dapat digunakan untuk pesan siaran satu kali yang ingin Anda kirimkan kepada pengguna Anda.
Kami akan kembali.
- Gunakan kasus: Misalkan Anda telah mengirimkan sifat pengguna 'Jenis Perusahaan' untuk pengguna Anda melalui API jalur pengguna kami. Katakanlah, Anda ingin mengirim pesan siaran ke semua pengguna Anda yang rekaman 'Jenis Perusahaan' berisi istilah 'toko kelontong'.
Kami akan kembali.
– Untuk melakukan ini, Anda perlu memilih kampanye 'satu kali' dan menetapkan kondisi filter berikut di halaman Pembuatan Kampanye: 'Jenis Perusahaan' berisi 'kelontong'. (Dalam contoh di bawah, jumlah pengguna yang memenuhi kriteria ini adalah 38.)
Kami akan kembali.
– Setelah Anda mengaktifkan kampanye dari halaman Pembuatan Kampanye, 38 pengguna tersebut akan menerima pemberitahuan pada tanggal yang dijadwalkan.
Kami akan kembali.
Klik di sini untuk melihat langkah-langkah terperinci untuk mengaktifkan Kampanye.

• Kampanye yang Sedang Berlangsung: Pelajari Lebih Lanjut

Apa itu API Jalur Peristiwa Interakt?

Bagaimana cara menambahkan Detail Acara untuk pengguna di Interakt melalui API jalur Acara
Kami akan kembali.
API jalur peristiwa memungkinkan pelanggan mencatat tindakan pengguna. Setiap tindakan pengguna (seperti pesanan baru yang dibuat, pendaftaran pengguna baru, dan sebagainya) akan memicu peristiwa ke titik akhir. Misalnya:

Untuk menambahkan acara baru untuk pengguna tertentu, payload berikut dapat dikirim dalam panggilan API:
Kami akan kembali.
POSTING https://api.interakt.ai/v1/public/track/events/
{

“Id pengguna”: “0123abc45d”,
“acara”: “Pemesanan Ditempatkan”,
"sifat-sifat": {
“pesananDibuat Oleh”: “Gavin Roberts”,
“orderCreatedDate”: “2020-11-01T012:10:26.122Z”,
“Nomor Pesanan”: “CUS001”,
“Nilai pesanan”: “50.00”
}
}

Panggilan API di atas memicu peristiwa OrderPlaced ketika pengguna Anda melakukan pemesanan di situs web/aplikasi Anda. Panggilan API meneruskan properti peristiwa orderCreatedBy, orderCreatedDate, orderNumber, dan orderValue ke titik akhir API.
Kami akan kembali.
Harap diperhatikan: Jika userId tidak ada untuk pengguna, “phoneNumber” & “countryCode” perlu ditentukan dalam Panggilan API Jalur Peristiwa di atas.

Kami akan kembali.

Di mana Anda dapat melihat Acara yang ditambahkan di dasbor Interakt Anda?
Kami akan kembali.
Detail acara muncul di kartu 'Acara' – kartu ini terlihat di 2 tempat:

1. Di kotak masuk, ngobrol dengan pengguna tertentu
2. Di bagian detail pengguna (saat mengklik entri pengguna)

Kami akan kembali.
Selain itu, Anda sekarang dapat memfilter daftar pengguna Anda dengan ciri-ciri ini (opsi filter tersedia di halaman Pengguna & di halaman Pemberitahuan, saat Anda membuat Kampanye Baru) – Anda dapat menemukan lebih lanjut di sini opsi filter yang berbeda, sesuai dengan tipe data sifat.

Kami akan kembali.

Dengan menggunakan API, picu Kampanye Berkelanjutan di Interakt

Pelajari Lebih Lanjut

API Pengambilan Kontak

Koleksi Tukang Pos untuk API ini.
Kami akan kembali.
Setiap kali Anda mendapatkan prospek baru di WhatsApp melalui Interakt, kini Anda dapat memastikan bahwa detail prospek tersebut diteruskan ke CRM/database Anda yang lain dengan menggunakan API Pengambilan Kontak. Cukup tambahkan panggilan API ke kode sistem Anda, atau, gunakan panggilan API ini di platform konektor (seperti Integromat / Zapier) untuk menyinkronkan Interakt dengan CRM berbasis SaaS Anda.

Otentikasi: Mekanisme otentikasi menggunakan Otentikasi Dasar HTTP yang mengharuskan Anda mengirimkan kunci API yang diawali dengan 'Dasar' rangkaian. Nilai ini diteruskan di header di bawah 'Otorisasi' dan pasangan kunci header akan terlihat seperti 'Otorisasi: DasarKunci API>'.
Kami akan kembali.
Harap diperhatikan: Anda dapat menemukan Kunci API di dasbor Anda. Buka Pengaturan > Pengaturan Pengembang > Kunci Rahasia.
Kami akan kembali.

Parameter Kueri: Ada 2 parameter kueri yang dapat disertakan dalam URL tempat API dipanggil: https://api.interakt.ai/v1/public/apis/users/?offset=0&limit=100
Kami akan kembali.

Membatasi: Nilai defaultnya adalah 100. Jika respons API berisi lebih dari 100 kontak, maka bidang 'has_next_page' dalam respons API akan benar dan API kemudian harus dipanggil lagi, dengan offset tetap 100.
Kami akan kembali.

Mengimbangi: Nilai defaultnya adalah 0.
Kami akan kembali.

Kesalahan: Titik akhir API kami akan mengembalikan 200 kode status untuk semua permintaan yang berhasil. Kesalahan 4xx akan ditampilkan untuk kasus berikut:
Kami akan kembali.

• Jika kredensial otorisasi yang dimasukkan salah.
Kami akan kembali.
• Jika parameter kueri 'batas' telah ditetapkan > 100

• Jika 'val' dari 'created_at_utc' atau 'modified_at_utc' tidak dalam format UTC di payload API

• Jika properti 'op' atau 'supr_op' belum dimasukkan dengan benar
Kami akan kembali.

Kesalahan 5xx akan ditampilkan jika terjadi beberapa kesalahan internal.
Kami akan kembali.

Cara memanggil API:
Kami akan kembali.
Kami akan kembali.Untuk mengambil kontak yang telah dibuat di Interakt setelah jam 5 sore (IST) pada 8-Sep-2021, payload berikut dapat dikirim dalam panggilan API.
Kami akan kembali.
POST https://api.interakt.ai/v1/public/apis/users/?offset=0&limit=100

{

"filter": [

{

“sifat”: “dibuat_at_utc”,
“op”: “gt”,
“val”: “2021-09-08T11:30:00.000Z”

}

]

}
Kami akan kembali.

Kami akan kembali.Untuk mengambil kontak yang telah dibuat di Interakt sebelum jam 5 sore (IST) pada 8-Sep-2021, payload berikut dapat dikirim dalam panggilan API.
Kami akan kembali.
POST https://api.interakt.ai/v1/public/apis/users/?offset=0&limit=100

{

"filter": [

{

“sifat”: “dibuat_at_utc”,
"op": "lt",
“val”: “2021-09-08T11:30:00.000Z”

}

]

}


Kami akan kembali.Untuk mengambil kontak yang telah dibuat di Interakt setelah jam 5 sore (IST) pada 7-Sep-2021 dan sebelum jam 5 sore (IST) pada 8-Sep-2021, payload berikut dapat dikirim dalam panggilan API.
Kami akan kembali.
POST https://api.interakt.ai/v1/public/apis/users/?offset=0&limit=100

{

"filter": [

{

“sifat”: “dibuat_at_utc”,
“op”: “gt”,
“val”: “2021-09-07T11:30:00.0000”

},

{

“sifat”: “dibuat_at_utc”,
"op": "lt",
“supr_op”: “dan”,
“val”: “2021-09-08T11:30:00.0000”

}

]

}


Kami akan kembali.Untuk mengambil kontak yang telah dimodifikasi di Interakt setelah jam 5 sore (IST) pada 8-Sep-2021, payload berikut dapat dikirim dalam panggilan API.
Kami akan kembali.
POST https://api.interakt.ai/v1/public/apis/users/?offset=0&limit=100

{

"filter": [

{

“sifat”: “dimodifikasi_at_utc”,
“op”: “gt”,
“val”: “2021-09-08T11:30:00.000Z”

}

]

}
Kami akan kembali.

Catatan:Kami akan kembali. Selalu kirimkan nilai datetime dalam format UTC. Jika yang dikirim hanya tanggal tanpa waktu (contoh: 2021-09-08), maka waktu diasumsikan jam 00:00.