PNS API list G

接口说明，查询号码组

https://number.nxcloud.com/api/pns/

请求头

参数名	类型	必填	说明	示例值
accessKey	string	是	用户的accessKey	fme2na3kdi3ki
action	string	是	请求方法	listGroup
bizType	string	是	[业务类型] 固定值 用来标识隐私号服务	5
ts	string	是	当前请求的时间戳（单位是毫秒），牛信服务端允许用户端请求最大时间误差为60秒	1655710885431
sign	string	是	API入参参数签名，签名算法

请求体

参数名	必填	类型	说明
limit	是	uint	取值范围[0,1k],0代表不限制（获取所有），最大只允许获取1k条数据,关于=0时候超过1k条的问题，只会返回1k条
offset	是	uint	偏移值，取值范围为[0,MAX],0代表从第一条开始

返回参数

参数名	类型	说明
code	int	返回码，0代表成功，其他失败
msg	string	返回码描述
requestId	string	请求id
data	Object	返回数据

data中返回参数详情：

参数名	类型	说明
groups	[]Object	号码组
total	int	号码组个数

groups中返回参数详情：

参数名	类型	说明
customerId	string	客户id
groupName	string	G号码组的名称
groupId	string	G号码组id
phones	string	电话号码，多个号码之间用英文逗号（,）分隔
remark	string	G号码组的备注信息。

请求示例

请求url

https://number.nxcloud.com/api/pns/

Header

KEY	VALUE
accessKey	sixgqophrnv4
ts	1670479632933
bizType	5
action	listGroup
sign	faxxxxxxxxxxxxxxxxxxxxxxxxxxxxd4

Body

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

返回示例

{
  "code": 0,
  "msg": "success",
  "requestId": "1602262837283131392",
  "data": {
    "groups": [
      {
        "customerId": "cus_1",
        "groupName": "groupA",
        "groupId": "b8c2aaf940d534d3c9ed8b780757f94e",
        "phones": "85211111114,85235753351,85235753311",
        "remark": "号码组A"
      }
    ],
    "total": 1
  }
}