API详情

短信发送和查询

短信下发

描述

实现短信下发功能,一次支持提交一个手机号。

注意:

下发短信前,需要先申请签名和短信模板,并通过审核。系统内置模板可直接使用。

URL

/bce/v2/message

HTTP Method

POST

请求参数

参数名称 类型 是否必需 描述
invokeId String 调用ID e.g. d2iL60UT-7N8-2236
phoneNumber String 手机号码,e.g. 13800138000
templateCode String 短信模板ID,模板申请成功后自动创建,全局内唯一。e.g. smsTpl:6nHdNumZ4ZtGaKO
contentVar String 模板变量内容,用于替换短信模板中定义的变量,为json字符串格式

返回值

参数名称 类型 是否必需 描述
requestId String 短信发送请求唯一流水ID
code String 短信提交状态,1000 表示提交成功
message String 短信提交状态描述

HTTP请求示例

POST /bce/v2/message HTTP/1.1

Host: sms.bj.baidubce.com

x-bce-content-sha256:e3d5591edbab45d28817fcb1463501d9e68ecb9730f440ac975da368ca4adbfc

x-bce-date:2014-06-11T08:23:49Z

Content-Type: application/json

Authorization:bce-auth-v1/AKIAIOSFODNN7EXAMPLE/1323937348/600//host;x-bce-date/=hQJj2pxypqJHQgU/BW1EZGUiNIYGhkQDf7tI6UgQ2qw=

Content-Length: 151

{
    "invokeId": "d2iL60UT-7N8-22368",
    "phoneNumber": "13800138000",
    "templateCode": "smsTpl:6nHdNumZ4ZtGaKO",
    "contentVar": {
        "others": "你好",
        "code": "7890"
    }
}

成功响应示例

HTTP/1.1 200 OK

Date: Thu, 12 Jun 2014 09:26:46 GMT

Content-Type: application/json; charset=utf-8

x-bce-request-id:98f651c-e230-4810f-8092-f77506d848

{
    "code": "1000",
    "message": "成功",
    "requestId": "98f651c-e230-4810f-8092-f77506d848"
}

查询短信流水信息

描述

查询短信的流水信息。

URL

/v1/message/{messageId}

HTTP Method

GET

请求参数

参数名称 类型 是否必需 描述
messageId String URL参数,短信发送流水号(即发送请求时,返回的requestId)

返回值

参数名称 类型 是否必需 描述
messageId String 请求中携带的短信流水号。
content String 发送的短信内容。
receiver List 短信收信人,采用json数组格式传递,形如["13800238000","13800138001"]。
sendTime String 短信发送时间,符合BCE API规范,形如:2014-06-12T10:08:22Z。

HTTP请求示例

GET /v1/message/123456789abefghiqwertioplkjhgfds HTTP/1.1

Host: sms.bj.baidubce.com

x-bce-date:2014-06-11T08:23:49Z

Content-Type: application/json

Authorization:bce-auth-v1/AKIAIOSFODNN7EXAMPLE/1323937348/600//host;x-bce-date/=hQJj2pxypqJHQgU/BW1EZGUiNIYGhkQDf7tI6UgQ2qw=

Content-Length: 151

成功响应示例

HTTP/1.1 200 OK

Date: Thu, 12 Jun 2014 09:26:46 GMT

Content-Type: application/json; charset=utf-8

x-bce-request-id:47e0ef1a-9bf2-11e1-9279-0100e8cf109a

{

    "messageId":"123456789abefghiqwertioplkjhgfds",

    "content":"您在JDMALL申请的验证码为123456",

    "receiver":["13800138000"],

    "sendTime":"2014-06-12T10:08:22Z"

}

短信模板

短信模板申请

描述

申请创建新的短信模板,并生成相应的模板ID。短信模板的申请需要BCE管理员审核,审核通过后的短信模块方可使用。

注意:

短信模板需要后台人工审核,用户需关注短信模板的审核结果。

URL

/bce/v2/applyTemplate

HTTP Method

POST

请求参数

参数名称 类型 是否必需 描述
invokeId String 短信模板ID,模板申请成功后自动创建,全局内唯一。e.g. smsTpl:6nHdNumZ4ZtGaKO
name String 模板名称,长度不大于32个字符
content String 模板变量内容,长度不大于300个字符,模板变量才使用${key}的形式,如:您的验证码是${code}
profileId String 多应用场景用户申请时需要填写, 一般用户无需填写

返回值

参数名称 类型 是否必需 描述
requestId String 申请模板请求唯一流水ID
code String 申请模板提交状态,1000 表示提交成功
message String 申请模板提交状态描述
data Object 申请模板响应数据,创建成功时,会响应data,否则无

申请模板data定义如下:

参数名称 类型 是否必需 描述
templateId String 申请创建的模板ID,如smsTpl:6nHdNumZ4ZtGaKO

