文档首页/ 云客服/ API参考/ 座席工作台/ 座席双呼/ 查询分配的软电话号码 (V1.0.0) (queryPhone)
更新时间：2024-08-02 GMT+08:00
查看PDF
分享

查询分配的软电话号码 (V1.0.0) (queryPhone)

场景描述

查询分配的软电话号码。

接口方法

POST

接口URI

https://域名/apiaccess/CC-Management/v1/mobileAgent/queryPhone，例如域名是service.besclouds.com

请求说明

表1 请求头参数

序号

名称

参数类型

是否必选

说明

1

X-APP-Key

string

False

appKey字段，用户标识

2

Authorization

string

True

鉴权字段，内容格式为：Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格）
表2 请求体参数

序号

名称

参数类型

是否必选

说明

1

limit

string

False

分页查询时单页最多的记录条数，默认值100，即每页显示100条，非必选

  • limit的值大于100则查询100条记录。
  • limit的值小于1则查询1条记录。

1

offset

string

False

分页查询偏移量，默认值0，即不需要偏移，非必选

响应说明

  • 响应状态码: 200
表3 响应体参数

序号

名称

参数类型

是否必选

说明

1.1

retCode

string

True

返回码。0表示成功，其他为失败。

1：查询失败

2：移动座席信息为空

3：注册服务地址或端口为空

4：limit或offset分页数据为空

5：虚拟呼叫中心信息为空

1.2

retMsg

string

False

失败原因的描述

1.3

result

object

False

返回结果

1.3.1

total

number

False

总记录数

1.3.2

regIPAddress

string

False

注册地址

长度限制：string（50）

1.3.3

phone

array[object]

False

软电话信息列表

1.3.3.1

phoneNum

string

False

软电话号码

长度限制：string（32）

1.3.3.2

password

string

False

软电话密码

长度限制：string（50）

1.3.3.3

id

string

False

配置信息id

1.3.3.4

status

number

False

注册状态，0：已注册，1：暂停状态

1.3.3.5

remark

string

False

备注信息

1.3.3.6

tenantId

string

False

租间id

1.3.3.7

partdbId

string

False

分区id

1.3.4

regPort

number

False

注册端口

长度限制：number（5）
  • 响应状态码: 400

    错误的请求：请检查请求路径及参数。

  • 响应状态码: 401

    未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。

  • 响应状态码: 404

    请求的内容未找到：请检查请求的路径。

  • 响应状态码: 500

    业务失败：请依次确认您请求中各参数的取值。

错误码

无。

报文样例

  • 场景描述：样例报文

    请求头：

    x-app-key:9******************************3  
Authorization:Bearer c******************************f  
Content-Type:application/json

    请求参数：

    {
	"offset": "0",
	"limit": "3"
}

    响应头：

    {
	"connection": "keep-alive",
	"content-type": "application/json;charset=UTF-8"
}

    响应参数：

    {
	"retMsg": "successfully",
	"retCode": "0",
	"result": {
		"total": 6,
		"regPort": "5060",
		"phone": [{
				"phoneNum": "999000",
				"password": "****"
			},
			{
				"phoneNum": "999001",
				"password": "****"
			},
			{
				"phoneNum": "999002",
				"password": "****"
			}
		],
		"regIPAddress": "10.10.18.36"
	}
}
父主题： 座席双呼