bblrtc
/
RTC会话控制协议v1.0.txt


RTC会话控制协议，基于http长轮询模型设计，客户端超时时间根据接入网络动态调整，例如3/4G网络超时设定是30秒，WIFI网络超时设定为60秒，服务器端超时统一设置为65秒，

接口定义
	用户登录
		HTTP方法&URI：POST /rscp/login
		URL参数：无
		HEADER参数：
			X-Member:aaaaa 成员ID
			X-Key:fsadfasfsadfasfsaasf 登录令牌
			X-Device-Id:ios-fdjalfjfadljsaf 设备ID，格式："$ua-$device_token"，例如：android-fdlfjklajfda, ios-fdjlfdasjklfdjaf
			X-Location:$latitude,$longitude 经纬度
		BODY参数：无

		HTTP响应头
			X-Sid:7973491249242 会话ID
			X-Code:OK
		Body:返回ICE服务器列表
			[{"uri":stun:182.254.133.31:3478"},{"uri":turn:182.254.133.31:3478","username":"username","password":"password"}],//ICE服务器


	用户登出
		HTTP方法&URI：POST /rscp/logout
		URL参数：无
		HEADER参数：
			X-Sid:7973491249242
		BODY参数：无

		HTTP响应头
			X-Code:OK

	设置呼叫转移
		HTTP方法&URI：POST /rscp/forward
		URL参数：无
		HEADER参数：
			X-Sid:7973491249242
			X-Forward:4083928432
			X-Temp-Forward:809483021
		BODY参数：无

		HTTP响应头
			X-Code:OK

	取消呼叫转移
		HTTP方法&URI：POST /rscp/forward
		URL参数：无
		HEADER参数：
			X-Sid:7973491249242
			X-Forward:1
			X-Temp-Forward:1
		BODY参数：无

		HTTP响应头
			X-Code:OK

	设置白名单
		HTTP方法&URI：POST /rscp/whitelist
		URL参数：无
		HEADER参数：
			X-Sid:7973491249242
			X-White-List:74932487921,840392184,0498213
		BODY参数：无

		HTTP响应头
			X-Code:OK

	设置黑名单
		HTTP方法&URI：POST /rscp/blacklist
		URL参数：无
		HEADER参数：
			X-Sid:7973491249242
			X-Black-List:74932487921,840392184,0498213
		BODY参数：无

		HTTP响应头
			X-Code:OK

	设置状态
		HTTP方法&URI：POST /rscp/state
		URL参数：无
		HEADER参数：
			X-Sid:7973491249242
			X-State:BUSY|REFUSE|NORMAL
		BODY参数：无

		HTTP响应头
			X-Code:OK

	发起呼叫
		HTTP方法&URI：POST /rscp/offer
		URL参数：无
		HEADER参数：
			X-Sid:7973491249242
			X-Msg-Id:fdsafsafsafdsa
			X-From:fasf
			X-To:aaaaa
		BODY：主叫方ICE服务器信息和SDP描述信息
			{"ice":[{"uri":stun:182.254.133.31:3478"},{"uri":turn:182.254.133.31:3478","username":"username","password":"password"}],"sdp":""}

		HTTP响应头:
			X-Code:OK
		BODY：如果成功呼叫则返回被叫方铃声地址
			{"ringing":"http://xxx/xxxx/xx."}

	确认呼叫
		HTTP方法&URI：POST /rscp/answer
		URL参数：无
		HEADER参数：
			X-Sid:54352435325
			X-Msg-Id:fdsafsafsafdsa
			X-Caller-Sid:7973491249242 主叫方SID
		BODY：被叫方SDP描述信息
			{"sdp":"XXXX"}

		HTTP响应头:
			X-Code:OK
	交换CANDIDATE信息
		HTTP方法&URI：POST /rscp/candidate
		URL参数：无
		HEADER参数：
			X-Sid:54352435325
			X-Msg-Id:fdsafsafsafdsa
			X-Caller-Sid:7973491249242 主叫方SID，如果是主叫方发生则可以省略此参数
		BODY：CANDIDATE描述信息
			{"sdpMid":"video","sdpMLineIndex":0,"sdp":"XXXX"}

		HTTP响应头:
			X-Code:OK

	终止通话
		HTTP方法&URI：POST /rscp/bye
		URL参数：无
		HEADER参数：
			X-Sid:54352435325
			X-Msg-Id:fdsafsafsafdsa
			X-Caller-Sid:7973491249242 主叫方SID，如果是主叫方发生则可以省略此参数
		BODY：无

		HTTP响应头:
			X-Code:OK

	等待接收信令
		HTTP方法&URI：GET /rscp/wait
		URL参数：无
		HEADER参数：
			X-Sid:7973491249242
			X-Msg-Id:fdsafsafsafdsa 当前会话中最后收到的消息ID，如果不传递则表示容忍部分消息丢失
		BODY参数：无

		HTTP响应头:
			X-Code:OK
		BODY:
		[
		{
			"msgid":"1",
			"type":"RTC-OFFER",
			"from":"47932847432",//主叫ID
			"caller-sid":"try112", //主叫会话ID
			"text":{"ice":[{"uri":stun:182.254.133.31:3478"},{"uri":turn:182.254.133.31:3478","username":"username","password":"password"}],"sdp":""}
		},
		{
			"msgid":"2",
			"type":"RTC-CANDIDATE",
			"caller-sid":"try112", //主叫会话ID
			"text":{} //CANDIDATE描述信息
		},
		{
			"msgid":"3",
			"type":"RTC-CANDIDATE",
			"caller-sid":"try112", //主叫会话ID
			"text":{} //CANDIDATE描述信息
		},
		{
			"msgid":"4",
			"type":"RTC-ANSWER",
			"caller-sid":"try112", //主叫会话ID
			"text":{} //SDP描述信息
		},
		{
			"msgid":"5",
			"type":"VOIP-BYE",
			"caller-sid":"try112", //主叫会话ID
			"recvtime":"2015-05-31 15:04:16"
		}]

错误代码
	X-Code :
		OK 成功
		Login Fail 登录失败
		SID REQUIRED SID缺失引起的错误
		SESSION TIMEOUT 会话超时
		PARAMETER ERROR 参数错误
		SESSION NOT FOUND 会话不存在
		IO ERROR IO错误