HTTP请求示例

POST /bce/v2/applyTemplate HTTP/1.1

Host: sms.bj.baidubce.com

x-bce-content-sha256:e3d5591edbab45d28817fcb1463501d9e68ecb9730f440ac975da368ca4adbfc

x-bce-date:2014-06-11T08:23:49Z

Content-Type: application/json

Authorization:bce-auth-v1/AKIAIOSFODNN7EXAMPLE/1323937348/600//host;x-bce-date/=hQJj2pxypqJHQgU/BW1EZGUiNIYGhkQDf7tI6UgQ2qw=

Content-Length: 151

{
    "invokeId": "dkw86m01T-26Nv9-H5Z3",
    "name": "验证码模板",
    "content": "您的验证码是${vCode},看完马上删了"
}

成功响应示例

HTTP/1.1 200 OK

Date: Thu, 12 Jun 2014 09:26:46 GMT

Content-Type: application/json; charset=utf-8

x-bce-request-id:47e0ef1a-9bf2-11e1-9279-0100e8cf109a

{
    "code": "1000",
    "data": {
        "templateId": "smsTpl:c298ebb9-8283-6nHdNumZ4ZtGaKO"
    },
    "message": "成功",
    "requestId": "47e0ef1a-9bf2-11e1-9279-0100e8cf109a"
}

删除短信模板

描述

删除既有的短信模板,包括审核中、已审核的模板。

URL

/v1/template/{templateId}

HTTP Method

DELETE

请求参数

参数名称 类型 是否必需 描述
templateId String URL参数。既有短信模板的ID,全局内唯一。如: smsTpl:6nHdNumZ4ZtGaKO,需要urlencode。

返回值

NULL

HTTP请求示例

DELETE /v1/template/smsTpl%3A6nHdNumZ4ZtGaKO HTTP/1.1

Host: sms.bj.baidubce.com

x-bce-content-sha256:e3d5591edbab45d28817fcb1463501d9e68ecb9730f440ac975da368ca4adbfc

x-bce-date:2014-06-11T08:23:49Z

Content-Type: application/json

Authorization:bce-auth-v1/AKIAIOSFODNN7EXAMPLE/1323937348/600//host;x-bce-date/=hQJj2pxypqJHQgU/BW1EZGUiNIYGhkQDf7tI6UgQ2qw=

Content-Length: 151

成功响应示例

HTTP/1.1 200 OK

Date: Thu, 12 Jun 2014 09:26:46 GMT

Content-Type: application/json; charset=utf-8

x-bce-request-id:47e0ef1a-9bf2-11e1-9279-0100e8cf109a

获取短信模板信息

描述

获取既有短信模板信息。

URL

/v1/template/{templateId}

HTTP Method

GET

请求参数

参数名称 类型 是否必需 描述
templateId String URL参数。既有短信模板的ID,全局内唯一。如: smsTpl:6nHdNumZ4ZtGaKO,需要urlencode。

返回值

参数名称 类型 是否必需 描述
templateId String 短信模板的ID,全局内唯一。形如:smsTpl:6nHdNumZ4ZtGaKO。
name String 短信模板名称。
content String 短信模板内容,长度限定在300字符以内,变量采用如下格式描述:${VAR}。
status String 短信模板状态,可选值包括:processing(审核中)、valid(审核成功)、unvalid(审核失败)。
createTime String 短信模板创建时间,符合SMS API标准,形如:2014-06-12T10:08:22Z。
updateTime String 短信模板更新时间,符合SMS API标准,形如:2014-06-12T10:08:22Z。

HTTP请求示例

GET /v1/template/smsTpl%3A6nHdNumZ4ZtGaKO HTTP/1.1

Host: sms.bj.baidubce.com

x-bce-date:2014-06-11T08:23:49Z

Content-Type: application/json

Authorization:bce-auth-v1/AKIAIOSFODNN7EXAMPLE/1323937348/600//host;x-bce-date/=hQJj2pxypqJHQgU/BW1EZGUiNIYGhkQDf7tI6UgQ2qw=

Content-Length: 151

成功响应示例

HTTP/1.1 200 OK

Date: Thu, 12 Jun 2014 09:26:46 GMT

Content-Type: application/json; charset=utf-8

x-bce-request-id:47e0ef1a-9bf2-11e1-9279-0100e8cf109a

{

    "templateId":"smsTpl:6nHdNumZ4ZtGaKO",

    "name:"verifyID",

    "content":"您在${VAR}申请的验证码为${VAR}",

    "status:"VALID",

    "createTime":"2014-06-12T10:08:22Z",

    "updateTime":"2014-06-12T10:08:22Z"

}

获取短信模板列表

描述

获取既有的短信模板列表,按照创建时间逆序排序。

注意:

