Logo Site EngageLab Mark Colored TransparentDocument
Search

Get Signature Configuration List

Get a list of all signature configurations under the current business, returning a list containing signature names, review status, number of associated templates, etc.

Request URL

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

Call Authentication

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

Request Example

Request Header

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

            
This code block in the floating window

Request Body

None

Request Parameters

None

Response Parameters

Success Response

The HTTP status code is 200, and the response body is an array of signature configurations:

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": 500, "message": "Internal server error" }
              
              {
  "code": 500,
  "message": "Internal server error"
}

            
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

Appendix

Signature Configuration Status (status)

Value Description
1 Pending Review
2 Approved
3 Rejected
Icon Solid Transparent White Qiyu
Contact Sales