专号管理¶
专号管理API用于管理用户所属的专号
获取专号列表¶
-
GET
/api/user/(string: telnum)/vtelnum
¶ 返回手机号码为 telnum 的用户所拥有的专号列表
Query Parameters: - page (int) – 要返回的页码。默认为1(1开始)。
- perPage (int) – 每页长度。如果不指定,服务器采用其默认设置。
Response Headers: - X-Pagination-Current-Page – 每页长度
- X-Pagination-Per-Page – 当前返回结果的页码(1开始)
- X-Pagination-Totle-Pages – 总页数
- X-Pagination-Totle-Entries – 总条目数
Response JSON Object: - vtelnum (string) – 专号
例子¶
此例子中,返回手机号码 (telnum) 为 123 的用户,所拥有的5个专号中的第3~4个
Request
GET /api/user/123/vtelnum?page=2&perPage=2 HTTP/1.1
Host: example.com
Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Pagination-Current-Page: 2
X-Pagination-Per-Page: 2
X-Pagination-Totle-Pages: 3
X-Pagination-Totle-Entries: 5
[{"vtelnum": "10003"}, {"vtelnum": "10004"}]
获取可选专号列表¶
-
GET
/api/user/(string: telnum)/availablevtelnum
¶ 返回手机号码为 telnum 的用户可以选取的可用专号的列表
Query Parameters: - page (int) – 要返回的页码。默认为1(1开始)。
- perPage (int) – 每页长度。如果不指定,服务器采用其默认设置。
Response Headers: - X-Pagination-Current-Page – 每页长度
- X-Pagination-Per-Page – 当前返回结果的页码(1开始)
- X-Pagination-Totle-Pages – 总页数
- X-Pagination-Totle-Entries – 总条目数
Response JSON Object: - vtelnum (string) – 专号
绑定新专号¶
-
POST
/api/user/(string: telnum)/vtelnum
¶ 手机号码为 telnum 的用户为该手机号码绑定一个新的专号
Request JSON Object: - vtelnum (string) – 要绑定的新专号