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

    群組可能存在,但目前帳戶不是該群組成員。