Ikhtisar API Dapatkan Pengguna Interakt (API Pengambilan Kontak)
Koleksi Tukang Pos untuk API ini.
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: Otentikasi kegunaan mekanisme 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>'.
Harap diperhatikan: Anda dapat menemukan Kunci API di dasbor Anda. Buka Pengaturan > Pengaturan Pengembang > Kunci Rahasia.
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
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 menjaga offset tetap 100.
Mengimbangi: Nilai defaultnya adalah 0.
Kesalahan: Titik akhir API kami akan mengembalikan 200 kode status untuk semua permintaan yang berhasil. Kesalahan 4xx akan ditampilkan untuk kasus berikut:
• Jika kredensial otorisasi yang dimasukkan salah.
• 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
Kesalahan 5xx akan ditampilkan jika terjadi beberapa kesalahan internal.
Cara memanggil Dapatkan API di Interakt
Untuk mengambil kontak yang telah dibuat di Interakt setelah jam 5 sore (IST) pada 8-Sep-2021, payload berikut dapat dikirim dalam panggilan API.
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”
}
]
}
Untuk mengambil kontak yang telah dibuat di Interakt sebelum jam 5 sore (IST) pada 8-Sep-2021, payload berikut dapat dikirim dalam panggilan API.
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”
}
]
}
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.
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”
}
]
}
Untuk mengambil kontak yang telah dimodifikasi di Interakt setelah jam 5 sore (IST) pada 8-Sep-2021, payload berikut dapat dikirim dalam panggilan API.
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”
}
]
}
Catatan: Selalu kirimkan nilai tanggal waktu dalam format UTC. Jika yang dikirim hanya tanggal tanpa waktu (contoh: 2021-09-08), maka waktu diasumsikan jam 00:00.
