Contacto
Se puede consultar, agregar, eliminar y actualizar la lista de contactos de SMS mediante la siguiente interfaz.
Consultar lista de contactos
Se devuelve la información básica de la lista de contactos de SMS.
URL
https://sms.api.engagelab.cc/v1/contact_lists
https://sms.api.engagelab.cc/v1/contact_lists
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
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| offset | Integer | no | posición de desplazamiento, [0-], el valor predeterminado es 0 |
| limit | Integer | no | cantidad, [0-100], el valor predeterminado es 100 |
| contact_list_name | string | no | nombre de la lista de contactos; admite consultas difusas |
Ejemplo de solicitud
curl -X GET "https://sms.api.engagelab.cc/v1/contact_lists?contact_list_name=test"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X GET "https://sms.api.engagelab.cc/v1/contact_lists?contact_list_name=test"
--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 |
|---|---|
| contact_list_id | ID de la lista de contactos |
| contact_list_name | nombre de la lista de contactos |
| description | descripción de la lista de contactos |
| member_count | recuento de contactos en la lista |
| create_time | hora de creación de la lista de contactos |
| update_time | hora de modificación de la lista de contactos |
Ejemplo de valor devuelto
{
"result": [{
"contact_List_id": 998,
"contact_list_name": "test",
"description": "",
"member_count": 4,
"create_time": "2016-05-10T15:18:38+0800",
"update_time": "2016-05-11T10:04:20+0800"
},
{
"contact_List_id": 999,
"contact_list_name": "test2",
"description": "",
"member_count": 1,
"create_time": "2016-06-29T12:54:59+0800",
"update_time": "2016-06-29T12:54:59+0800"
}
],
"count":2
"total": 10
}
{
"result": [{
"contact_List_id": 998,
"contact_list_name": "test",
"description": "",
"member_count": 4,
"create_time": "2016-05-10T15:18:38+0800",
"update_time": "2016-05-11T10:04:20+0800"
},
{
"contact_List_id": 999,
"contact_list_name": "test2",
"description": "",
"member_count": 1,
"create_time": "2016-06-29T12:54:59+0800",
"update_time": "2016-06-29T12:54:59+0800"
}
],
"count":2
"total": 10
}
Este bloque de código se muestra en una ventana flotante
Agregar lista de contactos
Se devuelve la información de la lista de contactos agregada correctamente.
URL
https://sms.api.engagelab.cc/v1/contact_lists
https://sms.api.engagelab.cc/v1/contact_lists
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 |
|---|---|---|---|
| contact_list_name | string | sí | nombre de la lista de contactos; solo admite números, letras, guiones bajos o guiones, con una longitud máxima de 48 caracteres |
| description | string | no | información descriptiva, de hasta 255 caracteres |
Ejemplo de solicitud
curl -X POST "https://sms.api.engagelab.cc/v1/contact_lists"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"contact_list_name": "beijing",
"description": "test"
}'
curl -X POST "https://sms.api.engagelab.cc/v1/contact_lists"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"contact_list_name": "beijing",
"description": "test"
}'
Este bloque de código se muestra en una ventana flotante
Descripción del valor devuelto
| Parámetro | Descripción |
|---|---|
| contact_list_id | ID de la lista de contactos |
| contact_list_name | nombre de la lista de contactos |
| description | descripción de la lista de contactos |
| member_count | recuento de contactos en la lista |
| create_time | hora de creación de la lista de contactos |
| update_time | hora de modificación de la lista de contactos |
Ejemplo de valor devuelto
Response-success
HTTP Status: 200
{
"result": {
"contact_list_id": 35,
"contact_list_name": "beijing",
"description": "test",
"member_count": 28,
"create_time": "2016-08-02T14:06:10+0800",
"update_time": "2017-05-19T10:55:24+0800"
}
}
{
"result": {
"contact_list_id": 35,
"contact_list_name": "beijing",
"description": "test",
"member_count": 28,
"create_time": "2016-08-02T14:06:10+0800",
"update_time": "2017-05-19T10:55:24+0800"
}
}
Este bloque de código se muestra en una ventana flotante
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Unauthorized."
}
{
"code": 30000,
"message": "Unauthorized."
}
Este bloque de código se muestra en una ventana flotante
Response-error
HTTP Status :400
// example of failed return results
{
"code": 35004,
"message": "contact_list_name cannot be empty"
}
// example of failed return results
{
"code": 35004,
"message": "contact_list_name cannot be empty"
}
Este bloque de código se muestra en una ventana flotante
Modificar lista de contactos
Se devuelve la información básica de la lista de contactos actualizada correctamente.
URL
https://sms.api.engagelab.cc/v1/contact_lists/{contact_list_id}
https://sms.api.engagelab.cc/v1/contact_lists/{contact_list_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 |
|---|---|---|---|
| contact_list_name | string | no | nombre de la lista de contactos; solo admite números, letras, guiones bajos o guiones, con una longitud máxima de 48 caracteres |
| description | string | no | información descriptiva, de hasta 255 caracteres |
Consejos:
- La hora de la lista solo se actualiza cuando se actualizan 'contact_listname' y 'description', y la hora de actualización de la lista no se actualiza al actualizar miembros.
Ejemplo de solicitud
curl -X PUT "https://sms.api.engagelab.cc/v1/contact_lists/1234"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"contact_list_name": "shanghai",
"description": "222"
}'
curl -X PUT "https://sms.api.engagelab.cc/v1/contact_lists/1234"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"contact_list_name": "shanghai",
"description": "222"
}'
Este bloque de código se muestra en una ventana flotante
Descripción del valor devuelto
| Parámetro | Descripción |
|---|---|
| count | número de modificaciones correctas |
Ejemplo de valor devuelto
Response-success
HTTP Status: 200
{
"count":1
}
{
"count":1
}
Este bloque de código se muestra en una ventana flotante
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Unauthorized."
}
{
"code": 30000,
"message": "Unauthorized."
}
Este bloque de código se muestra en una ventana flotante
Response-error
HTTP Status :400
// example of failed return results
{
"code": 35004,
"message": "contact_list_name cannot be empty"
}
// example of failed return results
{
"code": 35004,
"message": "contact_list_name cannot be empty"
}
Este bloque de código se muestra en una ventana flotante
Eliminar lista de contactos
Se devuelve la información básica sobre si la solicitud se realizó correctamente.
URL
https://sms.api.engagelab.cc/v1/contact_lists/{contact_list_id}
https://sms.api.engagelab.cc/v1/contact_lists/{contact_list_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
Content-type
application/x-www-form-urlencoded
application/x-www-form-urlencoded
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/contact_lists/1234"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X DELETE "https://sms.api.engagelab.cc/v1/contact_lists/1234"
--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 | recuento de listas eliminadas |
Ejemplo de valor devuelto
Response-success
HTTP Status: 200
{
"count": 1
}
{
"count": 1
}
Este bloque de código se muestra en una ventana flotante
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Unauthorized."
}
{
"code": 30000,
"message": "Unauthorized."
}
Este bloque de código se muestra en una ventana flotante
Response-error
HTTP Status :400
// example of failed return results
{
"code": 35008,
"message": "The contactListName does not exist"
}
// example of failed return results
{
"code": 35008,
"message": "The contactListName does not exist"
}
Este bloque de código se muestra en una ventana flotante
Se puede consultar, agregar, eliminar y actualizar miembros de la lista de contactos de SMS mediante la siguiente interfaz.
Consultar miembro de la lista
Se devuelve la información básica de los miembros en la lista de contactos de SMS.
URL
https://sms.api.engagelab.cc/v1/contact_lists/{contact_list_id}/members
https://sms.api.engagelab.cc/v1/contact_lists/{contact_list_id}/members
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
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| offset | Integer | no | posición de desplazamiento, [0-], el valor predeterminado es 0 |
| limit | Integer | no | cantidad, [0-100], el valor predeterminado es 100 |
| phone | string | no | número de teléfono del miembro; admite consultas difusas |
| member_ids | string | no | ID del miembro; admite varios ID; separados por números, hasta 100 |
Ejemplo de solicitud
curl -X GET "https://sms.api.engagelab.cc/v1/contact_lists/1025/members?phone=15652496875"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X GET "https://sms.api.engagelab.cc/v1/contact_lists/1025/members?phone=15652496875"
--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 |
|---|---|
| member_id | ID del miembro |
| phone | teléfono del miembro |
| name | nombre del miembro |
| vars | variables |
| create_time | hora de creación de la lista de contactos |
| update_time | hora de modificación de la lista de contactos |
Ejemplo de valor devuelto
{
"result": [
{
"member_id": 440164,
"phone": "18********",
"name": "",
"vars": "{'beizhu':'hello'}",
"create_time": "2016-10-18T15:13:27+0800",
"update_time": "2016-10-18T15:13:27+0800",
},
{
"member_id": 440964,
"phone": "13********",
"name": "",
"vars": "{'beizhu':'ss'}",
"create_time": "2016-10-18T15:13:27+0800",
"update_time": "2016-10-18T15:13:27+0800",
}
],
"total": 2,
"count": 2
}
{
"result": [
{
"member_id": 440164,
"phone": "18********",
"name": "",
"vars": "{'beizhu':'hello'}",
"create_time": "2016-10-18T15:13:27+0800",
"update_time": "2016-10-18T15:13:27+0800",
},
{
"member_id": 440964,
"phone": "13********",
"name": "",
"vars": "{'beizhu':'ss'}",
"create_time": "2016-10-18T15:13:27+0800",
"update_time": "2016-10-18T15:13:27+0800",
}
],
"total": 2,
"count": 2
}
Este bloque de código se muestra en una ventana flotante
Agregar miembro a la lista
Agregar miembros a la lista de contactos
URL
https://sms.api.engagelab.cc/v1/contact_lists/{contact_list_id}/members
https://sms.api.engagelab.cc/v1/contact_lists/{contact_list_id}/members
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 |
|---|---|---|---|
| members | Array [object] | sí | lista de miembros, hasta 1000 miembros. |
| phone | string | sí | teléfono, formato de número de teléfono internacional |
| name | string | no | nombre del miembro, máximo de 48 caracteres |
| vars | object | no | variables, el máximo es 1 KB |
Consejos:
- Al agregar variables vars, se debe tener en cuenta que no es necesario marcar la clave con '%', y la longitud de la clave no puede superar los 32 caracteres.
- En la variable vars, la variable cuya clave sea name se sobrescribirá con el parámetro name.
Ejemplo de solicitud
curl -X POST "https://sms.api.engagelab.cc/v1/contact_lists/1024/members"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"members": [
{
"phone": "+86158452369825",
"name": "aaa",
"vars": {"sex":"male","code":"1"}
},
{
"phone": "+8618754265414",
"name": "aaa",
"vars": {"sex":"female","code":"2"}
}
]
}'
curl -X POST "https://sms.api.engagelab.cc/v1/contact_lists/1024/members"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"members": [
{
"phone": "+86158452369825",
"name": "aaa",
"vars": {"sex":"male","code":"1"}
},
{
"phone": "+8618754265414",
"name": "aaa",
"vars": {"sex":"female","code":"2"}
}
]
}'
Este bloque de código se muestra en una ventana flotante
Descripción del valor devuelto
| Parámetro | Descripción |
|---|---|
| count | recuento de miembros agregados |
| invalid | miembro no válido |
Ejemplo de valor devuelto
Response-success
HTTP Status: 200
{
"result": {
"count": 1,
"invalid": ["130****"]
}
}
{
"result": {
"count": 1,
"invalid": ["130****"]
}
}
Este bloque de código se muestra en una ventana flotante
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Unauthorized."
}
{
"code": 30000,
"message": "Unauthorized."
}
Este bloque de código se muestra en una ventana flotante
Response-error
HTTP Status :400
// example of failed return results
{
"code": 35008,
"message": "The contactListId does not exist"
}
// example of failed return results
{
"code": 35008,
"message": "The contactListId does not exist"
}
Este bloque de código se muestra en una ventana flotante
Modificar miembro de la lista
Actualizar miembros de la lista de contactos
URL
https://sms.api.engagelab.cc/v1/contact_lists/{contact_member_id}/members/{member_id}
https://sms.api.engagelab.cc/v1/contact_lists/{contact_member_id}/members/{member_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 |
|---|---|---|---|
| member | Object | sí | miembro de la lista de contactos |
| phone | string | no | teléfono, formato de número de teléfono internacional |
| name | string | no | nombre del miembro, máximo de 48 caracteres |
| vars | object | no | variables, el máximo es 1 KB. La longitud de la clave no puede superar los 32 caracteres |
Ejemplo de solicitud
curl -X POST "https://sms.api.engagelab.cc/v1/contact_lists/1024/members/251224"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"member":
{
"phone": "158452369825",
"name": "aaa",
"vars": {"sex":"male","code":"1"}
}
}'
curl -X POST "https://sms.api.engagelab.cc/v1/contact_lists/1024/members/251224"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"member":
{
"phone": "158452369825",
"name": "aaa",
"vars": {"sex":"male","code":"1"}
}
}'
Este bloque de código se muestra en una ventana flotante
Descripción del valor devuelto
| Parámetro | Descripción |
|---|---|
| count | recuento de contactos modificados |
Ejemplo de valor devuelto
Response-success
HTTP Status: 200
{
"count": 1
}
{
"count": 1
}
Este bloque de código se muestra en una ventana flotante
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Unauthorized."
}
{
"code": 30000,
"message": "Unauthorized."
}
Este bloque de código se muestra en una ventana flotante
Response-error
HTTP Status :400
// example of failed return results
{
"code": 35008,
"message": "The contactListId does not exist"
}
// example of failed return results
{
"code": 35008,
"message": "The contactListId does not exist"
}
Este bloque de código se muestra en una ventana flotante
Eliminar miembro de la lista
Se devuelve si la eliminación se realizó correctamente.
URL
https://sms.api.engagelab.cc/v1/contact_lists/{contact_list_id}/members/{member_id}
https://sms.api.engagelab.cc/v1/contact_lists/{contact_list_id}/members/{member_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
Content-type
application/x-www-form-urlencoded
application/x-www-form-urlencoded
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/contact_lists/11/members/1234"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X DELETE "https://sms.api.engagelab.cc/v1/contact_lists/11/members/1234"
--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 | recuento de contactos eliminados |
Ejemplo de valor devuelto
Response-success
HTTP Status: 200
{
"count": 1
}
{
"count": 1
}
Este bloque de código se muestra en una ventana flotante
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Unauthorized."
}
{
"code": 30000,
"message": "Unauthorized."
}
Este bloque de código se muestra en una ventana flotante
Response-error
HTTP Status :400
// example of failed return results
{
"code": 35008,
"message": "The contactListId does not exist"
}
// example of failed return results
{
"code": 35008,
"message": "The contactListId does not exist"
}
Este bloque de código se muestra en una ventana flotante
