所有的API返回在没有一般性HTTP错误的情况下,都应使用HTTP 200 Ok 状态码,并在HTTP包体部分使用JSON格式指定整数返回码和文本返回信息,无论是全媒体系统还是对接全媒体系统的程序。
当API调用者收到非HTTP 200 Ok 返回,或者返回的JSON中错误码不为0时,都认为调用错误。其中,HTTP错误可以认为是通信错误,或者是系统无法提供错误原因的异常;而返回的JSON数据中的错误码和错误说明则可作为具体的错误提示信息。
HTTP返回的结果数据格式是:
{
"errcode": 1,
"errmsg": "1号错误"
}
errcode [必须] :返回码,必须是一个整数
errmsg [可选] :错误信息,必须是字符串或者 null