Automatizaciones

Comentario a mensaje: a quien comente una palabra clave, se le responde con un mensaje privado (Instagram, Facebook) o en público (todas las redes).

Listar automatizaciones

GET/v1/automations

Parámetros

• profileIdstringobligatorio
• accountIdstring

Respuesta 200

data []

• idstringobligatorio
• accountIdstringobligatorio
• platformstringobligatorio
• namestringobligatorio
• triggerstringobligatorio

  Valores: comment · story_reply

• postIdstring | nullobligatorio
• inboxPostIdstring | nullobligatorio
• keywordsstring[]obligatorio
• matchModestringobligatorio

  Valores: contains · word · exact

• excludeKeywordsstring[]obligatorio
• dmMessagestring
• buttonsobject[]obligatorio
  buttons

  • typestringobligatorio

    Valores: url · postback

  • titlestringobligatorio
  • urlstring (uri)
  • payloadstring
• commentReplystring
• dmDelaySecondsinteger

  máx. 9.007.199.254.740.991

• repeatstringobligatorio

  Valores: once · every_comment

• likeCommentbooleanobligatorio
• hideCommentbooleanobligatorio
• activebooleanobligatorio
• statsobjectobligatorio
  stats

  • triggeredintegerobligatorio

    máx. 9.007.199.254.740.991

  • dmsSentintegerobligatorio

    máx. 9.007.199.254.740.991

  • dmsFailedintegerobligatorio

    máx. 9.007.199.254.740.991

  • uniqueContactsintegerobligatorio

    máx. 9.007.199.254.740.991

  • linkClicksintegerobligatorio

    máx. 9.007.199.254.740.991

• createdAtstring (date-time)

curl

curl "https://api.usecrier.com/v1/automations" \
  -H "Authorization: Bearer $CRIER_API_KEY"

Node

const res = await fetch('https://api.usecrier.com/v1/automations', {
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
  },
});
const { data } = await res.json();

Python

import os, requests

res = requests.get(
    "https://api.usecrier.com/v1/automations",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
)
data = res.json()["data"]

Crear una automatización

POST/v1/automations

En Instagram y Facebook envía dmMessage (con hasta 3 botones) a quien comente una palabra clave; en TikTok, Threads, LinkedIn y YouTube publica commentReply. Sin publicación, vigila todas las de la cuenta.

Cuerpo

• namestringobligatorio

  máx. 100

• triggerstring

  story_reply: respuestas a una story de Instagram.

  Valores: comment · story_replyPor defecto: "comment"

• postIdstring | null

  Una publicación de Crier que vigilar.

• inboxPostIdstring | null

  O una publicación tal como la lista GET /v1/inbox/posts. Ninguna: todas.

• keywordsstring[]

  Vacío: cualquier comentario la activa.

  Por defecto: []máx. 50 elementos

• matchModestring

  Valores: contains · word · exactPor defecto: "contains"

• excludeKeywordsstring[]

  Por defecto: []máx. 50 elementos

• dmMessagestring

  Mensaje privado a quien comenta. Solo Instagram y Facebook, y obligatorio en ellas.

  máx. 1000

• buttonsobject[]

  Hasta 3 botones bajo el mensaje.

  Por defecto: []máx. 3 elementos

  buttons

  • typestringobligatorio

    Valores: url · postback

  • titlestringobligatorio

    máx. 20

  • urlstring (uri)
  • payloadstring

    máx. 1000

• commentReplystring

  Respuesta pública al comentario. Obligatoria en TikTok, Threads, LinkedIn y YouTube.

  máx. 2000

• dmDelaySecondsinteger

  máx. 86.400

• repeatstring

  once: un mensaje por persona.

  Valores: once · every_commentPor defecto: "once"

• likeCommentboolean

  Por defecto: false

• hideCommentboolean

  Por defecto: false

• activeboolean

  Por defecto: true

• accountIdstringobligatorio

  Cuenta de Instagram, Facebook, TikTok, Threads, LinkedIn o YouTube.

Respuesta 201

data

• idstringobligatorio
• accountIdstringobligatorio
• platformstringobligatorio
• namestringobligatorio
• triggerstringobligatorio

  Valores: comment · story_reply

• postIdstring | nullobligatorio
• inboxPostIdstring | nullobligatorio
• keywordsstring[]obligatorio
• matchModestringobligatorio

  Valores: contains · word · exact

