Get Chatwoot sync progress

curl --request GET \
  --url http://localhost:3000/chatwoot/sync/status \
  --header 'Authorization: Basic <encoded-value>'

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('http://localhost:3000/chatwoot/sync/status', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "3000",
  CURLOPT_URL => "http://localhost:3000/chatwoot/sync/status",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:3000/chatwoot/sync/status"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("http://localhost:3000/chatwoot/sync/status")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body

{
  "status": 200,
  "code": "SUCCESS",
  "message": "Sync status retrieved",
  "results": {
    "device_id": "my-device-id",
    "status": "running",
    "total_chats": 10,
    "synced_chats": 5,
    "total_messages": 100,
    "synced_messages": 50,
    "failed_messages": 2,
    "current_chat": "628123456789@s.whatsapp.net",
    "started_at": "2023-11-07T05:31:56Z",
    "completed_at": "2023-11-07T05:31:56Z",
    "error": "<string>"
  }
}

{
  "code": 400,
  "message": "field cannot be blank",
  "results": null
}

GET

chatwoot

sync

status

Get Chatwoot sync progress

curl --request GET \
  --url http://localhost:3000/chatwoot/sync/status \
  --header 'Authorization: Basic <encoded-value>'

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('http://localhost:3000/chatwoot/sync/status', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "3000",
  CURLOPT_URL => "http://localhost:3000/chatwoot/sync/status",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:3000/chatwoot/sync/status"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("http://localhost:3000/chatwoot/sync/status")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body

{
  "status": 200,
  "code": "SUCCESS",
  "message": "Sync status retrieved",
  "results": {
    "device_id": "my-device-id",
    "status": "running",
    "total_chats": 10,
    "synced_chats": 5,
    "total_messages": 100,
    "synced_messages": 50,
    "failed_messages": 2,
    "current_chat": "628123456789@s.whatsapp.net",
    "started_at": "2023-11-07T05:31:56Z",
    "completed_at": "2023-11-07T05:31:56Z",
    "error": "<string>"
  }
}

{
  "code": 400,
  "message": "field cannot be blank",
  "results": null
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

device_id

string

Device ID to check sync status for

Response

Sync status retrieved

status

integer

Example:

200

code

string

Example:

"SUCCESS"

message

string

Example:

"Sync status retrieved"

results

object

Show child attributes

WhatsApp API

Overview

Client Examples

Get Chatwoot sync progress

Authorizations

Query Parameters

Response