Firma de SMS
Se pueden consultar, añadir y actualizar firmas de SMS mediante la siguiente interfaz.
Consulta
Devuelve la información básica de la firma de SMS
URL
https://sms.api.engagelab.cc/v1/signs/{sign_id}
https://sms.api.engagelab.cc/v1/signs/{sign_id}
Este bloque de código se muestra en una ventana flotante
Método de solicitud HTTP
GET
GET
Este bloque de código se muestra en una ventana flotante
Encabezados de la solicitud
| Encabezado | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| Authorization | string | true | Basic base64(sms_user:sms_key) |
Ejemplo de solicitud
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>>"
Este bloque de código se muestra en una ventana flotante
Descripción del valor devuelto
| Parámetro | Descripción |
|---|---|
| sign_id | ID de la firma |
| sign_name | Nombre de la firma |
| create_time | Hora de creación de la firma |
| update_time | Hora de modificación de la firma |
Ejemplo de valor devuelto
Respuesta: Éxito
Estado HTTP: 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"
}
}
Este bloque de código se muestra en una ventana flotante
Respuesta: Error
Estado HTTP: 400
{
"code": 34010,
"message": "sign not exists"
}
{
"code": 34010,
"message": "sign not exists"
}
Este bloque de código se muestra en una ventana flotante
Consulta (por lotes)
URL
https://sms.api.engagelab.cc/v1/signs
https://sms.api.engagelab.cc/v1/signs
Este bloque de código se muestra en una ventana flotante
Método de solicitud HTTP
GET
GET
Este bloque de código se muestra en una ventana flotante
Encabezados de la solicitud
| Encabezado | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| Authorization | string | true | Basic base64(sms_user:sms_key) |
Descripción de parámetros
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| sign_name | string | true | Nombre de la firma; admite consultas difusas |
Ejemplo de solicitud
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>>"
Este bloque de código se muestra en una ventana flotante
Descripción del valor devuelto
| Parámetro | Descripción |
|---|---|
| sign_id | ID de la firma |
| sign_name | Nombre de la firma |
| create_time | Hora de creación de la firma |
| update_time | Hora de modificación de la firma |
Ejemplo de valor devuelto
Respuesta: Éxito
Estado HTTP: 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
}
Este bloque de código se muestra en una ventana flotante
Respuesta: Error
Estado HTTP: 401
{
"code": 30000,
"message": "Authentication failed"
}
{
"code": 30000,
"message": "Authentication failed"
}
Este bloque de código se muestra en una ventana flotante
Añadir
Devuelve la información básica de la firma de SMS tras añadirse correctamente
URL
https://sms.api.engagelab.cc/v1/signs
https://sms.api.engagelab.cc/v1/signs
Este bloque de código se muestra en una ventana flotante
Método de solicitud HTTP
POST
POST
Este bloque de código se muestra en una ventana flotante
Content-type
application/json
application/json
Este bloque de código se muestra en una ventana flotante
Encabezados de la solicitud
| Encabezado | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| Authorization | String | true | Basic base64(sms_user:sms_key) |
Descripción de parámetros
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| sign_name | string | Sí | Nombre de la firma, con una longitud de 2 a 60 caracteres y no puede contener los símbolos []、【】 |
Nota:
- La creación de firmas está limitada a 100 entradas en línea.
Ejemplo de solicitud
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"
}'
Este bloque de código se muestra en una ventana flotante
Descripción del valor devuelto
| Parámetro | Descripción |
|---|---|
| sign_id | ID de la firma |
| sign_name | Nombre de la firma |
| create_time | Hora de creación de la firma |
| update_time | Hora de modificación de la firma |
Ejemplo de valor devuelto
Respuesta: Éxito
Estado HTTP: 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"
}
}
Este bloque de código se muestra en una ventana flotante
Respuesta: Error
Estado HTTP: 400
{
"code": 34005,
"message": "Invalid sign_name"
}
{
"code": 34005,
"message": "Invalid sign_name"
}
Este bloque de código se muestra en una ventana flotante
Modificar
Devuelve la información básica de la firma de SMS tras actualizarse correctamente
URL
https://sms.api.engagelab.cc/v1/signs/{sign_id}
https://sms.api.engagelab.cc/v1/signs/{sign_id}
Este bloque de código se muestra en una ventana flotante
Método de solicitud HTTP
PUT
PUT
Este bloque de código se muestra en una ventana flotante
Content-type
application/json
application/json
Este bloque de código se muestra en una ventana flotante
Encabezados de la solicitud
| Encabezado | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| Authorization | String | true | Basic base64(sms_user:sms_key) |
Descripción de parámetros
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| sign_name | string | Sí | Nombre de la firma, con una longitud de 2 a 60 caracteres y no puede contener los símbolos []、【】 |
Ejemplo de solicitud
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"
}'
Este bloque de código se muestra en una ventana flotante
Ejemplo de valor devuelto
Respuesta: Éxito
Estado HTTP: 200
{
"count": 1
}
{
"count": 1
}
Este bloque de código se muestra en una ventana flotante
Respuesta: Error
Estado HTTP: 400
{
"code": 34005,
"message": "Invalid sign_name"
}
{
"code": 34005,
"message": "Invalid sign_name"
}
Este bloque de código se muestra en una ventana flotante
Eliminar
Devuelve información básica sobre si la eliminación se realizó correctamente
URL
https://sms.api.engagelab.cc/v1/signs/{sign_id}
https://sms.api.engagelab.cc/v1/signs/{sign_id}
Este bloque de código se muestra en una ventana flotante
Método de solicitud HTTP
DELETE
DELETE
Este bloque de código se muestra en una ventana flotante
Encabezados de la solicitud
| Encabezado | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| Authorization | string | true | Basic base64(sms_user:sms_key) |
Ejemplo de solicitud
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>>"
Este bloque de código se muestra en una ventana flotante
Ejemplo de valor devuelto
Respuesta: Éxito
Estado HTTP: 200
{
"count": 1
}
{
"count": 1
}
Este bloque de código se muestra en una ventana flotante
