Plantilla SMS

La siguiente interfaz permite añadir, modificar y eliminar plantillas de SMS, así como consultar, enviar para revisión y aprobar SMS y plantillas de SMS.

Consulta

Devuelve información detallada de la plantilla de SMS

URL

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

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

Este bloque de código se muestra en una ventana flotante

Método de solicitud HTTP

GET

GET

Este bloque de código se muestra en una ventana flotante

Encabezados de la solicitud

Encabezado	Tipo	Obligatorio	Descripción
Authorization	String	Sí	Basic base64(sms_user:sms_key)

Ejemplo de solicitud

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>>"

Este bloque de código se muestra en una ventana flotante

Descripción del valor devuelto

Parámetro	Descripción
template_id	ID de la plantilla
template_name	Nombre de la plantilla
msg_type	Tipo de SMS; 2 representa SMS internacional.
template_type	Tipo de contenido de SMS; 0 representa código de verificación, 1 representa notificación del sector y 2 representa marketing.
approval_status	Estado de revisión; 0 indica pendiente de revisión, 1 indica revisión aprobada, -1 indica revisión fallida, -2 no se ha enviado para revisión.
approval_message	Información de revisión; solo tiene valor cuando approval_status es -1.
template_content	Contenido de la plantilla, hasta 512 caracteres
create_time	Hora de creación de la plantilla
update_time	Hora de modificación de la plantilla

Ejemplo de valor devuelto

Respuesta: Éxito

Estado HTTP: 200

{ "result": { "template_id": 123, "template_name": "test", "msg_type": 2, "template_type": 1, "template_content": "Dear %name%,your consumption amount on the platform this month is:***", "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": "Dear %name%,your consumption amount on the platform this month is:***",
        "approval_status": 1,
        "approval_message": "",
        "create_time": "2015-03-23T14:27:48+0800",
        "update_time": "2017-03-29T14:27:48+0800"
    }
}

Este bloque de código se muestra en una ventana flotante

Respuesta: Error

Estado HTTP: 400

{ "code": 33001, "message": "The template does not exist" }

              
              {
    "code": 33001,
    "message": "The template does not exist"
}

Este bloque de código se muestra en una ventana flotante

Consulta (por lotes)

Devuelve información básica de la plantilla de SMS

URL

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

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

Este bloque de código se muestra en una ventana flotante

Método de solicitud HTTP

GET

GET

Este bloque de código se muestra en una ventana flotante

Encabezados de la solicitud

Encabezado	Tipo	Obligatorio	Descripción
Authorization	String	Sí	Basic base64(sms_user:sms_key)

Descripción de parámetros de consulta

Parámetro	Tipo	Obligatorio	Descripción
template_ids	String	No	ID de plantilla; admite valores múltiples separados por comas.
approval_status	String	No	Estado de revisión; 0 indica pendiente de revisión, 1 indica revisión aprobada, -1 indica revisión fallida, -2 no se ha enviado para revisión.
template_name	String	No	Nombre de la plantilla, coincidencia aproximada
offset	Int	No	Posición de desplazamiento, [0-], el valor predeterminado es 0
limit	Int	No	Cantidad, [0-100], el valor predeterminado es 100

Sugerencias:

Se puede especificar un ID de plantilla para la consulta. Si no se especifica, se consultarán todas las plantillas de forma predeterminada.

Ejemplo de solicitud

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>>"

Este bloque de código se muestra en una ventana flotante

Descripción del valor devuelto

Parámetro	Descripción
template_id	ID de la plantilla
template_name	Nombre de la plantilla
msg_type	Tipo de SMS
template_type	Tipo de contenido de SMS
approval_status	Estado de revisión
approval_message	Información de revisión; solo tiene valor cuando approval_status es -1.
template_content	Contenido de la plantilla
sign_id	ID de la firma
create_time	Hora de creación de la plantilla
update_time	Hora de modificación de la plantilla

Ejemplo de valor devuelto

Respuesta: Éxito

Estado HTTP: 200

