SIP呼叫

1 SIP呼叫

接口地址	方法	说明
BaseUrl/api/v1/sip/{appId}/{channelName}	GET	SIP呼叫

PathVariable：

参数	长度	描述
appId	32位字符串	控制台中项目的APP ID（应用标识ID）
channelName	32位字符串	channelName

Parameters：

参数	长度	描述
sipNumber		必填项，被叫号
nickname		可选项，自定义名称
streamId		可选项，流ID
onlyAudio		可选项，是否纯音频，true|false

响应数据：

实例：
[GET] https://192.168.2.125/client/api/v1/sip/60498d8e5476cf664d3985f6/9991009?sipNumber={sipNumber}&streamId={streamId}&nickname={nickname}
响应：
成功消息：
{
    "code": 200,
    "msg": "success",
    "data": {
      "state": 200,
      "msg": "success"
    }
}
失败消息：
{
  "msg": "SIP呼叫失败",
  "code": 20100
}

2 SIP挂断

接口地址	方法	说明
BaseUrl/api/v1/sip/remove/{appId}/{channelName}/{sipNumber}	GET	SIP挂断

PathVariable：

参数	长度	描述
appId	32位字符串	控制台中项目的APP ID（应用标识ID）
channelName	32位字符串	channelName
sipNumber		被叫号

响应数据：

实例：
[GET] https://192.168.2.125/client/api/v1/sip/remove/60498d8e5476cf664d3985f6/dfff/9991009
响应：
成功消息：
{
    "code": 200,
    "msg": "success",
    "data": {
      "state": 200,
      "msg": "success"
    }
}
失败消息：
{
  "msg": "SIP挂断失败",
  "code": 20101
}

3 SIP回调

接口地址	方法	说明
BaseUrl/api/v1/sip/callback/{appId}/{channelName}/{sipNumber}	GET	SIP挂断

PathVariable：

参数	长度	描述
appId	32位字符串	控制台中项目的APP ID（应用标识ID）
channelName	32位字符串	channelName
sipNumber		被叫号

RequestBody： Content-Type="application/json;charset=utf8"

参数	描述
code	状态码
msg	状态信息

响应数据：

实例：
[POST] https://192.168.2.125/client/api/v1/sip/callback/60498d8e5476cf664d3985f6/dfff/9991009
请求JSON数据：
{
	"code": "401",
	"msg": "拨号规则错误"
}
响应：
{
    "msg": "操作成功",
    "code": 200
}

4 dtmf

接口地址	方法	说明
BaseUrl/api/v1/sip/dtmf/{appId}/{channelName}	GET	SIP呼叫

PathVariable：

参数	长度	描述
appId	32位字符串	控制台中项目的APP ID（应用标识ID）
channelName	32位字符串	channelName

Parameters：

参数	长度	描述
sipNumber		必填项，被叫号
dtmf		必填项，密码
streamId		可选项，流ID
onlyAudio		可选项，是否纯音频，true|false

响应数据：

实例：
[GET] https://192.168.2.125/client/api/v1/sip/dtmf/60498d8e5476cf664d3985f6/9991009?sipNumber={sipNumber}&dtmf={dtmf}&streamId={streamId}
响应：
成功消息：
{
    "code": 200,
    "msg": "success",
    "data": {
      "state": 200,
      "msg": "success"
    }
}
失败消息：
{
  "code": 20105,
  "msg": "SIP挂断失败,没有找到对应呼叫的GW"
}

#