Conversations

Restart Conversation

If this is a WhatsApp conversation it is possible to restart the conversation by calling this endpoint. A WhatsApp template message will be sent asking the customer if they want to continue the conversation. The template is a marketing message and will cost about 11 cents. This opens up a new 24 hours window for chatting as soon as the customer replies with anything (even “No”). See the “Important” hint in the description of the reply_until field in this document! The conversation must have expired before.

POST

conversations

{id}

restart

If this is a WhatsApp conversation it is possible to restart the conversation by calling this endpoint. A WhatsApp template message will be sent asking the customer if they want to continue the conversation. The template is a marketing message and will cost about 11 cents. This opens up a new 24 hours window for chatting as soon as the customer replies with anything (even "No"). See the "Important" hint in the description of the reply_until field in this document! The conversation must have expired before.

curl --request POST \
  --url https://1-some-client.some-server.healvi-chat/third-party/v1/conversations/{id}/restart \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://1-some-client.some-server.healvi-chat/third-party/v1/conversations/{id}/restart"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://1-some-client.some-server.healvi-chat/third-party/v1/conversations/{id}/restart', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://1-some-client.some-server.healvi-chat/third-party/v1/conversations/{id}/restart",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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 := "https://1-some-client.some-server.healvi-chat/third-party/v1/conversations/{id}/restart"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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("https://1-some-client.some-server.healvi-chat/third-party/v1/conversations/{id}/restart")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "data": {
    "id": 123,
    "conversation_id": 123,
    "user_id": 123,
    "contents": [
      "<unknown>"
    ],
    "agent_reaction": "<string>",
    "customer_reaction": "<string>",
    "sent_at": "2023-01-01T12:00:00Z",
    "reference": "<unknown>",
    "latest_error": {
      "id": 123,
      "message_id": 123,
      "original_message": "<string>",
      "created_at": "2023-01-01T12:00:00Z"
    },
    "whatsapp_campaign": {
      "id": 123,
      "name": "<string>"
    }
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

integer

required

Response

200 - application/json

Success

data

object

A message within a conversation.

Show child attributes

If this is a WhatsApp conversation it is possible to restart the conversation by calling this endpoint. A WhatsApp template message will be sent asking the customer if they want to continue the conversation. The template is a marketing message and will cost about 11 cents. This opens up a new 24 hours window for chatting as soon as the customer replies with anything (even "No"). See the "Important" hint in the description of the reply_until field in this document! The conversation must have expired before.

curl --request POST \
  --url https://1-some-client.some-server.healvi-chat/third-party/v1/conversations/{id}/restart \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://1-some-client.some-server.healvi-chat/third-party/v1/conversations/{id}/restart"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://1-some-client.some-server.healvi-chat/third-party/v1/conversations/{id}/restart', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://1-some-client.some-server.healvi-chat/third-party/v1/conversations/{id}/restart",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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 := "https://1-some-client.some-server.healvi-chat/third-party/v1/conversations/{id}/restart"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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("https://1-some-client.some-server.healvi-chat/third-party/v1/conversations/{id}/restart")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "data": {
    "id": 123,
    "conversation_id": 123,
    "user_id": 123,
    "contents": [
      "<unknown>"
    ],
    "agent_reaction": "<string>",
    "customer_reaction": "<string>",
    "sent_at": "2023-01-01T12:00:00Z",
    "reference": "<unknown>",
    "latest_error": {
      "id": 123,
      "message_id": 123,
      "original_message": "<string>",
      "created_at": "2023-01-01T12:00:00Z"
    },
    "whatsapp_campaign": {
      "id": 123,
      "name": "<string>"
    }
  }
}

API Documentation

Endpoint Groups

Restart Conversation

Authorizations

Path Parameters

Response