呼叫管理

街机捕鱼大富翁破解版 www.ywfxb.tw 若您初次使用智齿呼叫中心PAAS对接接口,请在使用前阅读说明文档

调用说明

请求及响应报文格式采用JSON格式。

SoftVersion是当前使用的REST API版本,不同版本会有差异,智齿api版本规范为:v1代表第一版,v2代表第二版,当前最新的版本为v1,在开发时需要注意填写正确。

对接URL

当前云通信平台对接地址为://www.ywfxb.tw/comm/

一、坐席外呼

说明:座席人员主动发起外呼。座席状态只有在准备就绪、忙碌状态下才能进行外呼。

请求地址

POST:

/api/{softVersion}/call/agentMakeCall

请求包体

属性 类型 约束 说明 举例
companyId String 必选 公司id -
appId String 必选 应用id节点 -
number String 必选 座席手机号(手机登陆方式时)、voip账号 -
agentId String 必选 座席id -
displayNumber String 必选 外呼显示的主叫号码 -
destinationNumber String 必须 被叫号码 -
groupId String 必选 外呼时所在技能组 -

请求示例

{
  "companyId": "3bc989fa393b40b8b6208a539cc0e8ed",
  "appId": "286636dc58d645288db74f2601799b05",
  "number":"123550000",
  "agentId":"3503f305d991406aab746ddfbece4716",
  "destinationNumber":"18515239792",
  "groupId":"837105db68a64c819510af022ce36dd0"
}

响应包体

属性 类型 说明
callId String 通话的唯一标志
retCode String 请求状态码,取值000000(成功)
retMsg String 请求状态描述

响应示例

{
  "callId": “cb266f9c-ff7b-41d8-83cb-e5da321e9b1c”, 
  "retCode": "000000",
  "retMsg": "成功"
}

二、查询坐席状态

说明:查询座席的工作状态

请求地址

POST:

 /api/{softVersion}/call/queryAgentState

请求包体

属性 类型 约束 说明 举例
companyId String 必选 公司id -
appId String 必选 应用id节点 -
agentId String 必选 座席ID -

请求示例

{ 
    "companyId": "3bc6f5deb9b441388e3ea56dcfca8b8e",
    "appId": "2571b1d01a294b779e4bb3ebcf075596",
    "agentId":"9f4efcdeb3774d71aecc85e39c93357c"
}

响应包体

属性 类型 说明
retCode String 请求状态码,取值000000(成功)
retMsg String 请求状态描述
agentId String 座席ID
agentState String 坐席状态,其中-1为离线,0为忙碌(忙碌时根据basyCause判定具体是属于什么类型,115代表后处理状态),1为空闲,3为通话接通中,99为异常
busyCause String 自定义忙碌分类
callWay String 登录方式:2SIP话机;3手机方式

响应示例

{
    "item": {
        "agentId": "9f4efcdeb3774d71aecc85e39c93357c",
        "agentState": "1",
        "appId": "2571b1d01a294b779e4bb3ebcf075596",
        "companyId": "3bc6f5deb9b441388e3ea56dcfca8b8e"
        "callWay":"2"
    },
    "retCode": "000000",
    "retMsg": "success"
}

三、批量查询坐席状态

说明:批量查询座席的工作状态

请求地址

POST:

/api/{softVersion}/call/queryAllAgentState

请求包体

属性 类型 约束 说明 举例
companyId String 必选 公司id
appId String 必选 应用id节点

请求示例

{ 

       "companyId": "3bc6f5deb9b441388e3ea56dcfca8b8e",

       "appId": "2571b1d01a294b779e4bb3ebcf075596"

}

响应包体

属性 类型 说明
retCode String 请求状态码,取值000000(成功)
retMsg String 请求状态描述
items.agentId String 座席ID
items.agentState String 坐席状态,其中-1为离线,0为忙碌(忙碌时根据basyCause判定具体是属于什么类型,115代表后处理状态),1为空闲,3为通话接通中,99为异常
items.busyCause String 自定义忙碌分类
items.callWay String 登录方式:2SIP话机;3手机方式

响应示例

