DokumentasiEngagement Platform API
Sign inGet started
Guides
API

Agent Management

GET
/workspaces/{workspaceId}/agents
List Agents
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.
sortBy
string
Sort by field specified
Possible values: createdAt, statusAssignedCount, assignedCount, name
name
string
Filter by agent name
email
string
Filter by agent email
agentStatuses
array
Filter by agent status
roleIds
array
Filter by agent role ids
lastStatusActivitySince
string
To filter agents by their last status change since.
lastStatusActivityUpto
string
To filter agents by their last status change activity time.
agentIds
array
To find specific agents by their ids. If this is specified, other parameters are ignored.
Payload respons
results
array of object
wajib
Tampilkan atribut turunan
results.id
string
wajib
results.status
string
Possible values: active, away, out-of-office
results.statusBeforeOffline
string
Possible values: active, away, out-of-office
results.name
string
results.overrideName
boolean
results.workspaceId
string
wajib
results.type
string
Possible values: user, ai
results.userEmails
array of string
results.bio
string
results.avatarUrl
string
results.dropVms
array
Tampilkan atribut turunan
results.dropVms.name
string
results.dropVms.playback
object
wajib
Tampilkan atribut turunan
results.dropVms.playback.media
array of string
wajib
results.dropVms.playback.pauseMilliseconds
integer
results.tagCount
integer
results.wrapUpTime
integer
results.rootItemAssignedCount
integer
results.lastAssignedAt
string
results.lastSetToAwayAt
string
results.teams
array of object
Tampilkan atribut turunan
results.teams.id
string
The team's ID this agent belongs to.
results.teams.name
string
The name of the team this agent belongs to.
results.teams.memberSince
string
The timestamp of when this agent joined the team.
results.teams.activeMemberCount
integer
The number of active members in the team.
results.teams.pendingMemberCount
integer
The number of pending members in the team.
results.workload
object
Tampilkan atribut turunan
results.workload.id
string
results.workload.workload
object
Tampilkan atribut turunan
results.workload.workload.messaging
integer
results.workload.workload.email
integer
results.workload.rule
object
Tampilkan atribut turunan
results.workload.rule.id
string
wajib
results.workload.rule.workspaceId
string
wajib
results.workload.rule.name
string
wajib
results.workload.rule.description
string
wajib
results.workload.rule.default
boolean
results.workload.rule.capacity
object
wajib
Tampilkan atribut turunan
results.workload.rule.capacity.messaging
integer
results.workload.rule.capacity.email
integer
results.workload.rule.assignedAgentIds
array of string
results.workload.rule.createdAt
string
results.workload.rule.updatedAt
string
results.workload.ruleId
string
results.workload.updatedAt
string
results.createdAt
string
wajib
results.updatedAt
string
wajib
results.availability
object
Tampilkan atribut turunan
results.availability.status
string
Possible values: active, away, out-of-office
results.availability.activity
string
Possible values: available, in-call, busy, wrap-up-time, do-not-disturb, offline, not-available, out-of-hours, custom
results.availability.activityTtl
integer
results.availability.activityText
string
results.availability.lastStatusSet
string
results.availability.lastActivitySet
string
results.availability.updatedAt
string
results.timezone
string
results.defaultCountryCode
string
results.defaultCallerId
string
results.forwardNumber
object
Tampilkan atribut turunan
results.forwardNumber.enabled
boolean
results.forwardNumber.number
string
results.forwardNumber.maskCaller
boolean
results.transcriptionLocale
string
Curated set of BCP47 locale identifiers supported by Bird speech-to-text products
Possible values: ar-AE, ar-SA, cmn-CN, cy-GB, da-DK, de-CH, de-DE, el-GR, en-AU, en-GB, en-GB-WLS, en-IE, en-IN, en-NZ, en-US, en-ZA, es-ES, es-MX, es-US, fr-CA, fr-FR, he-IL, hi-IN, id-ID, is-IS, it-IT, ja-JP, ko-KR, ms-MY, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, ta-IN, te-IN, th-TH, tr-TR, vi-VN, zh-CN, zh-HK, zh-TW, arb, af-ZA, bn-IN, ca-ES, cmn-TW, cs-CZ, fi-FI, fil-PH, gu-IN, hu-HU, kn-IN, lt-LT, lv-LV, ml-IN, mr-IN, pa-IN, sk-SK, sr-RS, uk-UA, yue-HK, no-NO
results.roles
array of object
Tampilkan atribut turunan
results.roles.id
string
wajib
results.roles.type
string
wajib
Possible values: organization, managed
results.roles.workspaces
array of string
results.user
object
Tampilkan atribut turunan
results.user.id
string
ID of the user
results.user.name
string
The display name for the user
results.user.avatarUrl
string
URL to the user's profile picture.
results.user.defaultEmail
string
The default email of the user in the list of emails.
results.user.phoneNumber
string
results.weeklySchedule
object
Tampilkan atribut turunan
results.weeklySchedule.monday
object
Tampilkan atribut turunan
results.weeklySchedule.monday.from
object
wajib
Tampilkan atribut turunan
results.weeklySchedule.monday.from.hour
integer
wajib
results.weeklySchedule.monday.from.minute
integer
results.weeklySchedule.monday.to
object
wajib
Tampilkan atribut turunan
results.weeklySchedule.monday.to.hour
integer
wajib
results.weeklySchedule.monday.to.minute
integer
results.weeklySchedule.tuesday
object
Tampilkan atribut turunan
results.weeklySchedule.tuesday.from
object
wajib
Tampilkan atribut turunan
results.weeklySchedule.tuesday.from.hour
integer
wajib
results.weeklySchedule.tuesday.from.minute
integer
results.weeklySchedule.tuesday.to
object
wajib
Tampilkan atribut turunan
results.weeklySchedule.tuesday.to.hour
integer
wajib
results.weeklySchedule.tuesday.to.minute
integer
results.weeklySchedule.wednesday
object
Tampilkan atribut turunan
results.weeklySchedule.wednesday.from
object
wajib
Tampilkan atribut turunan
results.weeklySchedule.wednesday.from.hour
integer
wajib
results.weeklySchedule.wednesday.from.minute
integer
results.weeklySchedule.wednesday.to
object
wajib
Tampilkan atribut turunan
results.weeklySchedule.wednesday.to.hour
integer
wajib
results.weeklySchedule.wednesday.to.minute
integer
results.weeklySchedule.thursday
object
Tampilkan atribut turunan
results.weeklySchedule.thursday.from
object
wajib
Tampilkan atribut turunan
results.weeklySchedule.thursday.from.hour
integer
wajib
results.weeklySchedule.thursday.from.minute
integer
results.weeklySchedule.thursday.to
object
wajib
Tampilkan atribut turunan
results.weeklySchedule.thursday.to.hour
integer
wajib
results.weeklySchedule.thursday.to.minute
integer
results.weeklySchedule.friday
object
Tampilkan atribut turunan
results.weeklySchedule.friday.from
object
wajib
Tampilkan atribut turunan
results.weeklySchedule.friday.from.hour
integer
wajib
results.weeklySchedule.friday.from.minute
integer
results.weeklySchedule.friday.to
object
wajib
Tampilkan atribut turunan
results.weeklySchedule.friday.to.hour
integer
wajib
results.weeklySchedule.friday.to.minute
integer
results.weeklySchedule.saturday
object
Tampilkan atribut turunan
results.weeklySchedule.saturday.from
object
wajib
Tampilkan atribut turunan
results.weeklySchedule.saturday.from.hour
integer
wajib
results.weeklySchedule.saturday.from.minute
integer
results.weeklySchedule.saturday.to
object
wajib
Tampilkan atribut turunan
results.weeklySchedule.saturday.to.hour
integer
wajib
results.weeklySchedule.saturday.to.minute
integer
results.weeklySchedule.sunday
object
Tampilkan atribut turunan
results.weeklySchedule.sunday.from
object
wajib
Tampilkan atribut turunan
results.weeklySchedule.sunday.from.hour
integer
wajib
results.weeklySchedule.sunday.from.minute
integer
results.weeklySchedule.sunday.to
object
wajib
Tampilkan atribut turunan
results.weeklySchedule.sunday.to.hour
integer
wajib
results.weeklySchedule.sunday.to.minute
integer
results.holidays
array of object
Tampilkan atribut turunan
results.holidays.name
string
wajib
results.holidays.day
integer
wajib
results.holidays.month
integer
wajib
results.assignedSkills
array of object
Tampilkan atribut turunan
results.assignedSkills.id
string
wajib
results.assignedSkills.name
string
wajib
results.assignedSkills.selectedValues
array of object
wajib
Tampilkan atribut turunan
results.assignedSkills.selectedValues.icon
string
results.assignedSkills.selectedValues.id
string
wajib
results.assignedSkills.selectedValues.value
string
wajib
results.assignedSkills.valueType
string
wajib
AgentSkillValueType defines how can the Values of a Skill can be selected.
Possible values: single, multiple, boolean
results.defaultSenderId
string
The default Sender Profile to select for this agent when composing a new message.
results.outOfOfficeResponse
string
nextPageToken
string
The token that can be passed as pageToken in URL to retrieve the next set of results. If missing, no more results to display.
total
integer
The total number of results across all pages.
Contoh kode
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/agents' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
POST
/workspaces/{workspaceId}/agents
Create a new agent with specified details like name, role, and basic bio.
Payload permintaan
bio
string
type
string
wajib
Possible values: user
userId
string
wajib
teamId
string
teamIds
array of string
timezone
string
defaultCountryCode
string
weeklySchedule
object
Tampilkan parameter turunan
weeklySchedule.monday
object
Tampilkan parameter turunan
weeklySchedule.monday.from
object
wajib
Tampilkan parameter turunan
weeklySchedule.monday.from.hour
integer
wajib
weeklySchedule.monday.from.minute
integer
weeklySchedule.monday.to
object
wajib
Tampilkan parameter turunan
weeklySchedule.monday.to.hour
integer
wajib
weeklySchedule.monday.to.minute
integer
weeklySchedule.tuesday
object
Tampilkan parameter turunan
weeklySchedule.tuesday.from
object
wajib
Tampilkan parameter turunan
weeklySchedule.tuesday.from.hour
integer
wajib
weeklySchedule.tuesday.from.minute
integer
weeklySchedule.tuesday.to
object
wajib
Tampilkan parameter turunan
weeklySchedule.tuesday.to.hour
integer
wajib
weeklySchedule.tuesday.to.minute
integer
weeklySchedule.wednesday
object
Tampilkan parameter turunan
weeklySchedule.wednesday.from
object
wajib
Tampilkan parameter turunan
weeklySchedule.wednesday.from.hour
integer
wajib
weeklySchedule.wednesday.from.minute
integer
weeklySchedule.wednesday.to
object
wajib
Tampilkan parameter turunan
weeklySchedule.wednesday.to.hour
integer
wajib
weeklySchedule.wednesday.to.minute
integer
weeklySchedule.thursday
object
Tampilkan parameter turunan
weeklySchedule.thursday.from
object
wajib
Tampilkan parameter turunan
weeklySchedule.thursday.from.hour
integer
wajib
weeklySchedule.thursday.from.minute
integer
weeklySchedule.thursday.to
object
wajib
Tampilkan parameter turunan
weeklySchedule.thursday.to.hour
integer
wajib
weeklySchedule.thursday.to.minute
integer
weeklySchedule.friday
object
Tampilkan parameter turunan
weeklySchedule.friday.from
object
wajib
Tampilkan parameter turunan
weeklySchedule.friday.from.hour
integer
wajib
weeklySchedule.friday.from.minute
integer
weeklySchedule.friday.to
object
wajib
Tampilkan parameter turunan
weeklySchedule.friday.to.hour
integer
wajib
weeklySchedule.friday.to.minute
integer
weeklySchedule.saturday
object
Tampilkan parameter turunan
weeklySchedule.saturday.from
object
wajib
Tampilkan parameter turunan
weeklySchedule.saturday.from.hour
integer
wajib
weeklySchedule.saturday.from.minute
integer
weeklySchedule.saturday.to
object
wajib
Tampilkan parameter turunan
weeklySchedule.saturday.to.hour
integer
wajib
weeklySchedule.saturday.to.minute
integer
weeklySchedule.sunday
object
Tampilkan parameter turunan
weeklySchedule.sunday.from
object
wajib
Tampilkan parameter turunan
weeklySchedule.sunday.from.hour
integer
wajib
weeklySchedule.sunday.from.minute
integer
weeklySchedule.sunday.to
object
wajib
Tampilkan parameter turunan
weeklySchedule.sunday.to.hour
integer
wajib
weeklySchedule.sunday.to.minute
integer
holidays
array of object
Tampilkan parameter turunan
holidays.name
string
wajib
holidays.day
integer
wajib
holidays.month
integer
wajib
Payload respons
id
string
wajib
status
string
Possible values: active, away, out-of-office
statusBeforeOffline
string
Possible values: active, away, out-of-office
name
string
overrideName
boolean
workspaceId
string
wajib
type
string
Possible values: user, ai
userEmails
array of string
bio
string
avatarUrl
string
dropVms
array
Tampilkan atribut turunan
dropVms.name
string
dropVms.playback
object
wajib
Tampilkan atribut turunan
dropVms.playback.media
array of string
wajib
dropVms.playback.pauseMilliseconds
integer
tagCount
integer
wrapUpTime
integer
rootItemAssignedCount
integer
lastAssignedAt
string
lastSetToAwayAt
string
teams
array of object
Tampilkan atribut turunan
teams.id
string
The team's ID this agent belongs to.
teams.name
string
The name of the team this agent belongs to.
teams.memberSince
string
The timestamp of when this agent joined the team.
teams.activeMemberCount
integer
The number of active members in the team.
teams.pendingMemberCount
integer
The number of pending members in the team.
workload
object
Tampilkan atribut turunan
workload.id
string
workload.workload
object
Tampilkan atribut turunan
workload.workload.messaging
integer
workload.workload.email
integer
workload.rule
object
Tampilkan atribut turunan
workload.rule.id
string
wajib
workload.rule.workspaceId
string
wajib
workload.rule.name
string
wajib
workload.rule.description
string
wajib
workload.rule.default
boolean
workload.rule.capacity
object
wajib
Tampilkan atribut turunan
workload.rule.capacity.messaging
integer
workload.rule.capacity.email
integer
workload.rule.assignedAgentIds
array of string
workload.rule.createdAt
string
workload.rule.updatedAt
string
workload.ruleId
string
workload.updatedAt
string
createdAt
string
wajib
updatedAt
string
wajib
availability
object
Tampilkan atribut turunan
availability.status
string
Possible values: active, away, out-of-office
availability.activity
string
Possible values: available, in-call, busy, wrap-up-time, do-not-disturb, offline, not-available, out-of-hours, custom
availability.activityTtl
integer
availability.activityText
string
availability.lastStatusSet
string
availability.lastActivitySet
string
availability.updatedAt
string
timezone
string
defaultCountryCode
string
defaultCallerId
string
forwardNumber
object
Tampilkan atribut turunan
forwardNumber.enabled
boolean
forwardNumber.number
string
forwardNumber.maskCaller
boolean
transcriptionLocale
string
Curated set of BCP47 locale identifiers supported by Bird speech-to-text products
Possible values: ar-AE, ar-SA, cmn-CN, cy-GB, da-DK, de-CH, de-DE, el-GR, en-AU, en-GB, en-GB-WLS, en-IE, en-IN, en-NZ, en-US, en-ZA, es-ES, es-MX, es-US, fr-CA, fr-FR, he-IL, hi-IN, id-ID, is-IS, it-IT, ja-JP, ko-KR, ms-MY, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, ta-IN, te-IN, th-TH, tr-TR, vi-VN, zh-CN, zh-HK, zh-TW, arb, af-ZA, bn-IN, ca-ES, cmn-TW, cs-CZ, fi-FI, fil-PH, gu-IN, hu-HU, kn-IN, lt-LT, lv-LV, ml-IN, mr-IN, pa-IN, sk-SK, sr-RS, uk-UA, yue-HK, no-NO
roles
array of object
Tampilkan atribut turunan
roles.id
string
wajib
roles.type
string
wajib
Possible values: organization, managed
roles.workspaces
array of string
user
object
Tampilkan atribut turunan
user.id
string
ID of the user
user.name
string
The display name for the user
user.avatarUrl
string
URL to the user's profile picture.
user.defaultEmail
string
The default email of the user in the list of emails.
user.phoneNumber
string
weeklySchedule
object
Tampilkan atribut turunan
weeklySchedule.monday
object
Tampilkan atribut turunan
weeklySchedule.monday.from
object
wajib
Tampilkan atribut turunan
weeklySchedule.monday.from.hour
integer
wajib
weeklySchedule.monday.from.minute
integer
weeklySchedule.monday.to
object
wajib
Tampilkan atribut turunan
weeklySchedule.monday.to.hour
integer
wajib
weeklySchedule.monday.to.minute
integer
weeklySchedule.tuesday
object
Tampilkan atribut turunan
weeklySchedule.tuesday.from
object
wajib
Tampilkan atribut turunan
weeklySchedule.tuesday.from.hour
integer
wajib
weeklySchedule.tuesday.from.minute
integer
weeklySchedule.tuesday.to
object
wajib
Tampilkan atribut turunan
weeklySchedule.tuesday.to.hour
integer
wajib
weeklySchedule.tuesday.to.minute
integer
weeklySchedule.wednesday
object
Tampilkan atribut turunan
weeklySchedule.wednesday.from
object
wajib
Tampilkan atribut turunan
weeklySchedule.wednesday.from.hour
integer
wajib
weeklySchedule.wednesday.from.minute
integer
weeklySchedule.wednesday.to
object
wajib
Tampilkan atribut turunan
weeklySchedule.wednesday.to.hour
integer
wajib
weeklySchedule.wednesday.to.minute
integer
weeklySchedule.thursday
object
Tampilkan atribut turunan
weeklySchedule.thursday.from
object
wajib
Tampilkan atribut turunan
weeklySchedule.thursday.from.hour
integer
wajib
weeklySchedule.thursday.from.minute
integer
weeklySchedule.thursday.to
object
wajib
Tampilkan atribut turunan
weeklySchedule.thursday.to.hour
integer
wajib
weeklySchedule.thursday.to.minute
integer
weeklySchedule.friday
object
Tampilkan atribut turunan
weeklySchedule.friday.from
object
wajib
Tampilkan atribut turunan
weeklySchedule.friday.from.hour
integer
wajib
weeklySchedule.friday.from.minute
integer
weeklySchedule.friday.to
object
wajib
Tampilkan atribut turunan
weeklySchedule.friday.to.hour
integer
wajib
weeklySchedule.friday.to.minute
integer
weeklySchedule.saturday
object
Tampilkan atribut turunan
weeklySchedule.saturday.from
object
wajib
Tampilkan atribut turunan
weeklySchedule.saturday.from.hour
integer
wajib
weeklySchedule.saturday.from.minute
integer
weeklySchedule.saturday.to
object
wajib
Tampilkan atribut turunan
weeklySchedule.saturday.to.hour
integer
wajib
weeklySchedule.saturday.to.minute
integer
weeklySchedule.sunday
object
Tampilkan atribut turunan
weeklySchedule.sunday.from
object
wajib
Tampilkan atribut turunan
weeklySchedule.sunday.from.hour
integer
wajib
weeklySchedule.sunday.from.minute
integer
weeklySchedule.sunday.to
object
wajib
Tampilkan atribut turunan
weeklySchedule.sunday.to.hour
integer
wajib
weeklySchedule.sunday.to.minute
integer
holidays
array of object
Tampilkan atribut turunan
holidays.name
string
wajib
holidays.day
integer
wajib
holidays.month
integer
wajib
assignedSkills
array of object
Tampilkan atribut turunan
assignedSkills.id
string
wajib
assignedSkills.name
string
wajib
assignedSkills.selectedValues
array of object
wajib
Tampilkan atribut turunan
assignedSkills.selectedValues.icon
string
assignedSkills.selectedValues.id
string
wajib
assignedSkills.selectedValues.value
string
wajib
assignedSkills.valueType
string
wajib
AgentSkillValueType defines how can the Values of a Skill can be selected.
Possible values: single, multiple, boolean
defaultSenderId
string
The default Sender Profile to select for this agent when composing a new message.
outOfOfficeResponse
string
Contoh kode
curl -X POST 'https://api.bird.com/workspaces/{workspaceId}/agents' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
GET
/workspaces/{workspaceId}/all-agents
Lists all agents for a workspace returning only minimal fields for each agent.
Payload respons
results
array of object
wajib
Tampilkan atribut turunan
results.id
string
wajib
results.status
string
Possible values: active, away, out-of-office
results.activity
string
Possible values: available, in-call, busy, wrap-up-time, do-not-disturb, offline, not-available, out-of-hours, custom
results.name
string
results.avatarUrl
string
results.createdAt
string
wajib
Contoh kode
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/all-agents' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
GET
/workspaces/{workspaceId}/agents/{agentId}
Retrieve information about a specific agent, including their name, bio, status.
Payload respons
id
string
wajib
status
string
Possible values: active, away, out-of-office
statusBeforeOffline
string
Possible values: active, away, out-of-office
name
string
overrideName
boolean
workspaceId
string
wajib
type
string
Possible values: user, ai
userEmails
array of string
bio
string
avatarUrl
string
dropVms
array
Tampilkan atribut turunan
dropVms.name
string
dropVms.playback
object
wajib
Tampilkan atribut turunan
dropVms.playback.media
array of string
wajib
dropVms.playback.pauseMilliseconds
integer
tagCount
integer
wrapUpTime
integer
rootItemAssignedCount
integer
lastAssignedAt
string
lastSetToAwayAt
string
teams
array of object
Tampilkan atribut turunan
teams.id
string
The team's ID this agent belongs to.
teams.name
string
The name of the team this agent belongs to.
teams.memberSince
string
The timestamp of when this agent joined the team.
teams.activeMemberCount
integer
The number of active members in the team.
teams.pendingMemberCount
integer
The number of pending members in the team.
workload
object
Tampilkan atribut turunan
workload.id
string
workload.workload
object
Tampilkan atribut turunan
workload.workload.messaging
integer
workload.workload.email
integer
workload.rule
object
Tampilkan atribut turunan
workload.rule.id
string
wajib
workload.rule.workspaceId
string
wajib
workload.rule.name
string
wajib
workload.rule.description
string
wajib
workload.rule.default
boolean
workload.rule.capacity
object
wajib
Tampilkan atribut turunan
workload.rule.capacity.messaging
integer
workload.rule.capacity.email
integer
workload.rule.assignedAgentIds
array of string
workload.rule.createdAt
string
workload.rule.updatedAt
string
workload.ruleId
string
workload.updatedAt
string
createdAt
string
wajib
updatedAt
string
wajib
availability
object
Tampilkan atribut turunan
availability.status
string
Possible values: active, away, out-of-office
availability.activity
string
Possible values: available, in-call, busy, wrap-up-time, do-not-disturb, offline, not-available, out-of-hours, custom
availability.activityTtl
integer
availability.activityText
string
availability.lastStatusSet
string
availability.lastActivitySet
string
availability.updatedAt
string
timezone
string
defaultCountryCode
string
defaultCallerId
string
forwardNumber
object
Tampilkan atribut turunan
forwardNumber.enabled
boolean
forwardNumber.number
string
forwardNumber.maskCaller
boolean
transcriptionLocale
string
Curated set of BCP47 locale identifiers supported by Bird speech-to-text products
Possible values: ar-AE, ar-SA, cmn-CN, cy-GB, da-DK, de-CH, de-DE, el-GR, en-AU, en-GB, en-GB-WLS, en-IE, en-IN, en-NZ, en-US, en-ZA, es-ES, es-MX, es-US, fr-CA, fr-FR, he-IL, hi-IN, id-ID, is-IS, it-IT, ja-JP, ko-KR, ms-MY, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, ta-IN, te-IN, th-TH, tr-TR, vi-VN, zh-CN, zh-HK, zh-TW, arb, af-ZA, bn-IN, ca-ES, cmn-TW, cs-CZ, fi-FI, fil-PH, gu-IN, hu-HU, kn-IN, lt-LT, lv-LV, ml-IN, mr-IN, pa-IN, sk-SK, sr-RS, uk-UA, yue-HK, no-NO
roles
array of object
Tampilkan atribut turunan
roles.id
string
wajib
roles.type
string
wajib
Possible values: organization, managed
roles.workspaces
array of string
user
object
Tampilkan atribut turunan
user.id
string
ID of the user
user.name
string
The display name for the user
user.avatarUrl
string
URL to the user's profile picture.
user.defaultEmail
string
The default email of the user in the list of emails.
user.phoneNumber
string
weeklySchedule
object
Tampilkan atribut turunan
weeklySchedule.monday
object
Tampilkan atribut turunan
weeklySchedule.monday.from
object
wajib
Tampilkan atribut turunan
weeklySchedule.monday.from.hour
integer
wajib
weeklySchedule.monday.from.minute
integer
weeklySchedule.monday.to
object
wajib
Tampilkan atribut turunan
weeklySchedule.monday.to.hour
integer
wajib
weeklySchedule.monday.to.minute
integer
weeklySchedule.tuesday
object
Tampilkan atribut turunan
weeklySchedule.tuesday.from
object
wajib
Tampilkan atribut turunan
weeklySchedule.tuesday.from.hour
integer
wajib
weeklySchedule.tuesday.from.minute
integer
weeklySchedule.tuesday.to
object
wajib
Tampilkan atribut turunan
weeklySchedule.tuesday.to.hour
integer
wajib
weeklySchedule.tuesday.to.minute
integer
weeklySchedule.wednesday
object
Tampilkan atribut turunan
weeklySchedule.wednesday.from
object
wajib
Tampilkan atribut turunan
weeklySchedule.wednesday.from.hour
integer
wajib
weeklySchedule.wednesday.from.minute
integer
weeklySchedule.wednesday.to
object
wajib
Tampilkan atribut turunan
weeklySchedule.wednesday.to.hour
integer
wajib
weeklySchedule.wednesday.to.minute
integer
weeklySchedule.thursday
object
Tampilkan atribut turunan
weeklySchedule.thursday.from
object
wajib
Tampilkan atribut turunan
weeklySchedule.thursday.from.hour
integer
wajib
weeklySchedule.thursday.from.minute
integer
weeklySchedule.thursday.to
object
wajib
Tampilkan atribut turunan
weeklySchedule.thursday.to.hour
integer
wajib
weeklySchedule.thursday.to.minute
integer
weeklySchedule.friday
object
Tampilkan atribut turunan
weeklySchedule.friday.from
object
wajib
Tampilkan atribut turunan
weeklySchedule.friday.from.hour
integer
wajib
weeklySchedule.friday.from.minute
integer
weeklySchedule.friday.to
object
wajib
Tampilkan atribut turunan
weeklySchedule.friday.to.hour
integer
wajib
weeklySchedule.friday.to.minute
integer
weeklySchedule.saturday
object
Tampilkan atribut turunan
weeklySchedule.saturday.from
object
wajib
Tampilkan atribut turunan
weeklySchedule.saturday.from.hour
integer
wajib
weeklySchedule.saturday.from.minute
integer
weeklySchedule.saturday.to
object
wajib
Tampilkan atribut turunan
weeklySchedule.saturday.to.hour
integer
wajib
weeklySchedule.saturday.to.minute
integer
weeklySchedule.sunday
object
Tampilkan atribut turunan
weeklySchedule.sunday.from
object
wajib
Tampilkan atribut turunan
weeklySchedule.sunday.from.hour
integer
wajib
weeklySchedule.sunday.from.minute
integer
weeklySchedule.sunday.to
object
wajib
Tampilkan atribut turunan
weeklySchedule.sunday.to.hour
integer
wajib
weeklySchedule.sunday.to.minute
integer
holidays
array of object
Tampilkan atribut turunan
holidays.name
string
wajib
holidays.day
integer
wajib
holidays.month
integer
wajib
assignedSkills
array of object
Tampilkan atribut turunan
assignedSkills.id
string
wajib
assignedSkills.name
string
wajib
assignedSkills.selectedValues
array of object
wajib
Tampilkan atribut turunan
assignedSkills.selectedValues.icon
string
assignedSkills.selectedValues.id
string
wajib
assignedSkills.selectedValues.value
string
wajib
assignedSkills.valueType
string
wajib
AgentSkillValueType defines how can the Values of a Skill can be selected.
Possible values: single, multiple, boolean
defaultSenderId
string
The default Sender Profile to select for this agent when composing a new message.
outOfOfficeResponse
string
Contoh kode
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/agents/{agentId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
GET
/workspaces/{workspaceId}/agents/{agentId}/presigned-upload
Retrieve the url and form data to post profile avatar directly.
Payload respons
mediaUrl
string
URL to download the media from
fileId
string
File ID
url
string
wajib
URL to post the image to
formData
object
wajib
expectedFields
array of string
Contoh kode
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/agents/{agentId}/presigned-upload' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
POST
/workspaces/{workspaceId}/agents/{agentId}/presigned-upload/audio
Retrieve the url and form data to post audio files directly.
Payload respons
mediaUrl
string
URL to download the media from
fileId
string
File ID
url
string
wajib
URL to post the image to
formData
object
wajib
expectedFields
array of string
Contoh kode
curl -X POST 'https://api.bird.com/workspaces/{workspaceId}/agents/{agentId}/presigned-upload/audio' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
GET
/workspaces/{workspaceId}/agents/{agentId}/media/{fileId}/download
Get media download from an agent
Contoh kode
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/agents/{agentId}/media/{fileId}/download' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
PATCH
/workspaces/{workspaceId}/agents/{agentId}
Modify the details of a specific agent, such as their name, bio, status.
Payload permintaan
name
string
bio
string
status
string
Possible values: active, away, out-of-office
avatarUrl
string
dropVms
array
Tampilkan parameter turunan
dropVms.name
string
dropVms.playback
object
wajib
Tampilkan parameter turunan
dropVms.playback.media
array of string
wajib
dropVms.playback.pauseMilliseconds
integer
wrapUpTime
integer
timezone
string
defaultCountryCode
string
defaultCallerId
string
forwardNumber
object
Tampilkan parameter turunan
forwardNumber.enabled
boolean
forwardNumber.number
string
forwardNumber.maskCaller
boolean
transcriptionLocale
string
Curated set of BCP47 locale identifiers supported by Bird speech-to-text products
Possible values: ar-AE, ar-SA, cmn-CN, cy-GB, da-DK, de-CH, de-DE, el-GR, en-AU, en-GB, en-GB-WLS, en-IE, en-IN, en-NZ, en-US, en-ZA, es-ES, es-MX, es-US, fr-CA, fr-FR, he-IL, hi-IN, id-ID, is-IS, it-IT, ja-JP, ko-KR, ms-MY, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, ta-IN, te-IN, th-TH, tr-TR, vi-VN, zh-CN, zh-HK, zh-TW, arb, af-ZA, bn-IN, ca-ES, cmn-TW, cs-CZ, fi-FI, fil-PH, gu-IN, hu-HU, kn-IN, lt-LT, lv-LV, ml-IN, mr-IN, pa-IN, sk-SK, sr-RS, uk-UA, yue-HK, no-NO
weeklySchedule
object
Tampilkan parameter turunan
weeklySchedule.monday
object
Tampilkan parameter turunan
weeklySchedule.monday.from
object
wajib
Tampilkan parameter turunan
weeklySchedule.monday.from.hour
integer
wajib
weeklySchedule.monday.from.minute
integer
weeklySchedule.monday.to
object
wajib
Tampilkan parameter turunan
weeklySchedule.monday.to.hour
integer
wajib
weeklySchedule.monday.to.minute
integer
weeklySchedule.tuesday
object
Tampilkan parameter turunan
weeklySchedule.tuesday.from
object
wajib
Tampilkan parameter turunan
weeklySchedule.tuesday.from.hour
integer
wajib
weeklySchedule.tuesday.from.minute
integer
weeklySchedule.tuesday.to
object
wajib
Tampilkan parameter turunan
weeklySchedule.tuesday.to.hour
integer
wajib
weeklySchedule.tuesday.to.minute
integer
weeklySchedule.wednesday
object
Tampilkan parameter turunan
weeklySchedule.wednesday.from
object
wajib
Tampilkan parameter turunan
weeklySchedule.wednesday.from.hour
integer
wajib
weeklySchedule.wednesday.from.minute
integer
weeklySchedule.wednesday.to
object
wajib
Tampilkan parameter turunan
weeklySchedule.wednesday.to.hour
integer
wajib
weeklySchedule.wednesday.to.minute
integer
weeklySchedule.thursday
object
Tampilkan parameter turunan
weeklySchedule.thursday.from
object
wajib
Tampilkan parameter turunan
weeklySchedule.thursday.from.hour
integer
wajib
weeklySchedule.thursday.from.minute
integer
weeklySchedule.thursday.to
object
wajib
Tampilkan parameter turunan
weeklySchedule.thursday.to.hour
integer
wajib
weeklySchedule.thursday.to.minute
integer
weeklySchedule.friday
object
Tampilkan parameter turunan
weeklySchedule.friday.from
object
wajib
Tampilkan parameter turunan
weeklySchedule.friday.from.hour
integer
wajib
weeklySchedule.friday.from.minute
integer
weeklySchedule.friday.to
object
wajib
Tampilkan parameter turunan
weeklySchedule.friday.to.hour
integer
wajib
weeklySchedule.friday.to.minute
integer
weeklySchedule.saturday
object
Tampilkan parameter turunan
weeklySchedule.saturday.from
object
wajib
Tampilkan parameter turunan
weeklySchedule.saturday.from.hour
integer
wajib
weeklySchedule.saturday.from.minute
integer
weeklySchedule.saturday.to
object
wajib
Tampilkan parameter turunan
weeklySchedule.saturday.to.hour
integer
wajib
weeklySchedule.saturday.to.minute
integer
weeklySchedule.sunday
object
Tampilkan parameter turunan
weeklySchedule.sunday.from
object
wajib
Tampilkan parameter turunan
weeklySchedule.sunday.from.hour
integer
wajib
weeklySchedule.sunday.from.minute
integer
weeklySchedule.sunday.to
object
wajib
Tampilkan parameter turunan
weeklySchedule.sunday.to.hour
integer
wajib
weeklySchedule.sunday.to.minute
integer
holidays
array of object
Tampilkan parameter turunan
holidays.name
string
wajib
holidays.day
integer
wajib
holidays.month
integer
wajib
assignedSkills
array of object
Tampilkan parameter turunan
assignedSkills.id
string
wajib
assignedSkills.name
string
wajib
assignedSkills.selectedValues
array of object
wajib
Tampilkan parameter turunan
assignedSkills.selectedValues.icon
string
assignedSkills.selectedValues.id
string
wajib
assignedSkills.selectedValues.value
string
wajib
assignedSkills.valueType
string
wajib
AgentSkillValueType defines how can the Values of a Skill can be selected.
Possible values: single, multiple, boolean
defaultSenderId
string
The default Sender Profile to select for this agent when composing a new message.
outOfOfficeResponse
string
Payload respons
id
string
wajib
status
string
Possible values: active, away, out-of-office
statusBeforeOffline
string
Possible values: active, away, out-of-office
name
string
overrideName
boolean
workspaceId
string
wajib
type
string
Possible values: user, ai
userEmails
array of string
bio
string
avatarUrl
string
dropVms
array
Tampilkan atribut turunan
dropVms.name
string
dropVms.playback
object
wajib
Tampilkan atribut turunan
dropVms.playback.media
array of string
wajib
dropVms.playback.pauseMilliseconds
integer
tagCount
integer
wrapUpTime
integer
rootItemAssignedCount
integer
lastAssignedAt
string
lastSetToAwayAt
string
teams
array of object
Tampilkan atribut turunan
teams.id
string
The team's ID this agent belongs to.
teams.name
string
The name of the team this agent belongs to.
teams.memberSince
string
The timestamp of when this agent joined the team.
teams.activeMemberCount
integer
The number of active members in the team.
teams.pendingMemberCount
integer
The number of pending members in the team.
workload
object
Tampilkan atribut turunan
workload.id
string
workload.workload
object
Tampilkan atribut turunan
workload.workload.messaging
integer
workload.workload.email
integer
workload.rule
object
Tampilkan atribut turunan
workload.rule.id
string
wajib
workload.rule.workspaceId
string
wajib
workload.rule.name
string
wajib
workload.rule.description
string
wajib
workload.rule.default
boolean
workload.rule.capacity
object
wajib
Tampilkan atribut turunan
workload.rule.capacity.messaging
integer
workload.rule.capacity.email
integer
workload.rule.assignedAgentIds
array of string
workload.rule.createdAt
string
workload.rule.updatedAt
string
workload.ruleId
string
workload.updatedAt
string
createdAt
string
wajib
updatedAt
string
wajib
availability
object
Tampilkan atribut turunan
availability.status
string
Possible values: active, away, out-of-office
availability.activity
string
Possible values: available, in-call, busy, wrap-up-time, do-not-disturb, offline, not-available, out-of-hours, custom
availability.activityTtl
integer
availability.activityText
string
availability.lastStatusSet
string
availability.lastActivitySet
string
availability.updatedAt
string
timezone
string
defaultCountryCode
string
defaultCallerId
string
forwardNumber
object
Tampilkan atribut turunan
forwardNumber.enabled
boolean
forwardNumber.number
string
forwardNumber.maskCaller
boolean
transcriptionLocale
string
Curated set of BCP47 locale identifiers supported by Bird speech-to-text products
Possible values: ar-AE, ar-SA, cmn-CN, cy-GB, da-DK, de-CH, de-DE, el-GR, en-AU, en-GB, en-GB-WLS, en-IE, en-IN, en-NZ, en-US, en-ZA, es-ES, es-MX, es-US, fr-CA, fr-FR, he-IL, hi-IN, id-ID, is-IS, it-IT, ja-JP, ko-KR, ms-MY, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, ta-IN, te-IN, th-TH, tr-TR, vi-VN, zh-CN, zh-HK, zh-TW, arb, af-ZA, bn-IN, ca-ES, cmn-TW, cs-CZ, fi-FI, fil-PH, gu-IN, hu-HU, kn-IN, lt-LT, lv-LV, ml-IN, mr-IN, pa-IN, sk-SK, sr-RS, uk-UA, yue-HK, no-NO
roles
array of object
Tampilkan atribut turunan
roles.id
string
wajib
roles.type
string
wajib
Possible values: organization, managed
roles.workspaces
array of string
user
object
Tampilkan atribut turunan
user.id
string
ID of the user
user.name
string
The display name for the user
user.avatarUrl
string
URL to the user's profile picture.
user.defaultEmail
string
The default email of the user in the list of emails.
user.phoneNumber
string
weeklySchedule
object
Tampilkan atribut turunan
weeklySchedule.monday
object
Tampilkan atribut turunan
weeklySchedule.monday.from
object
wajib
Tampilkan atribut turunan
weeklySchedule.monday.from.hour
integer
wajib
weeklySchedule.monday.from.minute
integer
weeklySchedule.monday.to
object
wajib
Tampilkan atribut turunan
weeklySchedule.monday.to.hour
integer
wajib
weeklySchedule.monday.to.minute
integer
weeklySchedule.tuesday
object
Tampilkan atribut turunan
weeklySchedule.tuesday.from
object
wajib
Tampilkan atribut turunan
weeklySchedule.tuesday.from.hour
integer
wajib
weeklySchedule.tuesday.from.minute
integer
weeklySchedule.tuesday.to
object
wajib
Tampilkan atribut turunan
weeklySchedule.tuesday.to.hour
integer
wajib
weeklySchedule.tuesday.to.minute
integer
weeklySchedule.wednesday
object
Tampilkan atribut turunan
weeklySchedule.wednesday.from
object
wajib
Tampilkan atribut turunan
weeklySchedule.wednesday.from.hour
integer
wajib
weeklySchedule.wednesday.from.minute
integer
weeklySchedule.wednesday.to
object
wajib
Tampilkan atribut turunan
weeklySchedule.wednesday.to.hour
integer
wajib
weeklySchedule.wednesday.to.minute
integer
weeklySchedule.thursday
object
Tampilkan atribut turunan
weeklySchedule.thursday.from
object
wajib
Tampilkan atribut turunan
weeklySchedule.thursday.from.hour
integer
wajib
weeklySchedule.thursday.from.minute
integer
weeklySchedule.thursday.to
object
wajib
Tampilkan atribut turunan
weeklySchedule.thursday.to.hour
integer
wajib
weeklySchedule.thursday.to.minute
integer
weeklySchedule.friday
object
Tampilkan atribut turunan
weeklySchedule.friday.from
object
wajib
Tampilkan atribut turunan
weeklySchedule.friday.from.hour
integer
wajib
weeklySchedule.friday.from.minute
integer
weeklySchedule.friday.to
object
wajib
Tampilkan atribut turunan
weeklySchedule.friday.to.hour
integer
wajib
weeklySchedule.friday.to.minute
integer
weeklySchedule.saturday
object
Tampilkan atribut turunan
weeklySchedule.saturday.from
object
wajib
Tampilkan atribut turunan
weeklySchedule.saturday.from.hour
integer
wajib
weeklySchedule.saturday.from.minute
integer
weeklySchedule.saturday.to
object
wajib
Tampilkan atribut turunan
weeklySchedule.saturday.to.hour
integer
wajib
weeklySchedule.saturday.to.minute
integer
weeklySchedule.sunday
object
Tampilkan atribut turunan
weeklySchedule.sunday.from
object
wajib
Tampilkan atribut turunan
weeklySchedule.sunday.from.hour
integer
wajib
weeklySchedule.sunday.from.minute
integer
weeklySchedule.sunday.to
object
wajib
Tampilkan atribut turunan
weeklySchedule.sunday.to.hour
integer
wajib
weeklySchedule.sunday.to.minute
integer
holidays
array of object
Tampilkan atribut turunan
holidays.name
string
wajib
holidays.day
integer
wajib
holidays.month
integer
wajib
assignedSkills
array of object
Tampilkan atribut turunan
assignedSkills.id
string
wajib
assignedSkills.name
string
wajib
assignedSkills.selectedValues
array of object
wajib
Tampilkan atribut turunan
assignedSkills.selectedValues.icon
string
assignedSkills.selectedValues.id
string
wajib
assignedSkills.selectedValues.value
string
wajib
assignedSkills.valueType
string
wajib
AgentSkillValueType defines how can the Values of a Skill can be selected.
Possible values: single, multiple, boolean
defaultSenderId
string
The default Sender Profile to select for this agent when composing a new message.
outOfOfficeResponse
string
Contoh kode
curl -X PATCH 'https://api.bird.com/workspaces/{workspaceId}/agents/{agentId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
DELETE
/workspaces/{workspaceId}/agents/{agentId}
Remove a specific agent from the system, permanently deleting their profile and associated data.
Contoh kode
curl -X DELETE 'https://api.bird.com/workspaces/{workspaceId}/agents/{agentId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
GET
/workspaces/{workspaceId}/agents/me
Retrieve information about a specific agent, including their name, bio, status.
Payload respons
id
string
wajib
status
string
Possible values: active, away, out-of-office
statusBeforeOffline
string
Possible values: active, away, out-of-office
name
string
overrideName
boolean
workspaceId
string
wajib
type
string
Possible values: user, ai
userEmails
array of string
bio
string
avatarUrl
string
dropVms
array
Tampilkan atribut turunan
dropVms.name
string
dropVms.playback
object
wajib
Tampilkan atribut turunan
dropVms.playback.media
array of string
wajib
dropVms.playback.pauseMilliseconds
integer
tagCount
integer
wrapUpTime
integer
rootItemAssignedCount
integer
lastAssignedAt
string
lastSetToAwayAt
string
teams
array of object
Tampilkan atribut turunan
teams.id
string
The team's ID this agent belongs to.
teams.name
string
The name of the team this agent belongs to.
teams.memberSince
string
The timestamp of when this agent joined the team.
teams.activeMemberCount
integer
The number of active members in the team.
teams.pendingMemberCount
integer
The number of pending members in the team.
workload
object
Tampilkan atribut turunan
workload.id
string
workload.workload
object
Tampilkan atribut turunan
workload.workload.messaging
integer
workload.workload.email
integer
workload.rule
object
Tampilkan atribut turunan
workload.rule.id
string
wajib
workload.rule.workspaceId
string
wajib
workload.rule.name
string
wajib
workload.rule.description
string
wajib
workload.rule.default
boolean
workload.rule.capacity
object
wajib
Tampilkan atribut turunan
workload.rule.capacity.messaging
integer
workload.rule.capacity.email
integer
workload.rule.assignedAgentIds
array of string
workload.rule.createdAt
string
workload.rule.updatedAt
string
workload.ruleId
string
workload.updatedAt
string
createdAt
string
wajib
updatedAt
string
wajib
availability
object
Tampilkan atribut turunan
availability.status
string
Possible values: active, away, out-of-office
availability.activity
string
Possible values: available, in-call, busy, wrap-up-time, do-not-disturb, offline, not-available, out-of-hours, custom
availability.activityTtl
integer
availability.activityText
string
availability.lastStatusSet
string
availability.lastActivitySet
string
availability.updatedAt
string
timezone
string
defaultCountryCode
string
defaultCallerId
string
forwardNumber
object
Tampilkan atribut turunan
forwardNumber.enabled
boolean
forwardNumber.number
string
forwardNumber.maskCaller
boolean
transcriptionLocale
string
Curated set of BCP47 locale identifiers supported by Bird speech-to-text products
Possible values: ar-AE, ar-SA, cmn-CN, cy-GB, da-DK, de-CH, de-DE, el-GR, en-AU, en-GB, en-GB-WLS, en-IE, en-IN, en-NZ, en-US, en-ZA, es-ES, es-MX, es-US, fr-CA, fr-FR, he-IL, hi-IN, id-ID, is-IS, it-IT, ja-JP, ko-KR, ms-MY, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, ta-IN, te-IN, th-TH, tr-TR, vi-VN, zh-CN, zh-HK, zh-TW, arb, af-ZA, bn-IN, ca-ES, cmn-TW, cs-CZ, fi-FI, fil-PH, gu-IN, hu-HU, kn-IN, lt-LT, lv-LV, ml-IN, mr-IN, pa-IN, sk-SK, sr-RS, uk-UA, yue-HK, no-NO
roles
array of object
Tampilkan atribut turunan
roles.id
string
wajib
roles.type
string
wajib
Possible values: organization, managed
roles.workspaces
array of string
user
object
Tampilkan atribut turunan
user.id
string
ID of the user
user.name
string
The display name for the user
user.avatarUrl
string
URL to the user's profile picture.
user.defaultEmail
string
The default email of the user in the list of emails.
user.phoneNumber
string
weeklySchedule
object
Tampilkan atribut turunan
weeklySchedule.monday
object
Tampilkan atribut turunan
weeklySchedule.monday.from
object
wajib
Tampilkan atribut turunan
weeklySchedule.monday.from.hour
integer
wajib
weeklySchedule.monday.from.minute
integer
weeklySchedule.monday.to
object
wajib
Tampilkan atribut turunan
weeklySchedule.monday.to.hour
integer
wajib
weeklySchedule.monday.to.minute
integer
weeklySchedule.tuesday
object
Tampilkan atribut turunan
weeklySchedule.tuesday.from
object
wajib
Tampilkan atribut turunan
weeklySchedule.tuesday.from.hour
integer
wajib
weeklySchedule.tuesday.from.minute
integer
weeklySchedule.tuesday.to
object
wajib
Tampilkan atribut turunan
weeklySchedule.tuesday.to.hour
integer
wajib
weeklySchedule.tuesday.to.minute
integer
weeklySchedule.wednesday
object
Tampilkan atribut turunan
weeklySchedule.wednesday.from
object
wajib
Tampilkan atribut turunan
weeklySchedule.wednesday.from.hour
integer
wajib
weeklySchedule.wednesday.from.minute
integer
weeklySchedule.wednesday.to
object
wajib
Tampilkan atribut turunan
weeklySchedule.wednesday.to.hour
integer
wajib
weeklySchedule.wednesday.to.minute
integer
weeklySchedule.thursday
object
Tampilkan atribut turunan
weeklySchedule.thursday.from
object
wajib
Tampilkan atribut turunan
weeklySchedule.thursday.from.hour
integer
wajib
weeklySchedule.thursday.from.minute
integer
weeklySchedule.thursday.to
object
wajib
Tampilkan atribut turunan
weeklySchedule.thursday.to.hour
integer
wajib
weeklySchedule.thursday.to.minute
integer
weeklySchedule.friday
object
Tampilkan atribut turunan
weeklySchedule.friday.from
object
wajib
Tampilkan atribut turunan
weeklySchedule.friday.from.hour
integer
wajib
weeklySchedule.friday.from.minute
integer
weeklySchedule.friday.to
object
wajib
Tampilkan atribut turunan
weeklySchedule.friday.to.hour
integer
wajib
weeklySchedule.friday.to.minute
integer
weeklySchedule.saturday
object
Tampilkan atribut turunan
weeklySchedule.saturday.from
object
wajib
Tampilkan atribut turunan
weeklySchedule.saturday.from.hour
integer
wajib
weeklySchedule.saturday.from.minute
integer
weeklySchedule.saturday.to
object
wajib
Tampilkan atribut turunan
weeklySchedule.saturday.to.hour
integer
wajib
weeklySchedule.saturday.to.minute
integer
weeklySchedule.sunday
object
Tampilkan atribut turunan
weeklySchedule.sunday.from
object
wajib
Tampilkan atribut turunan
weeklySchedule.sunday.from.hour
integer
wajib
weeklySchedule.sunday.from.minute
integer
weeklySchedule.sunday.to
object
wajib
Tampilkan atribut turunan
weeklySchedule.sunday.to.hour
integer
wajib
weeklySchedule.sunday.to.minute
integer
holidays
array of object
Tampilkan atribut turunan
holidays.name
string
wajib
holidays.day
integer
wajib
holidays.month
integer
wajib
assignedSkills
array of object
Tampilkan atribut turunan
assignedSkills.id
string
wajib
assignedSkills.name
string
wajib
assignedSkills.selectedValues
array of object
wajib
Tampilkan atribut turunan
assignedSkills.selectedValues.icon
string
assignedSkills.selectedValues.id
string
wajib
assignedSkills.selectedValues.value
string
wajib
assignedSkills.valueType
string
wajib
AgentSkillValueType defines how can the Values of a Skill can be selected.
Possible values: single, multiple, boolean
defaultSenderId
string
The default Sender Profile to select for this agent when composing a new message.
outOfOfficeResponse
string
Contoh kode
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/agents/me' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
PATCH
/workspaces/{workspaceId}/agents/me
Modify the details of a specific agent, such as their name, bio, status.
Payload permintaan
name
string
bio
string
status
string
Possible values: active, away, out-of-office
avatarUrl
string
dropVms
array
Tampilkan parameter turunan
dropVms.name
string
dropVms.playback
object
wajib
Tampilkan parameter turunan
dropVms.playback.media
array of string
wajib
dropVms.playback.pauseMilliseconds
integer
wrapUpTime
integer
timezone
string
defaultCountryCode
string
defaultCallerId
string
forwardNumber
object
Tampilkan parameter turunan
forwardNumber.enabled
boolean
forwardNumber.number
string
forwardNumber.maskCaller
boolean
transcriptionLocale
string
Curated set of BCP47 locale identifiers supported by Bird speech-to-text products
Possible values: ar-AE, ar-SA, cmn-CN, cy-GB, da-DK, de-CH, de-DE, el-GR, en-AU, en-GB, en-GB-WLS, en-IE, en-IN, en-NZ, en-US, en-ZA, es-ES, es-MX, es-US, fr-CA, fr-FR, he-IL, hi-IN, id-ID, is-IS, it-IT, ja-JP, ko-KR, ms-MY, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, ta-IN, te-IN, th-TH, tr-TR, vi-VN, zh-CN, zh-HK, zh-TW, arb, af-ZA, bn-IN, ca-ES, cmn-TW, cs-CZ, fi-FI, fil-PH, gu-IN, hu-HU, kn-IN, lt-LT, lv-LV, ml-IN, mr-IN, pa-IN, sk-SK, sr-RS, uk-UA, yue-HK, no-NO
weeklySchedule
object
Tampilkan parameter turunan
weeklySchedule.monday
object
Tampilkan parameter turunan
weeklySchedule.monday.from
object
wajib
Tampilkan parameter turunan
weeklySchedule.monday.from.hour
integer
wajib
weeklySchedule.monday.from.minute
integer
weeklySchedule.monday.to
object
wajib
Tampilkan parameter turunan
weeklySchedule.monday.to.hour
integer
wajib
weeklySchedule.monday.to.minute
integer
weeklySchedule.tuesday
object
Tampilkan parameter turunan
weeklySchedule.tuesday.from
object
wajib
Tampilkan parameter turunan
weeklySchedule.tuesday.from.hour
integer
wajib
weeklySchedule.tuesday.from.minute
integer
weeklySchedule.tuesday.to
object
wajib
Tampilkan parameter turunan
weeklySchedule.tuesday.to.hour
integer
wajib
weeklySchedule.tuesday.to.minute
integer
weeklySchedule.wednesday
object
Tampilkan parameter turunan
weeklySchedule.wednesday.from
object
wajib
Tampilkan parameter turunan
weeklySchedule.wednesday.from.hour
integer
wajib
weeklySchedule.wednesday.from.minute
integer
weeklySchedule.wednesday.to
object
wajib
Tampilkan parameter turunan
weeklySchedule.wednesday.to.hour
integer
wajib
weeklySchedule.wednesday.to.minute
integer
weeklySchedule.thursday
object
Tampilkan parameter turunan
weeklySchedule.thursday.from
object
wajib
Tampilkan parameter turunan
weeklySchedule.thursday.from.hour
integer
wajib
weeklySchedule.thursday.from.minute
integer
weeklySchedule.thursday.to
object
wajib
Tampilkan parameter turunan
weeklySchedule.thursday.to.hour
integer
wajib
weeklySchedule.thursday.to.minute
integer
weeklySchedule.friday
object
Tampilkan parameter turunan
weeklySchedule.friday.from
object
wajib
Tampilkan parameter turunan
weeklySchedule.friday.from.hour
integer
wajib
weeklySchedule.friday.from.minute
integer
weeklySchedule.friday.to
object
wajib
Tampilkan parameter turunan
weeklySchedule.friday.to.hour
integer
wajib
weeklySchedule.friday.to.minute
integer
weeklySchedule.saturday
object
Tampilkan parameter turunan
weeklySchedule.saturday.from
object
wajib
Tampilkan parameter turunan
weeklySchedule.saturday.from.hour
integer
wajib
weeklySchedule.saturday.from.minute
integer
weeklySchedule.saturday.to
object
wajib
Tampilkan parameter turunan
weeklySchedule.saturday.to.hour
integer
wajib
weeklySchedule.saturday.to.minute
integer
weeklySchedule.sunday
object
Tampilkan parameter turunan
weeklySchedule.sunday.from
object
wajib
Tampilkan parameter turunan
weeklySchedule.sunday.from.hour
integer
wajib
weeklySchedule.sunday.from.minute
integer
weeklySchedule.sunday.to
object
wajib
Tampilkan parameter turunan
weeklySchedule.sunday.to.hour
integer
wajib
weeklySchedule.sunday.to.minute
integer
holidays
array of object
Tampilkan parameter turunan
holidays.name
string
wajib
holidays.day
integer
wajib
holidays.month
integer
wajib
assignedSkills
array of object
Tampilkan parameter turunan
assignedSkills.id
string
wajib
assignedSkills.name
string
wajib
assignedSkills.selectedValues
array of object
wajib
Tampilkan parameter turunan
assignedSkills.selectedValues.icon
string
assignedSkills.selectedValues.id
string
wajib
assignedSkills.selectedValues.value
string
wajib
assignedSkills.valueType
string
wajib
AgentSkillValueType defines how can the Values of a Skill can be selected.
Possible values: single, multiple, boolean
defaultSenderId
string
The default Sender Profile to select for this agent when composing a new message.
outOfOfficeResponse
string
Payload respons
id
string
wajib
status
string
Possible values: active, away, out-of-office
statusBeforeOffline
string
Possible values: active, away, out-of-office
name
string
overrideName
boolean
workspaceId
string
wajib
type
string
Possible values: user, ai
userEmails
array of string
bio
string
avatarUrl
string
dropVms
array
Tampilkan atribut turunan
dropVms.name
string
dropVms.playback
object
wajib
Tampilkan atribut turunan
dropVms.playback.media
array of string
wajib
dropVms.playback.pauseMilliseconds
integer
tagCount
integer
wrapUpTime
integer
rootItemAssignedCount
integer
lastAssignedAt
string
lastSetToAwayAt
string
teams
array of object
Tampilkan atribut turunan
teams.id
string
The team's ID this agent belongs to.
teams.name
string
The name of the team this agent belongs to.
teams.memberSince
string
The timestamp of when this agent joined the team.
teams.activeMemberCount
integer
The number of active members in the team.
teams.pendingMemberCount
integer
The number of pending members in the team.
workload
object
Tampilkan atribut turunan
workload.id
string
workload.workload
object
Tampilkan atribut turunan
workload.workload.messaging
integer
workload.workload.email
integer
workload.rule
object
Tampilkan atribut turunan
workload.rule.id
string
wajib
workload.rule.workspaceId
string
wajib
workload.rule.name
string
wajib
workload.rule.description
string
wajib
workload.rule.default
boolean
workload.rule.capacity
object
wajib
Tampilkan atribut turunan
workload.rule.capacity.messaging
integer
workload.rule.capacity.email
integer
workload.rule.assignedAgentIds
array of string
workload.rule.createdAt
string
workload.rule.updatedAt
string
workload.ruleId
string
workload.updatedAt
string
createdAt
string
wajib
updatedAt
string
wajib
availability
object
Tampilkan atribut turunan
availability.status
string
Possible values: active, away, out-of-office
availability.activity
string
Possible values: available, in-call, busy, wrap-up-time, do-not-disturb, offline, not-available, out-of-hours, custom
availability.activityTtl
integer
availability.activityText
string
availability.lastStatusSet
string
availability.lastActivitySet
string
availability.updatedAt
string
timezone
string
defaultCountryCode
string
defaultCallerId
string
forwardNumber
object
Tampilkan atribut turunan
forwardNumber.enabled
boolean
forwardNumber.number
string
forwardNumber.maskCaller
boolean
transcriptionLocale
string
Curated set of BCP47 locale identifiers supported by Bird speech-to-text products
Possible values: ar-AE, ar-SA, cmn-CN, cy-GB, da-DK, de-CH, de-DE, el-GR, en-AU, en-GB, en-GB-WLS, en-IE, en-IN, en-NZ, en-US, en-ZA, es-ES, es-MX, es-US, fr-CA, fr-FR, he-IL, hi-IN, id-ID, is-IS, it-IT, ja-JP, ko-KR, ms-MY, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, ta-IN, te-IN, th-TH, tr-TR, vi-VN, zh-CN, zh-HK, zh-TW, arb, af-ZA, bn-IN, ca-ES, cmn-TW, cs-CZ, fi-FI, fil-PH, gu-IN, hu-HU, kn-IN, lt-LT, lv-LV, ml-IN, mr-IN, pa-IN, sk-SK, sr-RS, uk-UA, yue-HK, no-NO
roles
array of object
Tampilkan atribut turunan
roles.id
string
wajib
roles.type
string
wajib
Possible values: organization, managed
roles.workspaces
array of string
user
object
Tampilkan atribut turunan
user.id
string
ID of the user
user.name
string
The display name for the user
user.avatarUrl
string
URL to the user's profile picture.
user.defaultEmail
string
The default email of the user in the list of emails.
user.phoneNumber
string
weeklySchedule
object
Tampilkan atribut turunan
weeklySchedule.monday
object
Tampilkan atribut turunan
weeklySchedule.monday.from
object
wajib
Tampilkan atribut turunan
weeklySchedule.monday.from.hour
integer
wajib
weeklySchedule.monday.from.minute
integer
weeklySchedule.monday.to
object
wajib
Tampilkan atribut turunan
weeklySchedule.monday.to.hour
integer
wajib
weeklySchedule.monday.to.minute
integer
weeklySchedule.tuesday
object
Tampilkan atribut turunan
weeklySchedule.tuesday.from
object
wajib
Tampilkan atribut turunan
weeklySchedule.tuesday.from.hour
integer
wajib
weeklySchedule.tuesday.from.minute
integer
weeklySchedule.tuesday.to
object
wajib
Tampilkan atribut turunan
weeklySchedule.tuesday.to.hour
integer
wajib
weeklySchedule.tuesday.to.minute
integer
weeklySchedule.wednesday
object
Tampilkan atribut turunan
weeklySchedule.wednesday.from
object
wajib
Tampilkan atribut turunan
weeklySchedule.wednesday.from.hour
integer
wajib
weeklySchedule.wednesday.from.minute
integer
weeklySchedule.wednesday.to
object
wajib
Tampilkan atribut turunan
weeklySchedule.wednesday.to.hour
integer
wajib
weeklySchedule.wednesday.to.minute
integer
weeklySchedule.thursday
object
Tampilkan atribut turunan
weeklySchedule.thursday.from
object
wajib
Tampilkan atribut turunan
weeklySchedule.thursday.from.hour
integer
wajib
weeklySchedule.thursday.from.minute
integer
weeklySchedule.thursday.to
object
wajib
Tampilkan atribut turunan
weeklySchedule.thursday.to.hour
integer
wajib
weeklySchedule.thursday.to.minute
integer
weeklySchedule.friday
object
Tampilkan atribut turunan
weeklySchedule.friday.from
object
wajib
Tampilkan atribut turunan
weeklySchedule.friday.from.hour
integer
wajib
weeklySchedule.friday.from.minute
integer
weeklySchedule.friday.to
object
wajib
Tampilkan atribut turunan
weeklySchedule.friday.to.hour
integer
wajib
weeklySchedule.friday.to.minute
integer
weeklySchedule.saturday
object
Tampilkan atribut turunan
weeklySchedule.saturday.from
object
wajib
Tampilkan atribut turunan
weeklySchedule.saturday.from.hour
integer
wajib
weeklySchedule.saturday.from.minute
integer
weeklySchedule.saturday.to
object
wajib
Tampilkan atribut turunan
weeklySchedule.saturday.to.hour
integer
wajib
weeklySchedule.saturday.to.minute
integer
weeklySchedule.sunday
object
Tampilkan atribut turunan
weeklySchedule.sunday.from
object
wajib
Tampilkan atribut turunan
weeklySchedule.sunday.from.hour
integer
wajib
weeklySchedule.sunday.from.minute
integer
weeklySchedule.sunday.to
object
wajib
Tampilkan atribut turunan
weeklySchedule.sunday.to.hour
integer
wajib
weeklySchedule.sunday.to.minute
integer
holidays
array of object
Tampilkan atribut turunan
holidays.name
string
wajib
holidays.day
integer
wajib
holidays.month
integer
wajib
assignedSkills
array of object
Tampilkan atribut turunan
assignedSkills.id
string
wajib
assignedSkills.name
string
wajib
assignedSkills.selectedValues
array of object
wajib
Tampilkan atribut turunan
assignedSkills.selectedValues.icon
string
assignedSkills.selectedValues.id
string
wajib
assignedSkills.selectedValues.value
string
wajib
assignedSkills.valueType
string
wajib
AgentSkillValueType defines how can the Values of a Skill can be selected.
Possible values: single, multiple, boolean
defaultSenderId
string
The default Sender Profile to select for this agent when composing a new message.
outOfOfficeResponse
string
Contoh kode
curl -X PATCH 'https://api.bird.com/workspaces/{workspaceId}/agents/me' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
GET
/workspaces/{workspaceId}/agents/{agentId}/availability
Retrieve information about availability of a specific agent.
Payload respons
status
string
Possible values: active, away, out-of-office
activity
string
Possible values: available, in-call, busy, wrap-up-time, do-not-disturb, offline, not-available, out-of-hours, custom
activityTtl
integer
activityText
string
lastStatusSet
string
lastActivitySet
string
updatedAt
string
Contoh kode
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/agents/{agentId}/availability' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
PATCH
/workspaces/{workspaceId}/agents/{agentId}/availability
Modify the availability of a specific agent.
Payload permintaan
status
string
wajib
Possible values: active, away, out-of-office
activity
string
Possible values: available, in-call, busy, wrap-up-time, do-not-disturb, offline, not-available, out-of-hours, custom
activityTtl
integer
activityText
string
Payload respons
status
string
Possible values: active, away, out-of-office
activity
string
Possible values: available, in-call, busy, wrap-up-time, do-not-disturb, offline, not-available, out-of-hours, custom
activityTtl
integer
activityText
string
lastStatusSet
string
lastActivitySet
string
updatedAt
string
Contoh kode
curl -X PATCH 'https://api.bird.com/workspaces/{workspaceId}/agents/{agentId}/availability' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
GET
/workspaces/{workspaceId}/agents/{agentId}/workload
Retrieve information about workload of a specific agent.
Payload respons
id
string
workload
object
Tampilkan atribut turunan
workload.messaging
integer
workload.email
integer
rule
object
Tampilkan atribut turunan
rule.id
string
wajib
rule.workspaceId
string
wajib
rule.name
string
wajib
rule.description
string
wajib
rule.default
boolean
rule.capacity
object
wajib
Tampilkan atribut turunan
rule.capacity.messaging
integer
rule.capacity.email
integer
rule.assignedAgentIds
array of string
rule.createdAt
string
rule.updatedAt
string
ruleId
string
updatedAt
string
Contoh kode
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/agents/{agentId}/workload' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'