文档首页/ 消息&短信 MSGSMS/ API参考/ API/ 应用、签名、模板/ 短信应用/ 查询短信应用
更新时间：2024-08-06 GMT+08:00
查看PDF
分享

查询短信应用

功能介绍

该接口用于用户查询已创建的应用信息。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v2/{project_id}/msgsms/apps

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，参考“获取帐号、用户、项目的名称和ID”
表2 Query参数

参数

是否必选

参数类型

描述

app_name

否

String

应用名称

end_time

否

String

结束时间

limit

否

Integer

数量，默认值10

offset

否

Integer

偏移量

region

否

String

地域

  • cn：国内
  • intl：国际

sort_dir

否

String

排序方式

  • desc：降序
  • asc：升序

sort_key

否

String

排序字段，仅支持create_time

start_time

否

String

开始时间

status

否

String

状态

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

请求体参数类型，该字段必须设置为：application/json

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

results

Array of SmsAppQueryResp

查询结果

total

Long

总数
表5 响应SmsAppQueryResp参数

参数

是否必选

参数类型

描述

id

否

String

应用主键ID，用于获取、修改应用的唯一标识

create_time

否

String

创建时间

update_time

否

String

更新时间

customer_id

否

String

租户customer id

resource_id

否

String

租户resource id

developer_account

否

String

租户开发者账号

app_name

否

String

应用名称

omp_app_name

否

String

omp应用名称

app_key

否

String

应用key

up_link_addr

否

String

上行短信地址

status

否

String

应用状态

  • CREATED：待上线。应用暂未创建成功，请稍候。
  • SUSPENDED：暂停。无法发起业务请求。当客户所发短信内容触发业务违规，或客户申请退订短信业务时，运营经理会将客户短信应用暂停。
  • LAUNCHED：正常。应用添加成功，可以正常使用。

industry

否

Integer

行业类型

region

否

String

地域

1. cn：国内

2. intl：国际

enterprise_project_id

否

String

企业项目ID

enterprise_project_name

否

String

企业项目名称

ip_white_list

否

String

IP白名单

app_access_addr

否

String

接入地址

protocol

否

String

协议

platform

否

String

平台

is_support_multiomp

否

boolean

是否支持多OMP

tenant

否

TentantBasic

-
表6 TentantBasic

参数

是否必选

参数类型

描述

customer_id

否

String

租户customer id

customer_name

否

String

租户customer name

enterprise_name

否

String

租户企业名称

请求示例

查询短信应用，请求方式：GET，请求URI：/v2/{project_id}/msgsms/apps，返回短信应用数据列表，传入参数projectId，limit，offset，region。

GET /v2/845ada5bc7444f1295cd517af0123da1/msgsms/apps?app_name=auto_test789 
Host: 100.85.***.***:30300
Content-Type: application/json
X-Auth-Token:******

响应示例

{
    "results": [
        {
            "id": "9e61f59c-1a6b-4ee5-9651-5bca450694b3",
            "create_time": "2022-08-12 06:51:17",
            "update_time": "2022-08-12 06:51:17",
            "customer_id": "******c55c3c4526b2ed7a0213bc9871",
            "resource_id": "******8a-a690-4e14-a1c7-2430937336d0",
            "developer_account": "****66_sms",
            "app_name": "auto_test789",
            "app_key": "******3baZf4c856O4Qrbqvui3K2",
            "status": "LAUNCHED",
            "region": "cn",
            "intl_channel_num": "******886739",
            "enterprise_project_id": "0",
            "enterprise_project_name": "default",
            "app_access_addr": "https://100.**.***.**:8443",
            "protocol": "HTTP",
            "platform": "NFV",
            }
    ],
    "total": 1
}

返回值

返回值

描述

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

500

System error
父主题： 短信应用

相关文档