DokumentasiEngagement Platform API
Sign inGet started
Guides
API

SLA Policies

GET
/workspaces/{workspaceId}/inbox/sla-policies
List SLA policies
Parameter query
limit
integer
Limits the number of results to return.
pageToken
string
The cursor that keeps track of the current position in the results.
reverse
boolean
Reverses the order in which the results are returned.
Payload respons
nextPageToken
string
The token to fetch the next page of results. If empty, there are no more results to fetch.
results
array of object
wajib
Tampilkan atribut turunan
results.createdAt
string
wajib
results.description
string
wajib
results.id
string
wajib
results.metrics
object
Tampilkan atribut turunan
results.metrics.firstReplyTime
array of object
Tampilkan atribut turunan
results.metrics.firstReplyTime.breachThreshold
integer
wajib
The number of minutes until a ticket reaches a breached state for this SLA metric.
results.metrics.firstReplyTime.priority
string
wajib
Apply the metric for tickets with this priority
results.metrics.firstReplyTime.warningThreshold
integer
wajib
The number of minutes until a ticket reaches a warning state for this SLA metric.
results.metrics.nextReplyTime
array of object
Tampilkan atribut turunan
results.metrics.nextReplyTime.breachThreshold
integer
wajib
The number of minutes until a ticket reaches a breached state for this SLA metric.
results.metrics.nextReplyTime.priority
string
wajib
Apply the metric for tickets with this priority
results.metrics.nextReplyTime.warningThreshold
integer
wajib
The number of minutes until a ticket reaches a warning state for this SLA metric.
results.name
string
wajib
results.timeKeepingMethod
string
wajib
Determine how the timers are tracking expiry.
  • clock will simply count using the full 24 hours of a day.
  • businessHours takes into account the business hours configured for the assigned team.
Possible values: clock, businessHours
results.updatedAt
string
wajib
results.workspaceId
string
wajib
Contoh kode
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/inbox/sla-policies' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
POST
/workspaces/{workspaceId}/inbox/sla-policies
Create SLA policy
Payload permintaan
name
string
wajib
description
string
wajib
timeKeepingMethod
string
wajib
Determine how the timers are tracking expiry.
  • clock will simply count using the full 24 hours of a day.
  • businessHours takes into account the business hours configured for the assigned team.
Possible values: clock, businessHours
metrics
object
Tampilkan parameter turunan
metrics.firstReplyTime
array of object
Tampilkan parameter turunan
metrics.firstReplyTime.breachThreshold
integer
wajib
The number of minutes until a ticket reaches a breached state for this SLA metric.
metrics.firstReplyTime.priority
string
wajib
Apply the metric for tickets with this priority
metrics.firstReplyTime.warningThreshold
integer
wajib
The number of minutes until a ticket reaches a warning state for this SLA metric.
metrics.nextReplyTime
array of object
Tampilkan parameter turunan
metrics.nextReplyTime.breachThreshold
integer
wajib
The number of minutes until a ticket reaches a breached state for this SLA metric.
metrics.nextReplyTime.priority
string
wajib
Apply the metric for tickets with this priority
metrics.nextReplyTime.warningThreshold
integer
wajib
The number of minutes until a ticket reaches a warning state for this SLA metric.
Payload respons
createdAt
string
wajib
description
string
wajib
id
string
wajib
metrics
object
Tampilkan atribut turunan
metrics.firstReplyTime
array of object
Tampilkan atribut turunan
metrics.firstReplyTime.breachThreshold
integer
wajib
The number of minutes until a ticket reaches a breached state for this SLA metric.
metrics.firstReplyTime.priority
string
wajib
Apply the metric for tickets with this priority
metrics.firstReplyTime.warningThreshold
integer
wajib
The number of minutes until a ticket reaches a warning state for this SLA metric.
metrics.nextReplyTime
array of object
Tampilkan atribut turunan
metrics.nextReplyTime.breachThreshold
integer
wajib
The number of minutes until a ticket reaches a breached state for this SLA metric.
metrics.nextReplyTime.priority
string
wajib
Apply the metric for tickets with this priority
metrics.nextReplyTime.warningThreshold
integer
wajib
The number of minutes until a ticket reaches a warning state for this SLA metric.
name
string
wajib
timeKeepingMethod
string
wajib
Determine how the timers are tracking expiry.
  • clock will simply count using the full 24 hours of a day.
  • businessHours takes into account the business hours configured for the assigned team.
