Get Signature Configuration Details

Get detailed information about a signature configuration by signature ID, including signature name, review status, number of associated templates, etc.

Request URL

GET https://smsapi.engagelab.com/v1/sign-configs/:signId

Call Authentication

Please refer to Call Authentication to learn how to authenticate API requests.

Request Example

Request Header

GET /v1/sign-configs/987654321 HTTP/1.1 Content-Type: application/json Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

              
              GET /v1/sign-configs/987654321  HTTP/1.1
Content-Type: application/json
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

This code block in the floating window

Request Body

None

Request Parameters

Path Parameters

Parameter	Type	Option	Description
signId	String	Required	Signature ID

Response Parameters

Success Response

The HTTP status code is 200, and the response body is a signature configuration object:

Field	Type	Description
sign_id	String	Signature ID
sign_name	String	Signature name
status	Integer	Status: 1-Pending Review, 2-Approved, 3-Rejected
related_template_count	Integer	Number of associated templates
audit_remark	String	Review remarks
created_time	Integer	Creation time (Unix timestamp)
updated_time	Integer	Update time (Unix timestamp)

Success Example

{ "sign_id": "987654321", "sign_name": "Company Name", "status": 2, "related_template_count": 5, "audit_remark": "", "created_time": 1699000000, "updated_time": 1699000000 }

              
              {
  "sign_id": "987654321",
  "sign_name": "Company Name",
  "status": 2,
  "related_template_count": 5,
  "audit_remark": "",
  "created_time": 1699000000,
  "updated_time": 1699000000
}

This code block in the floating window

Error Response

The HTTP status code is 4xx/5xx, and the response body contains the following fields:

Field	Type	Description
code	Integer	Error code
message	String	Error details

Error Example

{ "code": 400, "message": "invalid signId" }

              
              {
  "code": 400,
  "message": "invalid signId"
}

This code block in the floating window

Error Codes

Error Code	HTTP Code	Description
400	400	Parameter error or business logic error
500	500	Internal server error

Common error messages:

invalid signId: Signature ID format error
sign config not exist: Signature configuration does not exist

Appendix

Signature Configuration Status (status)

Value	Description
1	Pending Review
2	Approved
3	Rejected