get
https://{host}/v2/customers/interaction
Lets you to fetch store interactions with a specific customer. This includes SMSs, emails, sent to the customer; missed calls received from the customer’s registered mobile number; and surveys submitted by the customer.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Example request
curl --location 'https://eu.api.capillarytech.com/v2/customers/interaction?identifierName=email&identifierValue=testloyal222%40gmail.com&type=email' \
--header 'Authorization: Basic =' \
--header 'Cookie: _cfuvid=a0NmZQvi.30LKK7NvCQJgMpK8Ig15sul9um2ZFRucDk-1757422794990-0.0.1.1-604800000'API endpoint example
https://eu.api.capillarytech.com/v2/customers/interaction?identifierName=mobile&network=capillary&identifierValue=917385022695
Query parameters
| Parameter | Type | Description |
|---|---|---|
| identifierName | enum | Type of customer identifier. Accepted values are: email, mobile, and external_id. At least one customer identifier is required. |
| identifierValue | string | Value for the identifier value. |
| network | enum | Filter results by communication network. Accepted values are facebook, twitter, foursquare, and capillary. |
| type | enum | Filter results by interaction type. The types of interaction are:
|
Response parameters
NoteYou can enable the OTP masking configuration and mask the OTPs. Refer to documentation on OTP masking.
| Parameter | Type | Description |
|---|---|---|
| name | String | Name of the customer. |
| interaction | Array | An array containing interaction details. |
| Number | The count of interactions. |
| String | The name of the interaction (e.g., "email"). |
| Array | An array containing message details. |
| -- id | Number | The unique identifier for the message. |
| -- receiver | String | The email address of the message receiver. |
| -- subject | String | The subject of the email message. |
| -- campaignId | Number | The campaign identifier associated with the message. |
| -- status | String | The status of the message delivery (e.g., "NOT-DELIVERED", DELIVERED," "SOFT_BOUNCED"). |
| -- sentDate | String | The date and time when the message was sent (format: "DD-MM-YYYY HH:mm:ss"). |
| -- sentDateISO | String | The date and time when the message was sent, in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ), returned in the server time zone. |
| -- deliveredTime | String | The date and time when the message was delivered (format: "YYYY-MM-DDTHH:mm:ssZ"). |
| -- userId | Number | The unique identifier for the user associated with the message. |
| warnings | Array | An array containing warning details. |
Example response
{
"name": "capillary",
"interaction": [
{
"count": 8,
"name": "email",
"messageList": [
{
"id": 1777595076402,
"receiver": "[email protected]",
"subject": "Segment Test Successfully Created",
"campaignId": -1,
"status": "OPENED",
"deliveredTime": "2026-05-08T14:43:30Z",
"sentDate": "08-05-2026 14:43:20",
"sentDateISO": "2026-05-08T09:13:20Z",
"userId": -1
},
{
"id": 1780276065829,
"receiver": "[email protected]",
"subject": "Quarterly Highlights from the Documentation Team",
"campaignId": -1,
"status": "OPENED",
"deliveredTime": "2026-06-08T14:32:10Z",
"sentDate": "08-06-2026 14:32:10",
"sentDateISO": "2026-06-08T09:02:10Z",
"userId": 564582355
},
{
"id": 1782872697559,
"receiver": "[email protected]",
"subject": "Message subject",
"campaignId": 0,
"status": "OPENED",
"deliveredTime": "2026-07-07T15:13:00Z",
"sentDate": "07-07-2026 15:13:00",
"sentDateISO": "2026-07-07T09:43:00Z",
"userId": 564582355
},
{
"id": 1780276068416,
"receiver": "[email protected]",
"subject": "Quarterly highlights from the documentation team",
"campaignId": -1,
"status": "OPENED",
"deliveredTime": "2026-06-08T15:28:30Z",
"sentDate": "08-06-2026 15:28:30",
"sentDateISO": "2026-06-08T09:58:30Z",
"userId": 564582355
},
{
"id": 1780276069024,
"receiver": "[email protected]",
"subject": "Quarterly highlights from the documentation team",
"campaignId": -1,
"status": "OPENED",
"deliveredTime": "2026-06-08T15:40:00Z",
"sentDate": "08-06-2026 15:39:50",
"sentDateISO": "2026-06-08T10:09:50Z",
"userId": 564582355
},
{
"id": 1769908080394,
"receiver": "[email protected]",
"subject": "Quarterly Highlights from the Documentation Team",
"campaignId": 308301,
"status": "OPENED",
"deliveredTime": "2026-02-11T17:30:30Z",
"sentDate": "11-02-2026 17:30:20",
"sentDateISO": "2026-02-11T12:00:20Z",
"userId": 564582355
},
{
"id": 1780276068431,
"receiver": "[email protected]",
"subject": "Quarterly highlights from the documentation team",
"campaignId": -1,
"status": "OPENED",
"deliveredTime": "2026-06-08T15:29:00Z",
"sentDate": "08-06-2026 15:28:55",
"sentDateISO": "2026-06-08T09:58:55Z",
"userId": 564582355
},
{
"id": 1780276077976,
"receiver": "[email protected]",
"subject": "Quarterly highlights from the documentation team",
"campaignId": 324424,
"status": "OPENED",
"deliveredTime": "2026-06-08T18:00:20Z",
"sentDate": "08-06-2026 18:00:10",
"sentDateISO": "2026-06-08T12:30:10Z",
"userId": 564582355
}
]
}
],
"warnings": []
}{
"name": "capillary",
"interaction": [
{
"count": 0,
"name": "survey",
"surveys": []
},
{
"count": 0,
"name": "line",
"messageList": []
},
{
"count": 3,
"name": "viber",
"messageList": [
{
"id": 1746038123052,
"receiver": "917385022695",
"subject": "AAAAAAACCCCCCC",
"campaignId": 1241780,
"status": "FAILED",
"sentDate": "26-05-2025 15:52:02",
"userId": 432796209
},
{
"id": 1746038123393,
"receiver": "917385022695",
"subject": "test-hello",
"campaignId": 1241780,
"status": "FAILED",
"sentDate": "26-05-2025 16:17:07",
"userId": 432796209
},
{
"id": 1746038178479,
"receiver": "917385022695",
"subject": "Hii,This is the message in viber.",
"campaignId": 1242049,
"status": "FAILED",
"sentDate": "28-05-2025 13:52:07",
"userId": 432796209
}
]
},
{
"count": 0,
"name": "email",
"messageList": []
},
{
"count": 0,
"name": "whatsapp",
"messageList": []
},
{
"count": 0,
"name": "missed_call",
"usedStatus": false
},
{
"count": 4,
"name": "phone",
"messageList": [
{
"id": 1740767431623,
"receiver": "919988221100",
"subject": "Sample message Akash Vibertest",
"campaignId": -1,
"status": "GTW_NOT_FOUND",
"sentDate": "07-03-2025 13:48:50",
"userId": 432796209
},
{
"id": 1740767429676,
"receiver": "919988221100",
"subject": "Sample message Akash Vibertest",
"campaignId": -1,
"status": "GTW_NOT_FOUND",
"sentDate": "07-03-2025 12:57:06",
"userId": 432796209
},
{
"id": 1740767429770,
"receiver": "919988221100",
"subject": "Sample message Akash Vibertest",
"campaignId": -1,
"status": "GTW_NOT_FOUND",
"sentDate": "07-03-2025 13:01:12",
"userId": 432796209
},
{
"id": 1740767430545,
"receiver": "919988221100",
"subject": "Sample message Akash Vibertest",
"campaignId": -1,
"status": "GTW_NOT_FOUND",
"sentDate": "07-03-2025 13:37:22",
"userId": 432796209
}
]
},
{
"count": 4,
"name": "sms",
"messageList": [
{
"id": 1740767431623,
"receiver": "919988221100",
"subject": "Sample message Akash Vibertest",
"campaignId": -1,
"status": "GTW_NOT_FOUND",
"sentDate": "07-03-2025 13:48:50",
"userId": 432796209
},
{
"id": 1740767429676,
"receiver": "919988221100",
"subject": "Sample message Akash Vibertest",
"campaignId": -1,
"status": "GTW_NOT_FOUND",
"sentDate": "07-03-2025 12:57:06",
"userId": 432796209
},
{
"id": 1740767429770,
"receiver": "919988221100",
"subject": "Sample message Akash Vibertest",
"campaignId": -1,
"status": "GTW_NOT_FOUND",
"sentDate": "07-03-2025 13:01:12",
"userId": 432796209
},
{
"id": 1740767430545,
"receiver": "919988221100",
"subject": "Sample message Akash Vibertest",
"campaignId": -1,
"status": "GTW_NOT_FOUND",
"sentDate": "07-03-2025 13:37:22",
"userId": 432796209
}
]
},
{
"count": 0,
"name": "zalo",
"messageList": []
}
],
"warnings": []
}{
"name": "capillary",
"interaction": [
{
"count": 0,
"name": "email",
"messageList": []
}
],
"warnings": []
}API specific error codes
| Error Code | Description | Reason |
|---|---|---|
| 1012 | Cannot find customer for provided mobile/external-id/e-mail/id | mobile/external-id/e-mail/id invalid or unsupported |