Étiquette SMS
Vous pouvez interroger, ajouter, modifier et supprimer des étiquettes SMS via l'interface suivante.
Interroger
Retourne les informations de base des étiquettes SMS.
URL
https://sms.api.engagelab.cc/v1/labels/{label_id}
https://sms.api.engagelab.cc/v1/labels/{label_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/labels/598802"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X GET "https://sms.api.engagelab.cc/v1/labels/598802"
--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 |
|---|---|
| label_id | ID de l'étiquette |
| label_name | nom de l'étiquette |
| create_time | date de création de l'étiquette |
| update_time | date de modification de l'étiquette |
Exemple de valeur retournée
Réponse-succès
Statut HTTP : 200
{
"result":
{
"label_id": 598802,
"label_name": "xjm226",
"create_time": "2022-11-14T14:27:48+0800",
"update_time": "2022-11-14T14:27:48+0800"
}
}
{
"result":
{
"label_id": 598802,
"label_name": "xjm226",
"create_time": "2022-11-14T14:27:48+0800",
"update_time": "2022-11-14T14:27:48+0800"
}
}
Afficher ce bloc de code dans la fenêtre flottante
Réponse-erreur
Statut HTTP : 400
{
"code": 34020,
"message": "label_id must be a integer"
}
{
"code": 34020,
"message": "label_id must be a integer"
}
Afficher ce bloc de code dans la fenêtre flottante
Interroger (Lot)
Liste des étiquettes retournées
URL
https://sms.api.engagelab.cc/v1/labels
https://sms.api.engagelab.cc/v1/labels
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 de la requête
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| offset | Integer | non | position de l'offset, [0-], par défaut 0 |
| limit | Integer | non | quantité, [0-100], par défaut 100 |
| label_name | string | non | recherche floue |
Exemple de requête
curl -X GET "https://sms.api.engagelab.cc/v1/labels?label_name=test"
--header "Authorization: Basic <<YOUR_AUTHORIZATION_KEY>>"
curl -X GET "https://sms.api.engagelab.cc/v1/labels?label_name=test"
--header "Authorization: Basic <<YOUR_AUTHORIZATION_KEY>>"
Afficher ce bloc de code dans la fenêtre flottante
Description des valeurs retournées
| Paramètre | Description |
|---|---|
| label_id | ID de l'étiquette |
| label_name | nom de l'étiquette |
| create_time | date de création de l'étiquette |
| update_time | date de modification de l'étiquette |
Exemple de valeur retournée
Réponse-succès
Statut HTTP : 200
{
"result": [
{
"create_time": "2022-11-14T14:27:48+0800",
"label_id": 10,
"label_name": "test",
"update_time": "2022-11-14T14:27:48+0800"
}
],
"total": 28,
"count": 1
}
{
"result": [
{
"create_time": "2022-11-14T14:27:48+0800",
"label_id": 10,
"label_name": "test",
"update_time": "2022-11-14T14:27:48+0800"
}
],
"total": 28,
"count": 1
}
Afficher ce bloc de code dans la fenêtre flottante
Réponse-erreur
Statut HTTP : 401
{
"code": 30000,
"message": "Unauthorized."
}
{
"code": 30000,
"message": "Unauthorized."
}
Afficher ce bloc de code dans la fenêtre flottante
Ajouter
Retourne les informations de base de l'étiquette SMS après ajout réussi.
URL
https://sms.api.engagelab.cc/v1/labels
https://sms.api.engagelab.cc/v1/labels
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 |
|---|---|---|---|
| label_name | string | oui | nom de l'étiquette à ajouter. Maximum 64 caractères. |
Astuces
- La limite supérieure de création d'étiquettes est de 100000
Exemple de requête
curl -X POST "https://sms.api.engagelab.cc/v1/labels"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"label_name": "test2"
}'
curl -X POST "https://sms.api.engagelab.cc/v1/labels"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"label_name": "test2"
}'
Afficher ce bloc de code dans la fenêtre flottante
Description des valeurs retournées
| Paramètre | Description |
|---|---|
| label_id | ID de l'étiquette |
| label_name | nom de l'étiquette |
| create_time | date de création de l'étiquette |
| update_time | date de modification de l'étiquette |
Exemple de valeur retournée
Réponse-succès
Statut HTTP : 200
{
"result": {
"label_id": 11,
"label_name": "test",
"create_time": "2022-11-14T14:27:48+0800",
"update_time": "2022-11-14T14:27:48+0800"
}
}
{
"result": {
"label_id": 11,
"label_name": "test",
"create_time": "2022-11-14T14:27:48+0800",
"update_time": "2022-11-14T14:27:48+0800"
}
}
Afficher ce bloc de code dans la fenêtre flottante
Réponse-erreur
Statut HTTP : 401
{
"code": 30000,
"message": "Unauthorized."
}
{
"code": 30000,
"message": "Unauthorized."
}
Afficher ce bloc de code dans la fenêtre flottante
Modifier
URL
https://sms.api.engagelab.cc/v1/labels/{label_id}
https://sms.api.engagelab.cc/v1/labels/{label_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 |
|---|---|---|---|
| label_name | string | oui | nouveau nom de l'étiquette. Maximum 64 caractères. |
Exemple de requête
curl -X PUT "https://sms.api.engagelab.cc/v1/labels/11"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"label_name": "test3"
}'
curl -X PUT "https://sms.api.engagelab.cc/v1/labels/11"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"label_name": "test3"
}'
Afficher ce bloc de code dans la fenêtre flottante
Description des valeurs retournées
| Paramètre | Description |
|---|---|
| count | nombre d'étiquettes modifiées |
Exemple de valeur retournée
Réponse-succès
Statut HTTP : 200
{
"count":1
}
{
"count":1
}
Afficher ce bloc de code dans la fenêtre flottante
Réponse-erreur
Statut HTTP : 401
{
"code": 30000,
"message": "Unauthorized."
}
{
"code": 30000,
"message": "Unauthorized."
}
Afficher ce bloc de code dans la fenêtre flottante
Supprimer
URL
https://sms.api.engagelab.cc/v1/labels/{label_id}
https://sms.api.engagelab.cc/v1/labels/{label_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://sms.api.engagelab.cc/v1/labels/11"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X DELETE "https://sms.api.engagelab.cc/v1/labels/11"
--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 |
|---|---|
| count | nombre d'étiquettes supprimées |
Exemple de valeur retournée
Réponse-succès
Statut HTTP : 200
{
"count": 1
}
{
"count": 1
}
Afficher ce bloc de code dans la fenêtre flottante
Réponse-erreur
Statut HTTP : 401
{
"code": 30000,
"message": "Unauthorized."
}
{
"code": 30000,
"message": "Unauthorized."
}
Afficher ce bloc de code dans la fenêtre flottante
