Help Center/Message & SMS/API Reference/APIs/Application and Template APIs/SMS Application APIs/Obtaining Application Details
Updated on 2023-08-30 GMT+08:00
View PDF

Obtaining Application Details

Function

This API is used to query application details.

URI

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

Table 1 URI parameters

Parameter

Mandatory

Type

Description

id

Yes

String

Primary key ID of the application. For details, see id in Table 5.

project_id

Yes

String

Project ID. For details, see Obtaining Account, User, and Project Information.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Request body parameter type. This parameter must be set to application/json.

X-Auth-Token

Yes

String

User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Description

id

Primary key ID of the application.

create_time

Creation time.

update_time

Update time.

customer_id

Customer ID.

resource_id

Resource ID.

developer_account

Developer account.

app_name

Application name.

app_key

Application key.

status

Application status.

  • CREATED: pending (to be brought online). The application has not been created. Wait for a while.
  • SUSPENDED: suspended. Service requests cannot be initiated. If the SMS content sent violates service rules or you apply to unsubscribe from the Message & SMS service, the operation manager will suspend your SMS application.
  • LAUNCHED: normal. The application is added and can be used properly.

region

Region.

intl_channel_num

European SMS channel number.

enterprise_project_id

Enterprise project ID.

enterprise_project_name

Enterprise project name.

app_access_addr

Access address.

protocol

Protocol.

platform

Platform.

Request Example

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

Response Example

{
    "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",
    "tenant": {
        "customer_id": "******c55c3c4526b2ed7a0213bc9871",
        "customer_name": "****05",
        "enterprise_name": "Huawei Technologies Co., Ltd."
    },
    "resource_id": "******8a-a690-4e14-a1c7-2430937336d0",
    "developer_account": "****66_sms",
    "app_name": "auto_test789",
    "omp_app_name": "******4877bf46b5906a3240636bc7aa",
    "app_key": "******3baZf4c856O4Qrbqvui3K2",
    "status": "LAUNCHED",
    "industry": 14,
    "region": "intl",
    "intl_channel_num": "******886739",
    "enterprise_project_id": "0",
    "enterprise_project_name": "default",
    "protocol": "HTTP",
    "platform": "NFV",
    "is_support_multiomp": false
}

Returned Values

Status Code

Description

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

500

System error