{

    "items": [{

        "agentId": "9f4efcdeb3774d71aecc85e39c93357c",

        "agentState": "1",

        "appId": "2571b1d01a294b779e4bb3ebcf075596",

        "companyId": "3bc6f5deb9b441388e3ea56dcfca8b8e",

 "callWay":"2"

},

{

        "agentId": "8f4efcdeb3774d71aecc85e39c93357c",

        "agentState": "1",

        "appId": "2571b1d01a294b779e4bb3ebcf075596",

        "companyId": "3bc6f5deb9b441388e3ea56dcfca8b8e",

 "callWay":"2"

    }

],

    "retCode": "000000",

    "retMsg": "success"

}

四、修改坐席状态

请求地址

POST:

 /api/{softVersion}/call/updateAgentState

请求包体

属性 类型 约束 说明 举例
companyId String 必选 公司id -
appId String 必选 应用id节点 -
agentId String 必须 座席ID 无此参数返回全部座席。
agentState String 必选 改变为的状态 “1”:就绪 其他值则为自定义状态 ,在后续坐席状态推送时通过busyCause字段回传

请求示例

{
  "companyId": "23446e243e594504b0fd0f679cafeeed",
  "appId": "efcf295bc4694468be54bca2f23e26ec",
  "agentId":"a3f7555ffdc74b45956028ccc891d882",
  "agentState":"1"
}

响应包体

属性 类型 说明
retCode String 请求状态码,取值000000(成功)
retMsg String 请求状态描述

响应示例

{
    "retCode": "000000",
    "retMsg": "成功"
}

五、坐席结束通话转满意度评价

说明:征得用户同意后座席可主动结速通话,但用户通话未挂断,应用侧可继续为用户执行后续业务逻辑。

请求地址

POST:

 /api/{softVersion}/call/agentTransferCS

请求包体

属性 类型 约束 说明 举例
companyId String 必选 公司id -
appId String 必选 应用id节点 -
caller String 必选 主叫号码。 -
callId String 必选 通话的callId -
agentId String 必选 座席id 8001

请求示例

{ 
"companyId": "afd4f2ab7bda428bb833bee5304e480f",
"appId": "986f49cb014e4c5192ddd063cefbb23a",
"caller": "18515234567",
"callId": "ecd9da53-fbf2-4c3a-a9ad-a66441e417da",
"agentId": "00c5eb93bf5d4ea286caa0ded61f9de5"
}

响应包体

属性 类型 说明
retCode String 请求状态码,取值000000(成功)
retMsg String 请求状态描述

响应示例

{
  "retCode": "000000",
  "retMsg": "成功"
}

六、坐席呼叫中发起转接

说明:通话中座席将用户的呼叫转接到另外一个座席或第三方号码接听。

请求地址

POST:

/api/{softVersion}/call/agentTransfer

请求包体

属性 类型 约束 说明 举例
companyId String 必选 公司id -
appId String 必选 应用id节点 -
agentId String 必选 座席id 8001
caller String 必选 转接发起者的voip号码或手机号 -
transferNumber String 必选 转到的坐席ID -
groupId String 必选 所属技能组ID -
caller String 必选 主叫号码 -
callId String 必选 通话ID -

请求示例

{ 
"companyId": "afd4f2ab7bda428bb833bee5304e480f",
"appId": "986f49cb014e4c5192ddd063cefbb23a",
"caller": "900540000",
"transferNumber": "900540001",
"groupId": "123qwe",
"callId": "ecd9da53-fbf2-4c3a-a9ad-a66441e417da",
"agentId": "00c5eb93bf5d4ea286caa0ded61f9de5"
    }

响应包体

属性 类型 说明
retCode String 请求状态码,取值000000(成功)
retMsg String 请求状态描述

响应示例

{
  "retCode": "000000",
  "retMsg": "成功"
}

七、坐席呼叫转接确认

说明:通话中座席将用户的呼叫转接到另外一个座席或第三方号码接听。

请求地址

POST:

/api/{softVersion}/call/agentTransferConfirm

请求包体

