1980tic
Buscar…
📥
API de contactos
Le permite agregar, editar y recuperar información de contacto a través de API.
Las llamadas a la API se realizan por canal. Los tokens se pueden generar usando el icono de llave, junto al canal deseado en Configuración . Hay un límite de frecuencia de 100 llamadas API por minuto.

Peticiones

La API de contactos se compone de varias solicitudes:

Obtener contacto por campo personalizado

Esta solicitud devuelve una lista de objetos de contacto con paginación.
1
/v1/contact/by_custom_field
Copied!

Ejemplo de solicitud GET

1
curl -X GET \
2
'https://app.1980tic.us/api/v1/contact/by_custom_field?name=firstName&value=Muhammad%20Mahin' \
3
-H 'Authorization: Bearer {channel_token}' \
4
-H 'Content-Type: application/json'
Copied!

Respuesta: éxito (estado HTTP → 200)

1
{
2
"data": [
3
{
4
"id": "1776025372480910",
5
"custom_fields": {
6
"firstName": "Mahin",
7
"lastName": "Dar",
8
"locale": "en_GB",
9
"timezone": "5",
10
"gender": "male",
11
"phone": "123123",
12
"email": "[email protected]",
13
"customerid": "1"
14
},
15
"tags": [
16
"Blog Updates",
17
"Platform Updates"
18
],
19
"created_at": 1575618542
20
}
21
],
22
"links": {
23
"first": "http://app.1980TIC.com/api/v1/contact/by_custom_field?page=1",
24
"last": "http://app.1980TIC.com/api/v1/contact/by_custom_field?page=1",
25
"prev": null,
26
"next": null
27
},
28
"meta": {
29
"current_page": 1,
30
"from": 1,
31
"last_page": 1,
32
"path": "http://app.1980TIC.com/api/v1/contact/by_custom_field",
33
"per_page": 10,
34
"to": 1,
35
"total": 1
36
}
37
}
Copied!

Obtener contacto por ID

Esta solicitud devuelve un único objeto de contacto.
1
/v1/contact/{contact_id}
Copied!

Ejemplo de solicitud GET

1
curl -X GET \
2
https://app.1980tic.us/api/v1/contact/1776025372480910 \
3
-H 'Autorización: Portador {channel_token}' \
4
-H 'Tipo de contenido: aplicación / json' \
Copied!

Respuesta: éxito (estado HTTP → 200)

1
{
2
"data": {
3
"id": "1776025372480910",
4
"custom_fields": {
5
"firstName": "Mahin",
6
"lastName": "Dar",
7
"locale": "en_GB",
8
"timezone": "5",
9
"gender": "male",
10
"phone": "123123",
11
"email": "[email protected]",
12
"customerid": "1"
13
},
14
"tags": [
15
"Blog Updates",
16
"Platform Updates"
17
],
18
"created_at": 1575618542
19
}
20
}
Copied!

Actualizar contacto por ID

Esta solicitud actualiza un valor de campo personalizado de contacto.
1
/v1/contact/{contact_id}
Copied!

Ejemplo de solicitud PUT

1
curl -X PUT \
2
https://app.1980tic.us/api/v1/contact/1776025372480910 \
3
-H 'Authorization: Bearer {channel_token}' \
4
-H 'Content-Type: application/json' \
5
-d '{
6
"custom_fields": [
7
{
8
"name": "firstName",
9
"value": "Muhammad Mahin"
10
},
11
{
12
"name": "lastName",
13
"value": "Dar"
14
}
15
]
16
}'
Copied!

Respuesta: éxito (estado HTTP → 200)

1
{
2
"data": {
3
"id": "cus_112233344555"
4
}
5
}
Copied!

Limitaciones

Máximo 30 campos actualizados por solicitud.
Tenga en cuenta que en el caso del canal Viber, debido a una cierta limitación, la ID de contacto debe proporcionarse en un formato codificado en Base64 .

Agregar etiqueta por ID

Esta solicitud agrega etiquetas para un contacto.
1
/v1/contact/{contact_id}/tags
Copied!

Ejemplo de solicitud POST

1
curl -X POST \
2
https://app.1980tic.us/api/v1/contact/1776025372480910/tags \
3
-H 'Authorization: Bearer {channel_token}' \
4
-H 'Content-Type: application/json' \
5
-d '{
6
"tags": [
7
"Blog Updates",
8
"Platform Updates"
9
]
10
}'
Copied!

Respuesta: éxito (estado HTTP → 200)

1
{
2
"status": "success",
3
"message": "Contact Tags have been added successfully.",
4
"data": []
5
}
Copied!

Limitaciones

Máximo 10 etiquetas agregadas por solicitud.

Eliminar etiqueta por ID

Esta solicitud elimina las etiquetas de un contacto.
1
/v1/contact/{contact_id}/tags
Copied!

Ejemplo de solicitud DELETE

1
curl -X DELETE \
2
https://app.1980tic.us/api/v1/contact/1776025372480910/tags \
3
-H 'Authorization: Bearer {channel_token}' \
4
-H 'Content-Type: application/json' \
5
-d '{
6
"tags": [
7
"Blog Updates",
8
"Platform Updates"
9
]
10
}'
Copied!

Respuesta: éxito (estado HTTP → 200)

1
{
2
"status": "success",
3
"message": "Contact Tags deleted successfully.",
4
"data": []
5
}
Copied!

Limitaciones

Máximo de 10 etiquetas eliminadas por solicitud.
Tenga en cuenta que en el caso del canal Viber, debido a una cierta limitación, la ID de contacto debe proporcionarse en un formato codificado en Base64.

Crear contacto

Esta solicitud crea un contacto y establece valores para sus campos personalizados.
1
/v1/contact
Copied!

Ejemplo de solicitud GET

1
curl -X POST \
2
https://app.1980tic.us/api/v1/contact/ \
3
-H 'Authorization: Bearer {channel_api_token}' \
4
-H 'Content-Type: application/json' \
5
-d '{
6
"custom_fields": [
7
{
8
"name": "phone",
9
"value": "03244077087"
10
},
11
{
12
"name": "firstName",
13
"value": "Muhammad Mahin"
14
},
15
{
16
"name": "lastName",
17
"value": "Dar"
18
}
19
]
20
}'
Copied!

Respuesta: éxito (estado HTTP → 200)

1
{
2
"data": {
3
"id": "cus_112233344555"
4
}
5
}
Copied!

Códigos de error

No autorizado (estado HTTP → 401)

1
{
2
"status": "error",
3
"message": "API Token is invalid.",
4
"data": []
5
}
Copied!

Demasiadas solicitudes (estado HTTP → 429)

1
{
2
"status": "error",
3
"message": "Too many requests",
4
"data": []
5
}
Copied!

Método no permitido (estado HTTP → 405)

1
{
2
"status": "error",
3
"message": "405 Method Not Allowed.",
4
"data": []
5
}
Copied!

General (Estado HTTP → 403)

1
{
2
"status": "error",
3
"message": "Message String",
4
"data": []
5
}
Copied!

Limitaciones

Máximo 30 campos creados por solicitud.
Última actualización 9mo ago