短信服务查询API(V2)

开始使用前,请先创建应用,申请开通短信邮件服务。

请求

GET https://colibri.glodon.com/api/security/v2/sms?requestId={requestId}&mobile={mobile}

说明

::: tip 注意
requestId:请求发送短信流水号,V1短信发送接口需要自己生成,V2短信发送接口后台会生成,并返回给调用端。
:::

header 参数

参数名 必选 类型 描述
Authorization String Bearer app_access_token. 注:该 access_token 是应用级别

body 参数

参数名 必选 类型 描述
requestId String 发送短信流水(调用短信发送V2接口返回值data字段值),短信中requestId长度为32位
mobile String 如果mobile有值,则查询的是这一批流水中该mobile的发送状态,如果mobile为空,返回的是这一批流水所有mobile的发送状态

响应

HTTP 代码 说明 类型
200 ok 请求成功,根据业务 code 解析实际结果
401 invalid_token 请求头里面的 accessToken 无效
600 业务异常 业务异常

HTTP 请求示例

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
  
Request request = new Request.Builder()
  .url("https://colibri.glodon.com/api/security/v2/sms?requestId=072ea480ccc940a0b1049f70439eed40&mobile=15652460416")
  .method("GET", null)
  .addHeader("Authorization", "Bearer cn-5a81d247-5cd7-4e52-a9b2-78796e34fc55")
  .build();
  
Response response = client.newCall(request).execute();

curl -X GET 'https://colibri.glodon.com/api/security/v2/sms?requestId=072ea480ccc940a0b1049f70439eed40&mobile=11052460416' \
--header 'Authorization: Bearer cn-5a81d247-5cd7-4e52-a9b2-78796e34fc55'

成功返回结果

{
    "code": 40000,
    "message": "OK",
    "data": [
        {
            "result": -1,
            "mobile": "151xxxx0416"
        },
        {
            "result": -1,
            "mobile": "150xxxx0417"
        }
    ]
}

异常返回结果

{"code":40200,"message":"colibri.oauth.scope.error","cause":"没有分配权限"}
{"code":40209,"message":"colibri.invalid.request.id","cause":"无效的requestID"} 
{"error":"invalid_token","error_description":"cn-5a81d247-5cd7-4e52-a9b2-78796e34fc56"}

返回字段result说明

result:-1:表示发送失败
result:0:发送成功