Logo Site EngageLab Mark Colored TransparentDocumentación
Server Center
Buscar
Español
English
繁體中文
简体中文
日本語
ภาษาไทย
Español
Indonesian
Deutsch
Français
Iniciar sesión

SMSHook

Última actualización：hace casi 3 años

Callback de estado de SMS

URL

Configuración definida por el usuario en la página
              
              Configuración definida por el usuario en la página
Este bloque de código se muestra en una ventana flotante

Content-Type:

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

Encabezados de la solicitud

Encabezado Tipo Descripción
X-SMSHook-Signature string firma
X-SMSHook-Timestamp long marca de tiempo de generación del mensaje
X-SMSHook-AppKey string clave de aplicación
X-SMSHook-Version string versión

Cuerpo de la solicitud

Parámetro Tipo Descripción
message_id string ID del mensaje
from string remitente (vacío en el mensaje template_approval)
to string destinatario (vacío en target, sent y template_approval)
server string SMS
itime long marca de tiempo de generación del mensaje
custom_args json campos definidos por el cliente
status json callback de estado del mensaje

Mensaje de estado target de SMS

status

Parámetro Tipo Descripción
message_status string target
status_data json object datos de estado
message string solicitud realizada correctamente
template_id int ID de la plantilla de SMS
template_type int tipo de contenido de SMS
label_id int ID de la etiqueta de SMS
user_id int ID de usuario
sms_user string SMS_USER
sms_ids array array de IDs de SMS del destinatario
to array array de destinatarios
msg_type int tipo 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": "successfully request", "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": "successfully request", 
            "sms_user": "xiaojinmintest", 
            "sms_ids": [
                "1679392394031_15_17153_881599_c1fjwa$+8618871186627", 
                "1679392394031_15_17153_881599_c1fjwa$008615727024341"
            ], 
            "template_type": 2, 
            "label_id": 0
        }
    }
}
Este bloque de código se muestra en una ventana flotante

Mensaje de estado sent de SMS

status

Parámetro Tipo Descripción
message_status string sent
status_data json object datos de estado
message string enviado correctamente
template_id int ID de la plantilla de SMS
template_type int tipo de contenido de SMS
label_id int ID de la etiqueta de SMS
user_id int ID de usuario
sms_user string SMS_USER
sms_ids array array de IDs de SMS del destinatario
to array array de destinatarios
msg_type int tipo 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": "successfully sent", "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": "successfully sent", 
            "sms_user": "xiaojinmintest", 
            "sms_ids": [
                "1679392394031_15_17153_881599_c1fjwa$+8618871186627", 
                "1679392394031_15_17153_881599_c1fjwa$008615727024341"
            ], 
            "template_type": 2, 
            "label_id": 0
        }
    }
}
Este bloque de código se muestra en una ventana flotante

Mensaje de estado delivered de SMS

status

Parámetro Tipo Descripción
message_status string delivered
status_data json object datos de estado
message string entregado correctamente
template_id int ID de la plantilla de SMS
template_type int tipo de contenido de SMS
label_id int ID de la etiqueta de SMS
user_id int ID de usuario
sms_user string SMS_USER
sms_id string ID de SMS
msg_count int número de mensajes SMS
msg_type int tipo de SMS
outbound_time string hora de solicitud al canal
receipt_time string hora de recepción
{ "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": "successfully delivered", "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": "successfully delivered", 
            "sms_user": "huangli_SMS", 
            "template_type": 1, 
            "msg_count": 1, 
            "label_id": 0
        }
    }
}
Este bloque de código se muestra en una ventana flotante

Mensaje de estado delivered_failed de SMS

status

Parámetro Tipo Descripción
message_status string delivered_failed
status_data json object datos de estado
template_id int ID de la plantilla de SMS
template_type int tipo de contenido de SMS
label_id int ID de la etiqueta de SMS
user_id int ID de usuario
sms_user string SMS_USER
sms_id string ID de SMS
outbound_time string hora de solicitud al canal
receipt_time string hora de recepción
msg_count int número de mensajes SMS
msg_type int tipo de SMS
error_code int código de error
error_detail json detalle del error
message string registro de error
sub_stat int subcategoría de error; 4xx indica un fallo de procesamiento para la categoría, 5XX indica un fallo de envío para la categoría
sub_stat_desc string mensaje de error
{ "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": "sending type not supported" }, "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": "sending type not supported"
    },
    "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
    }
  }
}
Este bloque de código se muestra en una ventana flotante

Callback de respuesta de SMS

URL

Configuración definida por el usuario en la página
              
              Configuración definida por el usuario en la página
Este bloque de código se muestra en una ventana flotante

Content-Type:

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

Encabezados de la solicitud

Encabezado Tipo Descripción
X-SMSHook-Signature string firma
X-SMSHook-Timestamp long marca de tiempo de generación del mensaje
X-SMSHook-AppKey string clave de aplicación
X-SMSHook-Version string versión

Cuerpo de la solicitud

Parámetro Tipo Descripción
message_id string ID del mensaje
to string destinatario
server string SMS
itime long marca de tiempo de generación del mensaje
custom_args json campos definidos por el cliente
response json callback de respuesta del mensaje

Mensaje de respuesta de reply de SMS

response

Parámetro Tipo Descripción
event string reply
response_data json object datos de respuesta
template_id int ID de la plantilla de SMS
template_type int tipo de contenido de SMS
label_id int ID de la etiqueta de SMS
user_id int ID de usuario
sms_user string SMS_USER
sms_id string ID de SMS
reply_content int contenido de la respuesta
reply_time string hora de respuesta
msg_type int tipo 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
        }
    }
}
Este bloque de código se muestra en una ventana flotante

Callback de estado de SMS

Mensaje de notificación template_approval de plantilla de SMS

notification

Parámetro Tipo Descripción
event string template_approval
notification_data json object datos de respuesta
template_id string ID de la plantilla de SMS
template_type int tipo de contenido de SMS
user_id string ID de usuario
msg_type int tipo de SMS
approval_status string resultados de revisión de la plantilla
approval_message string información de revisión de la plantilla
{ "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": "pass" } } }
              
              {
    "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": "pass"
        }
    }
}
Este bloque de código se muestra en una ventana flotante
Icon Solid Transparent White Qiyu
Contacto