RtcSipInviteMember - Sip邀请入会

邀请SIP加入频道

接口说明

QPS 限制

本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
rtc:RtcSipInviteMembernone
*App
acs:rtc::{#accountId}:app/{#AppId}

请求参数

名称类型必填描述示例值
AppIdstring

应用 ID,通过控制台创建和查询,仅支持传单个 ID。

eo85****
ChannelIdstring

频道 ID,仅支持传单个 ID。

$rtc_channelid
Uidstring

用户 ID。

$rtc_userid
DeviceTypestring

呼叫第三方 sip 的设备类型:

  • sip_device
  • mcu
  • phone

备注:当前阶段,仅支持 phone 类型

phone
ServerAddressstring
  1. 就近接入 rtc sip 服务器 IP 地址。
  2. 用户通过本地进行解析域名:rtcsip.dingtalk.com 获取到就近接入地址。 如: dig rtcsip.dingtalk.com 获取
39.101.232.13
AppTokenstring

入会 token。生成代码参考 https://help.aliyun.com/document_detail/2689025.html

000qaaasas……b
Registeredboolean

第三方会议系统是否要注册呼入。

false
SipDisplayNamestring

在第三方显示的 user 名称。

testdevice
SipUserIdstring
  1. 当 DeviceType = mcu ,代表第三方会议系统
  2. 当 DeviceType = sip_device 代表注册设备
  3. 如果第三方会议系统要求注册呼入,则为第三方系统提供的注册账号
  4. 如果不需要注册呼叫,则为呼入第三方的 sip 用户名 rtc userid
$reg_userid
SipUserPasswordstring

如果第三方要注册呼入,匹配 SipUserId 的注册密码。

654321
SipRoomIdstring
  1. 当设备是 mcu 时,表示呼入的第三方会议系统的频道号码
  2. 当设备是 sip_device 时,表示要邀请的注册设备的注册号码
  3. 当设备是 phone 时,表示被叫的电话号码
18512514528
SipUristring
  1. 当设备是 mcu 表示第三方会议系统的地址信息 ip:port;transport=tcp/udp/tls 如:"30.240.160.66:5060;transport=tcp"
  2. 当设备是 sip_device 表示要邀请的注册设备的注册地址 如: 39.101.232.13
  3. 当设备是 phone 表示电话网关的地址信息 如:"30.240.160.66:5060;transport=tcp"
30.240.160.66:5060;transport=tcp
SipUserAgentstring

呼叫第三方 sip 的品牌型号 如 polycom/cisco/tencent/zoom/pstn

pstn
CallNumberstring

pstn 场景下自定义线路号码。

055112345678
TaskIdstring

任务 ID。

taskId

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

16A96B9A-F203-4EC5-8E43-CB92E68F4CF8

示例

正常返回示例

JSON格式

{
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CF8"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2025-11-05新增 OpenAPI查看变更详情