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

获取应用详情

功能介绍

该接口用于用户查询应用详情信息。

调试

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

URI

GET /v2/{project_id}/msgsms/apps/{id}

表1 路径参数

参数

是否必选

参数类型

描述

id

是

String

应用主键ID，参考表5 响应SmsAppQueryResp参数中的id

project_id

是

String

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

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

X-Auth-Token

是

String

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

响应参数

状态码： 200

表3 响应Body参数

参数

是否必选

参数类型

描述

id

否

integer

应用主键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

地域

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

-

请求示例

获取应用详情，返回应用详情信息，请求方式：GET，请求URI：/v2/{project_id}/msgsms/apps/{id}，路径参数id，project_id；请求头参数：X-Auth-Token，Content-Type。

GET /v2/845ada5bc7444f1295cd517af0123da1/msgsms/apps/9e61f59c-1a6b-4ee5-9651-5bca450694b3 
Host: 100.85.***.***:30300
Content-Type: application/json
X-Auth-Token:******

响应示例

{
    "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",
    "protocol": "HTTP",
    "platform": "NFV",
}

返回值

返回值

描述

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

500

System error
父主题： 短信应用

相关文档