Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Get Customer Interactions

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.

get/customers/interaction

Query parameters

identifierName'email' | 'mobile' | 'external_id'

Identifier type of the customer.

identifierValuestring

Value for the identifier type.

network'facebook' | 'twitter' | 'foursquare' | 'capillary'

Filter results by communication network.

type'email' | 'emailbulk' | 'checkin' | 'like' | 'comment' | 'mention' | 'retweet' | 'tweet' | 'feedback' | 'whatsapp' | 'zalo' | 'line'

Filter results by interaction type. email (for transaction email), emailbulk (for bulk email), checkin (applicable only for foursquare/facebook), like, comment (for facebook); mention, retweet, tweet (only for Twitter network); feedback (only for Capillary).

Response

200

OR

Example response

{
  "name": "capillary",
  "interaction": [
    {
      "count": 8,
      "name": "email",
      "messageList": [
        {
          "id": 1685581782856,
          "receiver": "tom.sawyer@capillarytech.com",
          "subject": "Rewards redeemed",
          "campaignId": 469,
          "status": "SOFT_BOUNCED",
          "sentDate": "09-06-2023 14:05:20",
          "userId": 177269954
        }
      ]
    }
  ]
}