统一座席状态
帐号可使用的统一状态，包括默认统一状态和自定义统一状态。
JSON格式
统一代理状态表示为具有以下属性的JSON对象:
| 名字 | 类型 | 只读 | 强制性的 | 描述 |
|---|---|---|---|---|
| 自定义 | 数组 | 假 | 假 | 自定义统一状态对象数组 |
| 默认的 | 数组 | 假 | 假 | 默认统一状态对象数组 |
| 链接 | 对象 | 假 | 假 | 数据的上一页和下一页的分页链接 |
| 元 | 对象 | 假 | 假 | 其他关于统一代理状态响应的非标准信息 |
获取该帐号可用的统一代理状态。
GET / api / v2 / agent_availabilities / agent_statuses
获取帐户的默认和自定义统一状态。统一代理状态按字典顺序返回，并进行分页。不支持其他排序方法。
在没有查询参数的情况下，返回帐号默认和自定义统一状态的第一页。要导航到不同的状态页面，请使用所提供的分页链接。分页链接使用页面(前)或页面(后)参数。的页面(前)和页面(后)参数不能在单个请求中同时使用。
推断状态颜色
统一状态有一个推断的颜色。推断的状态颜色用于确定在Zendesk的统一状态切换器和用户配置文件图标周围的自定义状态的显示颜色。亚博只有启用了全通道路由功能，统一状态切换器才可见。
推断的状态颜色是基于每个通道的状态映射，按以下优先级顺序计算的:
优先级1:如果至少有一个“ONLINE”通道，则推断状态颜色将为“ONLINE”。
优先级2:如果2个或更多通道映射到相同的状态，则推断的状态颜色将相应设置(例如[“AWAY”，“AWAY”，“OFFLINE”]被推断为“AWAY”)。
优先级3:如果以上条件都不满足，则推断的状态颜色默认为“OFFLINE”(例如[“AWAY”，“TRANSFERS_ONLY”，“OFFLINE”]被推断为“OFFLINE”)。
允许
- 管理员
参数
| 名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| 页面(后) | 整数 | 查询 | 假 | 返回的游标下一个前面响应中的链接 |
| 页面(前) | 整数 | 查询 | 假 | 返回的游标上一页前面响应中的链接 |
| 页面(大小) | 整数 | 查询 | 假 | 每页返回的自定义统一状态的最大数量。每个请求都返回默认的统一状态 |
代码示例
旋度
旋度- v - u{email_address｝：{密码｝＼“https://example.亚博zendesk.com/api/v2/agent_availabilities/agent_statuses?page%5Bafter%5D=203&page%5Bsize%5D=5”＼——头“亚博Zendesk-Api-Version: 2023-02-01”＼——头“application / json内容类型:
去
进口（“fmt”“输入输出”“net/http”）函数主要（）{url：=“https://support.亚博zendesk.com/api/v2/agent_availabilities/agent_statuses?page[在]= 1234和页面(前)= 1234和页面大小= 88”方法：=“获得”要求的事情，犯错：=http．NewRequest（方法，url，零）如果犯错! =零{fmt．Println（犯错）返回｝要求的事情．头．添加（“亚博Zendesk-Api-Version”，“2023-02-01”）要求的事情．头．添加（“内容类型”，“application / json”）客户端：=&http．客户端{｝res，犯错：=客户端．做（要求的事情）如果犯错! =零{fmt．Println（犯错）返回｝推迟res．身体．关闭（）身体，犯错：=io．ReadAll（res．身体）如果犯错! =零{fmt．Println（犯错）返回｝fmt．Println（字符串（身体））｝
Java
进口com．squareup．okhttp．＊；OkHttpClient客户端=新OkHttpClient（）；HttpUrl．构建器urlBuilder=HttpUrl．解析（“https://support.亚博zendesk.com/api/v2/agent_availabilities/agent_statuses”）．newBuilder（）．addQueryParameter（“页面(后)”，“1234”）．addQueryParameter（“页面(前)”，“1234”）．addQueryParameter（“页面大小”，“88”）；请求请求=新请求．构建器（）．url（urlBuilder．构建（））．方法（“获得”，零）．addHeader（“亚博Zendesk-Api-Version”，“2023-02-01”）．addHeader（“内容类型”，“application / json”）．构建（）；响应响应=客户端．newCall（请求）．执行（）；
Nodejs
varaxios=需要（“axios”）；var配置={方法：“得到”，url：“https://support.亚博zendesk.com/api/v2/agent_availabilities/agent_statuses”，头：{“亚博Zendesk-Api-Version”：“2023-02-01”，“内容类型”：“application / json”，｝，参数个数：{的页面(后)：“1234”，的页面(前)：“1234”，页面(大小)的：“88”，｝，｝；axios（配置）．然后（函数（响应）{控制台．日志（JSON．stringify（响应．数据））；｝）．抓（函数（错误）{控制台．日志（错误）；｝）；
Python
进口请求url=“https://support.亚博zendesk.com/api/v2/agent_availabilities/agent_statuses?page[在]= 1234和页面(前)= 1234和页面大小= 88”头={“亚博Zendesk-Api-Version”：“2023-02-01”，“内容类型”：“application / json”，｝响应=请求．请求（“获得”，url，头=头）打印（响应．文本）
鲁比（人名）
需要“net/http”uri=URI（“https://support.亚博zendesk.com/api/v2/agent_availabilities/agent_statuses”）uri．查询=URI．encode_www_form（“页面(后)”：“1234”，“页面(前)”：“1234”，“页面大小”：“88”）请求=网：：HTTP：：得到．新（uri，“亚博Zendesk-Api-Version”：“2023-02-01”，“内容类型”：“application / json”）响应=网：：HTTP．开始uri．主机名，uri．港口，use_ssl：真正的做|http|http．请求（请求）结束
示例响应(年代)
200好了
//状态200 OK{“自定义”：［{“属性”：{“通道”：{“消息”：“走”，“支持”：“在线”，“交谈”：“走”｝，“描述”：“开会时使用”，“名称”：“在会议上”｝，“id”：205，“类型”：“agent_status”，“updated_at”：“2021 - 07 - 21 - t17:32:28z”｝，{“属性”：{“通道”：{“消息”：“走”，“支持”：“在线”，“交谈”：“走”｝，“描述”：“通话时使用”，“名称”：“自定义状态2”｝，“id”：206，“类型”：“agent_status”，“updated_at”：“2021 - 07 - 21 - t17:32:28z”｝］，“默认”：［{“属性”：{“描述”：“接不到工作”，“名称”：“离线”｝，“id”：2，“类型”：“agent_status”｝，{“属性”：{“描述”：“可以接受工作”，“名称”：“在线”｝，“id”：3.，“类型”：“agent_status”｝］，“链接”：{“下一个”：“https://example.亚博zendesk.com/api/v2/agent_availabilities/agent_statuses?page%5Bafter%5D=206”，“上一页”：“https://example.亚博zendesk.com/api/v2/agent_availabilities/agent_statuses?page%5Bbefore%5D=205”｝，“元”：{“has_more”：真正的｝｝
400错误请求
//状态400错误请求{“错误”：［{“代码”：“InvalidPaginationParameter”，“标题”："page[size]必须是一个正整数<= 100;有0”｝］｝
401年未经授权
//状态401未授权{“错误”：［{“代码”：“未经授权的”，“标题”：“未经授权的”｝］｝
403年被禁止的
//状态403禁止{“错误”：［{“代码”：“InvalidPermissions”，“标题”：“禁止”｝］｝
406不接受
//状态406不可接受{“错误”：［{“代码”：“NotAcceptable”，“标题”：“不可接受”｝］｝
423锁
//状态423锁定{“错误”：［{“代码”：“AccountLocked”，“标题”：“帐户被锁定”｝］｝
请求太多
//状态429请求过多{“错误”：［{“代码”：“TooManyRequests”，“标题”：“请求太多”｝］｝
500服务器内部错误
//状态500服务器内部错误{“错误”：［{“代码”：“InternalServerError”，“标题”："内部服务器错误"｝］｝
更新座席统一状态。
把/ api / v2 / agent_availabilities / agent_statuses /代理/ {agent_id}
更新座席统一状态。要求为该帐户启用全通道路由设置。
允许
- 管理员
参数
| 名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| agent_id | 整数 | 路径 | 真正的 | 代理id |
例子的身体
{“id”：“123”｝
代码示例
旋度
旋度- v - u{email_address｝：{密码｝＼——请求把“https://example.亚博zendesk.com/api/v2/agent_availabilities/agent_statuses/agents/1011”＼——头“亚博Zendesk-Api-Version: 2023-02-01”＼——头“application / json内容类型:＼——data-raw'{"id": 123}'
去
进口（“fmt”“输入输出”“net/http”“弦”）函数主要（）{url：=“https://support.亚博zendesk.com/api/v2/agent_availabilities/agent_statuses/agents/10011”方法：=“把”有效载荷：=字符串．NewReader（”{“id”:“123”} '）要求的事情，犯错：=http．NewRequest（方法，url，有效载荷）如果犯错! =零{fmt．Println（犯错）返回｝要求的事情．头．添加（“亚博Zendesk-Api-Version”，“2023-02-01”）要求的事情．头．添加（“内容类型”，“application / json”）客户端：=&http．客户端{｝res，犯错：=客户端．做（要求的事情）如果犯错! =零{fmt．Println（犯错）返回｝推迟res．身体．关闭（）身体，犯错：=io．ReadAll（res．身体）如果犯错! =零{fmt．Println（犯错）返回｝fmt．Println（字符串（身体））｝
Java
进口com．squareup．okhttp．＊；OkHttpClient客户端=新OkHttpClient（）；HttpUrl．构建器urlBuilder=HttpUrl．解析（“https://support.亚博zendesk.com/api/v2/agent_availabilities/agent_statuses/agents/10011”）．newBuilder（）；RequestBody身体=RequestBody．创建（MediaType．解析（“application / json”），＂＂”{\ \“id”：\”123\”｝＂＂”）；请求请求=新请求．构建器（）．url（urlBuilder．构建（））．方法（“把”，身体）．addHeader（“亚博Zendesk-Api-Version”，“2023-02-01”）．addHeader（“内容类型”，“application / json”）．构建（）；响应响应=客户端．newCall（请求）．执行（）；
Nodejs
varaxios=需要（“axios”）；var数据=JSON．stringify（{“id”：“123”｝）；var配置={方法：“把”，url：“https://support.亚博zendesk.com/api/v2/agent_availabilities/agent_statuses/agents/10011”，头：{“亚博Zendesk-Api-Version”：“2023-02-01”，“内容类型”：“application / json”，｝，数据：数据，｝；axios（配置）．然后（函数（响应）{控制台．日志（JSON．stringify（响应．数据））；｝）．抓（函数（错误）{控制台．日志（错误）；｝）；
Python
进口请求进口jsonurl=“https://support.亚博zendesk.com/api/v2/agent_availabilities/agent_statuses/agents/10011”有效载荷=json．加载（”““{“id”:“123”}”“”）头={“亚博Zendesk-Api-Version”：“2023-02-01”，“内容类型”：“application / json”，｝响应=请求．请求（“把”，url，头=头，json=有效载荷）打印（响应．文本）
鲁比（人名）
需要“net/http”uri=URI（“https://support.亚博zendesk.com/api/v2/agent_availabilities/agent_statuses/agents/10011”）请求=网：：HTTP：：把．新（uri，“亚博Zendesk-Api-Version”：“2023-02-01”，“内容类型”：“application / json”）请求．身体=％问（{“id”：“123”｝）响应=网：：HTTP．开始uri．主机名，uri．港口，use_ssl：真正的做|http|http．请求（请求）结束
示例响应(年代)
200好了
//状态200 OK{“数据”：{“属性”：{“agent_id”：10011，“agent_status”：{“id”：123，“名称”：“在会议上”｝｝，“id”：“agent_availabilities | 10011”，“类型”：“agent_availabilities”｝｝
400错误请求
//状态400错误请求{“错误”：［{“代码”：“InvalidParameter”，“标题”：“坏请求”｝］｝
401年未经授权
//状态401未授权{“错误”：［{“代码”：“未经授权的”，“标题”：“身份验证错误”｝］｝
403年被禁止的
//状态403禁止{“错误”：［{“代码”：“InvalidPermissions”，“标题”：“禁止”｝］｝
404未找到
//状态404未找到{“错误”：［{“代码”：“AgentNotFound”，“标题”：“没有找到”｝］｝
406不接受
//状态406不可接受{“错误”：［{“代码”：“NotAcceptable”，“标题”：“不可接受”｝］｝
409年冲突
//状态409冲突{“错误”：［{“代码”：“ConflictUpdate”，“标题”："无法更新当前代理状态，因为之前的更新仍未完成"｝］｝
423锁
//状态423锁定{“错误”：［{“代码”：“AccountLocked”，“标题”：“帐户被锁定”｝］｝
请求太多
//状态429请求过多{“错误”：［{“代码”：“TooManyRequests”，“标题”：“请求太多”｝］｝
500服务器内部错误
//状态500服务器内部错误{“错误”：［{“代码”：“InternalServerError”，“标题”："内部服务器错误"｝］｝