响应结果
PBX 返回的响应结果为 JSON 格式。
正常响应示例
接口调用成功后会返回提示 SUCCESS
的响应。部分 API 响应还会返回相应的参数。HTTP 的状态码为 200 OK。
HTTP/1.1 200 OK
{
"errcode": 0,
"errmsg": "SUCCESS",
}
异常响应示例
接口调用失败时会返回异常响应,以提示异常信息详情。异常响应中返回错误码、错误信息以及错误或重复的参数值,可帮助开发者快速定位错误,修改请求并重试。
你可以根据 错误码 & 错误信息 进行分析和排查错误。
异常响应示例 – 获取访问 token
此异常响应表示认证失败,并返回无效参数字段 invalid_param_list,提示用户名或密码出错。
{
"errcode": -1,
"errmsg": "FAILURE",
"invalid_param_list": [
{
"field": "username or password",
"value": "error"
}
]
}
异常响应示例 – 添加一条呼出路由
此异常响应表示参数错误导致请求失败,并返回无效参数字段 invalid_param_list,提示必填参数 name
遗漏。
{
"errcode": 40002,
"errmsg": "PARAMETER ERROR",
"invalid_param_list": [
{
"field": "name",
"validation_type": "required"
}
]
}
异常响应示例 – 添加一个分机
此异常响应表示由于存在重复参数值导致请求失败,并返回重复参数字段 duplicate_field_list,提示分机 1011 已经存在相同的邮箱地址。
{
"errcode": 40003,
"errmsg": "DUPLICATE KEY VALUE",
"submsg": "Extension create fail for duplicate fields",
"duplicate_field_list": [
{
"field": "email_addr",
"value": "example@126.com",
"external_source": "extension",
"external_source_name": "1011"
}
]
}