Get Template Configuration Details

Get detailed information about a template configuration by template ID, including template name, type, content, review status, etc.

Request URL

GET https://smsapi.engagelab.com/v1/template-configs/:templateId

Call Authentication

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

Request Example

Request Header

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

              
              GET /v1/template-configs/123456789  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
templateId	String	Required	Template ID

Response Parameters

Success Response

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

Field	Type	Description
template_id	String	Template ID
template_name	String	Template name
template_type	String	Template type: `utility` (notification), `marketing` (marketing)
template_content	String	Template content
country_codes	String	Main destination country codes, comma-separated
status	Integer	Status: 1-Pending Review, 2-Approved, 3-Rejected
sign_id	String	Signature ID (optional)
sign_name	String	Signature name (optional)
sign_position	Integer	Signature position: 0-none, 1-prefix, 2-suffix (optional)
sign_status	Integer	Signature status (optional)
audit_remark	String	Review remarks
created_time	Integer	Creation time (Unix timestamp)
updated_time	Integer	Update time (Unix timestamp)

Success Example

{ "template_id": "123456789", "template_name": "Order Notification Template", "template_type": "utility", "template_content": "Your order {order_no} has been shipped and is expected to be delivered by {delivery_time}", "country_codes": "CN,US", "status": 2, "sign_id": "987654321", "sign_name": "Company Name", "sign_position": 2, "sign_status": 2, "audit_remark": "", "created_time": 1699000000, "updated_time": 1699000000 }

              
              {
  "template_id": "123456789",
  "template_name": "Order Notification Template",
  "template_type": "utility",
  "template_content": "Your order {order_no} has been shipped and is expected to be delivered by {delivery_time}",
  "country_codes": "CN,US",
  "status": 2,
  "sign_id": "987654321",
  "sign_name": "Company Name",
  "sign_position": 2,
  "sign_status": 2,
  "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 templateId" }

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

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 templateId: Template ID format error
template config not exist: Template configuration does not exist

Appendix

Template Configuration Status (status)

Value	Description
1	Pending Review
2	Approved
3	Rejected

Template Type (template_type)

Value	Description
utility	Notification
marketing	Marketing