Callbot API ping - nxtele/http-api-document GitHub Wiki
callbot-api
v1.0.0
Base URLs:
aibot外部接口v3.0/探活
鉴权方式
鉴权请查看文档https://github.com/nxtele/http-api-document/wiki/Callbot-API-authorization
POST 探活接口
POST /callcentre/api/v3/ping
Body 请求参数
{
"data": "string"
}
请求参数
名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
---|---|---|---|---|---|
requestID | header | string | 是 | 请求唯一id | |
uuid | header | string | 是 | uuid,由被调用方给出 | |
createTs | header | string | 是 | 请求时间戳,(秒级) | |
sign | header | string | 是 | 签名 | |
algorithm | header | string | 否 | 签名的算法:MD5或者SHA256,不填默认用MD5 | |
body | body | object | 否 | none | |
» data | body | string | 是 | 透传字段 | none |
返回示例
200 Response
{
"data": "string",
"timestamp": 0,
"code": 0,
"msg": "string",
"reqId": "string"
}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
响应的header
名称 | 类型 | 必选 | 说明 |
---|---|---|---|
requestID | string | 是 | 与请求头一致 |
uuid | string | 是 | 与请求头一致 |
createTs | string | 是 | 响应时的秒级时间戳 |
sign | string | 是 | 生成方法与请求头sign生成算法一样 |
algorithm | string | 否 | 与请求头一致,签名的算法:MD5或者SHA256,不填默认用MD5 |
返回数据结构
状态码 200
名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
---|---|---|---|---|---|
» data | string | true | none | 透传字段 | none |
» timestamp | integer | true | none | 当前秒级时间戳,表示检查的时间 | none |
» code | integer | true | none | 响应码 | 0为成功,其余为失败 |
» msg | string | true | none | 响应消息 | none |
» reqId | string | true | none | 请求ID | none |