| 缩略语 | 全称 | 备注 |
|---|---|---|
| API | 指平台对外的接口能力 | |
| appId | 调用方应用标识,用于调用接口时鉴权 | 请联系对接运营获取 |
| appKey | 调用方密钥,用于调用接口时鉴权 | 请联系对接运营获取 |
| timeStamp | 过去的毫秒数,生成规则:timeStamp=new Date().getTime(); | |
| sign | 签名,规则为:sign = sha256(appId+appKey+timestamp) |
接口协议使用HTTPS,由服务提供方提供访问的URL规范,创建任务使用POST方法发送请求并获取应答报文;查询接口采用GET方法(详见接口描述)。发起和返回报文统一使用UTF-8编码。调用方与平台间交互同步等待超时时间根据实际情况协商。
注:所有接口入参不支持emoji等特殊字符。
生产环境地址: https://bluapi.shanghu.ai/
调用方需先向运营对接人申请appId和appKey,在请求报文头中加上appId、timeStamp、sign参数用于身份鉴权。
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| appId | Y | string | 调用方id(请联系运营获取) |
| timeStamp | Y | string | 过去的毫秒数,生成规则: timeStamp=new Date().getTime(); |
| sign | Y | string | 签名规则为: sha256(appId+a ppKey+timestamp) |

说明:建议一次性对接创建任务、上传名单、外呼回调、拨打(触达)前验证接口,拨打结果查询和取消名单接口可以不用对接。