logoDocumentation
Accueil de la Documentation
Rechercher
Français
English
繁體中文
简体中文
日本語
ภาษาไทย
Español
Indonesian
Deutsch
Français
Connexion

SMSHook

Dernière Mise à jour：almost 3 years ago

Callback de statut SMS

URL

Définie par l'utilisateur sur la page
              
              Définie par l'utilisateur sur la page
Afficher ce bloc de code dans la fenêtre flottante

Content-Type :

application/json; charset=utf-8
              
              application/json; charset=utf-8
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

En-têtes de la requête

En-tête Type Description
X-SMSHook-Signature string signature
X-SMSHook-Timestamp long horodatage de génération du message
X-SMSHook-AppKey string application
X-SMSHook-Version string version

Corps de la requête

Paramètre Type Description
message_id string identifiant du message
from string expéditeur (vide dans le message template_approval)
to string destinataire (vide dans target, sent et template_approval)
server string SMS
itime long horodatage de génération du message
custom_args json champs définis par le client
status json callback de statut du message

Message de statut cible SMS

status

Paramètre Type Description
message_status string target
status_data json object données de statut
message string demande réussie
template_id int ID du modèle SMS
template_type int type de contenu SMS
label_id int ID de l'étiquette SMS
user_id int ID de l'utilisateur
sms_user string SMS_USER
sms_ids array tableau d'ID SMS destinataires
to array tableau de destinataires
msg_type int type de SMS
{ "server": "sms", "message_id": "1679392394031_15_17153_881599_c1fjwa", "itime": 1679392394061, "status": { "message_status": "target", "status_data": { "user_id": 15, "to": [ "+8618871186627", "008615727024341" ], "msg_type": 2, "template_id": 881599, "message": "demande réussie", "sms_user": "xiaojinmintest", "sms_ids": [ "1679392394031_15_17153_881599_c1fjwa$+8618871186627", "1679392394031_15_17153_881599_c1fjwa$008615727024341" ], "template_type": 2, "label_id": 0 } } }
              
              {
    "server": "sms", 
    "message_id": "1679392394031_15_17153_881599_c1fjwa", 
    "itime": 1679392394061, 
    "status": {
        "message_status": "target", 
        "status_data": {
            "user_id": 15, 
            "to": [
                "+8618871186627", 
                "008615727024341"
            ], 
            "msg_type": 2, 
            "template_id": 881599, 
            "message": "demande réussie", 
            "sms_user": "xiaojinmintest", 
            "sms_ids": [
                "1679392394031_15_17153_881599_c1fjwa$+8618871186627", 
                "1679392394031_15_17153_881599_c1fjwa$008615727024341"
            ], 
            "template_type": 2, 
            "label_id": 0
        }
    }
}
Afficher ce bloc de code dans la fenêtre flottante

Message de statut envoyé SMS

status

Paramètre Type Description
message_status string sent
status_data json object données de statut
message string envoyé avec succès
template_id int ID du modèle SMS
template_type int type de contenu SMS
label_id int ID de l'étiquette SMS
user_id int ID de l'utilisateur
sms_user string SMS_USER
sms_ids array tableau d'ID SMS destinataires
to array tableau de destinataires
msg_type int type de SMS
{ "server": "sms", "message_id": "1679392394031_15_17153_881599_c1fjwa", "itime": 1679392394061, "status": { "message_status": "sent", "status_data": { "user_id": 15, "to": [ "+8618871186627", "008615727024341" ], "msg_type": 2, "template_id": 881599, "message": "envoyé avec succès", "sms_user": "xiaojinmintest", "sms_ids": [ "1679392394031_15_17153_881599_c1fjwa$+8618871186627", "1679392394031_15_17153_881599_c1fjwa$008615727024341" ], "template_type": 2, "label_id": 0 } } }
              
              {
    "server": "sms", 
    "message_id": "1679392394031_15_17153_881599_c1fjwa", 
    "itime": 1679392394061, 
    "status": {
        "message_status": "sent", 
        "status_data": {
            "user_id": 15, 
            "to": [
                "+8618871186627", 
                "008615727024341"
            ], 
            "msg_type": 2, 
            "template_id": 881599, 
            "message": "envoyé avec succès", 
            "sms_user": "xiaojinmintest", 
            "sms_ids": [
                "1679392394031_15_17153_881599_c1fjwa$+8618871186627", 
                "1679392394031_15_17153_881599_c1fjwa$008615727024341"
            ], 
            "template_type": 2, 
            "label_id": 0
        }
    }
}
Afficher ce bloc de code dans la fenêtre flottante

