curl --request POST \
--url https://api-v3.aui.io/apollo-api/messaging/v1/channels/{channel}/threads \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"phone_number": "<string>",
"thread_id": "<string>",
"user_id": "<string>",
"text": "<string>",
"agent_display_name": "<string>"
}
'import requests
url = "https://api-v3.aui.io/apollo-api/messaging/v1/channels/{channel}/threads"
payload = {
"phone_number": "<string>",
"thread_id": "<string>",
"user_id": "<string>",
"text": "<string>",
"agent_display_name": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
phone_number: '<string>',
thread_id: '<string>',
user_id: '<string>',
text: '<string>',
agent_display_name: '<string>'
})
};
fetch('https://api-v3.aui.io/apollo-api/messaging/v1/channels/{channel}/threads', 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-v3.aui.io/apollo-api/messaging/v1/channels/{channel}/threads",
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([
'phone_number' => '<string>',
'thread_id' => '<string>',
'user_id' => '<string>',
'text' => '<string>',
'agent_display_name' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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-v3.aui.io/apollo-api/messaging/v1/channels/{channel}/threads"
payload := strings.NewReader("{\n \"phone_number\": \"<string>\",\n \"thread_id\": \"<string>\",\n \"user_id\": \"<string>\",\n \"text\": \"<string>\",\n \"agent_display_name\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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://api-v3.aui.io/apollo-api/messaging/v1/channels/{channel}/threads")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"phone_number\": \"<string>\",\n \"thread_id\": \"<string>\",\n \"user_id\": \"<string>\",\n \"text\": \"<string>\",\n \"agent_display_name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-v3.aui.io/apollo-api/messaging/v1/channels/{channel}/threads")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"phone_number\": \"<string>\",\n \"thread_id\": \"<string>\",\n \"user_id\": \"<string>\",\n \"text\": \"<string>\",\n \"agent_display_name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"thread_id": "<string>",
"message_sid": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": [
{
"message": "<string>",
"field": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": [
{
"message": "<string>",
"field": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": [
{
"message": "<string>",
"field": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": [
{
"message": "<string>",
"field": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": [
{
"message": "<string>",
"field": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": [
{
"message": "<string>",
"field": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": [
{
"message": "<string>",
"field": "<string>"
}
]
}
}Start a channel thread
Send the opening message on channel and bind the recipient’s phone
number to a conversation thread. The agent is identified by your access
token. Omit thread_id to start a new thread (its id is returned); pass
it to continue an existing one. Template fields apply to WhatsApp only.
curl --request POST \
--url https://api-v3.aui.io/apollo-api/messaging/v1/channels/{channel}/threads \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"phone_number": "<string>",
"thread_id": "<string>",
"user_id": "<string>",
"text": "<string>",
"agent_display_name": "<string>"
}
'import requests
url = "https://api-v3.aui.io/apollo-api/messaging/v1/channels/{channel}/threads"
payload = {
"phone_number": "<string>",
"thread_id": "<string>",
"user_id": "<string>",
"text": "<string>",
"agent_display_name": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
phone_number: '<string>',
thread_id: '<string>',
user_id: '<string>',
text: '<string>',
agent_display_name: '<string>'
})
};
fetch('https://api-v3.aui.io/apollo-api/messaging/v1/channels/{channel}/threads', 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-v3.aui.io/apollo-api/messaging/v1/channels/{channel}/threads",
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([
'phone_number' => '<string>',
'thread_id' => '<string>',
'user_id' => '<string>',
'text' => '<string>',
'agent_display_name' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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-v3.aui.io/apollo-api/messaging/v1/channels/{channel}/threads"
payload := strings.NewReader("{\n \"phone_number\": \"<string>\",\n \"thread_id\": \"<string>\",\n \"user_id\": \"<string>\",\n \"text\": \"<string>\",\n \"agent_display_name\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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://api-v3.aui.io/apollo-api/messaging/v1/channels/{channel}/threads")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"phone_number\": \"<string>\",\n \"thread_id\": \"<string>\",\n \"user_id\": \"<string>\",\n \"text\": \"<string>\",\n \"agent_display_name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-v3.aui.io/apollo-api/messaging/v1/channels/{channel}/threads")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"phone_number\": \"<string>\",\n \"thread_id\": \"<string>\",\n \"user_id\": \"<string>\",\n \"text\": \"<string>\",\n \"agent_display_name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"thread_id": "<string>",
"message_sid": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": [
{
"message": "<string>",
"field": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": [
{
"message": "<string>",
"field": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": [
{
"message": "<string>",
"field": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": [
{
"message": "<string>",
"field": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": [
{
"message": "<string>",
"field": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": [
{
"message": "<string>",
"field": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": [
{
"message": "<string>",
"field": "<string>"
}
]
}
}Authorizations
Access token from POST /management/v1/auth/token (publishable-key exchange) or a login session. Publishable-key tokens are agent-scoped and serve the messaging surface; login tokens also serve management.
Path Parameters
Channel id: 'whatsapp' or 'sms'.
Body
Start (or continue) an outbound-first thread on a channel — the agent is
identified by your access token. thread_id is optional: present ->
continue that thread; absent -> a new thread is created and its id returned.
Recipient phone number in E.164 (e.g. +14155551234).
When set, continue this thread instead of creating a new one.
^[0-9a-fA-F]{24}$User id for a new thread; defaults to the phone's digits.
Opener body for non-template channels (SMS). Ignored by WhatsApp (uses templates).
WhatsApp only: bound to template variable {{1}}.