DocumentatieEngagement Platform API
Sign inGet started
Guides
API

Agent Management

GET
/workspaces/{workspaceId}/agents
List Agents
Queryparameters
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.
Antwoord-payload
results
array of object
verplicht
Onderliggende attributen tonen
results.id
string
verplicht
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
verplicht
results.type
string
Possible values: user, ai
results.userEmails
array of string
results.bio
string
results.avatarUrl
string
results.dropVms
array
Onderliggende attributen tonen
results.dropVms.name
string
results.dropVms.playback
object
verplicht
Onderliggende attributen tonen
results.dropVms.playback.media
array of string
verplicht
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
Onderliggende attributen tonen
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
Onderliggende attributen tonen
results.workload.id
string
results.workload.workload
object
Onderliggende attributen tonen
results.workload.workload.messaging
integer
results.workload.workload.email
integer
results.workload.rule
object
Onderliggende attributen tonen
results.workload.rule.id
string
verplicht
results.workload.rule.workspaceId
string
verplicht
results.workload.rule.name
string
verplicht
results.workload.rule.description
string
verplicht
results.workload.rule.default
boolean
results.workload.rule.capacity
object
verplicht
Onderliggende attributen tonen
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
verplicht
results.updatedAt
string
verplicht
results.availability
object
Onderliggende attributen tonen
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
Onderliggende attributen tonen
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
Onderliggende attributen tonen
results.roles.id
string
verplicht
results.roles.type
string
verplicht
Possible values: organization, managed
results.roles.workspaces
array of string
results.user
object
Onderliggende attributen tonen
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
Onderliggende attributen tonen
results.weeklySchedule.monday
object
Onderliggende attributen tonen
results.weeklySchedule.monday.from
object
verplicht
Onderliggende attributen tonen
results.weeklySchedule.monday.from.hour
integer
verplicht
results.weeklySchedule.monday.from.minute
integer
results.weeklySchedule.monday.to
object
verplicht
Onderliggende attributen tonen
results.weeklySchedule.monday.to.hour
integer
verplicht
results.weeklySchedule.monday.to.minute
integer
results.weeklySchedule.tuesday
object
Onderliggende attributen tonen
results.weeklySchedule.tuesday.from
object
verplicht
Onderliggende attributen tonen
results.weeklySchedule.tuesday.from.hour
integer
verplicht
results.weeklySchedule.tuesday.from.minute
integer
results.weeklySchedule.tuesday.to
object
verplicht
Onderliggende attributen tonen
results.weeklySchedule.tuesday.to.hour
integer
verplicht
results.weeklySchedule.tuesday.to.minute
integer
results.weeklySchedule.wednesday
object
Onderliggende attributen tonen
results.weeklySchedule.wednesday.from
object
verplicht
Onderliggende attributen tonen
results.weeklySchedule.wednesday.from.hour
integer
verplicht
results.weeklySchedule.wednesday.from.minute
integer
results.weeklySchedule.wednesday.to
object
verplicht
Onderliggende attributen tonen
results.weeklySchedule.wednesday.to.hour
integer
verplicht
results.weeklySchedule.wednesday.to.minute
integer
results.weeklySchedule.thursday
object
Onderliggende attributen tonen
results.weeklySchedule.thursday.from
object
verplicht
Onderliggende attributen tonen
results.weeklySchedule.thursday.from.hour
integer
verplicht
results.weeklySchedule.thursday.from.minute
integer
results.weeklySchedule.thursday.to
object
verplicht
Onderliggende attributen tonen
results.weeklySchedule.thursday.to.hour
integer
verplicht
results.weeklySchedule.thursday.to.minute
integer
results.weeklySchedule.friday
object
Onderliggende attributen tonen
results.weeklySchedule.friday.from
object
verplicht
Onderliggende attributen tonen
results.weeklySchedule.friday.from.hour
integer
verplicht
results.weeklySchedule.friday.from.minute
integer
results.weeklySchedule.friday.to
object
verplicht
Onderliggende attributen tonen
results.weeklySchedule.friday.to.hour
integer
verplicht
results.weeklySchedule.friday.to.minute
integer
results.weeklySchedule.saturday
object
Onderliggende attributen tonen
results.weeklySchedule.saturday.from
object
verplicht
Onderliggende attributen tonen
results.weeklySchedule.saturday.from.hour
integer
verplicht
results.weeklySchedule.saturday.from.minute
integer
results.weeklySchedule.saturday.to
object
verplicht
Onderliggende attributen tonen
results.weeklySchedule.saturday.to.hour
integer
verplicht
results.weeklySchedule.saturday.to.minute
integer
results.weeklySchedule.sunday
object
Onderliggende attributen tonen
results.weeklySchedule.sunday.from
object
verplicht
Onderliggende attributen tonen
results.weeklySchedule.sunday.from.hour
integer
verplicht
results.weeklySchedule.sunday.from.minute
integer
results.weeklySchedule.sunday.to
object
verplicht
Onderliggende attributen tonen
results.weeklySchedule.sunday.to.hour
integer
verplicht
results.weeklySchedule.sunday.to.minute
integer
results.holidays
array of object
Onderliggende attributen tonen
results.holidays.name
string
verplicht
results.holidays.day
integer
verplicht
results.holidays.month
integer
verplicht
results.assignedSkills
array of object
Onderliggende attributen tonen
results.assignedSkills.id
string
verplicht
results.assignedSkills.name
string
verplicht
results.assignedSkills.selectedValues
array of object
verplicht
Onderliggende attributen tonen
results.assignedSkills.selectedValues.icon
string
results.assignedSkills.selectedValues.id
string
verplicht
results.assignedSkills.selectedValues.value
string
verplicht
results.assignedSkills.valueType
string
verplicht
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.
Codevoorbeeld
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.
Verzoek-payload
bio
string
type
string
verplicht
Possible values: user
userId
string
verplicht
teamId
string
teamIds
array of string
timezone
string
defaultCountryCode
string
weeklySchedule
object
Onderliggende parameters tonen
weeklySchedule.monday
object
Onderliggende parameters tonen
weeklySchedule.monday.from
object
verplicht
Onderliggende parameters tonen
weeklySchedule.monday.from.hour
integer
verplicht
weeklySchedule.monday.from.minute
integer
weeklySchedule.monday.to
object
verplicht
Onderliggende parameters tonen
weeklySchedule.monday.to.hour
integer
verplicht
weeklySchedule.monday.to.minute
integer
weeklySchedule.tuesday
object
Onderliggende parameters tonen
weeklySchedule.tuesday.from
object
verplicht
Onderliggende parameters tonen
weeklySchedule.tuesday.from.hour
integer
verplicht
weeklySchedule.tuesday.from.minute
integer
weeklySchedule.tuesday.to
object
verplicht
Onderliggende parameters tonen
weeklySchedule.tuesday.to.hour
integer
verplicht
weeklySchedule.tuesday.to.minute
integer
weeklySchedule.wednesday
object
Onderliggende parameters tonen
weeklySchedule.wednesday.from
object
verplicht
Onderliggende parameters tonen
weeklySchedule.wednesday.from.hour
integer
verplicht
weeklySchedule.wednesday.from.minute
integer
weeklySchedule.wednesday.to
object
verplicht
Onderliggende parameters tonen
weeklySchedule.wednesday.to.hour
integer
verplicht
weeklySchedule.wednesday.to.minute
integer
weeklySchedule.thursday
object
Onderliggende parameters tonen
weeklySchedule.thursday.from
object
verplicht
Onderliggende parameters tonen
weeklySchedule.thursday.from.hour
integer
verplicht
weeklySchedule.thursday.from.minute
integer
weeklySchedule.thursday.to
object
verplicht
Onderliggende parameters tonen
weeklySchedule.thursday.to.hour
integer
verplicht
weeklySchedule.thursday.to.minute
integer
weeklySchedule.friday
object
Onderliggende parameters tonen
weeklySchedule.friday.from
object
verplicht
Onderliggende parameters tonen
weeklySchedule.friday.from.hour
integer
verplicht
weeklySchedule.friday.from.minute
integer
weeklySchedule.friday.to
object
verplicht
Onderliggende parameters tonen
weeklySchedule.friday.to.hour
integer
verplicht
weeklySchedule.friday.to.minute
integer
weeklySchedule.saturday
object
Onderliggende parameters tonen
weeklySchedule.saturday.from
object
verplicht
Onderliggende parameters tonen
weeklySchedule.saturday.from.hour
integer
verplicht
weeklySchedule.saturday.from.minute
integer
weeklySchedule.saturday.to
object
verplicht
Onderliggende parameters tonen
weeklySchedule.saturday.to.hour
integer
verplicht
weeklySchedule.saturday.to.minute
integer
weeklySchedule.sunday
object
Onderliggende parameters tonen
weeklySchedule.sunday.from
object
verplicht
Onderliggende parameters tonen
weeklySchedule.sunday.from.hour
integer
verplicht
weeklySchedule.sunday.from.minute
integer
weeklySchedule.sunday.to
object
verplicht
Onderliggende parameters tonen
weeklySchedule.sunday.to.hour
integer
verplicht
weeklySchedule.sunday.to.minute
integer
holidays
array of object
Onderliggende parameters tonen
holidays.name
string
verplicht
holidays.day
integer
verplicht
holidays.month
integer
verplicht
Antwoord-payload
id
string
verplicht
status
string
Possible values: active, away, out-of-office
statusBeforeOffline
string
Possible values: active, away, out-of-office
name
string
overrideName
boolean
workspaceId
string
verplicht
type
string
Possible values: user, ai
userEmails
array of string
bio
string
avatarUrl
string
dropVms
array
Onderliggende attributen tonen
dropVms.name
string
dropVms.playback
object
verplicht
Onderliggende attributen tonen
dropVms.playback.media
array of string
verplicht
dropVms.playback.pauseMilliseconds
integer
tagCount
integer
wrapUpTime
integer
rootItemAssignedCount
integer
lastAssignedAt
string
lastSetToAwayAt
string
teams
array of object
Onderliggende attributen tonen
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
Onderliggende attributen tonen
workload.id
string
workload.workload
object
Onderliggende attributen tonen
workload.workload.messaging
integer
workload.workload.email
integer
workload.rule
object
Onderliggende attributen tonen
workload.rule.id
string
verplicht
workload.rule.workspaceId
string
verplicht
workload.rule.name
string
verplicht
workload.rule.description
string
verplicht
workload.rule.default
boolean
workload.rule.capacity
object
verplicht
Onderliggende attributen tonen
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
verplicht
updatedAt
string
verplicht
availability
object
Onderliggende attributen tonen
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
Onderliggende attributen tonen
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
Onderliggende attributen tonen
roles.id
string
verplicht
roles.type
string
verplicht
Possible values: organization, managed
roles.workspaces
array of string
user
object
Onderliggende attributen tonen
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
Onderliggende attributen tonen
weeklySchedule.monday
object
Onderliggende attributen tonen
weeklySchedule.monday.from
object
verplicht
Onderliggende attributen tonen
weeklySchedule.monday.from.hour
integer
verplicht
weeklySchedule.monday.from.minute
integer
weeklySchedule.monday.to
object
verplicht
Onderliggende attributen tonen
weeklySchedule.monday.to.hour
integer
verplicht
weeklySchedule.monday.to.minute
integer
weeklySchedule.tuesday
object
Onderliggende attributen tonen
weeklySchedule.tuesday.from
object
verplicht
Onderliggende attributen tonen
weeklySchedule.tuesday.from.hour
integer
verplicht
weeklySchedule.tuesday.from.minute
integer
weeklySchedule.tuesday.to
object
verplicht
Onderliggende attributen tonen
weeklySchedule.tuesday.to.hour
integer
verplicht
weeklySchedule.tuesday.to.minute
integer
weeklySchedule.wednesday
object
Onderliggende attributen tonen
weeklySchedule.wednesday.from
object
verplicht
Onderliggende attributen tonen
weeklySchedule.wednesday.from.hour
integer
verplicht
weeklySchedule.wednesday.from.minute
integer
weeklySchedule.wednesday.to
object
verplicht
Onderliggende attributen tonen
weeklySchedule.wednesday.to.hour
integer
verplicht
weeklySchedule.wednesday.to.minute
integer
weeklySchedule.thursday
object
Onderliggende attributen tonen
weeklySchedule.thursday.from
object
verplicht
Onderliggende attributen tonen
weeklySchedule.thursday.from.hour
integer
verplicht
weeklySchedule.thursday.from.minute
integer
weeklySchedule.thursday.to
object
verplicht
Onderliggende attributen tonen
weeklySchedule.thursday.to.hour
integer
verplicht
weeklySchedule.thursday.to.minute
integer
weeklySchedule.friday
object
Onderliggende attributen tonen
weeklySchedule.friday.from
object
verplicht
Onderliggende attributen tonen
weeklySchedule.friday.from.hour
integer
verplicht
weeklySchedule.friday.from.minute
integer
weeklySchedule.friday.to
object
verplicht
Onderliggende attributen tonen
weeklySchedule.friday.to.hour
integer
verplicht
weeklySchedule.friday.to.minute
integer
weeklySchedule.saturday
object
Onderliggende attributen tonen
weeklySchedule.saturday.from
object
verplicht
Onderliggende attributen tonen
weeklySchedule.saturday.from.hour
integer
verplicht
weeklySchedule.saturday.from.minute
integer
weeklySchedule.saturday.to
object
verplicht
Onderliggende attributen tonen
weeklySchedule.saturday.to.hour
integer
verplicht
weeklySchedule.saturday.to.minute
integer
weeklySchedule.sunday
object
Onderliggende attributen tonen
weeklySchedule.sunday.from
object
verplicht
Onderliggende attributen tonen
weeklySchedule.sunday.from.hour
integer
verplicht
weeklySchedule.sunday.from.minute
integer
weeklySchedule.sunday.to
object
verplicht
Onderliggende attributen tonen
weeklySchedule.sunday.to.hour
integer
verplicht
weeklySchedule.sunday.to.minute
integer
holidays
array of object
Onderliggende attributen tonen
holidays.name
string
verplicht
holidays.day
integer
verplicht
holidays.month
integer
verplicht
assignedSkills
array of object
Onderliggende attributen tonen
assignedSkills.id
string
verplicht
assignedSkills.name
string
verplicht
assignedSkills.selectedValues
array of object
verplicht
Onderliggende attributen tonen
assignedSkills.selectedValues.icon
string
assignedSkills.selectedValues.id
string
verplicht
assignedSkills.selectedValues.value
string
verplicht
assignedSkills.valueType
string
verplicht
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
Codevoorbeeld
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.
Antwoord-payload
results
array of object
verplicht
Onderliggende attributen tonen
results.id
string
verplicht
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
verplicht
Codevoorbeeld
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.
Antwoord-payload
id
string
verplicht
status
string
Possible values: active, away, out-of-office
statusBeforeOffline
string
Possible values: active, away, out-of-office
name
string
overrideName
boolean
workspaceId
string
verplicht
type
string
Possible values: user, ai
userEmails
array of string
bio
string
avatarUrl
string
dropVms
array
Onderliggende attributen tonen
dropVms.name
string
dropVms.playback
object
verplicht
Onderliggende attributen tonen
dropVms.playback.media
array of string
verplicht
dropVms.playback.pauseMilliseconds
integer
tagCount
integer
wrapUpTime
integer
rootItemAssignedCount
integer
lastAssignedAt
string
lastSetToAwayAt
string
teams
array of object
Onderliggende attributen tonen
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
Onderliggende attributen tonen
workload.id
string
workload.workload
object
Onderliggende attributen tonen
workload.workload.messaging
integer
workload.workload.email
integer
workload.rule
object
Onderliggende attributen tonen
workload.rule.id
string
verplicht
workload.rule.workspaceId
string
verplicht
workload.rule.name
string
verplicht
workload.rule.description
string
verplicht
workload.rule.default
boolean
workload.rule.capacity
object
verplicht
Onderliggende attributen tonen
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
verplicht
updatedAt
string
verplicht
availability
object
Onderliggende attributen tonen
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
Onderliggende attributen tonen
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
Onderliggende attributen tonen
roles.id
string
verplicht
roles.type
string
verplicht
Possible values: organization, managed
roles.workspaces
array of string
user
object
Onderliggende attributen tonen
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
Onderliggende attributen tonen
weeklySchedule.monday
object
Onderliggende attributen tonen
weeklySchedule.monday.from
object
verplicht
Onderliggende attributen tonen
weeklySchedule.monday.from.hour
integer
verplicht
weeklySchedule.monday.from.minute
integer
weeklySchedule.monday.to
object
verplicht
Onderliggende attributen tonen
weeklySchedule.monday.to.hour
integer
verplicht
weeklySchedule.monday.to.minute
integer
weeklySchedule.tuesday
object
Onderliggende attributen tonen
weeklySchedule.tuesday.from
object
verplicht
Onderliggende attributen tonen
weeklySchedule.tuesday.from.hour
integer
verplicht
weeklySchedule.tuesday.from.minute
integer
weeklySchedule.tuesday.to
object
verplicht
Onderliggende attributen tonen
weeklySchedule.tuesday.to.hour
integer
verplicht
weeklySchedule.tuesday.to.minute
integer
weeklySchedule.wednesday
object
Onderliggende attributen tonen
weeklySchedule.wednesday.from
object
verplicht
Onderliggende attributen tonen
weeklySchedule.wednesday.from.hour
integer
verplicht
weeklySchedule.wednesday.from.minute
integer
weeklySchedule.wednesday.to
object
verplicht
Onderliggende attributen tonen
weeklySchedule.wednesday.to.hour
integer
verplicht
weeklySchedule.wednesday.to.minute
integer
weeklySchedule.thursday
object
Onderliggende attributen tonen
weeklySchedule.thursday.from
object
verplicht
Onderliggende attributen tonen
weeklySchedule.thursday.from.hour
integer
verplicht
weeklySchedule.thursday.from.minute
integer
weeklySchedule.thursday.to
object
verplicht
Onderliggende attributen tonen
weeklySchedule.thursday.to.hour
integer
verplicht
weeklySchedule.thursday.to.minute
integer
weeklySchedule.friday
object
Onderliggende attributen tonen
weeklySchedule.friday.from
object
verplicht
Onderliggende attributen tonen
weeklySchedule.friday.from.hour
integer
verplicht
weeklySchedule.friday.from.minute
integer
weeklySchedule.friday.to
object
verplicht
Onderliggende attributen tonen
weeklySchedule.friday.to.hour
integer
verplicht
weeklySchedule.friday.to.minute
integer
weeklySchedule.saturday
object
Onderliggende attributen tonen
weeklySchedule.saturday.from
object
verplicht
Onderliggende attributen tonen
weeklySchedule.saturday.from.hour
integer
verplicht
weeklySchedule.saturday.from.minute
integer
weeklySchedule.saturday.to
object
verplicht
Onderliggende attributen tonen
weeklySchedule.saturday.to.hour
integer
verplicht
weeklySchedule.saturday.to.minute
integer
weeklySchedule.sunday
object
Onderliggende attributen tonen
weeklySchedule.sunday.from
object
verplicht
Onderliggende attributen tonen
weeklySchedule.sunday.from.hour
integer
verplicht
weeklySchedule.sunday.from.minute
integer
weeklySchedule.sunday.to
object
verplicht
Onderliggende attributen tonen
weeklySchedule.sunday.to.hour
integer
verplicht
weeklySchedule.sunday.to.minute
integer
holidays
array of object
Onderliggende attributen tonen
holidays.name
string
verplicht
holidays.day
integer
verplicht
holidays.month
integer
verplicht
assignedSkills
array of object
Onderliggende attributen tonen
assignedSkills.id
string
verplicht
assignedSkills.name
string
verplicht
assignedSkills.selectedValues
array of object
verplicht
Onderliggende attributen tonen
assignedSkills.selectedValues.icon
string
assignedSkills.selectedValues.id
string
verplicht
assignedSkills.selectedValues.value
string
verplicht
assignedSkills.valueType
string
verplicht
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
Codevoorbeeld
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.
Antwoord-payload
mediaUrl
string
URL to download the media from
fileId
string
File ID
url
string
verplicht
URL to post the image to
formData
object
verplicht
expectedFields
array of string
Codevoorbeeld
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.
Antwoord-payload
mediaUrl
string
URL to download the media from
fileId
string
File ID
url
string
verplicht
URL to post the image to
formData
object
verplicht
expectedFields
array of string
Codevoorbeeld
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
Codevoorbeeld
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.
Verzoek-payload
name
string
bio
string
status
string
Possible values: active, away, out-of-office
avatarUrl
string
dropVms
array
Onderliggende parameters tonen
dropVms.name
string
dropVms.playback
object
verplicht
Onderliggende parameters tonen
dropVms.playback.media
array of string
verplicht
dropVms.playback.pauseMilliseconds
integer
wrapUpTime
integer
timezone
string
defaultCountryCode
string
defaultCallerId
string
forwardNumber
object
Onderliggende parameters tonen
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
Onderliggende parameters tonen
weeklySchedule.monday
object
Onderliggende parameters tonen
weeklySchedule.monday.from
object
verplicht
Onderliggende parameters tonen
weeklySchedule.monday.from.hour
integer
verplicht
weeklySchedule.monday.from.minute
integer
weeklySchedule.monday.to
object
verplicht
Onderliggende parameters tonen
weeklySchedule.monday.to.hour
integer
verplicht
weeklySchedule.monday.to.minute
integer
weeklySchedule.tuesday
object
Onderliggende parameters tonen
weeklySchedule.tuesday.from
object
verplicht
Onderliggende parameters tonen
weeklySchedule.tuesday.from.hour
integer
verplicht
weeklySchedule.tuesday.from.minute
integer
weeklySchedule.tuesday.to
object
verplicht
Onderliggende parameters tonen
weeklySchedule.tuesday.to.hour
integer
verplicht
weeklySchedule.tuesday.to.minute
integer
weeklySchedule.wednesday
object
Onderliggende parameters tonen
weeklySchedule.wednesday.from
object
verplicht
Onderliggende parameters tonen
weeklySchedule.wednesday.from.hour
integer
verplicht
weeklySchedule.wednesday.from.minute
integer
weeklySchedule.wednesday.to
object
verplicht
Onderliggende parameters tonen
weeklySchedule.wednesday.to.hour
integer
verplicht
weeklySchedule.wednesday.to.minute
integer
weeklySchedule.thursday
object
Onderliggende parameters tonen
weeklySchedule.thursday.from
object
verplicht
Onderliggende parameters tonen
weeklySchedule.thursday.from.hour
integer
verplicht
weeklySchedule.thursday.from.minute
integer
weeklySchedule.thursday.to
object
verplicht
Onderliggende parameters tonen
weeklySchedule.thursday.to.hour
integer
verplicht
weeklySchedule.thursday.to.minute
integer
weeklySchedule.friday
object
Onderliggende parameters tonen
weeklySchedule.friday.from
object
verplicht
Onderliggende parameters tonen
weeklySchedule.friday.from.hour
integer
verplicht
weeklySchedule.friday.from.minute
integer
weeklySchedule.friday.to
object
verplicht
Onderliggende parameters tonen
weeklySchedule.friday.to.hour
integer
verplicht
weeklySchedule.friday.to.minute
integer
weeklySchedule.saturday
object
Onderliggende parameters tonen
weeklySchedule.saturday.from
object
verplicht
Onderliggende parameters tonen
weeklySchedule.saturday.from.hour
integer
verplicht
weeklySchedule.saturday.from.minute
integer
weeklySchedule.saturday.to
object
verplicht
Onderliggende parameters tonen
weeklySchedule.saturday.to.hour
integer
verplicht
weeklySchedule.saturday.to.minute
integer
weeklySchedule.sunday
object
Onderliggende parameters tonen
weeklySchedule.sunday.from
object
verplicht
Onderliggende parameters tonen
weeklySchedule.sunday.from.hour
integer
verplicht
weeklySchedule.sunday.from.minute
integer
weeklySchedule.sunday.to
object
verplicht
Onderliggende parameters tonen
weeklySchedule.sunday.to.hour
integer
verplicht
weeklySchedule.sunday.to.minute
integer
holidays
array of object
Onderliggende parameters tonen
holidays.name
string
verplicht
holidays.day
integer
verplicht
holidays.month
integer
verplicht
assignedSkills
array of object
Onderliggende parameters tonen
assignedSkills.id
string
verplicht
assignedSkills.name
string
verplicht
assignedSkills.selectedValues
array of object
verplicht
Onderliggende parameters tonen
assignedSkills.selectedValues.icon
string
assignedSkills.selectedValues.id
string
verplicht
assignedSkills.selectedValues.value
string
verplicht
assignedSkills.valueType
string
verplicht
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
Antwoord-payload
id
string
verplicht
status
string
Possible values: active, away, out-of-office
statusBeforeOffline
string
Possible values: active, away, out-of-office
name
string
overrideName
boolean
workspaceId
string
verplicht
type
string
Possible values: user, ai
userEmails
array of string
bio
string
avatarUrl
string
dropVms
array
Onderliggende attributen tonen
dropVms.name
string
dropVms.playback
object
verplicht
Onderliggende attributen tonen
dropVms.playback.media
array of string
verplicht
dropVms.playback.pauseMilliseconds
integer
tagCount
integer
wrapUpTime
integer
rootItemAssignedCount
integer
lastAssignedAt
string
lastSetToAwayAt
string
teams
array of object
Onderliggende attributen tonen
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
Onderliggende attributen tonen
workload.id
string
workload.workload
object
Onderliggende attributen tonen
workload.workload.messaging
integer
workload.workload.email
integer
workload.rule
object
Onderliggende attributen tonen
workload.rule.id
string
verplicht
workload.rule.workspaceId
string
verplicht
workload.rule.name
string
verplicht
workload.rule.description
string
verplicht
workload.rule.default
boolean
workload.rule.capacity
object
verplicht
Onderliggende attributen tonen
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
verplicht
updatedAt
string
verplicht
availability
object
Onderliggende attributen tonen
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
Onderliggende attributen tonen
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
Onderliggende attributen tonen
roles.id
string
verplicht
roles.type
string
verplicht
Possible values: organization, managed
roles.workspaces
array of string
user
object
Onderliggende attributen tonen
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
Onderliggende attributen tonen
weeklySchedule.monday
object
Onderliggende attributen tonen
weeklySchedule.monday.from
object
verplicht
Onderliggende attributen tonen
weeklySchedule.monday.from.hour
integer
verplicht
weeklySchedule.monday.from.minute
integer
weeklySchedule.monday.to
object
verplicht
Onderliggende attributen tonen
weeklySchedule.monday.to.hour
integer
verplicht
weeklySchedule.monday.to.minute
integer
weeklySchedule.tuesday
object
Onderliggende attributen tonen
weeklySchedule.tuesday.from
object
verplicht
Onderliggende attributen tonen
weeklySchedule.tuesday.from.hour
integer
verplicht
weeklySchedule.tuesday.from.minute
integer
weeklySchedule.tuesday.to
object
verplicht
Onderliggende attributen tonen
weeklySchedule.tuesday.to.hour
integer
verplicht
weeklySchedule.tuesday.to.minute
integer
weeklySchedule.wednesday
object
Onderliggende attributen tonen
weeklySchedule.wednesday.from
object
verplicht
Onderliggende attributen tonen
weeklySchedule.wednesday.from.hour
integer
verplicht
weeklySchedule.wednesday.from.minute
integer
weeklySchedule.wednesday.to
object
verplicht
Onderliggende attributen tonen
weeklySchedule.wednesday.to.hour
integer
verplicht
weeklySchedule.wednesday.to.minute
integer
weeklySchedule.thursday
object
Onderliggende attributen tonen
weeklySchedule.thursday.from
object
verplicht
Onderliggende attributen tonen
weeklySchedule.thursday.from.hour
integer
verplicht
weeklySchedule.thursday.from.minute
integer
weeklySchedule.thursday.to
object
verplicht
Onderliggende attributen tonen
weeklySchedule.thursday.to.hour
integer
verplicht
weeklySchedule.thursday.to.minute
integer
weeklySchedule.friday
object
Onderliggende attributen tonen
weeklySchedule.friday.from
object
verplicht
Onderliggende attributen tonen
weeklySchedule.friday.from.hour
integer
verplicht
weeklySchedule.friday.from.minute
integer
weeklySchedule.friday.to
object
verplicht
Onderliggende attributen tonen
weeklySchedule.friday.to.hour
integer
verplicht
weeklySchedule.friday.to.minute
integer
weeklySchedule.saturday
object
Onderliggende attributen tonen
weeklySchedule.saturday.from
object
verplicht
Onderliggende attributen tonen
weeklySchedule.saturday.from.hour
integer
verplicht
weeklySchedule.saturday.from.minute
integer
weeklySchedule.saturday.to
object
verplicht
Onderliggende attributen tonen
weeklySchedule.saturday.to.hour
integer
verplicht
weeklySchedule.saturday.to.minute
integer
weeklySchedule.sunday
object
Onderliggende attributen tonen
weeklySchedule.sunday.from
object
verplicht
Onderliggende attributen tonen
weeklySchedule.sunday.from.hour
integer
verplicht
weeklySchedule.sunday.from.minute
integer
weeklySchedule.sunday.to
object
verplicht
Onderliggende attributen tonen
weeklySchedule.sunday.to.hour
integer
verplicht
weeklySchedule.sunday.to.minute
integer
holidays
array of object
Onderliggende attributen tonen
holidays.name
string
verplicht
holidays.day
integer
verplicht
holidays.month
integer
verplicht
assignedSkills
array of object
Onderliggende attributen tonen
assignedSkills.id
string
verplicht
assignedSkills.name
string
verplicht
assignedSkills.selectedValues
array of object
verplicht
Onderliggende attributen tonen
assignedSkills.selectedValues.icon
string
assignedSkills.selectedValues.id
string
verplicht
assignedSkills.selectedValues.value
string
verplicht
assignedSkills.valueType
string
verplicht
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
Codevoorbeeld
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.
Codevoorbeeld
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.
Antwoord-payload
id
string
verplicht
status
string
Possible values: active, away, out-of-office
statusBeforeOffline
string
Possible values: active, away, out-of-office
name
string
overrideName
boolean
workspaceId
string
verplicht
type
string
Possible values: user, ai
userEmails
array of string
bio
string
avatarUrl
string
dropVms
array
Onderliggende attributen tonen
dropVms.name
string
dropVms.playback
object
verplicht
Onderliggende attributen tonen
dropVms.playback.media
array of string
verplicht
dropVms.playback.pauseMilliseconds
integer
tagCount
integer
wrapUpTime
integer
rootItemAssignedCount
integer
lastAssignedAt
string
lastSetToAwayAt
string
teams
array of object
Onderliggende attributen tonen
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
Onderliggende attributen tonen
workload.id
string
workload.workload
object
Onderliggende attributen tonen
workload.workload.messaging
integer
workload.workload.email
integer
workload.rule
object
Onderliggende attributen tonen
workload.rule.id
string
verplicht
workload.rule.workspaceId
string
verplicht
workload.rule.name
string
verplicht
workload.rule.description
string
verplicht
workload.rule.default
boolean
workload.rule.capacity
object
verplicht
Onderliggende attributen tonen
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
verplicht
updatedAt
string
verplicht
availability
object
Onderliggende attributen tonen
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
Onderliggende attributen tonen
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
Onderliggende attributen tonen
roles.id
string
verplicht
roles.type
string
verplicht
Possible values: organization, managed
roles.workspaces
array of string
user
object
Onderliggende attributen tonen
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
Onderliggende attributen tonen
weeklySchedule.monday
object
Onderliggende attributen tonen
weeklySchedule.monday.from
object
verplicht
Onderliggende attributen tonen
weeklySchedule.monday.from.hour
integer
verplicht
weeklySchedule.monday.from.minute
integer
weeklySchedule.monday.to
object
verplicht
Onderliggende attributen tonen
weeklySchedule.monday.to.hour
integer
verplicht
weeklySchedule.monday.to.minute
integer
weeklySchedule.tuesday
object
Onderliggende attributen tonen
weeklySchedule.tuesday.from
object
verplicht
Onderliggende attributen tonen
weeklySchedule.tuesday.from.hour
integer
verplicht
weeklySchedule.tuesday.from.minute
integer
weeklySchedule.tuesday.to
object
verplicht
Onderliggende attributen tonen
weeklySchedule.tuesday.to.hour
integer
verplicht
weeklySchedule.tuesday.to.minute
integer
weeklySchedule.wednesday
object
Onderliggende attributen tonen
weeklySchedule.wednesday.from
object
verplicht
Onderliggende attributen tonen
weeklySchedule.wednesday.from.hour
integer
verplicht
weeklySchedule.wednesday.from.minute
integer
weeklySchedule.wednesday.to
object
verplicht
Onderliggende attributen tonen
weeklySchedule.wednesday.to.hour
integer
verplicht
weeklySchedule.wednesday.to.minute
integer
weeklySchedule.thursday
object
Onderliggende attributen tonen
weeklySchedule.thursday.from
object
verplicht
Onderliggende attributen tonen
weeklySchedule.thursday.from.hour
integer
verplicht
weeklySchedule.thursday.from.minute
integer
weeklySchedule.thursday.to
object
verplicht
Onderliggende attributen tonen
weeklySchedule.thursday.to.hour
integer
verplicht
weeklySchedule.thursday.to.minute
integer
weeklySchedule.friday
object
Onderliggende attributen tonen
weeklySchedule.friday.from
object
verplicht
Onderliggende attributen tonen
weeklySchedule.friday.from.hour
integer
verplicht
weeklySchedule.friday.from.minute
integer
weeklySchedule.friday.to
object
verplicht
Onderliggende attributen tonen
weeklySchedule.friday.to.hour
integer
verplicht
weeklySchedule.friday.to.minute
integer
weeklySchedule.saturday
object
Onderliggende attributen tonen
weeklySchedule.saturday.from
object
verplicht
Onderliggende attributen tonen
weeklySchedule.saturday.from.hour
integer
verplicht
weeklySchedule.saturday.from.minute
integer
weeklySchedule.saturday.to
object
verplicht
Onderliggende attributen tonen
weeklySchedule.saturday.to.hour
integer
verplicht
weeklySchedule.saturday.to.minute
integer
weeklySchedule.sunday
object
Onderliggende attributen tonen
weeklySchedule.sunday.from
object
verplicht
Onderliggende attributen tonen
weeklySchedule.sunday.from.hour
integer
verplicht
weeklySchedule.sunday.from.minute
integer
weeklySchedule.sunday.to
object
verplicht
Onderliggende attributen tonen
weeklySchedule.sunday.to.hour
integer
verplicht
weeklySchedule.sunday.to.minute
integer
holidays
array of object
Onderliggende attributen tonen
holidays.name
string
verplicht
holidays.day
integer
verplicht
holidays.month
integer
verplicht
assignedSkills
array of object
Onderliggende attributen tonen
assignedSkills.id
string
verplicht
assignedSkills.name
string
verplicht
assignedSkills.selectedValues
array of object
verplicht
Onderliggende attributen tonen
assignedSkills.selectedValues.icon
string
assignedSkills.selectedValues.id
string
verplicht
assignedSkills.selectedValues.value
string
verplicht
assignedSkills.valueType
string
verplicht
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
Codevoorbeeld
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.
Verzoek-payload
name
string
bio
string
status
string
Possible values: active, away, out-of-office
avatarUrl
string
dropVms
array
Onderliggende parameters tonen
dropVms.name
string
dropVms.playback
object
verplicht
Onderliggende parameters tonen
dropVms.playback.media
array of string
verplicht
dropVms.playback.pauseMilliseconds
integer
wrapUpTime
integer
timezone
string
defaultCountryCode
string
defaultCallerId
string
forwardNumber
object
Onderliggende parameters tonen
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
Onderliggende parameters tonen
weeklySchedule.monday
object
Onderliggende parameters tonen
weeklySchedule.monday.from
object
verplicht
Onderliggende parameters tonen
weeklySchedule.monday.from.hour
integer
verplicht
weeklySchedule.monday.from.minute
integer
weeklySchedule.monday.to
object
verplicht
Onderliggende parameters tonen
weeklySchedule.monday.to.hour
integer
verplicht
weeklySchedule.monday.to.minute
integer
weeklySchedule.tuesday
object
Onderliggende parameters tonen
weeklySchedule.tuesday.from
object
verplicht
Onderliggende parameters tonen
weeklySchedule.tuesday.from.hour
integer
verplicht
weeklySchedule.tuesday.from.minute
integer
weeklySchedule.tuesday.to
object
verplicht
Onderliggende parameters tonen
weeklySchedule.tuesday.to.hour
integer
verplicht
weeklySchedule.tuesday.to.minute
integer
weeklySchedule.wednesday
object
Onderliggende parameters tonen
weeklySchedule.wednesday.from
object
verplicht
Onderliggende parameters tonen
weeklySchedule.wednesday.from.hour
integer
verplicht
weeklySchedule.wednesday.from.minute
integer
weeklySchedule.wednesday.to
object
verplicht
Onderliggende parameters tonen
weeklySchedule.wednesday.to.hour
integer
verplicht
weeklySchedule.wednesday.to.minute
integer
weeklySchedule.thursday
object
Onderliggende parameters tonen
weeklySchedule.thursday.from
object
verplicht
Onderliggende parameters tonen
weeklySchedule.thursday.from.hour
integer
verplicht
weeklySchedule.thursday.from.minute
integer
weeklySchedule.thursday.to
object
verplicht
Onderliggende parameters tonen
weeklySchedule.thursday.to.hour
integer
verplicht
weeklySchedule.thursday.to.minute
integer
weeklySchedule.friday
object
Onderliggende parameters tonen
weeklySchedule.friday.from
object
verplicht
Onderliggende parameters tonen
weeklySchedule.friday.from.hour
integer
verplicht
weeklySchedule.friday.from.minute
integer
weeklySchedule.friday.to
object
verplicht
Onderliggende parameters tonen
weeklySchedule.friday.to.hour
integer
verplicht
weeklySchedule.friday.to.minute
integer
weeklySchedule.saturday
object
Onderliggende parameters tonen
weeklySchedule.saturday.from
object
verplicht
Onderliggende parameters tonen
weeklySchedule.saturday.from.hour
integer
verplicht
weeklySchedule.saturday.from.minute
integer
weeklySchedule.saturday.to
object
verplicht
Onderliggende parameters tonen
weeklySchedule.saturday.to.hour
integer
verplicht
weeklySchedule.saturday.to.minute
integer
weeklySchedule.sunday
object
Onderliggende parameters tonen
weeklySchedule.sunday.from
object
verplicht
Onderliggende parameters tonen
weeklySchedule.sunday.from.hour
integer
verplicht
weeklySchedule.sunday.from.minute
integer
weeklySchedule.sunday.to
object
verplicht
Onderliggende parameters tonen
weeklySchedule.sunday.to.hour
integer
verplicht
weeklySchedule.sunday.to.minute
integer
holidays
array of object
Onderliggende parameters tonen
holidays.name
string
verplicht
holidays.day
integer
verplicht
holidays.month
integer
verplicht
assignedSkills
array of object
Onderliggende parameters tonen
assignedSkills.id
string
verplicht
assignedSkills.name
string
verplicht
assignedSkills.selectedValues
array of object
verplicht
Onderliggende parameters tonen
assignedSkills.selectedValues.icon
string
assignedSkills.selectedValues.id
string
verplicht
assignedSkills.selectedValues.value
string
verplicht
assignedSkills.valueType
string
verplicht
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
Antwoord-payload
id
string
verplicht
status
string
Possible values: active, away, out-of-office
statusBeforeOffline
string
Possible values: active, away, out-of-office
name
string
overrideName
boolean
workspaceId
string
verplicht
type
string
Possible values: user, ai
userEmails
array of string
bio
string
avatarUrl
string
dropVms
array
Onderliggende attributen tonen
dropVms.name
string
dropVms.playback
object
verplicht
Onderliggende attributen tonen
dropVms.playback.media
array of string
verplicht
dropVms.playback.pauseMilliseconds
integer
tagCount
integer
wrapUpTime
integer
rootItemAssignedCount
integer
lastAssignedAt
string
lastSetToAwayAt
string
teams
array of object
Onderliggende attributen tonen
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
Onderliggende attributen tonen
workload.id
string
workload.workload
object
Onderliggende attributen tonen
workload.workload.messaging
integer
workload.workload.email
integer
workload.rule
object
Onderliggende attributen tonen
workload.rule.id
string
verplicht
workload.rule.workspaceId
string
verplicht
workload.rule.name
string
verplicht
workload.rule.description
string
verplicht
workload.rule.default
boolean
workload.rule.capacity
object
verplicht
Onderliggende attributen tonen
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
verplicht
updatedAt
string
verplicht
availability
object
Onderliggende attributen tonen
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
Onderliggende attributen tonen
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
Onderliggende attributen tonen
roles.id
string
verplicht
roles.type
string
verplicht
Possible values: organization, managed
roles.workspaces
array of string
user
object
Onderliggende attributen tonen
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
Onderliggende attributen tonen
weeklySchedule.monday
object
Onderliggende attributen tonen
weeklySchedule.monday.from
object
verplicht
Onderliggende attributen tonen
weeklySchedule.monday.from.hour
integer
verplicht
weeklySchedule.monday.from.minute
integer
weeklySchedule.monday.to
object
verplicht
Onderliggende attributen tonen
weeklySchedule.monday.to.hour
integer
verplicht
weeklySchedule.monday.to.minute
integer
weeklySchedule.tuesday
object
Onderliggende attributen tonen
weeklySchedule.tuesday.from
object
verplicht
Onderliggende attributen tonen
weeklySchedule.tuesday.from.hour
integer
verplicht
weeklySchedule.tuesday.from.minute
integer
weeklySchedule.tuesday.to
object
verplicht
Onderliggende attributen tonen
weeklySchedule.tuesday.to.hour
integer
verplicht
weeklySchedule.tuesday.to.minute
integer
weeklySchedule.wednesday
object
Onderliggende attributen tonen
weeklySchedule.wednesday.from
object
verplicht
Onderliggende attributen tonen
weeklySchedule.wednesday.from.hour
integer
verplicht
weeklySchedule.wednesday.from.minute
integer
weeklySchedule.wednesday.to
object
verplicht
Onderliggende attributen tonen
weeklySchedule.wednesday.to.hour
integer
verplicht
weeklySchedule.wednesday.to.minute
integer
weeklySchedule.thursday
object
Onderliggende attributen tonen
weeklySchedule.thursday.from
object
verplicht
Onderliggende attributen tonen
weeklySchedule.thursday.from.hour
integer
verplicht
weeklySchedule.thursday.from.minute
integer
weeklySchedule.thursday.to
object
verplicht
Onderliggende attributen tonen
weeklySchedule.thursday.to.hour
integer
verplicht
weeklySchedule.thursday.to.minute
integer
weeklySchedule.friday
object
Onderliggende attributen tonen
weeklySchedule.friday.from
object
verplicht
Onderliggende attributen tonen
weeklySchedule.friday.from.hour
integer
verplicht
weeklySchedule.friday.from.minute
integer
weeklySchedule.friday.to
object
verplicht
Onderliggende attributen tonen
weeklySchedule.friday.to.hour
integer
verplicht
weeklySchedule.friday.to.minute
integer
weeklySchedule.saturday
object
Onderliggende attributen tonen
weeklySchedule.saturday.from
object
verplicht
Onderliggende attributen tonen
weeklySchedule.saturday.from.hour
integer
verplicht
weeklySchedule.saturday.from.minute
integer
weeklySchedule.saturday.to
object
verplicht
Onderliggende attributen tonen
weeklySchedule.saturday.to.hour
integer
verplicht
weeklySchedule.saturday.to.minute
integer
weeklySchedule.sunday
object
Onderliggende attributen tonen
weeklySchedule.sunday.from
object
verplicht
Onderliggende attributen tonen
weeklySchedule.sunday.from.hour
integer
verplicht
weeklySchedule.sunday.from.minute
integer
weeklySchedule.sunday.to
object
verplicht
Onderliggende attributen tonen
weeklySchedule.sunday.to.hour
integer
verplicht
weeklySchedule.sunday.to.minute
integer
holidays
array of object
Onderliggende attributen tonen
holidays.name
string
verplicht
holidays.day
integer
verplicht
holidays.month
integer
verplicht
assignedSkills
array of object
Onderliggende attributen tonen
assignedSkills.id
string
verplicht
assignedSkills.name
string
verplicht
assignedSkills.selectedValues
array of object
verplicht
Onderliggende attributen tonen
assignedSkills.selectedValues.icon
string
assignedSkills.selectedValues.id
string
verplicht
assignedSkills.selectedValues.value
string
verplicht
assignedSkills.valueType
string
verplicht
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
Codevoorbeeld
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.
Antwoord-payload
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
Codevoorbeeld
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.
Verzoek-payload
status
string
verplicht
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
Antwoord-payload
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
Codevoorbeeld
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.
Antwoord-payload
id
string
workload
object
Onderliggende attributen tonen
workload.messaging
integer
workload.email
integer
rule
object
Onderliggende attributen tonen
rule.id
string
verplicht
rule.workspaceId
string
verplicht
rule.name
string
verplicht
rule.description
string
verplicht
rule.default
boolean
rule.capacity
object
verplicht
Onderliggende attributen tonen
rule.capacity.messaging
integer
rule.capacity.email
integer
rule.assignedAgentIds
array of string
rule.createdAt
string
rule.updatedAt
string
ruleId
string
updatedAt
string
Codevoorbeeld
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/agents/{agentId}/workload' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'