Modèle SMS

L'interface suivante permet d'ajouter, de modifier et de supprimer des modèles de SMS, ainsi que d'interroger, de soumettre et d'approuver des SMS et des modèles de SMS.

Requête

Informations détaillées du modèle SMS retourné

URL

https://sms.api.engagelab.cc/v1/templates/{template_id}

              
              https://sms.api.engagelab.cc/v1/templates/{template_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/templates/1235" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

              
              curl -X GET "https://sms.api.engagelab.cc/v1/templates/1235" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

Afficher ce bloc de code dans la fenêtre flottante

Description des valeurs de retour

Paramètre	Description
template_id	ID du modèle
template_name	Nom du modèle
msg_type	Type de SMS, 2 représente un SMS international
template_type	Type de contenu SMS, 0 pour code de vérification, 1 pour notification sectorielle, 2 pour marketing
approval_status	Statut de la révision, 0 en attente, 1 approuvé, -1 refusé, -2 non soumis
approval_message	Information de révision, uniquement si approval_status = -1
template_content	Contenu du modèle, jusqu'à 512 caractères
create_time	Date de création du modèle
update_time	Date de modification du modèle

Exemple de valeur retournée

Réponse-succès

HTTP Status: 200

{ "result": { "template_id": 123, "template_name": "test", "msg_type": 2, "template_type": 1, "template_content": "Cher %name%, votre montant de consommation sur la plateforme ce mois-ci est :***", "approval_status": 1, "approval_message": "", "create_time": "2015-03-23T14:27:48+0800", "update_time": "2017-03-29T14:27:48+0800" } }

              
              {
    "result": {
        "template_id": 123,
        "template_name": "test",
        "msg_type": 2,
        "template_type": 1,
        "template_content": "Cher %name%, votre montant de consommation sur la plateforme ce mois-ci est :***",
        "approval_status": 1,
        "approval_message": "",
        "create_time": "2015-03-23T14:27:48+0800",
        "update_time": "2017-03-29T14:27:48+0800"
    }
}

Afficher ce bloc de code dans la fenêtre flottante

Réponse-erreur

HTTP Status :400

{ "code": 33001, "message": "Le modèle n'existe pas" }

              
              {
    "code": 33001,
    "message": "Le modèle n'existe pas"
}

Afficher ce bloc de code dans la fenêtre flottante

Requête (Lot)

Informations de base du modèle SMS retourné

URL

https://sms.api.engagelab.cc/v1/templates

              
              https://sms.api.engagelab.cc/v1/templates

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 requête

Paramètre	Type	Obligatoire	Description
template_ids	string	non	ID du modèle, utilisé à plusieurs fins ; séparer
approval_status	string	non	Statut de la révision, 0 en attente, 1 approuvé, -1 refusé, -2 non soumis
template_name	string	non	Nom du modèle, correspondance floue
offset	int	non	Position de décalage, [0-], défaut 0
limit	int	non	Quantité, [0-100], défaut 100

Astuces :

Les utilisateurs peuvent spécifier un ID de modèle pour la requête. Si non spécifié, tous les modèles seront interrogés par défaut.

Exemple de requête

curl -X GET "https://sms.api.engagelab.cc/v1/templates?approval_status=1" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

              
              curl -X GET "https://sms.api.engagelab.cc/v1/templates?approval_status=1" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

Afficher ce bloc de code dans la fenêtre flottante

Description des valeurs de retour

Paramètre	Description
template_id	ID du modèle
template_name	Nom du modèle
msg_type	Type de SMS
template_type	Type de contenu SMS
approval_status	Statut de la révision
approval_message	Information de révision, uniquement si approval_status = -1
template_content	Contenu du modèle
sign_id	ID de la signature
create_time	Date de création du modèle
update_time	Date de modification du modèle

Exemple de valeur retournée

Réponse-succès

HTTP Status: 200

{ "result" : [{ "template_id" : 100, "template_name" : "tset", "msg_type" : 2, "template_type" : 1, "template_content" : "Cher %name%, votre montant de consommation sur la plateforme ce mois-ci est :***", "approval_status" : 1, "approval_message": "", "create_time" : "2016-08-25T14:27:48+0800", "update_time" : "2016-08-25T14:27:48+0800" } ], "count":1, "total" : 1 }

              
              {
    "result" :  [{
                "template_id" : 100,
                "template_name" : "tset",
                "msg_type" : 2,
                "template_type" : 1,
                "template_content" : "Cher %name%, votre montant de consommation sur la plateforme ce mois-ci est :***",
                "approval_status" : 1,
                "approval_message": "",
                "create_time" : "2016-08-25T14:27:48+0800",
                "update_time" : "2016-08-25T14:27:48+0800"
            }
        ],
        "count":1,
        "total" : 1
    }

Afficher ce bloc de code dans la fenêtre flottante

Réponse-erreur

HTTP Status: 400

{ "code": 30002, "message": "limite invalide" }

              
              {
  "code": 30002,
  "message": "limite invalide"
}

Afficher ce bloc de code dans la fenêtre flottante

Ajouter

Retourne les informations sur la réussite de l'ajout

URL

