Contactos
Los contactos son una parte central de seven. En esta página, nos ocuparemos de los diferentes puntos finales de contacto que le permiten gestionar contactos de manera programática. Veremos cómo consultar, crear, actualizar y eliminar contactos.
El modelo de contacto
El modelo de contacto contiene toda la información sobre sus contactos, como el nombre, el avatar y el número de teléfono. Si ha creado propiedades de contacto personalizadas, se mostrará el nombre único como una propiedad adicional en el objeto properties.
Propiedades
- Name
id- Type
- integer
- Description
ID única del contacto.
- Name
avatar- Type
- string
- Description
La URL del avatar del contacto.
intials- Name
initials- Type
- string
- Description
Las iniciales del contacto.
- Name
color- Type
- hex color
- Description
Código de color hexadecimal.
validation- Name
state- Type
- string
- Description
El último resultado de validación del número de móvil del contacto. Puede tener uno de los valores valid, invalid, absent o unknown.
- Name
timestamp- Type
- timestamp
- Description
El momento de la última validación del número de móvil del contacto.
properties- Name
firstname- Type
- string
- Description
Nombre del contacto.
- Name
lastname- Type
- string
- Description
Apellido del contacto.
- Name
home_number- Type
- phonenumber
- Description
Número de teléfono fijo del contacto.
- Name
mobile_number- Type
- phonenumber
- Description
Número de teléfono móvil del contacto.
- Name
address- Type
- string
- Description
Dirección del contacto.
- Name
email- Type
- string
- Description
Correo electrónico del contacto.
- Name
postal_code- Type
- integer
- Description
Código postal del contacto.
- Name
city- Type
- string
- Description
Ciudad del contacto.
- Name
birthday- Type
- date
- Description
Fecha de nacimiento del contacto.
- Name
notes- Type
- string
- Description
Notas sobre el contacto.
- Name
groups- Type
- array
- Description
Un array que consiste en los IDs de los grupos a los que pertenece el contacto. Al modificar o crear un contacto, si se especifica esta propiedad, debe contener todos los IDs de los grupos a los que el contacto debe pertenecer.
- Name
created- Type
- timestamp
- Description
Momento de creación del contacto.
{
"id": 12876881,
"avatar": "https://static.seven.io/uploads/contact_images/4A000c0d4e9431F483090dE8D13F3806.jpg",
"validation": {
"state": "absent",
"timestamp": "2024-01-09 16:08:29"
},
"initials": {
"initials": "PM",
"color": "9EB384"
},
"properties": {
"firstname": "Peter",
"lastname": "Mustermann",
"mobile_number": 4917612345678,
"home_number": null,
"email": null,
"address": null,
"postal_code": null,
"city": null,
"birthday": "1977-07-07",
"notes": null,
},
"groups": [
18008
],
"created": "2024-01-09 13:14:48"
}
Consultar lista de contactos
Con este punto final, puede obtener una lista paginada de todos sus contactos. De forma predeterminada, se muestran un máximo de 30 contactos por página.
- Name
order_by- Type
- string
- Optional
- Optional
- Description
La columna por la que se deben ordenar los contactos.
- Name
order_direction- Type
- string
- Optional
- Optional
- Description
La dirección de la ordenación. Puede ser asc o desc.
- Name
search- Type
- string
- Optional
- Optional
- Description
Con este parámetro, puede buscar en sus contactos en todas las columnas.
- Name
offset- Type
- integer
- Optional
- Optional
- Description
La página que se debe mostrar.
- Name
limit- Type
- integer
- Optional
- Optional
- Description
La cantidad de contactos que se deben mostrar por página. Puede ser un valor entre 30 y 500.
- Name
group_id- Type
- integer
- Optional
- Optional
- Description
Mostrar solo contactos que son miembros de un grupo específico.
Anfrage
curl -G https://gateway.seven.io/api/contacts \
-H "X-Api-Key: SU_CLAVE_API" \
Antwort
{
"pagingMetadata": {
"offset": 0,
"count": 30,
"total": 20013,
"limit": 30,
"has_more": true
},
"data": [
{
"id": 12876881,
"avatar": "https://static.seven.io/uploads/contact_images/4A000c0d4e9431F483090dE8D13F3806.jpg",
"validation": {
"state": "absent",
"timestamp": "2024-01-09 16:08:29"
},
"initials": {
"initials": "PM",
"color": "9EB384"
},
"properties": {
"firstname": "Peter",
"lastname": "Mustermann",
"mobile_number": 4917612345678,
"home_number": null,
"email": null,
"address": null,
"postal_code": null,
"city": null,
"birthday": "1977-07-07",
"notes": null,
},
"groups": [
18008
],
"created": "2024-01-09 13:14:48"
},
{
"id": 12454415,
// ...
}
]
}
Crear contacto
Con este punto final, puede agregar un nuevo contacto. Si todo ha salido bien, recibirá el objeto de contacto creado como respuesta. Si ha creado propiedades de contacto personalizadas y desea establecerlas en el contacto, proporcione el nombre único de la propiedad como un parámetro adicional.
cURL
curl https://gateway.seven.io/api/contacts \
-H "X-Api-Key: IHR_API_SCHLÜSSEL" \
-d "firstname=Frank" \
-d "lastname=McAllister" \
-d "mobile_number=1-800-759-3000" \
-d "avatar=https://picsum.photos/200"
Response
{
"id": 12876882,
"avatar": "https://static.seven.io/uploads/contact_images/4A000c0d4e9431F483090dE8D13F3806.jpg",
"validation": {
"state": null,
"timestamp": null
},
"initials": {
"initials": "FM",
"color": "EEE0C9"
},
"properties": {
"firstname": "Frank",
"lastname": "McAllister",
"mobile_number": "18007593000",
"home_number": null,
"email": null,
"address": null,
"postal_code": null,
"city": null,
"birthday": null,
"notes": null,
},
"groups": [],
"created": "2024-01-09 13:12:48"
}
Obtener contacto
Con este punto final, puede obtener un contacto proporcionando su ID. En la lista arriba en esta página, puede leer qué propiedades están incluidas en los objetos de contacto.
cURL
curl https://gateway.seven.io/api/contacts/12876881 \
-H "X-Api-Key: SU_CLAVE_API"
Response
{
"id": 12876881,
"avatar": "https://static.seven.io/uploads/contact_images/4A000c0d4e9431F483090dE8D13F3806.jpg",
"validation": {
"state": "absent",
"timestamp": "2024-01-09 16:08:29"
},
"initials": {
"initials": "PM",
"color": "9EB384"
},
"properties": {
"firstname": "Peter",
"lastname": "Mustermann",
"mobile_number": 4917612345678,
"home_number": null,
"email": null,
"address": null,
"postal_code": null,
"city": null,
"birthday": "1977-07-07",
"notes": null,
},
"groups": [
18008
],
"created": "2024-01-09 13:14:48"
}
Actualizar contacto
Con este punto final, puede cambiar una o más propiedades de un contacto. Los nombres de las propiedades se pueden encontrar en la lista del modelo de contacto. Como respuesta, recibirá el objeto de contacto actualizado.
cURL
curl -X PATCH https://gateway.seven.io/api/contacts/12876881 \
-H "X-Api-Key: IHR_API_SCHLÜSSEL" \
-d firstname="Marc" \
-d lastname="Gump"
Response
{
"id": 12876881,
"avatar": "https://static.seven.io/uploads/contact_images/4A000c0d4e9431F483090dE8D13F3806.jpg",
"validation": {
"state": "absent",
"timestamp": "2024-01-09 16:08:29"
},
"initials": {
"initials": "CF",
"color": "9EB384"
},
"properties": {
"firstname": "Marc",
"lastname": "Gump",
"mobile_number": 4917612345678,
"home_number": null,
"email": null,
"address": null,
"postal_code": null,
"city": null,
"birthday": "1977-07-07",
"notes": null
},
"groups": [
´ 18008
],
"created": "2024-01-09 13:14:48"
}
Eliminar contacto
Este punto final le permite eliminar contactos de su lista de contactos.
cURL
curl -X DELETE https://gateway.seven.io/api/contacts/12454414 \
-H "X-Api-Key: SU_CLAVE_API"