{ "result" : [{ "template_id" : 100, "template_name" : "tset", "msg_type" : 2, "template_type" : 1, "template_content" : "Dear %name%,your consumption amount on the platform this month is:***", "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" : "Dear %name%,your consumption amount on the platform this month is:***",
                "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
    }

Este bloque de código se muestra en una ventana flotante

Respuesta: Error

Estado HTTP: 400

{ "code": 30002, "message": "invalid limit" }

              
              {
  "code": 30002,
  "message": "invalid limit"
}

Este bloque de código se muestra en una ventana flotante

Añadir

Devuelve información sobre si la adición se realizó correctamente

URL

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

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

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

Content-Type

application/json

              
              application/json

Este bloque de código se muestra en una ventana flotante

Encabezados de la solicitud

Encabezado	Tipo	Obligatorio	Descripción
Authorization	String	Sí	Basic base64(sms_user:sms_key)

Descripción de parámetros

Parámetro	Tipo	Obligatorio	Descripción
template_name	String	Sí	Nombre de la plantilla, único dentro de la cuenta, con una longitud máxima de 64 caracteres.
template_content	String	Sí	El contenido de la plantilla no puede contener caracteres como [],【】, test, 测试, con una longitud máxima de 512 caracteres
template_type	String	Sí	Tipo de contenido de SMS; 0 representa código de verificación, 1 representa notificación del sector y 2 representa marketing.
msg_type	String	No	Tipo de SMS; 2 representa SMS internacional; el valor predeterminado es 2.
sign_id	Integer	No	ID de la firma
sign_pos	String	No	Posición de la firma; 0 representa al inicio, 1 representa al final; el valor predeterminado es 0
submit	Bool	No	Si se envía directamente para revisión; el valor predeterminado es false

Ejemplo de solicitud

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": "Dear %name%,your consumption amount on the platform this month is:***", "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": "Dear %name%,your consumption amount on the platform this month is:***",
    "sign_id": 1235,
    "template_type": "0"
}'

Este bloque de código se muestra en una ventana flotante

Descripción del valor devuelto

Parámetro	Descripción
template_id	ID de la plantilla
template_name	Nombre de la plantilla
msg_type	Tipo de SMS
template_type	Tipo de contenido de SMS
approval_status	Estado de revisión
approval_message	Información de revisión; solo tiene valor cuando approval_status es -1.
template_content	Contenido de la plantilla
sign_id	ID de la firma
create_time	Hora de creación de la plantilla
update_time	Hora de modificación de la plantilla

Ejemplo de valor devuelto

Respuesta: Éxito

Estado HTTP: 200

{ "result" : { "template_id" : 200, "template_name" : "bill", "msg_type" : 2, "template_type" : 1, "template_content" : "Dear %name%,your consumption amount on the platform this month is:***", "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" : "Dear %name%,your consumption amount on the platform this month is:***",
        "approval_status" : 1,
        "approval_message": "",
        "create_time" : "2022-08-25T14:35:48+0800",
        "update_time" : "2022-08-25T14:35:48+0800"
        
    }
}

Este bloque de código se muestra en una ventana flotante

Respuesta: Error

Estado HTTP: 400

{ "code": 33006, "message": "Template name only supports 64 characters" }

              
              {
    "code": 33006,
    "message": "Template name only supports 64 characters"
}

Este bloque de código se muestra en una ventana flotante

Enviar para revisión

Devuelve información básica sobre si el envío se realizó correctamente

URL

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

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

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

Content-Type

application/json

              
              application/json

Este bloque de código se muestra en una ventana flotante

Encabezados de la solicitud

Encabezado	Tipo	Obligatorio	Descripción
Authorization	String	Sí	Basic base64(sms_user:sms_key)

Ejemplo de solicitud

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"

Este bloque de código se muestra en una ventana flotante

Ejemplo de valor devuelto

Respuesta: Éxito

Estado HTTP: 200

{ }

Este bloque de código se muestra en una ventana flotante

Modificar

Devuelve información básica sobre si el envío se realizó correctamente

URL

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

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

Este bloque de código se muestra en una ventana flotante

Método de solicitud HTTP

PUT

PUT

Este bloque de código se muestra en una ventana flotante

Content-Type

application/json

              
              application/json

Este bloque de código se muestra en una ventana flotante

Encabezados de la solicitud

Encabezado	Tipo	Obligatorio	Descripción
Authorization	String	Sí	Basic base64(sms_user:sms_key)

Descripción de parámetros

Parámetro	Tipo	Obligatorio	Descripción
template_name	String	No	Nombre de la plantilla, único dentro de la cuenta, con una longitud máxima de 64 caracteres.
template_content	String	No	El contenido de la plantilla no puede contener caracteres como [],【】, test, 测试, con una longitud máxima de 512 caracteres
sign_id	Integer	No	ID de la firma
sign_pos	String	No	Posición de la firma; 0 representa al inicio, 1 representa al final; el valor predeterminado es 0
template_type	String	No	Tipo de contenido de SMS; 0 representa código de verificación, 1 representa notificación del sector y 2 representa marketing
submit	Bool	No	Si se envía directamente para revisión; el valor predeterminado es false

Sugerencias：

Tras llamar a esta interfaz, actualizar template_name no provocará un cambio en el estado de aprobación de la plantilla, mientras que la actualización de otros parámetros sí provocará un cambio en el estado de aprobación de la plantilla.

Ejemplo de solicitud

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": "Dear %name%,your consumption amount on the platform this month is:***", "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": "Dear %name%,your consumption amount on the platform this month is:***",
    "sign_id": 132,
    "template_type": 0
    }'

