API 参考

参考

错误码参考

请求失败时,先查看 HTTP 状态,再读取 error.code 或五位数字 error.numeric_code 判断原因。error.message 用于阅读,不用于程序判断;排查时保留 request_id。

400 Bad Request

  • invalid_request10000

    检查 JSON 请求体和必填字段。

  • invalid_provider30000

    检查 URL 中的渠道标识。

  • unsupported_action30005

    无法识别此账号操作,请使用文档列出的操作。

  • invalid_conversation_type37000

    type 必须为 user、group 或 channel。

  • unsupported_conversation_type37001

    渠道不支持此操作,请选择能力表中支持的操作。

  • unsupported_message_type36000

    请使用此渠道支持的 message.type。

  • unsupported_provider_auth_mode20018

    请使用此渠道支持的 auth_mode。

  • auth_mode_phone_required20019

    此授权方式要求创建账号时填写 provider_data.phone。

  • invalid_reply_token36006

    无法读取引用令牌,请原样复制入站事件的 data.message.reply_token。

  • provider_invalid_request30001

    检查渠道专属字段及其格式。

  • create_api_key_failed11101

    操作被拒绝,请检查请求并保留 request_id 排查。

  • update_api_key_failed11102

    操作被拒绝,请检查请求并保留 request_id 排查。

  • rotate_api_key_failed11103

    操作被拒绝,请检查请求并保留 request_id 排查。

  • update_workspace_failed41001

    操作被拒绝,请检查请求并保留 request_id 排查。

401 Unauthorized

  • missing_api_key11000

    请添加 X-Api-Key 请求头。

  • invalid_api_key11001

    检查 API Key 是否正确且已启用。

403 Forbidden

  • beta_feature_not_enabled41002

    工作区需开通内测资格,才能使用通话接口和显式订阅通话事件。

  • cors_forbidden11009

    CORS 来源、方法或请求头不被允许,请检查调用环境。

404 Not Found

  • call_not_found38003

    当前账号和工作区下不存在该通话。

  • not_found10001

    请检查 API 路径和 HTTP 方法。

  • conversation_not_found37002

    渠道未找到此会话,请核对标识和所属账号。

  • contact_not_found35000

    此账号下未找到联系人,请核对标识。

  • group_not_found34004

    此账号下未找到群组,请核对群组 ID。

409 Conflict

  • call_already_active38000

    该账号已有本系统管理的通话。查询 call_id 后挂断,或等待通话结束。

  • account_allocation_busy20011

    账号正在分配,请稍后重试。

  • no_allocatable_server20013

    此区域暂无可分配资源,请查询其他可分配区域。

  • workspace_account_quota_exceeded20014

    工作区消息账号额度已用满,请检查用量与额度。

  • duplicate_provider_account20015

    工作区内已有另一个账号绑定相同的渠道身份。

  • account_already_authorized20016

    账号已经授权,请复用;确需重新授权时先取消当前授权。

  • account_binding_not_found30006

    账号尚无有效的渠道连接绑定,请检查账号状态。

  • provider_account_mismatch20017

    请求中的渠道身份与账号绑定不一致。

  • provider_not_ready30009

    连接尚未就绪,请检查授权及 runtime_status 后再决定是否重试。

422 Unprocessable Entity

  • contact_not_found35000

    GET /contacts/info 返回 Conversation not found,请核对目标标识和本次查询使用的账号。

