Desk Platform API v1
Desk Platform API
Desk Platform API
Version 1

Quick reply

Copy link

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

Copy link

The following table shows the list of properties in a quick reply usage resource.

Property nameTypeDescription

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 ticket_id or date range.


Actions

Copy link
  • API endpoints are relative to the base URL allocated to your application. In this page, the / endpoint refers to https://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

Copy link
ActionHTTP request

Get quick reply usage

GET /quick_reply_usage_logs/stats
Retrieves how many times each quick reply was used in a specific ticket or date range.


Get quick reply usage

Copy link

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

Copy link
GET https://desk-api-{application_id}.sendbird.com/platform/v1/quick_reply_usage_logs/stats

Parameters

Copy link

The following table lists the supported parameters for this action.

Optional
Parameter nameTypeDescription

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 YYYY-MM-DD format (inclusive). Must be used with end_date.

end_date

string

The end date of the range, in YYYY-MM-DD format (inclusive). Must be used with start_date.

With ticket_idWith date range
?ticket_id=5849705

Note: You must provide either ticket_id or both start_date and end_date.


Response

Copy link

If successful, this action returns an array of quick reply usage resources.

[
  {
    "quickReplyId": 5184,
    "quickReplyName": "QuickReply1",
    "count": 5
  },
  {
    "quickReplyId": 4539,
    "quickReplyName": "Greeting",
    "count": 4
  },
  {
    "quickReplyId": 4538,
    "quickReplyName": "Closing Statement",
    "count": 7
  },
  {
    "quickReplyId": 4537,
    "quickReplyName": "Alternative Greeting",
    "count": 3
  }
]