# 兑换虚拟号
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南
接口英文名:getvirtualtelnumber
可通过该接口兑换虚拟号
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/channels/ec/order/virtualtelnumber/get?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为:131
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String parameters
参数名 | 类型 | 必填 | 示例 | 说明 |
---|---|---|---|---|
access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证,可使用 access_token、authorizer_access_token |
# 请求体 Request Payload
参数名 | 类型 | 必填 | 示例 | 说明 |
---|---|---|---|---|
order_id | string | 是 | 12345 | 订单id,可通过获取订单列表接口获取 |
# 3. 返回参数
# 返回体 Response Payload
参数名 | 类型 | 示例 | 说明 |
---|---|---|---|
errcode | number | 0 | 错误码 |
errmsg | string | ok | 错误信息 |
virtual_tel_number | string | 6767532382 | 虚拟号码 |
virtual_tel_expire_time | number | xxxxxxxx | 虚拟号码过期时间 |
get_virtual_tel_cnt | number | 1 | 兑换虚拟号码次数 |
# 4. 注意事项
- 重新兑换的虚拟号码有效期为3天,每个订单可以兑换3次。
- 该接口用于在订单结束后,原虚拟号码会失效,商家可按需重新兑换虚拟号码。
# 5. 代码示例
请求示例
{
"order_id": "12345"
}
返回示例
{
"errcode": 0,
"errmsg": "ok",
"virtual_tel_number": "6767532382",
"virtual_tel_expire_time": xxxxxxxx,
"get_virtual_tel_cnt": 1
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码
错误码 | 错误描述 | 解决方案 |
---|---|---|
40097 | 请求体参数不正确,请检查各个参数是否按规范填写,具体原因请查看errmsg | |
47001 | 请求体格式不正确,请检查请求体中各个参数的类型是否正确 | |
48001 | 无权调用本api,请检查相关权限是否已开通 | |
100002 | 订单不存在 | |
100003 | 订单更新过于频繁,更新订单失败,请重试 | |
6060453 | 不是虚拟号订单,不允许兑换虚拟号码 | |
6060454 | 虚拟号码未过期,请获取订单详情查看 | |
6060455 | 超过最大可兑换虚拟号码次数 |
# 7. 适用范围
本接口支持「微信小店」账号类型调用。其他账号类型如无特殊说明,均不可调用。