Message de statut délivré SMS

status

Paramètre Type Description
message_status string delivered
status_data json object données de statut
message string délivré avec succès
template_id int ID du modèle SMS
template_type int type de contenu SMS
label_id int ID de l'étiquette SMS
user_id int ID de l'utilisateur
sms_user string SMS_USER
sms_id string ID du SMS
msg_count int nombre de messages SMS
msg_type int type de SMS
outbound_time string heure de demande canal
receipt_time string heure de réception
{ "server": "sms", "message_id": "1679387065399_15_17155_881597_0poco8$+115927992951", "to": "+115927992951", "itime": 1679388949000, "status": { "message_status": "delivered", "status_data": { "outbound_time": "2023-03-21 16:55:25", "receipt_time": "2023-03-21 16:55:49", "sms_id": "1679387065399_15_17155_881597_0poco8$+115927992951", "user_id": 15, "msg_type": 2, "template_id": 881597, "message": "délivré avec succès", "sms_user": "huangli_SMS", "template_type": 1, "msg_count": 1, "label_id": 0 } } }
              
              {
    "server": "sms", 
    "message_id": "1679387065399_15_17155_881597_0poco8$+115927992951", 
    "to": "+115927992951", 
    "itime": 1679388949000, 
    "status": {
        "message_status": "delivered", 
        "status_data": {
            "outbound_time": "2023-03-21 16:55:25", 
            "receipt_time": "2023-03-21 16:55:49",
            "sms_id": "1679387065399_15_17155_881597_0poco8$+115927992951", 
            "user_id": 15, 
            "msg_type": 2, 
            "template_id": 881597,  
            "message": "délivré avec succès", 
            "sms_user": "huangli_SMS", 
            "template_type": 1, 
            "msg_count": 1, 
            "label_id": 0
        }
    }
}
Afficher ce bloc de code dans la fenêtre flottante

Message de statut échec de livraison SMS

status

Paramètre Type Description
message_status string delivered_failed
status_data json object données de statut
template_id int ID du modèle SMS
template_type int type de contenu SMS
label_id int ID de l'étiquette SMS
user_id int ID de l'utilisateur
sms_user string SMS_USER
sms_id string ID du SMS
outbound_time string heure de demande canal
receipt_time string heure de réception
msg_count int nombre de messages SMS
msg_type int type de SMS
error_code int code d'erreur
error_detail json détail de l'erreur
message string journal d'erreur
sub_stat int sous-catégorie d'erreur, 4xx indique un échec de traitement pour la catégorie, 5XX indique un échec d'envoi pour la catégorie
sub_stat_desc string message d'erreur
{ "server": "sms", "message_id": "1679392394031_15_17153_881599_c1fjwa$+8618871186627", "to": "+8618871186627", "itime": 1679392394120, "status": { "message_status": "delivered_failed", "error_code": 480, "error_detail": { "message": "smsworker:local policy restrictions", "sub_stat": 480, "sub_stat_desc": "type d'envoi non pris en charge" }, "status_data": { "sms_id": "1679392394031_15_17153_881599_c1fjwa$+8618871186627", "user_id": 15, "msg_type": 2, "template_id": 881599, "outbound_time": "2023-03-21 17:53:14", "receipt_time":"2023-03-21 17:53:37", "sms_user": "xiaojinmintest", "template_type": 2, "msg_count": 1, "label_id": 0 } } }
              
              {
  "server": "sms",
  "message_id": "1679392394031_15_17153_881599_c1fjwa$+8618871186627",
  "to": "+8618871186627",
  "itime": 1679392394120,
  "status": {
    "message_status": "delivered_failed",
    "error_code": 480,
    "error_detail": {
      "message": "smsworker:local policy restrictions",
      "sub_stat": 480,
      "sub_stat_desc": "type d'envoi non pris en charge"
    },
    "status_data": {
      "sms_id": "1679392394031_15_17153_881599_c1fjwa$+8618871186627",
      "user_id": 15,
      "msg_type": 2,
      "template_id": 881599,
      "outbound_time": "2023-03-21 17:53:14",
      "receipt_time":"2023-03-21 17:53:37",
      "sms_user": "xiaojinmintest",
      "template_type": 2,
      "msg_count": 1,
      "label_id": 0
    }
  }
}
Afficher ce bloc de code dans la fenêtre flottante

