Kick out

Application servers can kick out participants of a group call (conference).

Supported call type	Minimum SDK version	Counterpart SDK event (Disconnected event)
Group call	Android: PlanetKit 3.8.9 iOS/macOS: PlanetKit 3.8.10 Windows: PlanetKit 3.8.9 Web: Not supported for WebPlanetKit	Android: onDisconnected iOS/macOS: didDisconnect Windows: OnDisconnected

The app server can kick out participants with a specific reason. The targeted app clients are kicked out with the Disconnected event.

The disconnect reason and user release code delivered by the Disconnected event are as follows:

• Disconnect reason: USER_ERROR
• User release code: Describes a specific reason delivered from AppSever

Tip

App clients running on SDK versions older than the ones listed above will be kicked out without a user release code.

Method and endpoint

• Method: DELETE
• Endpoint

/tas/v1/gcall/{serviceId}/{roomId}/member

Header

• Authorization: Basic {your credential}

Path parameters

Parameter	Description
serviceId	Service ID
roomId	Room ID

Query parameters

Parameter	Type	Format	Note
user_id	String	A string of user IDs concatenated with commas (,). user-id-01,user-id-02,...,user-id-N	Maximum number of IDs is 100
reason	String	Application-defined kickout reason. This is delivered to the app client as a user release code. The format of reason must be as follows: Allows letters[a-z, A-Z] and digits[0-9] only. Minimum length is 1 byte. If the app server generates a wrong formatted reason value, 400 BAD REQUEST is returned.

The following is an example of a query parameter.

{API URI}?user_id=user-01,user02,user-03

Request body

N/A

Response

N/A

Example

In this example, the app server kicks out usr_id1 and usr_id2 with 'tasDefinedReason'. Let's suppose the following:

• service-id: ex-service
• room-id: ex-room

curl --location --request \
DELETE 'https://vpnx-stn-api.line-apps.com/tas/v1/gcall/ex-service/ex-room/member?reason=tasDefinedReason&user_id=usr_id1,usr_id2' \
--header 'Authorization: Basic YWxhZGRpbjpvcGVuX3Nlc2FtZQ=='

Possible HTTP status codes

Possible HTTP status codes are as follows. For more information, see Error handling.

• 400, 401, 403, 404, 429, 500, 503