Quick reply
Quick reply API provides insight into how frequently quick replies are used by agents in your Desk application. You can retrieve usage counts for a specific ticket or date range. This allows you to understand which templates are most commonly used in customer support interactions.
Note: Quick replies can be created and managed in Quick replies on the Settings page on Sendbird Dashboard.
Resource representation
The following table shows the list of properties in a quick reply usage resource.
| Property name | Type | Description |
|---|---|---|
quickReplyId | int | The unique ID of the quick reply. |
quickReplyName | string | The name or subject of the quick reply. |
count | int | The number of times this quick reply was used within the provided |
Actions
- API endpoints are relative to the base URL allocated to your application. In this page, the
/endpoint refers tohttps://desk-api-{application_id}.sendbird.com/platform/v1
Note: To find your application ID, sign in to your dashboard, go to the Overview page, and then check Application ID.
List of actions
| Action | HTTP request |
|---|---|
|
Get quick reply usage
Retrieves data on how many times each quick reply was used in a specific ticket or within a specified date range. You must provide either ticket_id or the combination of start_date and end_date.
HTTP request
Parameters
The following table lists the supported parameters for this action.
Optional
| Parameter name | Type | Description |
|---|---|---|
ticket_id | int | The unique ID of the ticket. If provided, usage data is limited to that ticket. |
start_date | string | The start date of the range, in |
end_date | string | The end date of the range, in |
Note: You must provide either
ticket_idor bothstart_dateandend_date.
Response
If successful, this action returns an array of quick reply usage resources.