获取建房凭据
接口描述
获取指定设备的微信建房凭据，用于坐席端完成设备授权（wx.requestDeviceVoIP）与主动呼叫（wmpfVoip.callDevice）。
请求说明
| 接口ID |
协议 |
方法 |
PATH |
| 95 |
HTTPS |
POST |
/openapi/v1/voip/wx/sn_ticket |
PATH参数
无
URL参数
| 参数 |
类型 |
必填 |
说明 |
| accesskey_id |
string |
是 |
参见签名认证 |
| expires |
int |
是 |
参见签名认证 |
| signature |
string |
是 |
参见签名认证 |
HTTP请求头
| 名称 |
必填 |
说明 |
| Content-Type |
是 |
application/json |
| X-Agent-Token |
是 |
坐席登录返回的 token |
请求参数
| 参数 |
类型 |
必填 |
说明 |
| sn |
string |
是 |
设备 SN |
请求示例
POST https://open.vzicloud.com/openapi/v1/voip/wx/sn_ticket?accesskey_id=8d9EsDAD2115Q5PM8tuP6g1IdAglkayp&expires=1619022787&signature=G29eTBjMm0gZF7cpXNLX7Hrn0yM%3D HTTP/1.1
Content-Type: application/json
X-Agent-Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.***
{
"sn": "12345678901234"
}
返回说明
返回参数
| 参数 |
类型 |
说明 |
| app_id |
string |
客户小程序 appid |
| model_id |
string |
设备绑定的微信 model id，用于 wx.requestDeviceVoIP / wmpfVoip.callDevice 的 modelId 入参 |
| wxa_flavor |
int |
小程序版本：0 正式 / 1 开发 / 2 体验，需与小程序实际运行版本一致 |
| sn_ticket |
string |
设备授权票据，传给 wx.requestDeviceVoIP({snTicket})（授权必带，缺了授权不成功） |
错误码
错误码定义参见错误码。本接口特有的业务错误：
| HTTP 状态 |
code |
说明 |
| 400 |
1005 |
设备不存在（SN 不属于本公司）；该设备未绑定客户小程序（请联系管理员配置） |
返回示例
{
"app_id": "wx1234567890abcdef",
"model_id": "MD1234",
"wxa_flavor": 0,
"sn_ticket": "ST-***"
}