# Contact API ### **Get Contact by Contact Id** `GET` `/graph/contacts/contactById` API ini diperuntukkan untuk menampilkan informasi yang berisi data pelanggan milik 3Dolphins **Headers** | Nama | Value | | ------------- | ------------------ | | Content-Type | `application/json` | | Authorization | `Bearer ` | **Query Parameters**
NamaTipeDeskripsi
contactIdstringDigunakan untuk menentukan data kontak yang akan diambil. Setiap pelanggan yang berinteraksi melalui channel akan terbuat kontaknya ke dalam sistem.
ignoreDeletedbooleanMerupakan filter yang digunakan untuk menentukan data kontak yang akan diambil apakah mencakup kontak yang sudah terhapus.
includeChildrenSocialbooleanMerupakan filter yang digunakan untuk menentukan data kontak yang akan diambil apakah mencakup kontak turunan atau tidak (apabila kontak tersebut sudah pernah di merge contact) .
numberOfChildrenintegerMerupakan filter untuk menentukan jumlah kontak turunan yang akan ditampilkan.
**Response** {% tabs %} {% tab title="200" %} ```json { "id": "[customer_id]", "owner": "[owner_id]", "createdDate": 1720601207431, "createdBy": "[system/user id]", "modifiedDate": 1720601207431, "modifiedBy": "[system/user id]", "ageMax": 0, "ageMin": 0, "contactEmail": [ "bungasmara@gmail.com" ], "contactEmailString": "bungasmara@gmail.com", "contactFirstName": "Bunga", "contactLastName": "Asmara", "maxFollower": 0, "phoneTypes": [ "Mobile" ], "phones": [ "6285782120717" ], "phonesString": "6285782120717", "socialIdWebchat": [ "6285782120717-Bunga Asmara" ], "socialNameWebchat": [ "Bunga Asmara" ], "socialScreenNameWebchat": [ "bungasmara@gmail.com" ], "socialsString": "bungasmara@gmail.com,bungasmara@gmail.com", "username": "Bunga Asmara", "additionalFieldsObject": [ { "name": "NPWP", "value": null } ], "influencerCategory": "", "mapMaskedPhoneNumber": { "6285782120717": "6285782120717" }, "maskingMode": false, "firstFormattedPhone": "6285782120717", "maskedPhones": [ "6285782120717" ], "prettyCreatedDate": "10 Jul 2024 15:46", "rating": 0, "contactAccountIds": [ "bungasmara@gmail.com", "6285782120717" ], "contactTouchpoints": [ { "id": "bungasmara@gmail.com", "displayName": "Bunga Asmara", "screenName": "bungasmara@gmail.com", "profilePicture": null, "channelType": "javamail", "channelTypeIcon": "images/channel/ic_email.png", "contactId": "[contact_id]" } ], "phoneList": "6285782120717", "additionalFieldValueAsMap": {}, "availableTouchpoints": [ "images/channel/ic_email.png" ], "contactPhoneFormatted": "6285782120717", "haveAnySocialAccounts": false, "liveChatAccount": false, "contactEmailFormated": "bungasmara@gmail.com", "vipStatus": "No", "maskedSocialWhatsappId": [] } ``` {% endtab %} {% tab title="404" %} ```json { "status": "error", "data": null, "message": "Contact not found" } ``` {% endtab %} {% endtabs %} Berikut merupakan penjelasan dari body response field:
NamaDeskripsi
idMerupakan identifikasi unik untuk setiap pelanggan yang berinteraksi menggunakan channel 3Dolphins.
ownerMerupakan identifikasi unik untuk pemegang kontrol akses data dalam aplikasi, biasanya diisi menggunakan ID dari sistem.
createdDateMenunjukkan waktu ketika kontak pelanggan terbuat.
createdByMenunjukkan siapa yang membuat kontak tersebut. Apabila pelanggan berkomunikasi menggunakan channel biasanya isi dari field ini merupakan ID milik sistem. Namun apabila kontak pelanggan dibuat secara manual oleh user, maka akan berisi ID dari user tersebut.
modifiedDateDigunakan untuk menunjukkan kapan terakhir data kontak tersebut diubah.
modifiedByDigunakan untuk menunjukkan yang terakhir mengubah data kontak tersebut apakah dari user atau sistem.
contactEmailMenunjukkan email dari kontak tersebut. Pada field ini seluruh alamat email disimpan dalam bentuk ArrayList.
contactEmailStringMenunjukkan email dari kontak tersebut. Pada field ini seluruh alamat email disimpan dalam bentuk string.
contactFirstNameMenunjukkan nama pertama dari kontak pelanggan.
contactLastNameMenunjukkan nama terakhir dari kontak pelanggan.
phonesMenunjukkan nomor telepon dari pelanggan tersebut dalam bentuk ArrayList.
phonesStringMenunjukkan nomor telepon dari pelanggan tersebut. Pada field ini seluruh nomor telepon disimpan dalam bentuk String.
socialIdWebchatField ini digunakan untuk menandakan pelanggan tersebut datang dari channel live chat berupa identifikasi unik. Biasanya field ini merupakan kombinasi dari nama dan nomor telepon pelanggan.
socialNameWebchatMenunjukkan nama ketika pelanggan terhubung ke channel live chat.
socialScreenNameWebchatField ini berguna untuk menyimpan email ketika pelanggan mengakses channel live chat.
socialsStringSetiap pelanggan yang berinteraksi melalui salah satu channel 3Dolphins akan diberikan sebuah identifier. Field ini menyimpan data dalam bentuk String.
Contoh:
Rois Saputra adalah pelanggan yang berinteraksi dengan agen melalui channel WhatsApp dan Live Chat, sehingga memiliki nilai yang bersifat unik.
usernameMerupakan field untuk menyimpan username yang digunakan oleh pelanggan pada akun media sosial mereka. Namun, untuk channel live chat biasanya terdiri dari first name dan last name milik pelanggan.
additionalFieldsObjectDigunakan untuk menyimpan custom field yang ditambahkan pada data customer contact. Untuk menambahkan additional field anda dapat mengunjungi halaman ini.
maskingModeMerupakan field yang menentukan apakah nomor telepon kontak ini disembunyikan pada tampilan UI.
maskedPhonesMerupakan ArrayList untuk menyimpan nomor telepon pelanggan untuk keperluan fitur masking phone number.
prettyCreatedDateMerupakan hasil konversi kolom "createdDate" ke dalam format tanggal.
ratingMerupakan rating yang diberikan untuk pelanggan tersebut.
contactAccountIdsMerupaka field untuk menyimpan seluruh akun social dari pelanggan tersebut.
contactTouchPointsField ini digunakan untuk menyimpan ArrayList dari informasi kontak pelanggan. Digunakan untuk menampilkan rekomendasi kontak pelanggan ketika memilih recipient email.
additionalFieldValueAsMapMerupakan field untuk menyajikan data "additional field" dalam bentuk map ( struktur data berisi key - value).
availableTouchPointsField ini berguna untuk menampilkan gambar sesuai dengan channel dimana kontak pelanggan terbuat.
contactPhoneFormattedDigunakan untuk menyimpan nomor kontak pelanggan dalam bentuk data string.
haveAnySocialAccountsField ini berguna untuk menentukan apakah kontak pelanggan memiliki akun social di 3Dolphins.
liveChatAccountField ini untuk berguna untuk mengecek apakah pelanggan berasal dari channel live chat.
contactEmailFormatedDigunakan untuk menyimpan email dari kontak pelanggan dalam bentuk data string.
vipStatusMenunjukkan apakah contact tersebut diatur sebagai contact VIP.
### **Get All Contact** | Method | GET | | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | Media Type | application/json | | URL | http\://\[server]/dolphin/apiv1/graph/contacts/all?start=0\&count=2 | | Header | Authorization : Bearer \[generatedToken] | | Body | | | Status | 200 | | Response |

