API Reference
Start conversation
Requires conversations:start. WhatsApp only. Requires approved prepared template and recipient consent; respects opt-outs. Reuse Idempotency-Key with identical input only. Keys are scoped to the tenant and target conversation. Use requestEventId with message-request status to reconcile.
POST
/
conversations
/
start
Start conversation
curl --request POST \
--url https://platform-api.visitoai.com/m2m/v1/conversations/start \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"channel": "whatsapp",
"targetChannelId": "<string>",
"phoneNumber": "<string>",
"messageText": "<string>",
"consentConfirmed": true,
"contactName": "<string>"
}
'import requests
url = "https://platform-api.visitoai.com/m2m/v1/conversations/start"
payload = {
"channel": "whatsapp",
"targetChannelId": "<string>",
"phoneNumber": "<string>",
"messageText": "<string>",
"consentConfirmed": True,
"contactName": "<string>"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
channel: 'whatsapp',
targetChannelId: '<string>',
phoneNumber: '<string>',
messageText: '<string>',
consentConfirmed: true,
contactName: '<string>'
})
};
fetch('https://platform-api.visitoai.com/m2m/v1/conversations/start', 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://platform-api.visitoai.com/m2m/v1/conversations/start",
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([
'channel' => 'whatsapp',
'targetChannelId' => '<string>',
'phoneNumber' => '<string>',
'messageText' => '<string>',
'consentConfirmed' => true,
'contactName' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$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://platform-api.visitoai.com/m2m/v1/conversations/start"
payload := strings.NewReader("{\n \"channel\": \"whatsapp\",\n \"targetChannelId\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"messageText\": \"<string>\",\n \"consentConfirmed\": true,\n \"contactName\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Authorization", "Bearer <token>")
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://platform-api.visitoai.com/m2m/v1/conversations/start")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"channel\": \"whatsapp\",\n \"targetChannelId\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"messageText\": \"<string>\",\n \"consentConfirmed\": true,\n \"contactName\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform-api.visitoai.com/m2m/v1/conversations/start")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"channel\": \"whatsapp\",\n \"targetChannelId\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"messageText\": \"<string>\",\n \"consentConfirmed\": true,\n \"contactName\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"conversationId": "<string>",
"status": "queued",
"replyId": "<string>",
"requestEventId": "<string>"
}{
"error": {
"code": "M2M_AUTH_INSUFFICIENT_SCOPE",
"message": "M2M credential does not have required scope.",
"details": {
"requiredScopes": [
"conversations:write"
],
"missingScopes": [
"conversations:write"
]
}
}
}Authorizations
Server-side tenant-scoped credential created from Build > API Keys.
Headers
Required string length:
1 - 200Body
application/json
Available options:
whatsapp Required string length:
1 - 120Required string length:
8 - 32Available options:
en_US, es_MX Required string length:
1 - 1024Available options:
true Maximum string length:
200⌘I
Start conversation
curl --request POST \
--url https://platform-api.visitoai.com/m2m/v1/conversations/start \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"channel": "whatsapp",
"targetChannelId": "<string>",
"phoneNumber": "<string>",
"messageText": "<string>",
"consentConfirmed": true,
"contactName": "<string>"
}
'import requests
url = "https://platform-api.visitoai.com/m2m/v1/conversations/start"
payload = {
"channel": "whatsapp",
"targetChannelId": "<string>",
"phoneNumber": "<string>",
"messageText": "<string>",
"consentConfirmed": True,
"contactName": "<string>"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
channel: 'whatsapp',
targetChannelId: '<string>',
phoneNumber: '<string>',
messageText: '<string>',
consentConfirmed: true,
contactName: '<string>'
})
};
fetch('https://platform-api.visitoai.com/m2m/v1/conversations/start', 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://platform-api.visitoai.com/m2m/v1/conversations/start",
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([
'channel' => 'whatsapp',
'targetChannelId' => '<string>',
'phoneNumber' => '<string>',
'messageText' => '<string>',
'consentConfirmed' => true,
'contactName' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$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://platform-api.visitoai.com/m2m/v1/conversations/start"
payload := strings.NewReader("{\n \"channel\": \"whatsapp\",\n \"targetChannelId\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"messageText\": \"<string>\",\n \"consentConfirmed\": true,\n \"contactName\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Authorization", "Bearer <token>")
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://platform-api.visitoai.com/m2m/v1/conversations/start")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"channel\": \"whatsapp\",\n \"targetChannelId\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"messageText\": \"<string>\",\n \"consentConfirmed\": true,\n \"contactName\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform-api.visitoai.com/m2m/v1/conversations/start")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"channel\": \"whatsapp\",\n \"targetChannelId\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"messageText\": \"<string>\",\n \"consentConfirmed\": true,\n \"contactName\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"conversationId": "<string>",
"status": "queued",
"replyId": "<string>",
"requestEventId": "<string>"
}{
"error": {
"code": "M2M_AUTH_INSUFFICIENT_SCOPE",
"message": "M2M credential does not have required scope.",
"details": {
"requiredScopes": [
"conversations:write"
],
"missingScopes": [
"conversations:write"
]
}
}
}