用户需关注短信模板的审核结果,暂不支持自动审核。

URL

/v1/template

HTTP Method

GET

请求参数

NULL

返回值

参数名称 类型 是否必需 描述
templateList List 短信模板列表,templateInfo具体格式参见下表。

templateInfo格式如下:

参数名称 类型 是否必需 描述
templateId String 短信模板的ID,全局内唯一。形如:smsTpl:6nHdNumZ4ZtGaKO。
name String 短信模板名称。
content String 短信模板内容,长度限定在300字符以内,变量采用如下格式描述:${VAR}。
status String 短信模板状态,可选值包括:processing(审核中)、valid(审核成功)、unvalid(审核失败)。
createTime String 短信模板创建时间,符合SMS API标准,形如:2014-06-12T10:08:22Z。
updateTime String 短信模板更新时间,符合SMS API标准,形如:2014-06-12T10:08:22Z。

HTTP请求示例

GET /v1/template HTTP/1.1

Host: sms.bj.baidubce.com

x-bce-content-sha256:e3d5591edbab45d28817fcb1463501d9e68ecb9730f440ac975da368ca4adbfc

x-bce-date:2014-06-11T08:23:49Z

Content-Type: application/json

Authorization:bce-auth-v1/AKIAIOSFODNN7EXAMPLE/1323937348/600//host;x-bce-date/=hQJj2pxypqJHQgU/BW1EZGUiNIYGhkQDf7tI6UgQ2qw=

Content-Length: 151

成功响应示例

HTTP/1.1 200 OK

Date: Thu, 12 Jun 2014 09:26:46 GMT

Content-Type: application/json; charset=utf-8

x-bce-request-id:47e0ef1a-9bf2-11e1-9279-0100e8cf109a

{

    "templateList":{

        "templateId":"smsTpl:6nHdNumZ4ZtGaKO",

        "name:"verifyID",

        "content":"您在${VAR}申请的验证码为${VAR}",

        "status:"valid",

        "createTime":"2014-06-12T10:08:22Z",

        "updateTime":"2014-06-12T10:08:22Z"

}

}

配额管理

查询发送配额

描述

查询用户的发送限制配额。

URL

/v1/quota

HTTP Method

GET

请求参数

NULL

返回值

参数名称 类型 是否必需 描述
maxSendPerDay int 用户在单日内发送的最多短信数目,按自然日计时。
maxReceivePerPhoneNumberDay int 单终端用户在单日内允许接收的最大短信数,按自然日计时。
sentToday int 用户在最近当天内已发送的短信数目,按自然日计时。

HTTP请求示例

GET /v1/quota HTTP/1.1

Host: sms.bj.baidubce.com

x-bce-date:2014-06-11T08:23:49Z

Content-Type: application/json

Authorization:bce-auth-v1/AKIAIOSFODNN7EXAMPLE/1323937348/600//host;x-bce-date/=hQJj2pxypqJHQgU/BW1EZGUiNIYGhkQDf7tI6UgQ2qw=

Content-Length: 151

成功响应示例

HTTP/1.1 200 OK

Date: Thu, 12 Jun 2014 09:26:46 GMT

Content-Type: application/json; charset=utf-8

x-bce-request-id:47e0ef1a-9bf2-11e1-9279-0100e8cf109a

{

    "maxSendPerDay":10000,

    "maxReceivePerPhoneNumberDay":10,

    "sentToday":8000

}

终端用户短信接收管理

查询单终端用户短信接收信息

描述

查询单终端用户接收的短信信息。

URL

/v1/receiver/{phoneNumber}

HTTP Method

GET

请求参数

参数名称 类型 是否必需 描述
phoneNumber String URL参数。终端用户的手机号,仅支持单个用户,格式要求只包含数字,形如:13800138000。

返回值

参数名称 类型 是否必需 描述
maxReceivePerPhoneNumberDay int 单终端用户在24小时内允许接收的最大短信数,按自然日计时。
receivedToday int 单终端用户在最近24小时内已接收的短信数目,按自然日计时。

HTTP请求示例

GET /v1/receiver/13800138000 HTTP/1.1

Host: sms.bj.baidubce.com

x-bce-date:2014-06-11T08:23:49Z

Content-Type: application/json

Authorization:bce-auth-v1/AKIAIOSFODNN7EXAMPLE/1323937348/600//host;x-bce-date/=hQJj2pxypqJHQgU/BW1EZGUiNIYGhkQDf7tI6UgQ2qw=

Content-Length: 151

成功响应示例

HTTP/1.1 200 OK

Date: Thu, 12 Jun 2014 09:26:46 GMT

Content-Type: application/json; charset=utf-8

x-bce-request-id:47e0ef1a-9bf2-11e1-9279-0100e8cf109a

{

    "maxReceivePerPhoneNumberDay":10,

    "receivedToday":8

}