邀请SIP加入频道
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| rtc:RtcSipInviteMember | none | *App acs:rtc::{#accountId}:app/{#AppId} |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| AppId | string | 是 | 应用 ID,通过控制台创建和查询,仅支持传单个 ID。 | eo85**** |
| ChannelId | string | 是 | 频道 ID,仅支持传单个 ID。 | $rtc_channelid |
| Uid | string | 是 | 用户 ID。 | $rtc_userid |
| DeviceType | string | 是 | 呼叫第三方 sip 的设备类型:
备注:当前阶段,仅支持 phone 类型 | phone |
| ServerAddress | string | 否 |
| 39.101.232.13 |
| AppToken | string | 否 | 入会 token。生成代码参考 https://help.aliyun.com/document_detail/2689025.html | 000qaaasas……b |
| Registered | boolean | 是 | 第三方会议系统是否要注册呼入。 | false |
| SipDisplayName | string | 是 | 在第三方显示的 user 名称。 | testdevice |
| SipUserId | string | 是 |
| $reg_userid |
| SipUserPassword | string | 否 | 如果第三方要注册呼入,匹配 SipUserId 的注册密码。 | 654321 |
| SipRoomId | string | 是 |
| 18512514528 |
| SipUri | string | 否 |
| 30.240.160.66:5060;transport=tcp |
| SipUserAgent | string | 否 | 呼叫第三方 sip 的品牌型号 如 polycom/cisco/tencent/zoom/pstn | pstn |
| CallNumber | string | 否 | pstn 场景下自定义线路号码。 | 055112345678 |
| TaskId | string | 否 | 任务 ID。 | taskId |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CF8"
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2025-11-05 | 新增 OpenAPI | 查看变更详情 |
