Iniciar uma Jornada

curl

curl -X POST 'https://api.synergyconnect.com.br/v25.0/106540352242922/journeys/jrn_nbswy3dpeb3w64tm/runs' \
  -H "Authorization: Bearer $SYNERGY_API_KEY" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: pedido-42-a-caminho' \
  -d '{"recipient":{"wa_id":"5511999999999"}}'

JavaScript

const res = await fetch('https://api.synergyconnect.com.br/v25.0/106540352242922/journeys/jrn_nbswy3dpeb3w64tm/runs', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.SYNERGY_API_KEY}`,
    'Content-Type': 'application/json',
    'Idempotency-Key': 'pedido-42-a-caminho',
  },
  body: JSON.stringify({
    "recipient": {
      "wa_id": "5511999999999"
    }
  }),
});
console.log(res.status, await res.json());

Python

import os

import requests

res = requests.post(
    "https://api.synergyconnect.com.br/v25.0/106540352242922/journeys/jrn_nbswy3dpeb3w64tm/runs",
    headers={
        "Authorization": f"Bearer {os.environ['SYNERGY_API_KEY']}",
        "Idempotency-Key": "pedido-42-a-caminho",
    },
    json={
        "recipient": {
            "wa_id": "5511999999999",
        },
    },
)
print(res.status_code, res.json())

202

{
  "run_id": 4821
}

400

{
  "error": {
    "message": "(#100) Invalid parameter.",
    "type": "OAuthException",
    "code": 100,
    "error_data": {
      "messaging_product": "whatsapp",
      "details": "The Idempotency-Key header is required: 8 to 128 characters (letters, digits, _ . : -)."
    },
    "fbtrace_id": "syn-3f9a1c0b"
  }
}

Há 6 casos com este status; veja a tabela de respostas.

401

{
  "error": {
    "message": "(#190) Invalid OAuth access token.",
    "type": "OAuthException",
    "code": 190,
    "fbtrace_id": "syn-3f9a1c0b"
  }
}

403

{
  "error": {
    "message": "(#200) Permissions error: this key does not have access to this resource.",
    "type": "OAuthException",
    "code": 200,
    "fbtrace_id": "syn-3f9a1c0b"
  }
}

Há 3 casos com este status; veja a tabela de respostas.

404

{
  "error": {
    "message": "(#100) Unsupported request: object does not exist or this key cannot reach it.",
    "type": "OAuthException",
    "code": 100,
    "fbtrace_id": "syn-3f9a1c0b"
  }
}

Há 2 casos com este status; veja a tabela de respostas.

409

{
  "error": {
    "message": "(#1390001) This conversation is being handled by an agent. Bot keys cannot send to it until it is returned to the automation.",
    "type": "OAuthException",
    "code": 1390001,
    "fbtrace_id": "syn-3f9a1c0b"
  }
}

Há 3 casos com este status; veja a tabela de respostas.

422

{
  "error": {
    "message": "(#1390003) This Idempotency-Key was already used for a message to another recipient.",
    "type": "OAuthException",
    "code": 1390003,
    "fbtrace_id": "syn-3f9a1c0b"
  }
}

429

{
  "error": {
    "message": "(#130429) Rate limit hit: the number's message throughput has been reached.",
    "type": "OAuthException",
    "code": 130429,
    "fbtrace_id": "syn-3f9a1c0b"
  }
}

Há 4 casos com este status; veja a tabela de respostas.

503

{
  "error": {
    "message": "(#2) Service temporarily unavailable.",
    "type": "OAuthException",
    "code": 2,
    "fbtrace_id": "syn-3f9a1c0b"
  }
}