Disconnect reasons
For both 1-to-1 calls and group calls, LINE Planet provides a reason for call disconnection, which is called a disconnect reason. The disconnect reason values are commonly defined for client and server.
When a call is disconnected, a disconnect reason is delivered with a disconnect source (releaser_type on the server side), so your app client or app server can use the information to determine the cause and source of call disconnection.
The app client can get the information from the disconnected event callback, and the app server can get the information from 1-to-1 Call Event callback or Group Call Event callback.
Note
Disconnect sources
The following types of disconnect sources are available:
| Type | Value | Description |
|---|---|---|
| Callee | 1 | A callee in a 1-to-1 call |
| Caller | 2 | A caller in a 1-to-1 call |
| Participant | 3 | A participant in a group call |
| CloudServer | 4 | LINE Planet Cloud server |
| AppServer | 5 | Application server |
Disconnect reasons
The following sections describe disconnect reasons provided by LINE Planet. Each column in tables represents the following:
- Name: Name of the disconnect reason
- Value: Value of the disconnect reason
- Call type: Applicable call type. Can be 1-to-1 call, group call, or both.
- Disconnect source: Possible disconnect sources. An actual disconnect source can be one among the listed items. For more information, see Disconnect sources.
- Description: Description of the disconnect reason
Common reasons
The following disconnect reasons indicate non-error situations.
| Name | Value | Call type | Disconnect source | Description |
|---|---|---|---|---|
| NORMAL | 1001 | Both | Caller, Callee, Participant | Disconnected without any errors |
| DECLINE | 1002 | Both | Callee, CloudServer | - 1-to-1 call: The responder rejected a call. - Group call: The previously joined group call has been declined when entering the same group call room (e.g. re-joining after crash). |
| CELL_CALL | 1003 | Both | Caller, Callee, Participant | Received a cellular call during the Planet call |
| CANCEL | 1201 | 1-to-1 call | Caller | The initiator disconnected the call before the responder answers. |
| BUSY | 1202 | 1-to-1 call | Callee | The responder is calling. |
| NOANSWER | 1203 | 1-to-1 call | Caller | The responder doesn't answer. The initiator waits for the answer for 60 seconds. |
| ALREADY_GOT_A_CALL | 1204 | Both | CloudServer | The initiator or the participant already has an incoming call, but not received push yet. |
| MULTIDEV_IN_USE | 1205 | Both | CloudServer | A user using the same ID pair (user-id and service-id) is calling in another device. |
| MULTIDEV_ANSWER | 1206 | 1-to-1 call | CloudServer | A responder using the same ID pair (user-id and service-id) answered the call in another device. |
| MULTIDEV_DECLINE | 1207 | 1-to-1 call | CloudServer | A responder using the same ID pair (user-id and service-id) declined the call in another device. |
| MAX_CALL_TIME_EXCEEDED | 1208 | Both | CloudServer | Maximum call time has been reached. |
Error reasons for 1-to-1 calls or group calls
The following disconnect reasons indicate error situations in 1-to-1 calls or group calls.
| Name | Value | Call type | Disconnect source | Description |
|---|---|---|---|---|
| INTERNAL_ERROR | 1109 | Both | Caller, Callee, Participant, CloudServer | Disconnected by an internal error |
| USER_ERROR | 1110 | Both | Caller, Callee, AppServer | Application defined error. user_rel_code is accompanied.- 1-to-1 call: user_rel_code is defined by the call peer.- Group call: user_rel_code is defined by the app server. For example, see Kick out. |
| INTERNAL_KIT_ERROR | 1111 | Both | Caller, Callee, Participant | Disconnected by an OS-specific error |
| AUDIO_TX_NO_SRC | 1112 | Both | Caller, Callee, Participant | Audio source (e.g. mic) has not sent any audio data for a while. |
| NETWORK_UNSTABLE | 1301 | Both | Caller, Callee, Participant, CloudServer | Network is unavailable to keep a call. |
| PUSH_ERROR | 1302 | 1-to-1 call | CloudServer | LINE Planet Gateway failed to call the Notify callback, or the Notify callback returned a failure. Please check the app server or the Notify callback's URL. |
| AUTH_ERROR | 1303 | Both | CloudServer | Authentication failure |
| RELEASED_CALL | 1304 | Both | CloudServer | The call was already released. For example, the initiator already canceled the call. |
| SERVER_INTERNAL_ERROR | 1305 | Both | CloudServer | The server disconnected a call because of an internal error. |
| UNAVAILABLE_NETWORK | 1308 | Both | Caller, Callee, Participant | Disconnected due to the network being unavailable for a certain period of time |
| APP_DESTROY | 1309 | Both | Caller, Callee, Participant | The application process has been terminated. Detailed descriptions for each platform are as follows:
|
| SYSTEM_SLEEP | 1310 | Both | Caller, Callee, Participant | The application is in sleep mode. Detailed descriptions for each platform are as follows:
|
| SYSTEM_LOGOFF | 1311 | Both | Caller, Callee, Participant | The application is in logoff mode. Detailed descriptions for each platform are as follows:
|
| MTU_EXCEEDED | 1312 | Both | Caller, Callee, Participant | The call is not connected because the maximum transmission unit (MTU) is exceeded. |
| APP_SERVER_DATA_ERROR | 1313 | Both | CloudServer | The Planet Cloud server failed to deliver app server data to the app server. |
| DESKTOP_SCREEN_LOCKED | 1314 | Both | Caller, Callee, Participant | The desktop screen is locked. Note: This reason is applicable to macOS and Windows only. |
Error reasons for group calls only
The following disconnect reasons indicate error situations specific to group calls.
| Name | Value | Call type | Disconnect source | Description |
|---|---|---|---|---|
| ROOM_IS_FULL | 1401 | Group call | CloudServer | The number of participants in this room reached the limit. |
| ALONE_KICK_OUT | 1402 | Group call | CloudServer | The server kicks out a user when the user stays in a group call room alone for a long time. |
| WRONG_ROOM_ATTR | 1403 | Group call | CloudServer | Deprecated since PlanetKit 5.2 The room attribute is not matched. |
| ROOM_NOT_FOUND | 1404 | Group call | CloudServer | The room is destroyed because all remaining participants left before the other participant's joining is complete. |
| ANOTHER_INSTANCE_TRY_TO_JOIN | 1405 | Group call | Participant | Disconnected by trying to join from another instance. |
Error reasons related to HTTP connection
The following disconnect reasons indicate errors related to HTTP connection.
| Name | Value | Call type | Disconnect source | Description |
|---|---|---|---|---|
| SERVICE_ACCESS_TOKEN_ERROR | 1501 | Both | CloudServer | Invalid access token |
| SERVICE_INVALID_ID | 1502 | Both | CloudServer | An unacceptable character is used in service-id or user-id. |
| SERVICE_MAINTENANCE | 1503 | Both | CloudServer | Under maintenance |
| SERVICE_BUSY | 1504 | Both | CloudServer | LINE Planet Gateway is busy for now. |
| SERVICE_INTERNAL_ERROR | 1505 | Both | CloudServer | LINE Planet Gateway internal error. Joining failed in an old version (lower than 3.6) because the room has the SUBGROUP room attribute (created by PlanetKit 3.6 or higher) |
| SERVICE_HTTP_ERROR | 1506 | Both | Caller, Participant | Could not make an HTTP request. Please check the user's network environment: 1. Firewall settings 2. Client vaccine program |
| SERVICE_HTTP_CONNECTION_TIME_OUT | 1507 | Both | Caller, Participant | Could not make an HTTP request. Please check the user's network environment: 1. Firewall settings 2. Client vaccine program |
| SERVICE_HTTP_INVALID_PEER_CERT | 1508 | Both | Caller, Participant | SSL peer certificate or SSH remote key was invalid. |
| SERVICE_HTTP_CONNECT_FAIL | 1509 | Both | Caller, Participant | Could not make an HTTP request. Please check the user's network environment: 1. Firewall settings 2. Client vaccine program |
| SERVICE_HTTP_INVALID_URL | 1510 | Both | Caller, Participant | The URL format is invalid, or the host or proxy name could not be resolved. |
| SERVICE_INCOMPATIBLE_PLANETKIT_VER | 1511 | Both | CloudServer | The current PlanetKit version is deprecated. Need to upgrade. |
| SERVICE_TOO_MANY_REQUESTS | 1512 | Both | CloudServer | Too many call connection attempts in a short period of time. |