Table of Contents
2.8 接口级速查索引【已整理】
本节用于快速定位联调入口；完整请求/响应字段以本文档对应接口章节为准，字段名和值结构必须与真实接口一致。
| 场景 | 方法与路径 | 所属模块 | 关键请求字段 | 关键响应字段 |
|---|---|---|---|---|
| 登录 | POST /tieup/api/v1/auth/login |
Tieup-认证 | phone、password |
access_token、refresh_token、expires_in、user.profile_completion_step |
| 当前用户 | GET /tieup/api/v1/me |
Tieup-用户 | Header Authorization |
id、nickname、phone、profile_completion_step、current_identity、is_idol、is_scout、status |
| 系统消息 | GET /tieup/api/v1/me/system-messages / GET /tieup/api/v1/me/system-messages/{message_id} / PATCH /tieup/api/v1/me/system-messages/read / GET /tieup/api/v1/me/system-messages/unread-count / GET /tieup/api/v1/me/system-messages/summary |
Tieup-系统消息 | business_type、read_status、type、sys_message_ids |
title、content、created_at、type、type_label、read_status、unread_count、total_count、latest_message_at |
| 基本配置信息 | GET /tieup/api/v1/app/basic-config |
Tieup-基础 | Header X-App-Channel |
official_website_url、official_wechat_public_account、scout_alliance_commission_rate、customer_service_phone、customer_service_wechat、customer_service_email |
| H5 充值地址配置 | GET /tieup/api/v1/app/h5-recharge-config |
Tieup-基础 | Header Authorization |
enabled、开启时的 h5_recharge_url |
| 艺人群发已读配置 | GET /tieup/api/v1/im/broadcast-read-config |
Tieup-内容/IM | Header Authorization |
enabled |
| IM 消息用户侧删除 | DELETE /tieup/api/v1/im/messages |
Tieup-内容/IM | message_nos |
deleted_count、already_deleted_count、ignored_count、read_count、queued_count |
| 偶像详情 | GET /tieup/api/v1/artists/{artist_id} |
Tieup-艺人 | artist_id |
artist_id、artist_name、pricing、subscription_status、subscription_plan、video_call_plans |
| 艺人查看粉丝详情 | GET /tieup/api/v1/artist/fans/{fan_user_id} |
Tieup-艺人 | fan_user_id |
fan_nickname、fan_avatar、age、province_name、city_name、gender、signature、companion_days、candy_spent、is_scout |
| 创建订阅订单 | POST /tieup/api/v1/subscriptions |
Tieup-钱包/支付 | artist_id、subscription_plan_code、sub_type、payment_method、is_auto_renew、H5 可选 return_url |
order_no、payment_no、payment_method、pay_params、pay_status |
| 测试环境模拟订阅支付成功 | GET /tieup/api/v1/test/payment-orders/{order_no}/simulate-paid |
Tieup-钱包/支付 | order_no、third_party_order_no、paid_at、mock_key |
subscription_no、im_sync、rong_ultra_group_id、member_status |
| 测试环境查询融云超级群成员 | POST /tieup/api/v1/test/rongcloud/ultragroup/member-exists |
Tieup-钱包/支付 | artist_id、fan_user_id、mock_key |
exists、rong_user_id、rong_ultra_group_id、local_member_status |
| 测试环境解散融云超级群 | GET /tieup/api/v1/test/rongcloud/ultragroups/{rong_ultra_group_id}/dismiss |
Tieup-钱包/支付 | rong_ultra_group_id、mock_key |
deleted_group_count、deleted_member_count、rongcloud_response |
| 订单详情 | GET /tieup/api/v1/orders/{order_no} |
Tieup-钱包/支付 | order_no |
order_no、business_type、order_status、pay_status、pay_amount、payment_method |
| Apple IAP 小票 | POST /tieup/api/v1/payment-orders/apple-iap-receipts |
Tieup-钱包/支付 | receipt_data |
ack、matched_count、success_count、failed_count、results |
| 我的福利 | GET /tieup/api/v1/me/benefit-artists / GET /tieup/api/v1/me/benefit-artists/{artist_id}/benefits |
Tieup-福利 | artist_id、scope |
偶像福利统计、福利进度、兑换记录与履约信息 |
| 我的福利数量 | GET /tieup/api/v1/me/benefits/count |
Tieup-福利 | Header Authorization，按 Token 的 current_identity 判断当前使用端 |
粉丝端 redeemable_count；偶像端 pending_count |
| 兑换福利 | POST /tieup/api/v1/benefit-redemptions |
Tieup-福利 | benefit_id、address_id 或 receiver_name/receiver_phone/detail_address、邮箱快照、Header Idempotency-Key |
redemption_id、redemption_no、redemption_status、progress_snapshot |
| 福利兑换历史 | GET /tieup/api/v1/me/benefit-redemptions |
Tieup-福利 | redemption_status、benefit_id |
包含已下架或删除福利的历史兑换、地址邮箱快照与履约信息 |
| 视频通话可预约时间 | GET /tieup/api/v1/artists/{artist_id}/video-call-available-slots |
Tieup-艺人 | artist_id、start_date、days |
items[].slots[].start_at、items[].slots[].end_at、items[].slots[].status |
| 视频通话预约 | POST /tieup/api/v1/video-call-bookings |
Tieup-艺人 | artist_id、video_call_plan_code、scheduled_start_at、payment_method、Header Idempotency-Key |
booking_id、booking_no、status、room_no |
| 支付回调 | POST /tieup/api/v1/payment/wechat/notify / POST /tieup/api/v1/payment/alipay/notify / POST /tieup/api/v1/payment/apple/notifications |
Tieup-回调 | 第三方原始回调载荷 | handled、ack、message |