Possible values: clock, businessHours
updatedAt
string
wajib
workspaceId
string
wajib
Contoh kode
curl -X POST 'https://api.bird.com/workspaces/{workspaceId}/inbox/sla-policies' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
GET
/workspaces/{workspaceId}/inbox/sla-policies/{slaPolicyId}
Get SLA policy
Payload respons
createdAt
string
wajib
description
string
wajib
id
string
wajib
metrics
object
Tampilkan atribut turunan
metrics.firstReplyTime
array of object
Tampilkan atribut turunan
metrics.firstReplyTime.breachThreshold
integer
wajib
The number of minutes until a ticket reaches a breached state for this SLA metric.
metrics.firstReplyTime.priority
string
wajib
Apply the metric for tickets with this priority
metrics.firstReplyTime.warningThreshold
integer
wajib
The number of minutes until a ticket reaches a warning state for this SLA metric.
metrics.nextReplyTime
array of object
Tampilkan atribut turunan
metrics.nextReplyTime.breachThreshold
integer
wajib
The number of minutes until a ticket reaches a breached state for this SLA metric.
metrics.nextReplyTime.priority
string
wajib
Apply the metric for tickets with this priority
metrics.nextReplyTime.warningThreshold
integer
wajib
The number of minutes until a ticket reaches a warning state for this SLA metric.
name
string
wajib
timeKeepingMethod
string
wajib
Determine how the timers are tracking expiry.
  • clock will simply count using the full 24 hours of a day.
  • businessHours takes into account the business hours configured for the assigned team.
Possible values: clock, businessHours
updatedAt
string
wajib
workspaceId
string
wajib
Contoh kode
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/inbox/sla-policies/{slaPolicyId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
PATCH
/workspaces/{workspaceId}/inbox/sla-policies/{slaPolicyId}
Update SLA policy
Payload permintaan
name
string
description
string
timeKeepingMethod
string
Determine how the timers are tracking expiry.
  • clock will simply count using the full 24 hours of a day.
  • businessHours takes into account the business hours configured for the assigned team.
Possible values: clock, businessHours
metrics
object
Tampilkan parameter turunan
metrics.firstReplyTime
array of object
Tampilkan parameter turunan
metrics.firstReplyTime.breachThreshold
integer
wajib
The number of minutes until a ticket reaches a breached state for this SLA metric.
metrics.firstReplyTime.priority
string
wajib
Apply the metric for tickets with this priority
metrics.firstReplyTime.warningThreshold
integer
wajib
The number of minutes until a ticket reaches a warning state for this SLA metric.
metrics.nextReplyTime
array of object
Tampilkan parameter turunan
metrics.nextReplyTime.breachThreshold
integer
wajib
The number of minutes until a ticket reaches a breached state for this SLA metric.
metrics.nextReplyTime.priority
string
wajib
Apply the metric for tickets with this priority
metrics.nextReplyTime.warningThreshold
integer
wajib
The number of minutes until a ticket reaches a warning state for this SLA metric.
Payload respons
createdAt
string
wajib
description
string
wajib
id
string
wajib
metrics
object
Tampilkan atribut turunan
metrics.firstReplyTime
array of object
Tampilkan atribut turunan
metrics.firstReplyTime.breachThreshold
integer
wajib
The number of minutes until a ticket reaches a breached state for this SLA metric.
metrics.firstReplyTime.priority
string
wajib
Apply the metric for tickets with this priority
metrics.firstReplyTime.warningThreshold
integer
wajib
The number of minutes until a ticket reaches a warning state for this SLA metric.
metrics.nextReplyTime
array of object
Tampilkan atribut turunan
metrics.nextReplyTime.breachThreshold
integer
wajib
The number of minutes until a ticket reaches a breached state for this SLA metric.
metrics.nextReplyTime.priority
string
wajib
Apply the metric for tickets with this priority
metrics.nextReplyTime.warningThreshold
integer
wajib
The number of minutes until a ticket reaches a warning state for this SLA metric.
name
string
wajib
timeKeepingMethod
string
wajib
Determine how the timers are tracking expiry.
  • clock will simply count using the full 24 hours of a day.
  • businessHours takes into account the business hours configured for the assigned team.
Possible values: clock, businessHours
updatedAt
string
wajib
workspaceId
string
wajib
Contoh kode
curl -X PATCH 'https://api.bird.com/workspaces/{workspaceId}/inbox/sla-policies/{slaPolicyId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
DELETE
/workspaces/{workspaceId}/inbox/sla-policies/{slaPolicyId}
Delete SLA policy
Contoh kode
curl -X DELETE 'https://api.bird.com/workspaces/{workspaceId}/inbox/sla-policies/{slaPolicyId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'