Este bloque de código se muestra en una ventana flotante

Ejemplo de valor devuelto

Respuesta: Éxito

Estado HTTP: 200

{ "count": 1 }

              
               { 
 "count": 1 
 }

Este bloque de código se muestra en una ventana flotante

Respuesta: Error

Estado HTTP: 401

{ "code": 30000, "message": "Authentication failed" }

              
              {
  "code": 30000,
  "message": "Authentication failed"
}

Este bloque de código se muestra en una ventana flotante

Eliminar

URL

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

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

Este bloque de código se muestra en una ventana flotante

Método de solicitud HTTP

DELETE

              
              DELETE

Este bloque de código se muestra en una ventana flotante

Encabezados de la solicitud

Encabezado	Tipo	Obligatorio	Descripción
Authorization	String	Sí	Basic base64(sms_user:sms_key)

Ejemplo de solicitud

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>>"

Este bloque de código se muestra en una ventana flotante

Ejemplo de valor devuelto

Respuesta: Éxito

Estado HTTP: 200

{ "count": 1 }

              
               { 
 "count": 1 
 }

Este bloque de código se muestra en una ventana flotante

Plantilla de SMS

Consulta

URL

Método de solicitud HTTP

Encabezados de la solicitud

Ejemplo de solicitud

Descripción del valor devuelto

Ejemplo de valor devuelto

Consulta (por lotes)

URL

Método de solicitud HTTP

Encabezados de la solicitud

Descripción de parámetros de consulta

Ejemplo de solicitud

Descripción del valor devuelto

Ejemplo de valor devuelto

Añadir

URL

Método de solicitud HTTP

Content-Type

Encabezados de la solicitud

Descripción de parámetros

Ejemplo de solicitud

Descripción del valor devuelto

Ejemplo de valor devuelto

Enviar para revisión

URL

Método de solicitud HTTP

Content-Type

Encabezados de la solicitud

Ejemplo de solicitud

Ejemplo de valor devuelto

Modificar

URL

Método de solicitud HTTP

Content-Type

Encabezados de la solicitud

Descripción de parámetros

Ejemplo de solicitud

Ejemplo de valor devuelto

Eliminar

URL

Método de solicitud HTTP

Encabezados de la solicitud

Ejemplo de solicitud

Ejemplo de valor devuelto