AppPush
WebPush
WhatsApp
Email
SMS
OTP
SMS Sign
Last updated：2023-04-10
You can query, add, and update SMS signatures through the following interface.
Query
Return basic information of SMS signature
URL
https://sms.api.engagelab.cc/v1/signs/{sign_id}
https://sms.api.engagelab.cc/v1/signs/{sign_id}
This code block in the floating window
HTTP Request Method
GET
GET
This code block in the floating window
Request-Headers
| Header | Type | Required | Description |
|---|---|---|---|
| Authorization | string | true | Basic base64(sms_user:sms_key) |
Request Example
curl -X GET "https://sms.api.engagelab.cc/v1/signs/10"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X GET "https://sms.api.engagelab.cc/v1/signs/10"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
This code block in the floating window
Return Value Description
| Parameter | Description |
|---|---|
| sign_id | ID of sign |
| sign_name | name of sign |
| create_time | time of sign creation |
| update_time | time of sign modification |
Returned Value Example
Response-success
HTTP Status: 200
{
"result": {
"sign_id": 10,
"sign_name": "shanshan",
"create_time": "2021-04-10T10:44:37+0800",
"update_time": "2022-06-14T19:20:35+0800"
}
}
{
"result": {
"sign_id": 10,
"sign_name": "shanshan",
"create_time": "2021-04-10T10:44:37+0800",
"update_time": "2022-06-14T19:20:35+0800"
}
}
This code block in the floating window
Response-error
HTTP Status :400
{
"code": 34010,
"message": "sign not exists"
}
{
"code": 34010,
"message": "sign not exists"
}
This code block in the floating window
Query (Batch)
URL
https://sms.api.engagelab.cc/v1/signs
https://sms.api.engagelab.cc/v1/signs
This code block in the floating window
HTTP Request Method
GET
GET
This code block in the floating window
Request-Headers
| Header | Type | Required | Description |
|---|---|---|---|
| Authorization | string | true | Basic base64(sms_user:sms_key) |
Parameter Description
| Parameter | Type | Required | Description |
|---|---|---|---|
| sign_name | string | true | sign name, supports fuzzy queries |
Request Example
curl -X GET "https://sms.api.engagelab.cc/v1/signs"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X GET "https://sms.api.engagelab.cc/v1/signs"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
This code block in the floating window
Return Value Description
| Parameter | Description |
|---|---|
| sign_id | ID of sign |
| sign_name | name of sign |
| create_time | time of sign creation |
| update_time | time of sign modification |
Returned Value Example
Response-success
HTTP Status: 200
{
"result": [{
"sign_id": 1427,
"sign_name": "shanshan",
"create_time": "2015-04-10T10:44:37+0800",
"update_time": "2016-06-14T19:20:35+0800"
}
],
"count":1,
"total":1
}
{
"result": [{
"sign_id": 1427,
"sign_name": "shanshan",
"create_time": "2015-04-10T10:44:37+0800",
"update_time": "2016-06-14T19:20:35+0800"
}
],
"count":1,
"total":1
}
This code block in the floating window
Response-error
HTTP Status: 401
{
"code": 30000,
"message": "Authentication failed"
}
{
"code": 30000,
"message": "Authentication failed"
}
This code block in the floating window
Add
Return the basic information of SMS signature after successful addition
URL
https://sms.api.engagelab.cc/v1/signs
https://sms.api.engagelab.cc/v1/signs
This code block in the floating window
HTTP Request Method
POST
POST
This code block in the floating window
Content-type
application/json
application/json
This code block in the floating window
Request-Headers
| Header | Type | Required | Description |
|---|---|---|---|
| Authorization | String | true | Basic base64(sms_user:sms_key) |
Parameter Description
| Parameter | Type | Required | Description |
|---|---|---|---|
| sign_name | string | yes | Sign name, with a length of 2-60 characters and cannot contain symbols []、【】 |
Tips：
1.Signature creation is limited to 100 online entries.
Request Example
curl -X POST "https://sms.api.engagelab.cc/v1/signs"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"sign_name": "ccc"
}'
curl -X POST "https://sms.api.engagelab.cc/v1/signs"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"sign_name": "ccc"
}'
This code block in the floating window
Return Value Description
| Parameter | Description |
|---|---|
| sign_id | ID of sign |
| sign_name | name of sign |
| create_time | time of sign creation |
| update_time | time of sign modification |
Returned Value Example
Response-success
HTTP Status: 200
{
"result": {
"sign_id": 1529,
"sign_name": "ccc",
"create_time": "2015-04-10T10:44:37+0800",
"update_time": "2016-06-14T19:20:35+0800"
}
}
{
"result": {
"sign_id": 1529,
"sign_name": "ccc",
"create_time": "2015-04-10T10:44:37+0800",
"update_time": "2016-06-14T19:20:35+0800"
}
}
This code block in the floating window
Response-error
HTTP Status: 400
{
"code": 34005,
"message": "Invalid sign_name"
}
{
"code": 34005,
"message": "Invalid sign_name"
}
This code block in the floating window
Modify
Return the basic information of SMS signature after successful update
URL
https://sms.api.engagelab.cc/v1/signs/{sign_id}
https://sms.api.engagelab.cc/v1/signs/{sign_id}
This code block in the floating window
HTTP Request Method
PUT
PUT
This code block in the floating window
Content-type
application/json
application/json
This code block in the floating window
Request-Headers
| Header | Type | Required | Description |
|---|---|---|---|
| Authorization | String | true | Basic base64(sms_user:sms_key) |
Parameter Description
| Parameter | Type | Required | Description |
|---|---|---|---|
| sign_name | string | yes | Sign name, with a length of 2-60 characters and cannot contain symbols []、【】 |
Request Example
curl -X PUT "https://api.sendcloud.net/v1/signs/11617"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"sign_name": "ccc"
}'
curl -X PUT "https://api.sendcloud.net/v1/signs/11617"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"sign_name": "ccc"
}'
This code block in the floating window
Returned Value Example
Response-success
HTTP Status: 200
{
"count": 1
}
{
"count": 1
}
This code block in the floating window
Response-error
HTTP Status: 400
{
"code": 34005,
"message": "Invalid sign_name"
}
{
"code": 34005,
"message": "Invalid sign_name"
}
This code block in the floating window
Delete
Return basic information on whether the deletion was successful
URL
https://sms.api.engagelab.cc/v1/signs/{sign_id}
https://sms.api.engagelab.cc/v1/signs/{sign_id}
This code block in the floating window
HTTP Request Method
DELETE
DELETE
This code block in the floating window
Request-Headers
| Header | Type | Required | Description |
|---|---|---|---|
| Authorization | string | true | Basic base64(sms_user:sms_key) |
Request Example
curl -X DELETE "https://api.sendcloud.net/v1/signs/11617"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X DELETE "https://api.sendcloud.net/v1/signs/11617"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
This code block in the floating window
Returned Value Example
Response-success
HTTP Status: 200
{
"count": 1
}
{
"count": 1
}
This code block in the floating window