• excludeKeywordsstring[]obligatorio
• dmMessagestring
• buttonsobject[]obligatorio
  buttons

  • typestringobligatorio

    Valores: url · postback

  • titlestringobligatorio
  • urlstring (uri)
  • payloadstring
• commentReplystring
• dmDelaySecondsinteger

  máx. 9.007.199.254.740.991

• repeatstringobligatorio

  Valores: once · every_comment

• likeCommentbooleanobligatorio
• hideCommentbooleanobligatorio
• activebooleanobligatorio
• statsobjectobligatorio
  stats

  • triggeredintegerobligatorio

    máx. 9.007.199.254.740.991

  • dmsSentintegerobligatorio

    máx. 9.007.199.254.740.991

  • dmsFailedintegerobligatorio

    máx. 9.007.199.254.740.991

  • uniqueContactsintegerobligatorio

    máx. 9.007.199.254.740.991

  • linkClicksintegerobligatorio

    máx. 9.007.199.254.740.991

• createdAtstring (date-time)

curl

curl -X POST "https://api.usecrier.com/v1/automations" \
  -H "Authorization: Bearer $CRIER_API_KEY"

Node

const res = await fetch('https://api.usecrier.com/v1/automations', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
  },
});
const { data } = await res.json();

Python

import os, requests

res = requests.post(
    "https://api.usecrier.com/v1/automations",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
)
data = res.json()["data"]

Ver una automatización

GET/v1/automations/{id}

Parámetros

• idstringobligatorio

Respuesta 200

data

• idstringobligatorio
• accountIdstringobligatorio
• platformstringobligatorio
• namestringobligatorio
• triggerstringobligatorio

  Valores: comment · story_reply

• postIdstring | nullobligatorio
• inboxPostIdstring | nullobligatorio
• keywordsstring[]obligatorio
• matchModestringobligatorio

  Valores: contains · word · exact

• excludeKeywordsstring[]obligatorio
• dmMessagestring
• buttonsobject[]obligatorio
  buttons

  • typestringobligatorio

    Valores: url · postback

  • titlestringobligatorio
  • urlstring (uri)
  • payloadstring
• commentReplystring
• dmDelaySecondsinteger

  máx. 9.007.199.254.740.991

• repeatstringobligatorio

  Valores: once · every_comment

• likeCommentbooleanobligatorio
• hideCommentbooleanobligatorio
• activebooleanobligatorio
• statsobjectobligatorio
  stats

  • triggeredintegerobligatorio

    máx. 9.007.199.254.740.991

  • dmsSentintegerobligatorio

    máx. 9.007.199.254.740.991

  • dmsFailedintegerobligatorio

    máx. 9.007.199.254.740.991

  • uniqueContactsintegerobligatorio

    máx. 9.007.199.254.740.991

  • linkClicksintegerobligatorio

    máx. 9.007.199.254.740.991

• createdAtstring (date-time)

curl

curl "https://api.usecrier.com/v1/automations/aut_6r3e9w" \
  -H "Authorization: Bearer $CRIER_API_KEY"

Node

const res = await fetch('https://api.usecrier.com/v1/automations/aut_6r3e9w', {
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
  },
});
const { data } = await res.json();

Python

import os, requests

res = requests.get(
    "https://api.usecrier.com/v1/automations/aut_6r3e9w",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
)
data = res.json()["data"]

Editar o pausar una automatización

PATCH/v1/automations/{id}

Lo que no envíes se mantiene. active: false la pausa.

Parámetros

• idstringobligatorio

Cuerpo

• namestring

  máx. 100

• triggerstring

  story_reply: respuestas a una story de Instagram.

  Valores: comment · story_reply

• postIdstring | null

  Una publicación de Crier que vigilar.

• inboxPostIdstring | null

  O una publicación tal como la lista GET /v1/inbox/posts. Ninguna: todas.

• keywordsstring[]

  Vacío: cualquier comentario la activa.

  máx. 50 elementos

• matchModestring

  Valores: contains · word · exact

• excludeKeywordsstring[]

  máx. 50 elementos

• dmMessagestring

  Mensaje privado a quien comenta. Solo Instagram y Facebook, y obligatorio en ellas.

  máx. 1000