属性 类型 约束 说明 举例
companyId String 必选 公司id -
appId String 必选 应用id节点 -
callId String 必选 通话ID -
agentId String 必选 座席id 8001
caller String 必选 主叫号码 -

请求示例

{ 
"companyId": "afd4f2ab7bda428bb833bee5304e480f",
"appId": "986f49cb014e4c5192ddd063cefbb23a",
"caller": "900540000",
"callId": "ecd9da53-fbf2-4c3a-a9ad-a66441e417da",
"agentId": "00c5eb93bf5d4ea286caa0ded61f9de5"
    }

响应包体

属性 类型 说明
retCode String 请求状态码,取值000000(成功)
retMsg String 请求状态描述

响应示例

{
  "retCode": "000000",
  "retMsg": "成功"
}

八、坐席挂断

说明:坐席挂断。

请求地址

POST:

 /api/{softVersion}/call/agentHangUp

请求包体

属性 类型 约束 说明 举例
companyId String 必选 公司id -
appId String 必选 应用id节点 -
caller String 必选 主叫号码。 -
callId String 必选 通话的callId -
agentId String 必选 座席id 8001

请求示例

{ 
"companyId": "afd4f2ab7bda428bb833bee5304e480f",
"appId": "986f49cb014e4c5192ddd063cefbb23a",
"caller": "900540000",
"callId": "ecd9da53-fbf2-4c3a-a9ad-a66441e417da",
"agentId": "00c5eb93bf5d4ea286caa0ded61f9de5"
    }

响应包体

属性 类型 说明
retCode String 请求状态码,取值000000(成功)
retMsg String 请求状态描述

响应示例

{
  "retCode": "000000",
  "retMsg": "成功"
}

九、转接第三方号码

说明:转接第三方号码。

请求地址

POST:

 /api/{softVersion}/call/transferThirdNum

请求包体

属性 类型 约束 说明 举例
companyId String 必选 公司id -
appId String 必选 应用id节点 -
caller String 必选 主叫号码。 -
agentId String 必选 当前座席id -
callId String 必选 通话的callId -
transferType String 必选 转接类型:0-呼入转接,1-呼出转接 -
transferNumber String 必选 第三方号码 -

请求示例

{ 
"companyId": "afd4f2ab7bda428bb833bee5304e480f",
"appId": "986f49cb014e4c5192ddd063cefbb23a",
"caller": "900540000",
"transferType": "900540000",
" transferNumber": "18515238654",
"callId": "ecd9da53-fbf2-4c3a-a9ad-a66441e417da",
"agentId": "00c5eb93bf5d4ea286caa0ded61f9de5"
    }

响应包体

属性 类型 说明
retCode String 请求状态码,取值000000(成功)
retMsg String 请求状态描述

响应示例

{
  "retCode": "000000",
  "retMsg": "成功"
}

十、转接技能组

说明:转接技能组。

请求地址

POST:

 /api/{softVersion}/call/transferGroup

请求包体

属性 类型 约束 说明 举例
companyId String 必选 公司id -
appId String 必选 应用id节点 -
caller String 必选 主叫号码。 -
callId String 必选 通话的callId -
agentId String 必选 座席id -
transferType String 必选 转接类型:0-呼入转接,1-呼出转接 -
groupId String 必选 转接的技能组id -
timeout String 必选 排队超时时间(秒) -

请求示例

{ 
"companyId": "afd4f2ab7bda428bb833bee5304e480f",
"appId": "986f49cb014e4c5192ddd063cefbb23a",
"caller": "900540000",
"transferType": "900540000",
"groupId": "123qwe",
"timeout": "30",
"callId": "ecd9da53-fbf2-4c3a-a9ad-a66441e417da",
"agentId": "00c5eb93bf5d4ea286caa0ded61f9de5"
    }

响应包体

属性 类型 说明
retCode String 请求状态码,取值000000(成功)
retMsg String 请求状态描述

响应示例

{
  "retCode": "000000",
  "retMsg": "成功"
}

十一、监听

说明:监听。

请求地址

POST :

 /api/{softVersion}/call/agentEavesdrop

请求包体

