# Contact API
### **Get Contact by Contact Id**
| Method | GET |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Media Type | application/json |
| URL | http\://\[server]/dolphin/apiv1/graph/contacts?start=0\&count=1 |
| Header | Authorization : Bearer \[generatedToken] |
| Body | |
| Status | 200 |
| Response | {
“status”: “success”,
“data”: \[
{
“id”: “\[Id]”,
“owner”: “\[owner\_id]”,
“createdDate”: 1582876040695,
“createdBy”: “82ab0fd5cfd1e80d1ff97c0cfc9aa9e2”,
“modifiedDate”: 1582876040695,
“modifiedBy”: “82ab0fd5cfd1e80d1ff97c0cfc9aa9e2”,
“ageMax”: 0,
“ageMin”: 0,
“maxFollower”: 0,
“socialIdTwitter”: \[
“788583094249021440”
],
“socialScreenNameTwitter”: \[
“3dolphinsSRM”
],
“socialsString”: “3dolphinsSRM”,
“username”: “Name Not Available”,
“socialAccounts”: \[
“images/channel/ic\_twitter.png”
],
“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
}
],
“influencerCategory”: “”,
“contactTouchpoints”: \[],
“prettyCreatedDate”: “28 Feb 2020 02:47”,
“additionalFieldValueAsMap”: {},
“availableTouchpoints”: \[],
“contactPhoneFormatted”: “”,
“haveAnySocialAccounts”: true,
“liveChatAccount”: false
}
],
“hasMore”: false,
“nextIndex”: 0,
“prevIndex”: 0,
“totalResults”: 0
}
|
### **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
}
|