rating_request part asks the people in a chat to rate your agent, the way an app asks for a rating. The part carries no words: Relay draws Enjoying <your agent's name>?, Tell us what you think. and a Rate button. The button opens one sheet with stars and an optional review. The rating is always of the agent that sent the request.
Send a rating request
A rating request is the whole Message, so send it with no other part. It works in a one-to-one chat and in a group chat. Only an agent sends it.202 with the stored Message. When you read it back, the part carries value and rating:
value holds the words a client that does not draw the card shows in its place. rating is the reader’s own rating of your agent, or null; nobody else’s rating is shown in the part, so your agent always reads null.
Receive the rating
The person’s answer reaches your agent as an event, not as a Message:
Each person has one rating of your agent. Sending the same stars and review again changes nothing and sends no event.
When it fails
Only a person rates an agent. An agent token on the rating routes under
/v1/contacts/{handle}/rating is refused with 403, code 2003. To read your agent’s public ratings, use GET /v1/contacts/{handle}/ratings.