属性 类型 约束 说明 举例
companyId String 必选 公司id -
appId String 必选 应用id节点 -
transferType int 必选 呼入呼出标记。 -
callId String 必选 通话的callId -
agentId String 必选 被监听座席id -
groupId String 必选 所在技能组ID -
adminAgentId String 必选 监听方坐席id -

请求示例

{ 
"companyId": "626632d761be4da2a33c7f26f6e50b41",
"appId": "80ecc892384b4f03b62176d6654ef2e9",
"callId": "60ee821c-8873-4b7f-a84d-ec067690c7c4",
"groupId": "123ewq",
"agentId": "58755c771d294871a78a0c8dec2d1c5e",
"adminAgentId": "9c5abdf8d2c44aaeac6cc57baa3dd96f",
    }

响应包体

属性 类型 说明
retCode String 请求状态码,取值000000(成功)
retMsg String 请求状态描述

响应示例

{
  "retCode": "000000",
  "retMsg": "成功"
}

十二、强插

说明:强插。

请求地址

POST:

 /api/{softVersion}/call/agentInsert

请求包体

属性 类型 约束 说明 举例
companyId String 必选 公司id -
appId String 必选 应用id节点 -
callId String 必选 通话的callId -
transferType int 必选 呼入呼出标记。 -
agentId String 必选 被监听座席id -
adminAgentId String 必选 监听方坐席id -

请求示例

{ 
"companyId": "626632d761be4da2a33c7f26f6e50b41",
"appId": "80ecc892384b4f03b62176d6654ef2e9",
"callId": "60ee821c-8873-4b7f-a84d-ec067690c7c4",
"transferType": "1",
"agentId": "58755c771d294871a78a0c8dec2d1c5e",
"adminAgentId": "9c5abdf8d2c44aaeac6cc57baa3dd96f",
    } 
{ 
"companyId": "xx",
"appId": "xx",
"callId": "xx",
"caller": "xx",
"agentId": "xx",
"adminAgentId": "xx",
       }

响应包体

属性 类型 说明
retCode String 请求状态码,取值000000(成功)
retMsg String 请求状态描述

响应示例

{
  "retCode": "000000",
  "retMsg": "成功"
}

十三、强拆

说明:强拆。

请求地址

POST:

 /api/{softVersion}/call/agentBreak

请求包体

属性 类型 约束 说明 举例
companyId String 必选 公司id -
appId String 必选 应用id节点 -
callId String 必选 通话的callId -
transferType int 必选 呼入呼出标志。 -
agentId String 必选 被监听座席id -
adminAgentId String 必选 监听方坐席id -

请求示例

{ 
"companyId": "626632d761be4da2a33c7f26f6e50b41",
"appId": "80ecc892384b4f03b62176d6654ef2e9",
"callId": "60ee821c-8873-4b7f-a84d-ec067690c7c4",
"transferType": "1",
"agentId": "58755c771d294871a78a0c8dec2d1c5e",
"adminAgentId": "9c5abdf8d2c44aaeac6cc57baa3dd96f",
    }

响应包体

属性 类型 说明
retCode String 请求状态码,取值000000(成功)
retMsg String 请求状态描述

响应示例

{
  "retCode": "000000",
  "retMsg": "成功"
}

十四、取消监听

说明:取消监听。

请求地址

POST:

/api/{softVersion}/call/agentCancelMonitor

请求包体

属性 类型 约束 说明 举例
companyId String 必选 公司id -
appId String 必选 应用id节点 -
callId String 必选 通话的callId -
adminAgentId String 必选 监听方坐席id -

请求示例

{ 
"companyId": "7db203d2e7004a85bdd78fae4362830c",
"appId": "90f644715d174d53a7573e678aa42efa",
"callId": "3c34975e-da9a-4d49-a690-d53eddde5df9",
"adminAgentId": "16bbf9d49bd642f285cf81315da4c12d",
    }

响应包体

属性 类型 说明
retCode String 请求状态码,取值000000(成功)
retMsg String 请求状态描述

响应示例

{
  "retCode": "000000",
  "retMsg": "成功"
}

results matching ""

    No results matching ""