# 获取虚拟号码池
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南
接口英文名:getprivatenumberpool
可通过该接口获取虚拟号码池
相关事件通知:虚拟号更新回调通知
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/channels/ec/logistics/phonenumberpool/get?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用
# 第三方调用
- 本接口不支持第三方平台调用。
# 2. 请求参数
# 查询参数 Query String parameters
参数名 | 类型 | 必填 | 示例 | 说明 |
---|---|---|---|---|
access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证,可使用 access_token |
# 请求体 Request Payload
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
next_key | string | 是 | 分页参数,上一页请求返回。第一页可以不填 |
page_size | number | 是 | 每页数量(不超过100) |
# 3. 返回参数
# 返回体 Response Payload
参数名 | 类型 | 说明 |
---|---|---|
errcode | number | 错误码 |
errmsg | string | 错误信息 |
total_num | number | 总数 |
has_more | boolean | 是否还有下一页, true:有下一页;false:已经结束,没有下一页。 |
next_key | string | 分页参数,下一个页请求回传 |
phonenumbers | array | 订单号列表 |
# 4. 注意事项
本接口无特殊注意事项
# 5. 代码示例
请求示例
{
"next_key": "xxxx",
"page_size": 10
}
返回示例
{
"errcode": 0,
"errmsg": "ok",
"has_more":true,
"next_key":"xxxxx",
"total_num":3000,
"phonenumbers": ["xxxx","xxxx"]
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码
错误码 | 错误描述 | 解决方案 |
---|---|---|
40097 | 请求体参数不正确,请检查各个参数是否按规范填写 |
# 7. 适用范围
本接口在不同账号类型下的可调用情况:
小程序 | 公众号 |
---|---|
需申请 | 需申请 |
- 需申请:表示该账号类型需提交此场景的申请并审核通过后方可调用
- 其他未明确声明的账号类型,如无特殊说明,均不可调用此接口;