API设计

公共请求头

下表列出了所有SMS API所携带的公共头域。HTTP协议的标准头域不在这里列出了。

头域(Header) 说明
Content-Type application/json
Authorization 包含Access Key与请求签名
x-bce-date 表示日期一律采用YYYY-MM-DD方式,例如2014-06-01表示2014年6月1日。
x-bce-content-sha256 表示内容部分的SHA256签名的十六进制字符串。这里内容指HTTP Request Payload Body。即Content部分在被HTTP enID之前的原始数据。

公共头域将在每个SMS API中出现,是必需的头域,其中x-bce-content-sha256头域只出现在POST和PUT请求中。

POST、PUT、DELETE等请求数据放在request body中。

公共响应头

下表列出了所有SMS API的公共响应头域。HTTP协议的标准响应头域不在这里列出了。

头域(Header) 说明
Content-Type 只支持json格式,application/json; charset=utf-8
x-bce-request-id SMS后端生成,并自动设置到响应头域中

其中,request id使用UUID version 4由SMS服务生成。

通用错误返回

ID为错误码,所有错误码取值参考错误码部分内容。

{

  "requestId":"47e0ef1a-9bf2-11e1-9279-0100e8cf109a",

  "code":"NoSuchKey",

  "message":"The resource you requested does not exist",        

}

资源/操作说明

SMS所有资源实体定义如下(下面定义的所有资源的父层级都是account,在URL中并不体现账号层级):

资源名称 Method 描述
message POST、GET 短信下发,支持单短信批量用户下发、短信流水信息查询
template POST、DELETE、GET 短信模板的创建、修改、删除、获取模板列表、获取模板内容
quota GET 短信配额的设置、查询
receiver GET 单终端用户短信接收状况查询