签入签出接口说明

1.接口简介

第三方系统通过此接口可以在客户自己系统中实现将坐席设置为离线接听状态或者从登录状态签出。

2.接口请求

  • HTTP请求方式:POST

  • 请求链接:{HOST}/v20160818/account/SignInOrOut/ACCOUNTID?sig=SIG

  • 请求时请将{HOST}换成对接数据查询中获取到的请求域名,ACCOUNTID替换为账户编号,SIG是根据鉴权规则生成的,请看鉴权文档,查看具体的生成规则

  • 鉴权文档:接口鉴权

3.接口参数如下:(红色为必传参数)

参数 是否必填 说明
sign SignIn / SignOut 命令名称,签入接口固定名称为 SignIn
命令名称,签出接口固定名称为 SignOut
exten 座席号 当前账户下的坐席号一般为800080018002
ActionID 唯一字符串 随机码,用户用来标识请求的操作,服务器返回的中会带有对应的ActionID;在通话事件中会带有该字段;该字段最大长度是40个字节
ExtenType gateway 只有签入时有此参数。ExtenType 非必传。不传此字段默认签入手机,传的话值可以为Local或gateway。Local标示手机离线接听,gateway标示sip话机离线接听。

4.系统返回

  • 返回Json对象
{
    "Command": "Response",
    "Succeed": true,
    "ActionID": "SignIn0.41748595997299165",
    "Response": "SignIn"
}
  • 字段说明
    参数 说明
    Response SignIn 对应Action的名称
    ActionID 唯一字符串 对应操作的唯一标记
    Succeed 处理结果 请求是否成功,当不成功时会在Message字段中给出原因
    Message 结果说明 User has not bind gateway sip number or gateway sip number not register!:这个坐席未注册sip号或者未绑定sip号
    Reason 301 签出的时候会返回此参数。表示坐席不为离线接听状态,不能签出