Login Cadastre-se

Obter arquivo de mensagem

Endpoint: GET https://croncrm.com/api/v2/messages/get-file

Método para obter a URL de download (e metadados) de um arquivo vinculado a uma mensagem.

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

apiKey

Informe sua API Key gerada na interface do CRONCRM.

Sim

String

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

access_token

access_token da mensagem que possui o arquivo

Sim

String 

GET /api/v2/messages/get-file?access_token=MSG_TOKEN
Response do request

Em caso de sucesso, retorna HTTP 200 com success true. Se access_token não for informado, retorna 422. Se a mensagem não existir ou não possuir arquivo disponível, retorna 404. 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

file_mimetype

MIME type do arquivo retornado.

String

filename

Nome do arquivo.

String

url

URL para download/visualização do arquivo.

String (URL) 

{
  "success": true,
  "file_mimetype": "image/jpeg",
  "filename": "foto_123.jpg",
  "url": "https://.../arquivo.jpg"
}
 
<?php
$apiKey = 'SEU_API_KEY';
$baseUrl = 'https://croncrm.com/api/v2/messages/get-file';

$query = [
    'access_token' => 'MSG_TOKEN',
];

$url = $baseUrl . '?' . http_build_query($query);

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPGET => true,
    CURLOPT_HTTPHEADER => [
        'apiKey: ' . $apiKey,
    ],
]);

$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 -G \
  'https://croncrm.com/api/v2/messages/get-file' \
  -H 'apiKey: SEU_API_KEY' \
  --data-urlencode 'access_token=MSG_TOKEN'