见独技术

接入说明

各服务的调用格式与示例代码:

本页是两种服务共用的约定:API key、鉴权、拒绝与错误码、费用,以及用 API key 查询余额和账单。

API key

鉴权与连接

项规定
语音对话入口wss://api.jftxyun.com:31080/v1/realtime
纯识别入口wss://api.jftxyun.com:31080/v1/asr
鉴权WebSocket 握手请求头 Authorization: Bearer <key>。不接受用其他请求头、URL 参数或事件字段传 key
粒度一通电话(一次识别会话)一条 WebSocket 连接
首帧握手之后第一条消息必须是带 session_id 的 session.start;所有消息都是 JSON 文本帧,音频用 Base64

拒绝与错误码

握手被拒返回 HTTP 403:key 格式不对、不存在、已吊销或过期、账户停用、IP 不在白名单、key 用在了另一种服务的入口。具体原因不返回,请联系我们核对 key;403 不要重试。

握手成功、发出 session.start 之后准入失败,会收到一条 error(fatal: true),随后连接关闭。error.session_id 是你方 session.start 里的 session_id。

code关闭码可重试含义
INVALID_EVENT1008否超时没收到首帧,或首帧不是带 session_id 的 session.start
CONCURRENCY_LIMIT4429是超出账户的并发上限
INSUFFICIENT_BALANCE4402否余额不够开始这一通
CUSTOMER_INACTIVE4403是账户被暂停
NO_CAPACITY1013是暂时没有空闲的服务容量
SERVICE_UNAVAILABLE1013是服务暂时不可用

会话进行中:余额耗尽时先收到 error{code:"INSUFFICIENT_BALANCE", fatal:false},随后照常收到 session.result;被我们在管理端挂断时收到 error{code:"CALL_TERMINATED"},随后照常收到 session.result。

费用

session.result 带 billing: {currency, cost_micros},是这一通的费用;金额单位 micros,1 元 = 1,000,000 micros。计费规则与价格以用量后台公示的为准。

查询余额、用量与账单

用任一把 key 发 HTTPS GET,请求头同样是 Authorization: Bearer <key>,查到的是这把 key 所属账户的数据。key 不可用时回 HTTP 403。金额单位 micros,时间为北京时间(+08:00),月份按北京时间切。

curl -s -H "Authorization: Bearer $KEY" https://api.jftxyun.com:31080/v1/account
接口返回
GET /v1/account余额 balance_micros、信用额度 credit_limit_micros、可用额度 available_micros(扣除进行中通话的预留)、并发上限 max_concurrency、在线通话数 live_calls、当前价格 plan
GET /v1/usage?period=YYYY-MM该月(默认本月)的通话数 calls、消费 charged_micros、按服务分的 by_service、计费量 billed_quantity、被拒次数 refusals
GET /v1/sessions?limit=&before=&session_id=通话列表,按开始时间倒序:call_id、session_id、service、status、end_reason、started_at、ended_at、charged_micros、key_name、计价明细 lines。limit 默认 100、最大 1000;翻页把上一页最后一条的 started_at 作为 before
GET /v1/ledger?limit=&before_id=资金流水,按 id 倒序:kind(topup 充值 / charge 扣费 / refund 退款 / adjust 调整)、amount_micros(扣费为负)、balance_after_micros、call_id、created_at。翻页把上一页最后一条的 id 作为 before_id

同样的数据也可以登录用量后台查看。