Callback de réponse SMS

URL

Définie par l'utilisateur sur la page
              
              Définie par l'utilisateur sur la page
Afficher ce bloc de code dans la fenêtre flottante

Content-Type :

application/json; charset=utf-8
              
              application/json; charset=utf-8
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

En-têtes de la requête

En-tête Type Description
X-SMSHook-Signature string signature
X-SMSHook-Timestamp long horodatage de génération du message
X-SMSHook-AppKey string application
X-SMSHook-Version string version

Corps de la requête

Paramètre Type Description
message_id string identifiant du message
to string destinataire
server string SMS
itime long horodatage de génération du message
custom_args json champs définis par le client
response json callback de réponse du message

Message de réponse SMS

response

Paramètre Type Description
event string reply
response_data json object données de réponse
template_id int ID du modèle SMS
template_type int type de contenu SMS
label_id int ID de l'étiquette SMS
user_id int ID de l'utilisateur
sms_user string SMS_USER
sms_id string ID du SMS
reply_content int contenu de la réponse
reply_time string heure de la réponse
msg_type int type de SMS
{ "server": "sms", "message_id": "1679364048767_15_15814_905354_3y5z9a$17858502021", "to": "17858502021", "itime": 1679392394128, "response": { "event": "reply", "response_data": { "sms_id": "1679364048767_15_15814_905354_3y5z9a$17858502021", "user_id": 15, "reply_time": "2023-03-21 10:07:17", "msg_type": 2, "template_id": 905354, "sms_user": "cpx_sms", "template_type": 2, "reply_content": "T", "label_id": 0 } } }
              
              {
    "server": "sms", 
    "message_id": "1679364048767_15_15814_905354_3y5z9a$17858502021", 
    "to": "17858502021", 
    "itime": 1679392394128, 
    "response": {
        "event": "reply", 
        "response_data": {
            "sms_id": "1679364048767_15_15814_905354_3y5z9a$17858502021", 
            "user_id": 15, 
            "reply_time": "2023-03-21 10:07:17", 
            "msg_type": 2, 
            "template_id": 905354, 
            "sms_user": "cpx_sms", 
            "template_type": 2, 
            "reply_content": "T", 
            "label_id": 0
        }
    }
}
Afficher ce bloc de code dans la fenêtre flottante

Callback de statut SMS

Message de notification d'approbation de modèle SMS

notification

Paramètre Type Description
event string template_approval
notification_data json object données de notification
template_id string ID du modèle SMS
template_type int type de contenu SMS
user_id string ID de l'utilisateur
msg_type int type de SMS
approval_status string résultat de la revue du modèle
approval_message string informations de revue du modèle
{ "server": "sms", "message_id": "1679364048767_15_15864", "to": "17858502021", "itime": 1679392394179, "notification": { "event": "template_approval", "notification_data": { "user_id": 15, "msg_type": 2, "template_id": 905354, "template_type": 2, "approval_status": "1", "approval_message": "accepté" } } }
              
              {
    "server": "sms", 
    "message_id": "1679364048767_15_15864", 
    "to": "17858502021", 
    "itime": 1679392394179, 
    "notification": {
        "event": "template_approval", 
        "notification_data": {
            "user_id": 15, 
            "msg_type": 2, 
            "template_id": 905354, 
            "template_type": 2, 
            "approval_status": "1", 
            "approval_message": "accepté"
        }
    }
}
Afficher ce bloc de code dans la fenêtre flottante
Icon Solid Transparent White Qiyu
Contactez-nous