Login Cadastre-se

Criar/Alterar conversas

Endpoint: POST https://croncrm.com/api/v2/chats/create

Crie conversas. As conversas são responsáveis por agrupar as mensagens que você envia para cada pessoa. Caso a conversa já exista, este endpoint retorna 409.

Para cada conversa você pode inserir informações importantes como nome, data de nascimento, CPF/CNPJ, e-mail, celular adicional, telefone adicional, observações e dados de endereço.

IMPORTANTE: Uma conversa possui vários outros atributos não listados aqui neste método, confira aqui a lista completa de atributos.

IMPORTANTE: Não é necessário criar uma conversa para enviar mensagens; os métodos de enviar mensagens já as criam automaticamente.

Header do request
Atributo Descrição Obrigatório Tipo

apiKey

Informe sua API Key gerada na interface do CRONCRM.

Sim

String

Body do request

IMPORTANTE: Este endpoint apenas cria conversas. Se a conversa já existir, a API retornará 409 e não realizará atualização do perfil.

Atributo Descrição Obrigatório Tipo

chat_wid

Informe o número do contato.

Sim

String

profile_name

Informe um nome para a conversa (pode ser o nome da pessoa ou qualquer outro nome).

Seus usuários poderão alterar esta informação pela interface da plataforma.

Sim

String

profile_cpf_cnpj

CPF ou CNPJ para o perfil da conversa.

Seus usuários poderão alterar esta informação pela interface da plataforma.

Não

String

profile_email

E-mail para o perfil da conversa.

Seus usuários poderão alterar esta informação pela interface da plataforma.

Não

String

profile_celular

Celular adicional para o perfil da conversa.

Seus usuários poderão alterar esta informação pela interface da plataforma.

Não

String

profile_phone

Telefone adicional para o perfil da conversa.

Seus usuários poderão alterar esta informação pela interface da plataforma.

Não

String

profile_cep

CEP do endereço para o perfil da conversa.

Seus usuários poderão alterar esta informação pela interface da plataforma.

Não

String

profile_address

Endereço para o perfil da conversa.

Seus usuários poderão alterar esta informação pela interface da plataforma.

Não

String

profile_number

Número do endereço para o perfil da conversa.

Seus usuários poderão alterar esta informação pela interface da plataforma.

Não

String

profile_neighborhood

Bairro do endereço para o perfil da conversa.

Seus usuários poderão alterar esta informação pela interface da plataforma.

Não

String

profile_complement

Complemento do endereço para o perfil da conversa.

Seus usuários poderão alterar esta informação pela interface da plataforma.

Não

String

profile_birthdate

Data de nascimento para o perfil da conversa.

Seus usuários poderão alterar esta informação pela interface da plataforma.

Não

String

profile_city_ibge

Código IBGE da cidade do endereço para o perfil da conversa.

Utilize o método Estados e Cidades → Buscar cidades para localizar o código IBGE da cidade desejada.

Seus usuários poderão alterar esta informação pela interface da plataforma.

Não

String

profile_observations

Observações para o perfil da conversa.

Seus usuários poderão alterar esta informação pela interface da plataforma.

Não

String

access_token

(Não utilizado neste endpoint)

Não

String

Exemplo de request (criar)

{
  "chat_wid": "[email protected]",
  "profile_email": "[email protected]",
  "profile_name": "Cliente Exemplo"
}
Response do request

Em caso de sucesso, retorna 201. Se chat_wid ou profile_name não forem informados, retorna 422. Se chat_wid for inválido, retorna 400. Se profile_city_ibge for informado mas não existir, retorna 422. Se a conversa já existir, retorna 409. Método incorreto retorna 405; falhas inesperadas retornam 500.

Atributo Descrição Tipo

success

Informa se a operação teve sucesso ou não.

Boolean

msg

Mensagem de retorno.

String

chat

Será retornado um array com atributos da conversa.

Confira aqui os atributos de cada conversa.

Array 

{
  "success": true,
  "msg": "Conversa salva com sucesso.",
  "chat": {
    "created": {
      "date": "2024-01-10 10:34:14",
      "timezone_type": 3,
      "timezone": "America/Sao_Paulo"
    },
    "modified": {
      "date": "2024-01-10 15:27:28",
      "timezone_type": 3,
      "timezone": "America/Sao_Paulo"
    },
    "access_token": "CHAT_TOKEN",
    "chat_wid": "[email protected]",
    "is_important": false,
    "is_business": false,
    "is_enterprise": false,
    "is_group": false,
    "is_archive": false,
    "pin": false,
    "profile_name": "Testando API 1",
    "profile_picture": null,
    "blocked": false,
    "not_chatbot": false,
    "unread": 0,
    "customer_service_status_id": 4,
    "bot_last_trigger": "",
    "last_message_access_token": null,
    "last_message_source": null,
    "last_message_type": null,
    "last_message_body": null,
    "last_message_created": "",
    "last_message_timestamp": null,
    "profile_email": "",
    "profile_phone": "",
    "profile_celular": "",
    "profile_cpf_cnpj": "",
    "profile_cep": "xxxxx-xxx",
    "profile_address": "",
    "profile_number": "",
    "profile_neighborhood": "",
    "profile_complement": "",
    "profile_city_id": 3658,
    "profile_state_id": 19,
    "profile_birthdate": "",
    "profile_observations": ""
  }
}
 
<?php
$apiKey = 'SEU_API_KEY';
$url = 'https://croncrm.com/api/v2/chats/create';

$payload = [
    'chat_wid' => '[email protected]',
    'profile_email' => '[email protected]',
    'profile_name' => 'Cliente Exemplo',
];

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => [
        'apiKey: ' . $apiKey,
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode($payload, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE),
]);

$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
$error = curl_error($ch);
curl_close($ch);

if ($error) {
    throw new RuntimeException($error);
}

echo "HTTP {$httpCode}\n";
echo $response;
?>
curl -X POST \
  'https://croncrm.com/api/v2/chats/create' \
  -H 'apiKey: SEU_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"chat_wid":"[email protected]","profile_email":"[email protected]","profile_name":"Cliente Exemplo"}'