{
“status”: “success”,
“data”: \[
{
“id”: “\[id]”,
“spell”: \[
“andre”,
“”,
“62816553232”,
“andre”
],
“owner”: “\[owner]”,
“createdDate”: 1601275720504,
“createdBy”: “82ab0fd5cfd1e80d1ff97c0cfc9aa9e2”,
“modifiedDate”: 1601275720504,
“modifiedBy”: “82ab0fd5cfd1e80d1ff97c0cfc9aa9e2”,
“ageMax”: 0,
“ageMin”: 0,
“contactEmail”: \[
“”
],
“contactEmailString”: “”,
“contactFirstName”: “andre”,
“maxFollower”: 0,
“phoneTypes”: \[
“Mobile”
],
“phones”: \[
“62816553232”
],
“phonesString”: “62816553232”,
“socialIdWebchat”: \[
“62816553232-andre”
],
“socialNameWebchat”: \[
“andre”
],
“socialScreenNameWebchat”: \[
“”
],
“socialsString”: “,”
},
{
“id”: “\[id]”,
“spell”: \[
“andre”,
“”,
“62812643643”,
“andre”
],
“owner”: “\[owner]”,
“createdDate”: 1601275890818,
“createdBy”: “82ab0fd5cfd1e80d1ff97c0cfc9aa9e2”,
“modifiedDate”: 1601275890818,
“modifiedBy”: “82ab0fd5cfd1e80d1ff97c0cfc9aa9e2”,
“ageMax”: 0,
“ageMin”: 0,
“contactEmail”: \[
“”
],
“contactEmailString”: “”,
“contactFirstName”: “andre”,
“maxFollower”: 0,
“phoneTypes”: \[
“Mobile”
],
“phones”: \[
“62812643643”
],
“phonesString”: “62812643643”,
“socialIdWebchat”: \[
“62812643643-andre”
],
“socialNameWebchat”: \[
“andre”
],
“socialScreenNameWebchat”: \[
“”
],
“socialsString”: “,”
}
],
“hasMore”: true,
“nextIndex”: 2,
“prevIndex”: 0,
“totalResults”: 254
}