500 Internal Server Error

  • create_call_failed38002

    创建通话: 服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

  • call_control_failed38004

    服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

  • create_account_failed20002

    创建账号: 服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

  • update_account_failed20003

    更新账号: 服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

  • delete_account_failed20004

    删除账号: 服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

  • get_account_failed20001

    获取账号: 服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

  • list_accounts_failed20000

    列出账号: 服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

  • get_session_failed20005

    获取认证状态: 服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

  • get_auth_state_failed20006

    获取认证状态: 服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

  • run_action_failed20007

    服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

  • run_runtime_action_failed20008

    服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

  • run_session_action_failed20009

    服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

  • run_auth_action_failed20010

    服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

  • send_message_failed36001

    发送文本消息: 服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

  • pin_message_failed36002

    置顶 / 取消置顶消息: 服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

  • revoke_message_failed36003

    撤回消息: 服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

  • react_message_failed36004

    消息表情回应: 服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

  • edit_message_failed36005

    编辑消息: 服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

  • list_conversations_failed37003

    列出会话: 服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

  • get_conversation_failed37004

    获取会话详情: 服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

  • list_conversation_members_failed37005

    列出会话成员: 服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

  • mark_conversation_read_failed37006

    标记会话已读: 服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

  • mark_conversation_unread_failed37007

    标记会话未读: 服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

  • mute_conversation_failed37008

    静音会话: 服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

  • unmute_conversation_failed37009

    取消静音: 服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

  • pin_conversation_failed37010

    置顶会话: 服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

  • unpin_conversation_failed37011

    取消置顶会话: 服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

  • list_conversation_labels_failed37012

    列出会话标签: 服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

  • upsert_label_failed37013

    新建或更新标签: 服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

  • delete_label_failed37014

    删除标签: 服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

  • set_label_members_failed37015

    为会话增删标签: 服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

  • list_contacts_failed35001

    列出联系人: 服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

  • get_contact_failed35002

    获取联系人详情: 服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

  • create_contact_failed35003

    添加联系人: 服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

  • get_contact_membership_failed35004

    查询联系人状态: 服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

  • block_contact_failed35005

    封锁联系人: 服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

  • unblock_contact_failed35006

    解封联系人: 服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

  • list_blocklist_failed35007

    获取黑名单: 服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

  • set_contact_note_failed35008

    设置联系人备注: 服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

  • list_groups_failed34000

    列出群组: 服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

  • get_group_failed34001

    获取群详情: 服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

  • create_group_failed34002

    建群: 服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

  • leave_group_failed34003

    退群: 服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

  • update_group_members_failed34005

    管理群成员: 服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

  • update_group_info_failed34006

    修改群信息: 服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

  • list_group_join_requests_failed34007

    列出入群申请: 服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

  • update_group_join_requests_failed34008

    批准 / 拒绝入群申请: 服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

  • set_group_join_approval_mode_failed34009

    设置入群审批模式: 服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

  • get_group_invite_code_failed34010

    获取群邀请链接: 服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

  • list_webhook_endpoints_failed40000

    服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

  • create_webhook_endpoint_failed40001

    创建 Webhook 端点: 服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

  • get_webhook_endpoint_failed40002

    获取 Webhook 端点: 服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

  • update_webhook_endpoint_failed40003

    更新 Webhook 端点: 服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

  • deactivate_webhook_endpoint_failed40004

    停用 Webhook 端点: 服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

  • delete_webhook_endpoint_failed40005

    删除 Webhook 端点: 服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

  • get_workspace_failed41000

    获取当前工作区: 服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

  • list_api_keys_failed11100

    列出 API Key: 服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

  • list_provider_regions_failed30011

    列出渠道区域: 服务或渠道未能完成此操作。保留 request_id;重试写操作前先确认上次结果。

501 Not Implemented

  • unsupported_by_provider30003

    渠道不支持此操作,请选择能力表中支持的操作。

502 Bad Gateway

  • provider_adapter_not_found30004

    渠道服务暂不可用,请检查状态或稍后再试;重试写操作前先确认上次结果。

  • provider_unavailable30002

    渠道服务暂不可用,请检查状态或稍后再试;重试写操作前先确认上次结果。

503 Service Unavailable

  • call_service_unavailable38001

    通话服务不可用,请检查 Provider/Gateway 连接和配置。

  • allocation_service_unavailable20012

    账号分配服务暂不可用,请稍后重试。

Provider 细分数字码

这些数字码可细分 Provider 原因,但不会改变原 HTTP 状态或 legacy code。

  • provider_operation_failed30010

    Provider operation failed

    渠道未能完成操作,请保留 request_id 排查。

  • group_not_found34004

    Group not found

    未找到群组;部分已有渠道接口会保留原 HTTP 状态和 error.code。

  • group_not_participant34011

    Account is not participating in this group

    群组可能存在,但当前账号不是该群组成员。