> For AI agents: the complete documentation index is available at /apps-plugin/docs/llms.txt, the full documentation bundle is available at /apps-plugin/docs/llms-full.txt.

# sign

使用三方纯签约的签约单号拉起用户签约页面。

## 支持版本

前端库版本不低于 `0.0.28`。

## 支持平台

<table>
<thead>
<tr><th>平台</th><th>支持情况</th></tr>
</thead>
<tbody>
<tr><td>Android</td><td>支持</td></tr>
<tr><td>iOS</td><td>支持</td></tr>
<tr><td>PC</td><td>不支持</td></tr>
<tr><td>HarmonyOS</td><td>不支持</td></tr>
</tbody>
</table>

## 支持场景

<table>
<thead>
<tr><th>场景</th><th>支持情况</th></tr>
</thead>
<tbody>
<tr><td>页面</td><td>支持</td></tr>
<tr><td>卡片</td><td>支持</td></tr>
</tbody>
</table>

## 接入准备

### 前置条件

- **Android**：需用户已登录并完成抖音账号绑定，且当前处于前台可见页面
- **iOS**：需用户已登录并完成抖音账号绑定

## 使用说明

如果用户尚未绑定抖音账号，豆包可能先拉起账号绑定流程，再继续展示签约页面。

用户的最终签约状态必须以业务服务端查询签约单详情或收到的签约结果回调为准。
业务服务端还需要维护业务用户与签约 ID 的对应关系。

- 调用会拉起签约 UI 并需要用户交互，请在用户明确触发签约的交互场景中调用；请勿在无用户操作的后台逻辑中调用。

## 调用方式

### 异步 API

```typescript
sign(params: SignParams): Promise<SignResult>
```

## 入参

<table>
<thead>
<tr><th>名称</th><th>类型</th><th>必填</th><th>默认值</th><th>约束</th><th>说明</th></tr>
</thead>
<tbody>
<tr><td><code>orderId</code></td><td><code>string</code></td><td>是</td><td>-</td><td>-</td><td>平台签约订单号。<br><br>传入 `createSignOrder` 成功后返回的 `authOrderId`，不要使用业务侧订单号或自行构造的值。</td></tr>
</tbody>
</table>

## 调用示例

```typescript
import {
  createSignOrder,
  sign,
  type CreateSignOrderParams
} from '@doubao-dev/framework/api';

// 业务方自行实现：从业务服务端获取签约订单参数和签名；该函数不是 SDK API。
declare function getSignOrderParamsFromBusinessServer():
  Promise<CreateSignOrderParams>;
// 业务方自行实现：通过业务服务端确认最终签约状态；该函数不是 SDK API。
declare function refreshSignStatusFromBusinessServer(authOrderId: string): Promise<void>;

const orderParams = await getSignOrderParamsFromBusinessServer();
const orderResult = await createSignOrder(orderParams);

if ('authOrderId' in orderResult) {
  await sign({ orderId: orderResult.authOrderId });
  await refreshSignStatusFromBusinessServer(orderResult.authOrderId);
}
```

## 成功返回

<table>
<thead>
<tr><th>名称</th><th>类型</th><th>必返</th><th>说明</th></tr>
</thead>
<tbody>
<tr><td><code>code</code></td><td><code>number</code></td><td>否</td><td>错误码。</td></tr>
<tr><td><code>errLogId</code></td><td><code>string</code></td><td>否</td><td>用于服务端排查问题的错误日志 ID。</td></tr>
<tr><td><code>errMsg</code></td><td><code>string</code></td><td>否</td><td>错误信息。</td></tr>
<tr><td><code>errNo</code></td><td><code>string</code></td><td>否</td><td>错误编号。</td></tr>
</tbody>
</table>

### 返回示例

```json
{}
```

## 错误处理

错误对象和通用错误码见 [通用错误处理](/apps-plugin/docs/js-api/common-errors.md#错误返回)。

### 失败示例

```json
{
  "errNo": 114,
  "errMsg": "operation cancelled"
}
```

### 错误码

<table>
<thead>
<tr><th>errNo</th><th>errMsg</th><th>平台</th><th>触发条件</th><th>处理建议</th></tr>
</thead>
<tbody>
<tr><td><code>114</code></td><td><code>operation cancelled</code></td><td>Android</td><td>用户在签约收银台中取消了签约操作</td><td>用户需要时可再次调用 `sign` 重新发起签约。</td></tr>
</tbody>
</table>

#### 通用错误码

<table>
<thead>
<tr><th>errNo</th><th>errMsg</th><th>说明</th><th>平台</th></tr>
</thead>
<tbody>
<tr><td><code>102</code></td><td><code>internal error</code></td><td>内部错误</td><td>Android、iOS</td></tr>
<tr><td><code>103</code></td><td><code>feature not support</code></td><td>当前环境不支持该能力</td><td>Android、iOS</td></tr>
</tbody>
</table>

## 平台差异

- **Android**：需在前台可见的 Activity 中调用，应用退至后台或无有效页面时会返回失败。
- **Android**：用户主动取消签约时返回顶层 errNo 114（operation cancelled）；iOS 在该场景不返回顶层专属 errNo。

## 已知限制与注意事项

- 失败结果不会作为 await 的返回值，需通过 catch 捕获并从错误对象的 data 字段读取 code、errNo、errMsg、errLogId。
