Create Signature Configuration

Create a new signature configuration (Sender ID) to display the sender identity in SMS messages. After creation, the signature status is "Pending Review" and must pass the review before it can be used.

Request URL

POST 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

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

            

Request Body

              
              {
  "sign_name": "Company Name"
}

            

Request Parameters

Response Parameters

Success Response

The HTTP status code is 200, and the response body contains the following fields:

Success Example

              
              {
  "sign_id": "987654321"
}

            

Error Response

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

Error Example

              
              {
  "code": 400,
  "message": "sign_name already exist"
}

            

Error Codes

Common error messages:

• sign_name already exist: Signature name already exists

Notes

1. After creation, the signature status is "Pending Review" (status=1) and must pass the review before use.
2. Signature names must not be duplicated under the same business.
3. Signature names cannot contain forbidden characters: 【, 】, [, ]
4. The signature ID is a string-type number.

Appendix

Signature Configuration Status (status)