Skip to main content
POST
/
api
/
v1
/
conversations
/
cURL
curl --request POST \
  --url https://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/conversations/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "toNumber": "<string>",
  "fromNumber": "<string>",
  "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "phoneNumber": "<string>"
}
'
import requests

url = "https://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/conversations/"

payload = {
"toNumber": "<string>",
"fromNumber": "<string>",
"agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"phoneNumber": "<string>"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
toNumber: '<string>',
fromNumber: '<string>',
agentId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
phoneNumber: '<string>'
})
};

fetch('https://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/conversations/', 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://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/conversations/",
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([
'toNumber' => '<string>',
'fromNumber' => '<string>',
'agentId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'phoneNumber' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-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://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/conversations/"

payload := strings.NewReader("{\n \"toNumber\": \"<string>\",\n \"fromNumber\": \"<string>\",\n \"agentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"phoneNumber\": \"<string>\"\n}")

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

req.Header.Add("X-API-Key", "<api-key>")
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://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/conversations/")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"toNumber\": \"<string>\",\n \"fromNumber\": \"<string>\",\n \"agentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"phoneNumber\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/conversations/")

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"toNumber\": \"<string>\",\n \"fromNumber\": \"<string>\",\n \"agentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"phoneNumber\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "contact": {
    "phoneNumber": "<string>",
    "name": "<string>"
  },
  "activeAgent": "<string>",
  "whatsappNumber": "<string>",
  "chatWindowRemainingTime": "<string>",
  "lastMessage": "<string>",
  "isHumanTakeover": "<string>",
  "active": "<string>",
  "routing": "<string>",
  "webhookId": "<string>",
  "routingOverride": "<string>"
}
This endpoint lets you create a new conversation.

Authorizations

X-API-Key
string
header
required

API key authentication. Pass your API key in the X-API-Key header.

Body

application/json
toNumber
string

The phone number of the contact to create the conversation with.

fromNumber
string

The whatsapp number to send the mesage from

agentId
string<uuid>

The ID of the agent to start the conversation with. If this is a new agent for this conversation, it will be a trigger a new session with the agent.

message
object
phoneNumber
string

This has been deprecated. Use toNumber instead.

Response

201 - application/json
id
string<uuid>
required
read-only
contact
object
required
activeAgent
string
required
read-only
whatsappNumber
string
required
read-only
chatWindowRemainingTime
string
required
read-only
lastMessage
string
required
read-only
isHumanTakeover
string
required
read-only
active
string
required
read-only
routing
string
required
read-only
webhookId
string
required
read-only
routingOverride
string
required
read-only