Login Cadastre-se

Enviar localização

Endpoint: POST https://croncrm.com/api/v2/messages/send-location

Método para enviar uma localização para um chat/conversa.

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

apiKey

Informe sua API Key gerada na interface do CRONCRM.

Sim

String

toTransmit

Força a transmissão imediata da mensagem, sem passar pela fila.

Use toTransmit: 1 para ativar. Para não transmitir imediatamente, omita o header ou use toTransmit: 0.

Não

String / Boolean

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

chat_wid

Chat destino (wid)

Sim

String

latitude

Latitude

Sim

Number

longitude

Longitude

Sim

Number

address

Endereço

Sim

String

account_access_token

Usuário remetente (opcional)

Não

String 

{
  "chat_wid": "[email protected]",
  "latitude": -23.5505,
  "longitude": -46.6333,
  "address": "São Paulo, SP",
  "account_access_token": "ACCOUNT_TOKEN"
}
Response do request

Em caso de sucesso, este endpoint retorna HTTP 201. Se chat_wid, latitude, longitude ou address não forem informados, retorna 422. Se chat_wid for inválido, retorna 400. Se account_access_token for informado e inválido, retorna 400. Método incorreto retorna 405; falhas inesperadas retornam 500.

Quando o header toTransmit está ativado e a transmissão ocorre com sucesso, a resposta pode incluir campos adicionais na mensagem como message_wid, message_ack, message_timestamp e shipping_status.

Atributo Descrição Tipo

success

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

Boolean

msg

Mensagem de retorno.

String

chat

Dados da conversa.

Confira aqui os atributos de uma conversa.

Array

message

Dados da mensagem criada.

Confira aqui os atributos de uma mensagem.

Array 

{
  "success": true,
  "msg": "Mensagem criada com sucesso.",
  "chat": {
    "access_token": "CHAT_TOKEN"
  },
  "message": {
    "access_token": "MSG_TOKEN",
    "message_type": "location",
    "message_latitude": -23.5,
    "message_longitude": -46.6
  }
}
 
<?php
$apiKey = 'SEU_API_KEY';
$url = 'https://croncrm.com/api/v2/messages/send-location';

$payload = [
    'chat_wid' => '[email protected]',
    'latitude' => -23.5505,
    'longitude' => -46.6333,
    'address' => 'São Paulo, SP',
    'account_access_token' => 'ACCOUNT_TOKEN',
];

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => [
        'apiKey: ' . $apiKey,
        // Opcional: 'toTransmit: 1',
        '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/messages/send-location' \
  -H 'apiKey: SEU_API_KEY' \
  -H 'toTransmit: 1' \
  -H 'Content-Type: application/json' \
  -d '{"chat_wid":"[email protected]","latitude":-23.5505,"longitude":-46.6333,"address":"São Paulo, SP","account_access_token":"ACCOUNT_TOKEN"}'