| ### **Add Contact** | Method | POST | | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Media Type | application/json | | URL | http\://\[server]/dolphin/apiv1/graph/contacts/add | | Header | Authorization : Bearer \[generatedToken] | | Body | { “contactFirstName”: “\[first\_name]” } | | Status | 200 | | Response |

{
“status”: “success”,
“data”: {
“id”: “\[Id]”,
“owner”: “\[owner\_id]”,
“createdDate”: 1598713781253,
“createdBy”: “95bbbf64882dd7816c09996d56bbc1e2”,
“modifiedDate”: 1598713781253,
“modifiedBy”: “95bbbf64882dd7816c09996d56bbc1e2”,
“partial”: false,
“contactFirstName”: “Mira”,
“additionalField”: \[
“{\”name\”:\”customer\_name\”}”,
“{\”name\”:\”phone\_number\”}”,
“{\”name\”:\”email\_address\”}”,
“{\”name\”:\”last\_date\_purchase\”}”,
“{\”name\”:\”first\_time\_purchase\”}”,
“{\”name\”:\”num\_hotel\_transaction\”}”,
“{\”name\”:\”num\_flight\_transaction\”}”,
“{\”name\”:\”num\_train\_transaction\”}”,
“{\”name\”:\”num\_coupon\_usage\”}”,
“{\”name\”:\”last\_booking\_id\”}”,
“{\”name\”:\”last\_booking\_product\”}”,
“{\”name\”:\”last\_booking\_hotel\_name\”}”,
“{\”name\”:\”last\_booking\_hotel\_area\”}”,
“{\”name\”:\”last\_booking\_flight\_route\”}”,
“{\”name\”:\”last\_booking\_train\_route\”}”,
“{\”name\”:\”isregisteredchatbanking\”}”
],
“username”: “Mira”,
“socialAccounts”: \[],
“additionalFieldsObject”: \[
{
“name”: “customer\_name”,
“value”: null
},
{
“name”: “phone\_number”,
“value”: null
},
{
“name”: “email\_address”,
“value”: null
},
{
“name”: “last\_date\_purchase”,
“value”: null
},
{
“name”: “first\_time\_purchase”,
“value”: null
},
{
“name”: “num\_hotel\_transaction”,
“value”: null
},
{
“name”: “num\_flight\_transaction”,
“value”: null
},
{
“name”: “num\_train\_transaction”,
“value”: null
},
{
“name”: “num\_coupon\_usage”,
“value”: null
},
{
“name”: “last\_booking\_id”,
“value”: null
},
{
“name”: “last\_booking\_product”,
“value”: null
},
{
“name”: “last\_booking\_hotel\_name”,
“value”: null
},
{
“name”: “last\_booking\_hotel\_area”,
“value”: null
},
{
“name”: “last\_booking\_flight\_route”,
“value”: null
},
{
“name”: “last\_booking\_train\_route”,
“value”: null
},
{
“name”: “isregisteredchatbanking”,
“value”: null
}
],
“rating”: 0,
“contactAccountIds”: \[],
“contactTouchpoints”: \[],
“prettyCreatedDate”: “moments ago”,
“additionalFieldValueAsMap”: {
“customer\_name”: {
“name”: “customer\_name”,
“value”: null
},
“phone\_number”: {
“name”: “phone\_number”,
“value”: null
},
“email\_address”: {
“name”: “email\_address”,
“value”: null
},
“last\_date\_purchase”: {
“name”: “last\_date\_purchase”,
“value”: null
},
“first\_time\_purchase”: {
“name”: “first\_time\_purchase”,
“value”: null
},
“num\_hotel\_transaction”: {
“name”: “num\_hotel\_transaction”,
“value”: null
},
“num\_flight\_transaction”: {
“name”: “num\_flight\_transaction”,
“value”: null
},
“num\_train\_transaction”: {
“name”: “num\_train\_transaction”,
“value”: null
},
“num\_coupon\_usage”: {
“name”: “num\_coupon\_usage”,
“value”: null
},
“last\_booking\_id”: {
“name”: “last\_booking\_id”,
“value”: null
},
“last\_booking\_product”: {
“name”: “last\_booking\_product”,
“value”: null
},
“last\_booking\_hotel\_name”: {
“name”: “last\_booking\_hotel\_name”,
“value”: null
},
“last\_booking\_hotel\_area”: {
“name”: “last\_booking\_hotel\_area”,
“value”: null
},
“last\_booking\_flight\_route”: {
“name”: “last\_booking\_flight\_route”,
“value”: null
},
“last\_booking\_train\_route”: {
“name”: “last\_booking\_train\_route”,
“value”: null
},
“isregisteredchatbanking”: {
“name”: “isregisteredchatbanking”,
“value”: null
}
},
“availableTouchpoints”: \[],
“contactPhoneFormatted”: “”,
“haveAnySocialAccounts”: true,
“liveChatAccount”: false
},
“hasMore”: false,
“nextIndex”: 0,
“prevIndex”: 0,
“totalResults”: 0
}

