DocsICP FilingConsole
Documentation

RtcSipInviteMember

Updated at:
Copy as MD
Product
My Favorites

Invite a SIP device to join a channel

Operation description

QPS limit

The per-user QPS limit for this operation is 10 calls per second. Exceeding this limit triggers rate limiting, which may affect your business. Call this operation only as needed.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

rtc:RtcSipInviteMember

none

*App

acs:rtc::{#accountId}:app/{#AppId}

 None None

Request parameters

Parameter

Type

Required

Description

Example
AppId

string

Yes

Application ID. Get it from the console. Pass one ID only.

eo85****
ChannelId

string

Yes

Channel ID. Pass one ID only.

$rtc_channelid
Uid

string

Yes

User ID.

$rtc_userid
DeviceType

string

Yes

Device type of the third-party SIP system:

  • sip_device

  • mcu

  • phone

Note: Only phone is supported at this time.

phone
ServerAddress

string

No

  1. IP address of the nearest RTC SIP server.

  2. Resolve the domain name rtcsip.dingtalk.com locally to get the nearest address. For example, run dig rtcsip.dingtalk.com.

39.101.232.13
AppToken

string

No

Token required to join the meeting. For sample code, see the referenced document.

000qaaasas……b
Registered

boolean

Yes

Whether the third-party conferencing system must register before receiving the call.

false
SipDisplayName

string

Yes

Name displayed for the user on the third-party system.

testdevice
SipUserId

string

Yes

  1. If DeviceType is mcu, this is the third-party conferencing system.

  2. If DeviceType is sip_device, this is the registered device.

  3. If the third-party system requires registration, use the account provided by that system.

  4. If no registration is required, use the SIP username (RTC user ID).

$reg_userid
SipUserPassword

string

No

The registration password for the SipUserId. This parameter is required when a third party registers to receive incoming calls.

654321
SipRoomId

string

Yes

  1. If the device is an MCU, this is the channel number of the third-party conferencing system.

  2. If the device is a SIP device, this is the registration number of the device to invite.

  3. If the device is a phone, this is the called phone number.

18512514528
SipUri

string

No

  1. If the device is an MCU, this is the IP address and port of the third-party conferencing system in the format ip:port;transport=tcp/udp/tls. Example: 30.240.160.66:5060;transport=tcp.

  2. If the device is a SIP device, this is the registration address of the device to invite. Example: 39.101.232.13.

  3. If the device is a phone, this is the address of the PSTN gateway. Example: 30.240.160.66:5060;transport=tcp.

30.240.160.66:5060;transport=tcp
SipUserAgent

string

No

Brand or model of the third-party SIP device. Examples: polycom, cisco, tencent, zoom, pstn.

pstn
CallNumber

string

No

Custom line number for PSTN calls.

055112345678
TaskId

string

No

Task ID.

taskId

Response elements

Element

Type

Description

Example

object

RequestId

string

Request ID.

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

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.