https://sms.api.engagelab.cc/v1/templates

              
              https://sms.api.engagelab.cc/v1/templates

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
template_name	string	oui	Nom du modèle, unique dans le compte, longueur max 64 caractères
template_content	string	oui	Le contenu ne doit pas contenir [],【】, test, 测试, max 512 caractères
template_type	string	oui	Type de contenu SMS, 0 pour code de vérification, 1 pour notification sectorielle, 2 pour marketing
msg_type	string	non	Type de SMS, 2 pour SMS international, défaut 2
sign_id	integer	non	ID de la signature
sign_pos	string	non	Position de la signature, 0 devant, 1 derrière, défaut 0
submit	bool	non	Soumettre directement pour révision, défaut à false

Exemple de requête

curl -X POST "https://sms.api.engagelab.cc/v1/templates" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{ "template_name": "test", "template_content": "Cher %name%, votre montant de consommation sur la plateforme ce mois-ci est :***", "sign_id": 1235, "template_type": "0" }'

              
              curl -X POST "https://sms.api.engagelab.cc/v1/templates"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{
    "template_name": "test",
    "template_content": "Cher %name%, votre montant de consommation sur la plateforme ce mois-ci est :***",
    "sign_id": 1235,
    "template_type": "0"
}'

Afficher ce bloc de code dans la fenêtre flottante

Description des valeurs de retour

Paramètre	Description
template_id	ID du modèle
template_name	Nom du modèle
msg_type	Type de SMS
template_type	Type de contenu SMS
approval_status	Statut de la révision
approval_message	Information de révision, uniquement si approval_status = -1
template_content	Contenu du modèle
sign_id	ID de la signature
create_time	Date de création du modèle
update_time	Date de modification du modèle

Exemple de valeur retournée

Réponse-succès

HTTP Status: 200

{ "result" : { "template_id" : 200, "template_name" : "bill", "msg_type" : 2, "template_type" : 1, "template_content" : "Cher %name%, votre montant de consommation sur la plateforme ce mois-ci est :***", "approval_status" : 1, "approval_message": "", "create_time" : "2022-08-25T14:35:48+0800", "update_time" : "2022-08-25T14:35:48+0800" } }

              
              {
    "result" : {
        "template_id" : 200,
        "template_name" : "bill",
        "msg_type" : 2,
        "template_type" : 1,
        "template_content" : "Cher %name%, votre montant de consommation sur la plateforme ce mois-ci est :***",
        "approval_status" : 1,
        "approval_message": "",
        "create_time" : "2022-08-25T14:35:48+0800",
        "update_time" : "2022-08-25T14:35:48+0800"
    }
}

Afficher ce bloc de code dans la fenêtre flottante

Réponse-erreur

HTTP Status: 400

{ "code": 33006, "message": "Le nom du modèle ne supporte que 64 caractères" }

              
              {
    "code": 33006,
    "message": "Le nom du modèle ne supporte que 64 caractères"
}

Afficher ce bloc de code dans la fenêtre flottante

Soumettre

Retourne les informations de base sur la réussite de la soumission

URL

https://sms.api.engagelab.cc/v1/templates/{template_id}/submit

              
              https://sms.api.engagelab.cc/v1/templates/{template_id}/submit

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)

Exemple de requête

curl -X POST "https://sms.api.engagelab.cc/v1/templates/3381/submit" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/x-www-form-urlencoded"

              
              curl -X POST "https://sms.api.engagelab.cc/v1/templates/3381/submit"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/x-www-form-urlencoded"

Afficher ce bloc de code dans la fenêtre flottante

Exemple de valeur retournée

Réponse-succès

HTTP Status: 200

{ }

Afficher ce bloc de code dans la fenêtre flottante

Modifier

Retourne les informations de base sur la réussite de la soumission

URL

https://sms.api.engagelab.cc/v1/templates/{template_id}

              
              https://sms.api.engagelab.cc/v1/templates/{template_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
template_name	string	non	Nom du modèle, unique dans le compte, longueur max 64 caractères
template_content	string	non	Le contenu ne doit pas contenir [],【】, test, 测试, max 512 caractères
sign_id	integer	non	ID de la signature
sign_pos	string	non	Position de la signature, 0 devant, 1 derrière, défaut 0
template_type	string	non	Type de contenu SMS, 0 pour code de vérification, 1 pour notification sectorielle, 2 pour marketing
submit	bool	non	Soumettre directement pour révision, défaut à false

Astuces :

Après avoir appelé cette interface, la mise à jour du template_name ne change pas le statut d'approbation du modèle, tandis que la modification d'autres paramètres entraîne un changement du statut d'approbation.

Exemple de requête

curl -X PUT "https://sms.api.engagelab.cc/v1/templates/3381" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{ "template_name": "test", "template_content": "Cher %name%, votre montant de consommation sur la plateforme ce mois-ci est :***", "sign_id": 132, "template_type": 0 }'

              
              curl -X PUT "https://sms.api.engagelab.cc/v1/templates/3381"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{
    "template_name": "test",
    "template_content": "Cher %name%, votre montant de consommation sur la plateforme ce mois-ci est :***",
    "sign_id": 132,
    "template_type": 0
    }'

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: 401

{ "code": 30000, "message": "Échec de l'authentification" }

              
              {
  "code": 30000,
  "message": "Échec de l'authentification"
}

Afficher ce bloc de code dans la fenêtre flottante

Supprimer

URL

https://sms.api.engagelab.cc/v1/templates/{template_id}

              
              https://sms.api.engagelab.cc/v1/templates/{template_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/templates/3381" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

              
              curl -X DELETE "https://sms.api.engagelab.cc/v1/templates/3381" 
--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