服务端
服务端API文档

获取账号列表

更新时间: 2022/08/19 09:08:14

获取账号列表

URL

  • 请求方法:GET
  • URL:http://voip-host/api/v1/voip/account/sips/{appId}

请求参数

参数名称 类型 是否必选 示例 描述
appId string 必填 eca23f68c66d4acfceee77c200200359 应用APP ID。
limit int 选填 10 获取多少条数据。
offset int 选填 0 获取数据起始位置。

返回参数

参数名称 类型 示例 描述
code int 0 状态码。
message string OK 请求成功或者失败描述信息。
data string {"tenant":"cleverdj", . . . } 查询到的数据信息,json格式返回。
appId string d0ac282f-7e9e-4335-ab02-fc96be9d277d 应用ID,全局唯一的uuida。
sipAccount string 15700084166 sip内部通信帐号。
seatId string 266080 应用内子帐号,第三方传入。
sipPassword string gsjieiob sip内部通信密码。
sipDomain string voip.we.com 帐号域。
bindPhone string 15700084666 通信帐号绑定的手机号码。
dispNumber string 266080100000001 呼叫时的用户显号。
onlineType int 0 在线类型,0 sip在线 , 1 手机在线, 2 g2在线。

示例

请求示例

http://10.189.31.24:7702/api/v1/voip/account/sips/d0ac282f-7e9e-4335-ab02-fc96be9d277d?limit=10&offset=0

正常返回示例

{
  "code": 0,
  "data": [
    {
      "appId": "d0ac282f-7e9e-4335-ab02-fc96be9d277d",
      "bindPhone": "15700084166",
      "createTime": 0,
      "dispNumber": "266080100000001",
      "id": 0,
      "onlineType": 0,
      "sipAccount": "266080100000001",
      "sipDomain": "string",
      "sipPassword": "123456",
      "seatId": "seatid",
      "updateTime": 0
    }
  ],
  "message": "string"
}

错误码

  • body 中的错误码(code)

    该接口在 HTTP Body 中返回错误码(code),错误码列表请参考业务错误码

此文档是否对你有帮助?
有帮助
去反馈
  • 获取账号列表
  • URL
  • 请求参数
  • 返回参数
  • 示例
  • 请求示例
  • 正常返回示例
  • 错误码