API to Send Email / SMS feedback invitations V2 – Customer Radar

This API has been replaced by V3. We still support this API for legacy clients, for new clients please use V3.

Use to send an SMS or email feedback invitation to the customer after an interaction, transaction or milestone.

1.1 SUBMIT Campaign Details

1.1.1 Implementation

CR support team shall:

1.1.1.1 Generate a username and password for the client.

1.1.1.2 Set up / create a Client, Location, POM (Point Of Measure), Programme and share these details along with the username and password to the clients’ technical team and ask them to first authorize themselves by:

1.1.1.3 Authorization

1.1.1.3.1 Request

Method: POST

URL: api.feedback.fyi/auth/login

Example Body:

{
    "username":"testing" ,
     "password":"testing12345"
  }

1.1.1.3.2 Response

Example Response:

{
"token": "eyJ0eXAiOiJKVs23bGciOiJIUzI1NiJ9.eyJleHAfdsgfSDYyNDQsInVzZXJOYW1lIjoidGVzdCJ9.f5Lsz6jPsKFXL4fktRUvAD5wj3b0_ihm_rOrW9jkRGw",
"expiration": 1517434473.269,
"userName": "testing"
}

1.1.1.3.3 Implementation

This token needs to be set in the header for all requests and is valid for 60 minutes once generated. Once the token has expired, use “/auth/login” to authorise again using provided username and password and receive a new token.

1.1.1.4 Send interaction / transaction details

1.1.1.4.1 Request

Method: POST

URL: api.feedback.fyi/campaign/v1/invite

Headers:

Key	Value Example	Format	Req*	Details
Authorization	eyJ0sUHBDusmUUmiYQiL.CJaJ0-XAiabs	Alpha	Yes	The token which was received after successful submission of username and password.
Content-Type	application/json	JSON	Yes	Body or JSON format. Some tools may populate this value by default when adding raw JSON to Body.

Body Type: Raw / JSON

Body:

Key	Value Example	Format	Req*	Details
campaign_mode	SMS	Alpha	Yes	Select the invitation method the feedback is to be sent by. SMS or EMAIL
clientDisplayId	8291a9ed95237364c34ee32915f2189e7c	Alphanumeric	Yes	CR Support will provide clientDisplayID to clients. Look at specific set up under Client in the CR system.
locationDisplayId	1cf118a0326c38b29ha90b9674e90aa	Alphanumeric	Yes	CR Support will provide locationDisplayId to clients. Look at a specific location set up under Client in the CR system.
client_location_id	123	Alphanumeric	Yes
pomDisplayId	c8c112646af874c7b8d232db42f85a0c	Alphanumeric	Yes	CR Support will provide pomDisplayId to clients. Look at a specific Point-Of-Measure or sub measure set up under a Location & Client in the CR system.
client_pom_id	123	Alphanumeric	Yes
programmeDisplayId	4yfd864bcu6334	Alphanumeric	Yes	CR Support will provide a programmeDisplayId the client. Look at a specific Programme set up under Client in the CR system.
customer_email	address@domain.suffix	Email	No	Customer email address. Doesn’t do domain and sub-domain validation. Can be hidden.
customer_mobile	6421234567	Numeric	Yes	Customer mobile number. Doesn’t validate for length and other country code specific checks.
customer_name	Jack Black	Alphanumeric	No	Customer name.
metadata	*see below metadata elements		No	Clients shall be able to pass any additional information after putting info in the specific tag and value. Key is mapped to internal CR programme settings and must match case/spelling between client and CR. Clients can add as many fields as required. To add / update fields, contact the CR Support team at support@customerradar.com.

"metadata": {
       "contact_centre_operator": "Mr. Dave Brown",
       "booking_reference": "122334345",
       "quote_booking_date": "2020-07-07 07:52:10"
}

Example Request:

{
"campaign_mode": "EMAIL",
"clientDisplayId": "8291a9ed95237364c34ee32915f2189e7c",
"customer_email": "support@customerradar.com",
"customer_mobile": "6421123456",
"customer_name": "Harry",
"client_location_id":"123",
"metadata": {
"email":"support@customerradar.com"
},
"client_pom_id":"Support",
"programmeDisplayId": "4yfd864bcu6334"
}

Important:

1.1.1.4.2 clientDisplayId can be found in the URL when a particular client is selected in the Admin portal. Provided to the client by CR.

1.1.1.4.3 If the requester receive an exception as :

No Feedback code found for this clientDisplayId, locationDisplayId, pomDisplayId & programmeDisplayId.

The locationDisplayId, pomDisplayId & programmeDisplayId can be obtained via the lookup v2 APIs.

To send an email invitation, the programme must set SendGridId.

Provide correct details & try again.
This is set by CR Support.

This is highly likely when one of the following is true.:

1.1.1.4.3.1 The programme_name’s end date has passed.

1.1.1.4.3.2 Contact CR Support support@customerradar.com to resolve

1.1.1.4.4 Response