外观
注册 iOS VoIP 设备
登记当前 iOS 设备的 APNs VoIP token,用于离线来电唤醒。普通友盟通知不使用此接口注册。
POST /app/sdk/push/register
调用方: SDK 客户端 · 认证: IM Token
请求头:Authorization: Bearer <IM Token>。先通过宿主后端获取 Token,再交给 SDK 使用。
请求参数
JSON Body
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
device_id | string | 是 | 当前安装设备的稳定标识,1–128 位字母、数字、点、下划线、冒号或连字符。同一台设备持续使用同一个值。 |
token | string | 是 | APNs VoIP token,64–512 个小写十六进制字符,长度必须为偶数。 |
environment | string | 是 | development 开发环境;production 生产环境,应与 APNs 证书或配置一致。 |
bundle_id | string | 是 | iOS Bundle ID,最长 255 字符,至少两段,以点分隔,各段允许字母、数字、连字符。 |
请求示例
bash
curl 'https://example.com/app/sdk/push/register' \
-H "Authorization: Bearer $POPOIM_TOKEN" \
-H 'Content-Type: application/json' \
--data '{"device_id":"office-ios-01","token":"a72b42ab32f67f0433c507a81b65919162c930a6506cc62b0b83924046d43a7f","environment":"production","bundle_id":"com.example.office"}'使用说明
- 只提交上表四项。服务器为每个账号保留最近 10 台设备。
- 收到离线来电后,先读取指定通话状态,再决定是否展示来电;通知送达不代表通话仍在振铃。
返回参数
成功响应的最外层字段如下。下面所有业务字段都位于 data 中。
| 字段 | 类型 | 说明 |
|---|---|---|
code | integer | 0 表示成功;非 0 时查看 msg,不把 data 当成功结果使用。 |
msg | string | 成功通常为 ok,失败时为错误说明。 |
data | object | 本次请求的业务结果,字段见下表。 |
data 字段
| 字段 | 类型 | 说明 |
|---|---|---|
registered | boolean | 注册成功为 true。 |
返回示例
示例展示字段结构;ID、时间和资料仅作说明,请使用实际回包。
json
{
"code": 0,
"msg": "ok",
"data": {
"registered": true
}
}错误处理
先检查 HTTP 状态,再检查 code。业务失败可能仍为 HTTP 200;非 0 的 code 都不能当成功。完整错误码见请求约定。
