Signature SMS
Vous pouvez interroger, ajouter et mettre à jour des signatures SMS via l'interface suivante.
Interroger
Retourne les informations de base de la signature SMS
URL
https://sms.api.engagelab.cc/v1/signs/{sign_id}
https://sms.api.engagelab.cc/v1/signs/{sign_id}
Afficher ce bloc de code dans la fenêtre flottante
Méthode de requête HTTP
GET
GET
Afficher ce bloc de code dans la fenêtre flottante
En-têtes de la requête
| En-tête | Type | Obligatoire | Description |
|---|---|---|---|
| Authorization | string | oui | Basic base64(sms_user:sms_key) |
Exemple de requête
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>>"
Afficher ce bloc de code dans la fenêtre flottante
Description des valeurs retournées
| Paramètre | Description |
|---|---|
| sign_id | ID de la signature |
| sign_name | nom de la signature |
| create_time | date de création de la signature |
| update_time | date de modification de la signature |
Exemple de valeur retournée
Réponse-succès
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"
}
}
Afficher ce bloc de code dans la fenêtre flottante
Réponse-erreur
HTTP Status :400
{
"code": 34010,
"message": "sign not exists"
}
{
"code": 34010,
"message": "sign not exists"
}
Afficher ce bloc de code dans la fenêtre flottante
Interroger (Lot)
URL
https://sms.api.engagelab.cc/v1/signs
https://sms.api.engagelab.cc/v1/signs
Afficher ce bloc de code dans la fenêtre flottante
Méthode de requête HTTP
GET
GET
Afficher ce bloc de code dans la fenêtre flottante
En-têtes de la requête
| En-tête | Type | Obligatoire | Description |
|---|---|---|---|
| Authorization | string | oui | Basic base64(sms_user:sms_key) |
Description des paramètres
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| sign_name | string | oui | nom de la signature, prend en charge les recherches floues |
Exemple de requête
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>>"
Afficher ce bloc de code dans la fenêtre flottante
Description des valeurs retournées
| Paramètre | Description |
|---|---|
| sign_id | ID de la signature |
| sign_name | nom de la signature |
| create_time | date de création de la signature |
| update_time | date de modification de la signature |
Exemple de valeur retournée
Réponse-succès
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
}
Afficher ce bloc de code dans la fenêtre flottante
Réponse-erreur
HTTP Status: 401
{
"code": 30000,
"message": "Authentication failed"
}
{
"code": 30000,
"message": "Authentication failed"
}
Afficher ce bloc de code dans la fenêtre flottante
Ajouter
Retourne les informations de base de la signature SMS après ajout réussi
URL
https://sms.api.engagelab.cc/v1/signs
https://sms.api.engagelab.cc/v1/signs
Afficher ce bloc de code dans la fenêtre flottante
Méthode de requête HTTP
POST
POST
Afficher ce bloc de code dans la fenêtre flottante
Content-type
application/json
application/json
Afficher ce bloc de code dans la fenêtre flottante
En-têtes de la requête
| En-tête | Type | Obligatoire | Description |
|---|---|---|---|
| Authorization | string | oui | Basic base64(sms_user:sms_key) |
Description des paramètres
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| sign_name | string | oui | Nom de la signature, longueur de 2 à 60 caractères, sans symboles []、【】 |
Astuces :
- La création de signatures est limitée à 100 entrées en ligne.
Exemple de requête
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"
}'
Afficher ce bloc de code dans la fenêtre flottante
Description des valeurs retournées
| Paramètre | Description |
|---|---|
| sign_id | ID de la signature |
| sign_name | nom de la signature |
| create_time | date de création de la signature |
| update_time | date de modification de la signature |
Exemple de valeur retournée
Réponse-succès
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"
}
}
Afficher ce bloc de code dans la fenêtre flottante
Réponse-erreur
HTTP Status: 400
{
"code": 34005,
"message": "Invalid sign_name"
}
{
"code": 34005,
"message": "Invalid sign_name"
}
Afficher ce bloc de code dans la fenêtre flottante
Modifier
Retourne les informations de base de la signature SMS après mise à jour réussie
URL
https://sms.api.engagelab.cc/v1/signs/{sign_id}
https://sms.api.engagelab.cc/v1/signs/{sign_id}
Afficher ce bloc de code dans la fenêtre flottante
Méthode de requête HTTP
PUT
PUT
Afficher ce bloc de code dans la fenêtre flottante
Content-type
application/json
application/json
Afficher ce bloc de code dans la fenêtre flottante
En-têtes de la requête
| En-tête | Type | Obligatoire | Description |
|---|---|---|---|
| Authorization | string | oui | Basic base64(sms_user:sms_key) |
Description des paramètres
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| sign_name | string | oui | Nom de la signature, longueur de 2 à 60 caractères, sans symboles []、【】 |
Exemple de requête
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"
}'
Afficher ce bloc de code dans la fenêtre flottante
Exemple de valeur retournée
Réponse-succès
HTTP Status: 200
{
"count": 1
}
{
"count": 1
}
Afficher ce bloc de code dans la fenêtre flottante
Réponse-erreur
HTTP Status: 400
{
"code": 34005,
"message": "Invalid sign_name"
}
{
"code": 34005,
"message": "Invalid sign_name"
}
Afficher ce bloc de code dans la fenêtre flottante
Supprimer
Retourne les informations de base sur la réussite de la suppression
URL
https://sms.api.engagelab.cc/v1/signs/{sign_id}
https://sms.api.engagelab.cc/v1/signs/{sign_id}
Afficher ce bloc de code dans la fenêtre flottante
Méthode de requête HTTP
DELETE
DELETE
Afficher ce bloc de code dans la fenêtre flottante
En-têtes de la requête
| En-tête | Type | Obligatoire | Description |
|---|---|---|---|
| Authorization | string | oui | Basic base64(sms_user:sms_key) |
Exemple de requête
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>>"
Afficher ce bloc de code dans la fenêtre flottante
Exemple de valeur retournée
Réponse-succès
HTTP Status: 200
{
"count": 1
}
{
"count": 1
}
Afficher ce bloc de code dans la fenêtre flottante
