Send A Message
curl --request POST \
--url 'https://api.example.com/api/v1/messaging/{widget_id}?api_key=' \
--header 'Content-Type: application/json' \
--data '
{
"message": "Hi, how are you?",
"start_new_conversation": true,
"to": "919810012345"
}
'import requests
url = "https://api.example.com/api/v1/messaging/{widget_id}?api_key="
payload = {
"message": "Hi, how are you?",
"start_new_conversation": True,
"to": "919810012345"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({message: 'Hi, how are you?', start_new_conversation: true, to: '919810012345'})
};
fetch('https://api.example.com/api/v1/messaging/{widget_id}?api_key=', 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://api.example.com/api/v1/messaging/{widget_id}?api_key=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'message' => 'Hi, how are you?',
'start_new_conversation' => true,
'to' => '919810012345'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/messaging/{widget_id}?api_key="
payload := strings.NewReader("{\n \"message\": \"Hi, how are you?\",\n \"start_new_conversation\": true,\n \"to\": \"919810012345\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/messaging/{widget_id}?api_key=")
.header("Content-Type", "application/json")
.body("{\n \"message\": \"Hi, how are you?\",\n \"start_new_conversation\": true,\n \"to\": \"919810012345\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/messaging/{widget_id}?api_key=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"message\": \"Hi, how are you?\",\n \"start_new_conversation\": true,\n \"to\": \"919810012345\"\n}"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Messaging
Send A Message
To send a text message to a given telephone number or a contact
- widget_id: Widget ID to be used for initiating the call. It must be connected to WhatsApp or SMS.
- to: phone number of the recipient. should contain the country code. For ex: 16501111234
- contact_id: contact ID to whom the message is to be sent. (either to or contact_id must be given)
- message: text message to be sent.
- start_new_conversation: whether to start a new conversation or pick the latest.
POST
/
api
/
v1
/
messaging
/
{widget_id}
Send A Message
curl --request POST \
--url 'https://api.example.com/api/v1/messaging/{widget_id}?api_key=' \
--header 'Content-Type: application/json' \
--data '
{
"message": "Hi, how are you?",
"start_new_conversation": true,
"to": "919810012345"
}
'import requests
url = "https://api.example.com/api/v1/messaging/{widget_id}?api_key="
payload = {
"message": "Hi, how are you?",
"start_new_conversation": True,
"to": "919810012345"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({message: 'Hi, how are you?', start_new_conversation: true, to: '919810012345'})
};
fetch('https://api.example.com/api/v1/messaging/{widget_id}?api_key=', 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://api.example.com/api/v1/messaging/{widget_id}?api_key=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'message' => 'Hi, how are you?',
'start_new_conversation' => true,
'to' => '919810012345'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/messaging/{widget_id}?api_key="
payload := strings.NewReader("{\n \"message\": \"Hi, how are you?\",\n \"start_new_conversation\": true,\n \"to\": \"919810012345\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/messaging/{widget_id}?api_key=")
.header("Content-Type", "application/json")
.body("{\n \"message\": \"Hi, how are you?\",\n \"start_new_conversation\": true,\n \"to\": \"919810012345\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/messaging/{widget_id}?api_key=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"message\": \"Hi, how are you?\",\n \"start_new_conversation\": true,\n \"to\": \"919810012345\"\n}"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Your API KeyHTTPBearer
Your API key for authentication. You can generate it from the Settings page. Format: starts with in-.
Path Parameters
Body
application/json
Response
Successful Response
Was this page helpful?