Resumen de la API abierta

Métodos de autenticación, formato de respuesta, códigos de error y códigos de idioma compatibles.

En adelante, {API} hace referencia a la dirección del servicio, que encontrarás en la página «Integración» del panel.

Todas las solicitudes deben incluir Authorization: Bearer sk_live_... (se crea en la página «Integración» del panel, solo se muestra una vez y debe guardarse únicamente en el servidor).

Las respuestas siguen siempre el formato {"code": "SUCCESS", "message": "", "data": ...}. En caso de error, code es un código de error estable: úsalo para decidir cómo actuar; message es solo para lectura humana. Todos los importes son cadenas de texto.

Códigos de error

codeSituación
UNAUTHORIZEDLa API Key no es válida o ha sido revocada
VALIDATION_ERRORParámetros incorrectos; data contiene los campos concretos
NOT_FOUNDEl recurso no existe (incluidos los recursos que no te pertenecen)
PLAN_LIMIT_REACHEDSe ha superado el número de productos, la capacidad de la base de conocimiento o el número de agentes de tu plan
CONVERSATION_CLOSEDLa conversación ha finalizado; crea una nueva
CONVERSATION_OPENLa conversación aún no ha finalizado, no se puede valorar
RATE_LIMITEDDemasiadas solicitudes
USER_TOKEN_INVALIDLa firma de user_token no es correcta o ha caducado
CHECKOUT_FAILEDLa confirmación del pedido ya no es válida, o la interfaz de pedido no está disponible temporalmente (cuando se pulsa «Confirmar pedido» en el widget)
ORIGIN_NOT_ALLOWEDEl sitio web actual no está en la lista de sitios permitidos para la inserción
LANGUAGE_NOT_SUPPORTEDEl idioma no es compatible o no está habilitado
CHANNEL_CHECK_FAILEDNo se ha podido verificar el AppID / AppSecret del canal; message contiene el motivo devuelto por WeChat
CHANNEL_REMOVEDEl canal del que procede la conversación se ha eliminado y la respuesta no se puede enviar

Códigos de idioma admitidos: zh-CN, zh-TW, en, ja, ko, de, fr, es, pt, it, ru, ar, th, vi, id, ms, tr, nl, pl. Variantes como zh-Hant, pt-BR o en_US se convierten automáticamente al código correspondiente.

¿Te ha resultado útil esta página?

Última actualización: