login

最后更新时间 2026-04-17

该接口负责把业务方提供的登录凭证接入 Robin SDK，会话建立成功后，账号、联系人、会话、消息、群组、文件等用户态能力才能继续调用。

注意事项

该接口适用于四端统一登录接入，四端对外语义应保持一致，仅平台桥接写法不同。

应用能力	Android	iOS	Harmony	PC	发布状态
SDK Wrapper	支持	支持	支持	支持	已纳入 release/phase0

发布基线：

该接口接收 AuthLoginRequest 请求对象，字段定义如下。

名称	数据类型	是否必填	默认值	描述
`account`	`String`	是	-	登录使用的账号标识；当前实现兼容 user_id/account 两种输入语义。
`token`	`String`	是	-	上层接入方传入的登录凭证，用于触发认证链路。
`device_id`	`Option<String>`	否	-	可选设备标识；不传时运行时会回退到默认设备标识。

说明

请求对象由业务方传入，用于触发上层 SDK API 调用。平台 wrapper 可以按各自语言习惯封装参数对象，但字段语义必须与 AuthLoginRequest 保持一致。

该接口成功后返回 AuthLoginResponse 业务结果，字段定义如下。

名称	数据类型	描述
`account`	`String`	完成登录后的账号标识。
`session_state`	`String`	当前登录会话状态摘要，用于标识会话是否已建立。
`auth_ticket`	`String`	本次认证链路生成的认证票据，用于追踪登录请求。
`status`	`String`	登录结果状态；成功时表示本次认证流程已完成。
`sdk_token`	`String`	服务端颁发的 SDK token，用于后续 SDK 能力授权。
`im_token`	`String`	IM 协议连接使用的令牌。
`refresh_token`	`String`	用于后续刷新 sdk_token / im_token 的刷新令牌。
`expires_at`	`i64`	当前令牌组的过期时间戳，单位为秒。

调用前置条件：runtime.bootstrap
当前 SDK 状态要求：SDK 已完成引导，且当前存在可用的业务登录凭证。
调用成功后状态：调用成功后 SDK 进入 logged-in 状态，可继续访问用户态业务模块。
建议后续调用：account.getProfile、friend.list、contact.search、conversation.getSnapshot

平台	正式入口	绑定方式	错误返回方式
Android	`com.robin.sdk.RobinSdk`	kotlin-java-facade	result-error-object
iOS	`RobinSdk`	swift-facade	throws-result-enum
Harmony	`RobinSdk`	arkts-js-facade	result-code-object
PC	`robin_sdk_bridge`	native-bridge-facade	bridge-error-code

说明

当前仓库尚未提供该方法的真实平台 facade 调用代码片段。你可以先根据以下真实入口信息接入平台 wrapper；后续如补充 docs/examples/<platform>/auth-login.*，页面会自动渲染对应平台示例。

错误码	描述	排查建议
`invalid_argument`	输入参数无效或字段不符合接口要求。	根据本文输入参数说明检查必填项、字段类型和字段格式。
`action_not_enabled`	当前接口能力未开放，或当前发布范围不支持该调用。	检查接口是否已纳入当前发布范围，并确认目标平台已支持该能力。