| ### **Update the Contact Data by Contact Id** | Method | PUT | | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | Media Type | application/json | | URL | http\://\[server]/dolphin/apiv1/graph/contacts/update/\[contactId] | | Header |

Authorization : Bearer \[generatedToken]
ContactId : \[contactId]

| | Body | | | Status | 200 | | Response |

{
“status”: “success”,
“data”: {
“id”: “\[Id]”,
“owner”: “\[owner\_id]”,
“createdDate”: 1598714030772,
“createdBy”: “95bbbf64882dd7816c09996d56bbc1e2”,
“modifiedDate”: 1598714030772,
“modifiedBy”: “95bbbf64882dd7816c09996d56bbc1e2”,
“partial”: true
},
“hasMore”: false,
“nextIndex”: 0,
“prevIndex”: 0,
“totalResults”: 0
}

| ### **Update the Contact Data by Contact Id** | Method | PUT | | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | Media Type | application/json | | URL | http\://\[server]/dolphin/apiv1/graph/contacts/update/\[contactId] | | Header |

Authorization : Bearer \[generatedToken]
ContactId : \[contactId]

| | Body | | | Status | 200 | | Response |

{
“status”: “success”,
“data”: {
“id”: “\[Id]”,
“owner”: “\[owner\_id]”,
“createdDate”: 1598714030772,
“createdBy”: “95bbbf64882dd7816c09996d56bbc1e2”,
“modifiedDate”: 1598714030772,
“modifiedBy”: “95bbbf64882dd7816c09996d56bbc1e2”,
“partial”: true
},
“hasMore”: false,
“nextIndex”: 0,
“prevIndex”: 0,
“totalResults”: 0
}

