1 座席管理
BaseURI
/Accounts/{accountSid}/Applications/{applicationSid}/ccpaas/Agents
坐席属性
属性名 | 说明 |
agentNo | 坐席工号。应用下唯一 |
sipNumber | 座席绑定的SIP号码 |
pstnNumber | 坐席绑定PSTN号码 |
agentGroupId | 坐席所属坐席组 |
pwd | 坐席登陆密码 |
操作
操作 | Method | 请求 URI |
创建座席 | POST | {BaseURI}/create |
修改座席 | POST | {BaseURI}/update |
查询座席 | POST | {BaseURI}/query |
创建座席
请求示例
POST /Accounts/abcdefghijklmnopqrstuvwxyz012345/Applications/5d6dcb4dda22fb74262a0fec333b6d97/ccpaas/Agents/create HTTP/1.1
Content-Type: application/json;charset=utf-8
{
"agentNo":"1111",
"pstnNumber":"13910233679"，
"fromNumber":"13046343040"
}
请求参数说明
参数名 | R | 说明 |
agentNo | M | 坐席工号，应用自定义，应用范围内唯一（建议8位以内数字） |
pstnNumber | O | 坐席绑定的手机号 |
fromNumber | O | 坐席的外显号 |
响应示例
HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8
{
"statusCode": "00000",
"statusMsg": "succ",
"data": {
"agentNo":"1111",
"pwd":"zzzzz",
"sipNumber":"70010000110001",
"sipPwd":"zzzzzz",
}
}
HTTP/1.1 200 OK
{
"statusCode":"00000",
"statusMsg":"success"
}
响应参数说明
参数名称 | R | 描述信息 |
statusCode | M | 响应码 |
statusMsg | O | 响应描述 |
修改座席
请求示例
POST /Accounts/abcdefghijklmnopqrstuvwxyz012345/Applications/5d6dcb4dda22fb74262a0fec333b6d97/ccpaas/Agents/update HTTP/1.1
Content-Type: application/json;charset=utf-8
{
"agentNo":"1111",
"sipNumber":"700100002100000007"
}
请求参数说明
参数名 | R | 说明 |
agentNo | M | 坐席工号，必须是已存在的 |
pwd | O | 坐席登陆密码 |
sipNumber | O | 若值为""，则解绑坐席的SIP号码 |
pstnNumber | O | 若值为""，则将解绑坐席的PSTN号码 |
agentGroupId | O | 坐席所属坐席组 |
fromNumber | O | 坐席的外显号 |
响应示例
HTTP/1.1 200 OK
{
"statusCode":"00000",
"statusMsg":"success"
}
响应参数说明
参数名称 | R | 描述信息 |
statusCode | M | 响应码 |
statusMsg | O | 响应描述 |
查询座席
请求示例
POST /Accounts/abcdefghijklmnopqrstuvwxyz012345/Applications/5d6dcb4dda22fb74262a0fec333b6d97/ccpaas/Agents/query HTTP/1.1
Content-Type: application/json;charset=utf-8
请求参数说明
参数名 | R | 说明 |
agentNo | M | 坐席工号，必须是已存在的 |
响应示例
HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8
{
"statusCode": "00000",
"statusMsg": "succ",
"data": {
"pstnNumber":"13500000001",
"sipNumber":"700100002100000007",
"sipPwd":"hjdshfu",
"pwd":"zzzzz"
}
}
响应参数说明
参数名称 | R | 描述信息 |
statusCode | M | 响应码 |
statusMsg | O | 响应描述 |
data | O | 坐席数据 |
获取所有坐席工号
请求示例
POST /2018-01-01/Accounts/abcdefghijklmnopqrstuvwxyz012345/Applications/5d6dcb4dda22fb74262a0fec333b6d97/ccpaas/Agents/getall HTTP/1.1
Content-Type: application/json;charset=utf-8
响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 135
{
"statusCode": "00000",
"statusMsg": "succ",
"data":["1101","1111"]
}
响应参数说明
参数名称 | R | 描述信息 |
statusCode | M | 响应码 |
statusMsg | O | 响应描述 |
data | O | 坐席工号列表 |
2 SIP分机管理
BaseURI
/Accounts/{accountSid}/Applications/{applicationSid}/ccpaas/sipexts
SIP分机属性
属性名 | 说明 |
sipNumber | SIP号码 |
pwd | SIP密码，6至10位，由数字和字母组成 |
操作
操作 | Method | 请求 URI |
修改密码 | POST | {BaseURI}/updatePasswd |
修改SIP分机密码
请求示例
POST /Accounts/abcdefghijklmnopqrstuvwxyz012345/Applications/5d6dcb4dda22fb74262a0fec333b6d97/ccpaas/sipexts/updatePasswd HTTP/1.1
Content-Type: application/json;charset=utf-8
{
"sipNumber":"700100002100000007",
"pwd":"dfie12"
}
请求参数说明
参数名 | R | 说明 |
sipNumber | M | SIP号码 |
pwd | M | 密码 "dfie12" |
响应示例
HTTP/1.1 200 OK
{
"statusCode":"00000",
"statusMsg":"success"
}
响应参数说明
参数名称 | R | 描述信息 |
statusCode | M | 响应码 |
statusMsg | O | 响应描述 |
3 坐席组管理
Base URI
/{SoftVersion}/Accounts/{accountSid}/Applications/{appSid}/ccpaas/AgentGroups
坐席组属性 | 说明 |
agentGroupId | 坐席组号；应用下唯一 |
description | 描述 |
userCli | 坐席组关联的主叫标识 |
操作
操作 | Method | 请求 URI |
创建坐席组 | POST | {BaseURI}/create |
删除坐席组 | POST | {BaseURI}/delete |
修改坐席组 | POST | {BaseURI}/update |
查询坐席组 | POST | {BaseURI}/query |
获取所有坐席组标识 | POST | {BaseURI}/getall |
创建坐席组
请求示例
POST /2018-01-01/Accounts/abcdefghijklmnopqrstuvwxyz012345/Applications/5d6dcb4dda22fb74262a0fec333b6d97/ccpaas/AgentGroups/create HTTP/1.1
Content-Type: application/json;charset=utf-8
{
"agentGroupId":"AG1001",
"description":"坐席组1001"
}
请求参数说明
参数名称 | R | 说明 |
queagentGroupId | M | 应用下唯一 |
description | O | 描述 |
userCli | O | 主叫线标识 |
响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 135
{
"statusCode": "00000",
"statusMsg": "succ",
"data":{
"agentGroupId":"AG1001",
"description":"坐席组1001"
}
}
响应参数说明
参数名称 | R | 描述信息 |
statusCode | M | 响应码 |
statusMsg | O | 响应描述 |
data | O | 坐席组数据 |
删除坐席组
请求示例
POST /2018-01-01/Accounts/abcdefghijklmnopqrstuvwxyz012345/Applications/5d6dcb4dda22fb74262a0fec333b6d97/ccpaas/AgentGroups/delete HTTP/1.1
Content-Type: application/json;charset=utf-8
{
"agentGroupId":"AG1001"
}
请求参数说明
参数名称 | R | 说明 |
agentGroupId | M | 应用下唯一 |
响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 135
{
"statusCode": "00000",
"statusMsg": "succ",
}
响应参数说明
参数名称 | R | 描述信息 |
statusCode | M | 响应码 |
statusMsg | O | 响应描述 |
修改坐席组
请求示例
POST /2018-01-01/Accounts/abcdefghijklmnopqrstuvwxyz012345/Applications/5d6dcb4dda22fb74262a0fec333b6d97/ccpaas/AgentGroups/update HTTP/1.1
Content-Type: application/json;charset=utf-8
{
"agentGroupId":"AG1001",
"description":"坐席组1001"
}
请求参数说明
参数名称 | R | 说明 |
agentGroupId | M | 应用下唯一 |
description | O | 描述 |
userCli | O | 主叫线标识 |
响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 135
{
"statusCode": "00000",
"statusMsg": "succ",
"data":{
"agentGroupId":"AG1001",
"description":"坐席组1001"
}
}
响应参数说明
参数名称 | R | 描述信息 |
statusCode | M | 响应码 |
statusMsg | O | 响应描述 |
data | O | 坐席组信息 |
查询坐席组
请求示例
POST /2018-01-01/Accounts/abcdefghijklmnopqrstuvwxyz012345/Applications/5d6dcb4dda22fb74262a0fec333b6d97/ccpaas/AgentGroups/query HTTP/1.1
Content-Type: application/json;charset=utf-8
{
"agentGroupId":"AG1001"
}
请求参数说明
参数名称 | R | 说明 |
agentGroupId | M | 坐席组Id |
响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 135
{
"statusCode": "00000",
"statusMsg": "succ",
"data":[
{
"agentGroupId":"AG1001",
"description":"坐席组1001",
"agents":["1001","1002","1003"]
}
]
}
响应参数说明
参数名称 | R | 描述信息 |
statusCode | M | 响应码 |
statusMsg | O | 响应描述 |
data | O | 坐席组信息及坐席组的坐席号列表 |
|
| 以下为data中的信息 |
agentGroupId | C | 坐席组号 |
description | O | 坐席组描述 |
userCli | O | 坐席组主叫线标识 |
agents | O | 坐席组的坐席号列表 |
获取所有坐席组号
请求示例
POST /2018-01-01/Accounts/abcdefghijklmnopqrstuvwxyz012345/Applications/5d6dcb4dda22fb74262a0fec333b6d97/ccpaas/AgentGroups/getall HTTP/1.1
Content-Type: application/json;charset=utf-8
响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 135
{
"statusCode": "00000",
"statusMsg": "succ",
"data":["AG1001","AG1011"]
}
响应参数说明
参数名称 | R | 描述信息 |
statusCode | M | 响应码 |
statusMsg | O | 响应描述 |
data | O | 坐席组号列表 |
4 队列管理
Base URI
/{SoftVersion}/Accounts/{accountSid}/Applications/{appSid}/ccpaas/Queues
队列属性 | 说明 |
queueId | 队列号；应用下唯一 |
description | 队列描述 |
userCli | 队列上关联的主叫标识 |
priority | 队列优先级；默认取值1，取值范围1-10(数值越高优先级越高) |
prompt | 排队等待提示音 |
timeout | 超时 |
操作
操作 | Method | 请求 URI |
创建队列 | POST | {BaseURI}/create |
删除队列 | POST | {BaseURI}/delete |
修改队列 | POST | {BaseURI}/update |
查询队列 | POST | {BaseURI}/query |
获取所有队列标识 | POST | {BaseURI}/getall |
创建队列
请求示例
POST /2018-01-01/Accounts/abcdefghijklmnopqrstuvwxyz012345/Applications/5d6dcb4dda22fb74262a0fec333b6d97/ccpaas/Queues/create HTTP/1.1
Content-Type: application/json;charset=utf-8
{
"queueId":"Q1001",
"description":"队列1001",
"priority":"10"
}
请求参数说明
参数名称 | R | 说明 |
queueId | M | 应用下唯一 |
description | O | 描述 |
priority | O | 优先级 |
userCli | O | 主叫线标识 |
prompt | O | 排队等待提示音 |
timeout | O | 超时 |
响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 135
{
"statusCode": "00000",
"statusMsg": "succ",
"data":{
"queueId":"Q1001",
"description":"队列1001",
"priority":"10"
}
}
响应参数说明
参数名称 | R | 描述信息 |
statusCode | M | 响应码 |
statusMsg | O | 响应描述 |
data | O | 队列数据 |
删除队列
请求示例
POST /2018-01-01/Accounts/abcdefghijklmnopqrstuvwxyz012345/Applications/5d6dcb4dda22fb74262a0fec333b6d97/ccpaas/Queues/delete HTTP/1.1
Content-Type: application/json;charset=utf-8
请求参数说明
响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 135
{
"statusCode": "00000",
"statusMsg": "succ",
}
响应参数说明
参数名称 | R | 描述信息 |
statusCode | M | 响应码 |
statusMsg | O | 响应描述 |
修改队列
请求示例
POST /2018-01-01/Accounts/abcdefghijklmnopqrstuvwxyz012345/Applications/5d6dcb4dda22fb74262a0fec333b6d97/ccpaas/Queues/update HTTP/1.1
Content-Type: application/json;charset=utf-8
{
"queueId":"Q1001",
"description":"队列1001",
"priority":"10"
}
请求参数说明
参数名称 | R | 说明 |
queueId | M | 应用下唯一 |
description | O | 描述 |
priority | O | 优先级 |
userCli | O | 主叫线标识 |
prompt | O | 排队等待提示音 |
timeout | O | 超时 |
响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 135
{
"statusCode": "00000",
"statusMsg": "succ",
"data":{
"queueId":"Q1001",
"description":"队列1001",
"priority":"10"
}
}
响应参数说明
参数名称 | R | 描述信息 |
statusCode | M | 响应码 |
statusMsg | O | 响应描述 |
data | O | 队列数据 |
查询队列
请求示例
POST /2018-01-01/Accounts/abcdefghijklmnopqrstuvwxyz012345/Applications/5d6dcb4dda22fb74262a0fec333b6d97/ccpaas/Queues/query HTTP/1.1
Content-Type: application/json;charset=utf-8
请求参数说明
响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 135
{
"statusCode": "00000",
"statusMsg": "succ",
"data":[
{
"queueId":"Q1001",
"description":"队列1001",
"priority":"10"
}
]
}
响应参数说明
参数名称 | R | 描述信息 |
statusCode | M | 响应码 |
statusMsg | O | 响应描述 |
data | O | 队列数据 |
获取所有队列号
请求示例
POST /2018-01-01/Accounts/abcdefghijklmnopqrstuvwxyz012345/Applications/5d6dcb4dda22fb74262a0fec333b6d97/ccpaas/Queues/getall HTTP/1.1
Content-Type: application/json;charset=utf-8
响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 135
{
"statusCode": "00000",
"statusMsg": "succ",
"data":["Q1001","Q1011"]
}
响应参数说明
参数名称 | R | 描述信息 |
statusCode | M | 响应码 |
statusMsg | O | 响应描述 |
data | O | 队列数据 |
5 坐席-队列绑定关系管理
/Accounts/{accountSid}/Applications/{applicationSid}/ccpaas/AgentQueueMappings
坐席-队列绑定关系属性 | 说明 |
agentNo | 坐席号 |
queueId | 队列号 |
degree | 坐席在队列中的熟练度 |
操作
操作 | Method | 请求 URI |
创建坐席-队列绑定关系 | POST | {BaseURI}/create |
删除坐席-队列绑定关系 | POST | {BaseURI}/delete |
查询坐席-队列绑定关系 | POST | {BaseURI}/query |
创建坐席-队列绑定关系
请求示例
POST /2018-01-01/Accounts/abcdefghijklmnopqrstuvwxyz012345/Applications/5d6dcb4dda22fb74262a0fec333b6d97/ccpaas/AgentQueueMappings/create HTTP/1.1
Content-Type: application/json;charset=utf-8
{
"agentNo":"1001",
"queueId":"Q1001"
}
请求参数说明
参数名称 | R | 说明 |
agentNo | M | 坐席号 |
queueId | M | 队列标识。 |
override | O | 覆盖标志。"0"(默认)不覆盖；"1":覆盖（解绑）座席的其他绑定关系 |
响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 135
{
"statusCode": "00000",
"statusMsg": "succ",
}
响应参数说明
参数名称 | R | 描述信息 |
statusCode | M | 响应码 |
statusMsg | O | 响应描述 |
错误响应码说明
statusCode | 说明 |
10011 | （绑定）已经存在 |
10012 | （绑定）失败 |
删除坐席-队列绑定关系
请求示例
POST /2018-01-01/Accounts/abcdefghijklmnopqrstuvwxyz012345/Applications/5d6dcb4dda22fb74262a0fec333b6d97/ccpaas/AgentQueueMappings/delete HTTP/1.1
Content-Type: application/json;charset=utf-8
{
"agentNo":"1001",
"queueId":"Q1001"
}
请求参数说明
参数名称 | R | 说明 |
queueId | M | 队列标识。 |
agentNo | O | 坐席号。如果不存在，则解绑队列上绑定的所有坐席 |
响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 135
{
"statusCode": "00000",
"statusMsg": "succ"
}
响应参数说明
参数名称 | R | 描述信息 |
statusCode | M | 响应码 |
statusMsg | O | 响应描述 |
错误响应码说明
statusCode | 说明 |
10021 | （解绑）关系不存在 |
10022 | （解绑）失败 |
查询坐席-队列绑定关系
请求示例
POST /2018-01-01/Accounts/abcdefghijklmnopqrstuvwxyz012345/Applications/5d6dcb4dda22fb74262a0fec333b6d97/ccpaas/AgentQueueMappings/query HTTP/1.1
Content-Type: application/json;charset=utf-8
请求参数说明
参数名称 | R | 说明 |
agentNo | O | 坐席号 |
queueId | O | 队列标识 |
响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 135
{
"statusCode": "00000",
"statusMsg": "succ",
"data":[
{
"agentNo":"1001",
"queueId":"Q1001"
}
]
}
响应参数说明
参数名称 | R | 描述信息 |
statusCode | M | 响应码 |
statusMsg | O | 响应描述 |
data | O | 坐席-队列绑定关系列表 |
|
| 以下为data中的信息 |
agentNo | O | 坐席组号 |
queueId | O | 队列号描述 |