SMS Label

Se pueden consultar, añadir, modificar y eliminar etiquetas de SMS mediante la siguiente interfaz.

Consulta

Devuelve la información básica de las etiquetas de SMS.

URL

https://sms.api.engagelab.cc/v1/labels/{label_id}

              
              https://sms.api.engagelab.cc/v1/labels/{label_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	true	Basic base64(sms_user:sms_key)

Ejemplo de solicitud

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

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

Descripción del valor devuelto

Parámetro	Descripción
label_id	ID de la etiqueta
label_name	Nombre de la etiqueta
create_time	Hora de creación de la etiqueta
update_time	Hora de modificación de la etiqueta

Ejemplo de valor devuelto

Respuesta: Éxito

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

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

Respuesta: Error

Estado HTTP: 400

{ "code": 34020, "message": "label_id must be a integer" }

              
              {
  "code": 34020,
  "message": "label_id must be a integer"
}

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

Consulta (por lotes)

Lista de etiquetas devueltas

URL

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

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

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	true	Basic base64(sms_user:sms_key)

Descripción de parámetros de consulta

Parámetro	Tipo	Obligatorio	Descripción
offset	Integer	No	Posición de desplazamiento (offset), [0-], el valor predeterminado es 0
limit	Integer	No	Cantidad, [0-100], el valor predeterminado es 100
label_name	string	No	Consulta difusa

Ejemplo de solicitud

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

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

Descripción del valor devuelto

Parámetro	Descripción
label_id	ID de la etiqueta
label_name	Nombre de la etiqueta
create_time	Hora de creación de la etiqueta
update_time	Hora de modificación de la etiqueta

Ejemplo de valor devuelto

Respuesta: Éxito

Estado 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
}

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

Respuesta: Error

Estado HTTP: 401

{ "code": 30000, "message": "Unauthorized." }

              
              {  
    "code": 30000,
    "message": "Unauthorized."
}

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

Añadir

Devuelve la información básica de la etiqueta de SMS tras añadirse correctamente.

URL

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

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

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	true	Basic base64(sms_user:sms_key)

Descripción de parámetros

Parámetro	Tipo	Obligatorio	Descripción
label_name	string	Sí	Nombre de la etiqueta que se va a añadir. Máximo 64 caracteres.

Nota

El límite superior de creación de etiquetas es de 100000.

Ejemplo de solicitud

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

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

Descripción del valor devuelto

Parámetro	Descripción
label_id	ID de la etiqueta
label_name	Nombre de la etiqueta
create_time	Hora de creación de la etiqueta
update_time	Hora de modificación de la etiqueta

Ejemplo de valor devuelto

Respuesta: Éxito

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

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

Respuesta: Error

Estado HTTP: 401

{ "code": 30000, "message": "Unauthorized." }

              
              {
    "code": 30000,
    "message": "Unauthorized."
}

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

Modificar

URL

https://sms.api.engagelab.cc/v1/labels/{label_id}

              
              https://sms.api.engagelab.cc/v1/labels/{label_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	true	Basic base64(sms_user:sms_key)

Descripción de parámetros

Parámetro	Tipo	Obligatorio	Descripción
label_name	string	Sí	Nuevo nombre de la etiqueta. Máximo 64 caracteres.

Ejemplo de solicitud

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

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

Descripción del valor devuelto

Parámetro	Descripción
count	Número de etiquetas modificadas

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": "Unauthorized." }

              
              {
    "code": 30000,
    "message": "Unauthorized."
}

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

Eliminar

URL

https://sms.api.engagelab.cc/v1/labels/{label_id}

              
              https://sms.api.engagelab.cc/v1/labels/{label_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	true	Basic base64(sms_user:sms_key)

Ejemplo de solicitud

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

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

Descripción del valor devuelto

Parámetro	Descripción
count	Número de etiquetas eliminadas

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": "Unauthorized." }

              
              {
    "code": 30000,
    "message": "Unauthorized."
}

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

Etiqueta 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

Modificar

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

Eliminar

URL

Método de solicitud HTTP

Encabezados de la solicitud

Ejemplo de solicitud

Descripción del valor devuelto

Ejemplo de valor devuelto