| ### **Update the Contact Data by Email** | Method | PUT | | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | Media Type | application/json | | URL | http\://\[server]/dolphin/apiv1/graph/contacts/update/email/\[contact\_email] | | Header |

Authorization : Bearer \[generatedToken]
Email : \[contact\_email]

| | Body | | | Status | 200 | | Response |

{
“status”: “success”,
“data”: {},
“hasMore”: false,
“nextIndex”: 0,
“prevIndex”: 0,
“totalResults”: 0
}

| ### **Update the Contact Data by Account Id and Channel Type** | Method | PUT | | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | Media Type | application/json | | URL | http\://\[server]/dolphin/apiv1/graph/contacts/update/\[accountId]/channelType/\[channelType] | | Header |

Authorization : Bearer \[generatedToken]
accountId : \[accountId]
ChannelType : \[channelType]

| | Body |

{
“id”: “\[Id]”,
“owner”: “\[ownerId]”,
“contactId”: “\[contactId]”
}

| | Status | 200 | | Response |

{
“status”: “success”,
“data”: {,
“id”: “\[Id]”,
“owner”: “\[ownerId]”,
“createdDate”: 1599195510899,
“createdBy”: “f1b380ced4477dd87e8d7ad842af7ae2”,
“modifiedDate”: 1599195510899,
“modifiedBy”: “f1b380ced4477dd87e8d7ad842af7ae2”,
“partial”: true,
“contactId”: “\[contactId]”,
“socialIdWebchat”: \[
“62812374142-chi”
]
},
“hasMore”: false,
“nextIndex”: 0,
“prevIndex”: 0,
“totalResults”: 0
}

| ### **Get Contact Additional Fields** | Method | Get | | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | Media Type | application/json | | URL | http\://\[server]/dolphin/apiv1/graph/contacts/additionalFields | | Header | Authorization : Bearer \[generatedToken] | | Body | | | Status | 200 | | Response |

{
“status”: “success”,
“data”: {
\ : “additionalFields”: “\[]”,
“nanoInfluencer”: {
“minFollowers”: 1,
“maxFollowers”: 100
},
“microInfluencer”: {
“minFollowers”: 101,
“maxFollowers”: 300
},
“macroInfluencer”: {
“minFollowers”: 301,
“maxFollowers”: 300
},
“megaInfluencer”: {
“minFollowers”: 5000,
“maxFollowers”: 9223372036854776000
},
“customerIdentificationUrl”: “”
},
“hasMore”: false,
“nextIndex”: 0,
“prevIndex”: 0,
“totalResults”: 0
}

|