📌 Once you have obtained the access token , you can now record interactions of your clients in RAY through the API.
Service
Information must be obtained through this service:
GET /feedback/reviews
Input message structure
The fields in bold are mandatory
company | It is the business identifier in RAY, you should check which one corresponds to you. |
from | Date since, in date format (2022-03-01T03:00:00.753Z) |
to | Date until, in date format (2022-03-01T03:00:00.753Z) |
pageNumber | Page number that is consulted, given that the service is paginated. |
pageSize | Number of elements that are brought per page of the result. |
stores | List of stores that are consulted, this is in case you want to consult a subset of stores instead of all the company's stores. |
withComment | Boolean to indicate if you only want reviews that have comments |
withoutReply | Boolean to indicate whether you want only unanswered reviews |
sources | Sources of the reviews that you want to consult: 1= RAY, 2=Google, 3=Facebook |
scores | Reviews with certain scores ranging from 1 to 5 |
Response message structure
A return code of 200 indicates successful operation. If there are validation or permission errors, they will be indicated in the message field and the statusCode will be different than 200.
The result is a collection of items where each one represents a review and contains the following data (we leave only those of interest):
Id | Review ID |
Score | Review Score |
Comment | Comment left by the person who wrote the review. |
Date | Date the review was written |
ReplyComment | Response to review |
ReviewerDisplayName | Name of person who left the review |
ReviewerEmail | Email of the person who left the review |
SocialSourceId | Source of the review, corresponds to: 1= RAY; 2=Google; 3=Facebook |
Example response:
{ "data": { "items": [ { "id": 18236418, "score": 1, "comment": "muy mal servicio", "date": 1649187371000, "storeId": 3, "companyId": 3, "storeName": "RAY", "storeWebsite": "http://www.rayapp.io", "socialSourceId": 1, "replyComment": "Hello Melisa, thank you very much for your feedback. We are sorry that you did not have a good experience with the service. \n\nWe appreciate you taking the time to leave us a comment. If there is anything else that you think we should improve, I will leave it to you. a link to continue chatting http://bit.ly/FeedbackBotBit \n\nI am Cristian, responsible for the Customer Success area, and we greatly value the feedback from our clients. We are committed to ensuring that in each contact, they have a good experience. \nTo dissipation. Regards \n", "replyTime": 1649190822428, "reviewerDisplayName": "Melisa", "reviewerProfilePhotoUrl": "https://cdn-admin.botbit.io/static/img/avatars/noavatar.jpg", "reviewerEmail": "+mail@botbitmail.com", "userId": 5194249, "replierId": null, "replierFullName": "RAY", "generatedBy": null, "matchedByName": null, "matchedByTimestamp": null, "matchedWithoutStoreId": null, "autoReplied": true, "modifiedAfterReply": false, "replyEdited": null } ], "pageNumber": 0, "pageSize": 10, "totalSize": 1, "empty": false }, "result": "success", "message": "ok", "statusCode": 200 } |
In case of service unavailability or connectivity errors, retries can be made on the client application side.
Related articles
Visit our Help Center , there you will find more information to continue learning about the platform.
What do you think of this article? 👇