Atur Informasi Kontak

Informasi kontak dapat digunakan sebagai target komunikasi lintas saluran, seperti notifikasi aplikasi, SMS, email, dan WhatsApp. Jika informasi kontak pengguna berubah, API ini dapat digunakan untuk memperbaruinya.

Pengaturan informasi kontak harus dikaitkan dengan EUID.

Alamat Endpoint

POST /v1/user/contact

Autentikasi Permintaan

EngageLab REST API menggunakan HTTP Basic Authentication sebagai metode autentikasi. Tambahkan Authorization pada Header HTTP:

Authorization: Basic ${base64_auth_string}

              
              Authorization: Basic ${base64_auth_string}

Tampilkan blok kode ini di jendela mengambang

base64_auth_string dihasilkan dengan algoritma: base64(api_key:api_secret).

Nama header: "Authorization", nilainya adalah pasangan "username:password" yang telah dienkode base64 (dipisahkan titik dua).
Untuk MA API, username adalah APIKey, password adalah APISecret. Silakan konfigurasikan sumber data tipe API untuk mendapatkan APIKey dan API Secret.

Contoh Permintaan

Header Permintaan

> POST /v1/user/contact > Content-Type: application/json > Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==

              
              > POST /v1/user/contact
> Content-Type: application/json
> Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==

Tampilkan blok kode ini di jendela mengambang

Body Permintaan

{ "euid":10362473, "contacts":{ "mobile_phone": "18023456879", "email": "12@gmail.com" } }

              
              {
    "euid":10362473,
    "contacts":{
        "mobile_phone": "18023456879",
        "email": "12@gmail.com"
    }
}

Tampilkan blok kode ini di jendela mengambang

Parameter Permintaan

Field	Tipe	Wajib	Deskripsi
euid	Long	Ya	ID unik pengguna (EUID)
contacts	JSON	Ya	Kunci adalah nama informasi kontak, nilai adalah string. Informasi kontak yang didukung: email, mobile_phone, landline_phone, whatsapp_phone

Parameter Balasan

Field	Tipe	Wajib	Deskripsi
code	Int	Ya	Status pemanggilan API. 0 berarti berhasil/berhasil sebagian, nilai lain berarti gagal.
message	String	Ya	Deskripsi hasil pemanggilan API, menjelaskan kode balasan.

Semua Berhasil

{ "code": 0, "message": "success" }

              
              {
    "code": 0,
    "message": "success"
}

Tampilkan blok kode ini di jendela mengambang

Semua Gagal

{ "code": 0, "message": "success" }

              
              {
    "code": 0,
    "message": "success"
}

Tampilkan blok kode ini di jendela mengambang

Kode Error

Kode	Deskripsi	Penjelasan Detail
40050	Autentikasi antarmuka gagal.	Pastikan project ID dan secret key sudah benar.
40007	EUID kosong.	Silakan periksa nilai EUID.
50031	Project ID tidak valid.	Silakan periksa apakah APIKey dan APISecret sudah benar.
50034	Project ID tidak ada.	Silakan periksa apakah APIKey dan APISecret sudah benar, dan cek apakah proyek sudah dihapus.
50074	Sumber data API tidak ada.	Silakan periksa apakah APIKey dan APISecret sudah benar, dan cek apakah sumber data API sudah dihapus.
55004	Parameter bisnis tidak valid.	Silakan periksa apakah field pada parameter permintaan sudah benar.
55101	Jumlah pengenal pengguna melebihi batas.	Pastikan jumlah nilai identifikasi pengguna tidak lebih dari 100.
55102	Ada nama atribut pengguna yang tidak valid.	Pastikan nama atribut sesuai syarat penamaan, tidak kosong/tidak menggunakan karakter khusus/tidak melebihi batas panjang.
55103	Nilai atribut pengguna tidak boleh kosong.	Pastikan nilai atribut pengguna pada body permintaan tidak kosong.
55105	Nilai pengenal pengguna tidak boleh lebih dari 256 karakter.	Pastikan nilai identifikasi pengguna tidak melebihi 256 karakter.
55106	Nama pengenal pengguna tidak didukung.	Pastikan nama identifikasi pengguna adalah user_id, anonymous_id, atau registration_id.
55107	Nilai pengenal pengguna kosong.	Pastikan nilai identifikasi pengguna pada body permintaan tidak kosong.
55108	EUID tidak valid.	Silakan periksa nilai EUID.
-1	Kesalahan server internal.	Silakan hubungi dukungan teknis EngageLab.