• buttonsobject[]

  Hasta 3 botones bajo el mensaje.

  máx. 3 elementos

  buttons

  • typestringobligatorio

    Valores: url · postback

  • titlestringobligatorio

    máx. 20

  • urlstring (uri)
  • payloadstring

    máx. 1000

• commentReplystring

  Respuesta pública al comentario. Obligatoria en TikTok, Threads, LinkedIn y YouTube.

  máx. 2000

• dmDelaySecondsinteger

  máx. 86.400

• repeatstring

  once: un mensaje por persona.

  Valores: once · every_comment

• likeCommentboolean
• hideCommentboolean
• activeboolean

Respuesta 200

data

• idstringobligatorio
• accountIdstringobligatorio
• platformstringobligatorio
• namestringobligatorio
• triggerstringobligatorio

  Valores: comment · story_reply

• postIdstring | nullobligatorio
• inboxPostIdstring | nullobligatorio
• keywordsstring[]obligatorio
• matchModestringobligatorio

  Valores: contains · word · exact

• excludeKeywordsstring[]obligatorio
• dmMessagestring
• buttonsobject[]obligatorio
  buttons

  • typestringobligatorio

    Valores: url · postback

  • titlestringobligatorio
  • urlstring (uri)
  • payloadstring
• commentReplystring
• dmDelaySecondsinteger

  máx. 9.007.199.254.740.991

• repeatstringobligatorio

  Valores: once · every_comment

• likeCommentbooleanobligatorio
• hideCommentbooleanobligatorio
• activebooleanobligatorio
• statsobjectobligatorio
  stats

  • triggeredintegerobligatorio

    máx. 9.007.199.254.740.991

  • dmsSentintegerobligatorio

    máx. 9.007.199.254.740.991

  • dmsFailedintegerobligatorio

    máx. 9.007.199.254.740.991

  • uniqueContactsintegerobligatorio

    máx. 9.007.199.254.740.991

  • linkClicksintegerobligatorio

    máx. 9.007.199.254.740.991

• createdAtstring (date-time)

curl

curl -X PATCH "https://api.usecrier.com/v1/automations/aut_6r3e9w" \
  -H "Authorization: Bearer $CRIER_API_KEY"

Node

const res = await fetch('https://api.usecrier.com/v1/automations/aut_6r3e9w', {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
  },
});
const { data } = await res.json();

Python

import os, requests

res = requests.patch(
    "https://api.usecrier.com/v1/automations/aut_6r3e9w",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
)
data = res.json()["data"]

Borrar una automatización

DELETE/v1/automations/{id}

Parámetros

• idstringobligatorio

Respuesta 204

Sin contenido

curl

curl -X DELETE "https://api.usecrier.com/v1/automations/aut_6r3e9w" \
  -H "Authorization: Bearer $CRIER_API_KEY"

Node

await fetch('https://api.usecrier.com/v1/automations/aut_6r3e9w', {
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
  },
});

Python

import os, requests

requests.delete(
    "https://api.usecrier.com/v1/automations/aut_6r3e9w",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
)

Qué ha hecho una automatización

GET/v1/automations/{id}/logs

Cada comentario que la activó, el más reciente primero, con el resultado del mensaje.

Parámetros

• idstringobligatorio
• skipinteger

  máx. 9.007.199.254.740.991

• limitinteger

  máx. 100

Respuesta 200

data

• itemsobject[]obligatorio
  items

  • idstringobligatorio
  • commenterobjectobligatorio
    commenter

    • namestring
    • usernamestring
  • commentTextstring
  • statusstringobligatorio

    Valores: pending · sent · failed · skipped · gated

  • errorstring
  • replyStatusstring
  • clickedbooleanobligatorio
  • createdAtstring (date-time)obligatorio
• totalintegerobligatorio

  máx. 9.007.199.254.740.991

curl

curl "https://api.usecrier.com/v1/automations/aut_6r3e9w/logs" \
  -H "Authorization: Bearer $CRIER_API_KEY"

Node

const res = await fetch('https://api.usecrier.com/v1/automations/aut_6r3e9w/logs', {
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
  },
});
const { data } = await res.json();

Python

import os, requests

res = requests.get(
    "https://api.usecrier.com/v1/automations/aut_6r3e9w/logs",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
)
data = res.json()["data"]