Enqueue a conversation session
curl --request POST \
--url https://messenger-public-api.cogfy.com/conversation-sessions/enqueue \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '
{
"waId": "<string>",
"phoneNumberWaId": "<string>",
"queueId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"observation": "<string>"
}
'import requests
url = "https://messenger-public-api.cogfy.com/conversation-sessions/enqueue"
payload = {
"waId": "<string>",
"phoneNumberWaId": "<string>",
"queueId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"observation": "<string>"
}
headers = {
"api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
waId: '<string>',
phoneNumberWaId: '<string>',
queueId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
observation: '<string>'
})
};
fetch('https://messenger-public-api.cogfy.com/conversation-sessions/enqueue', 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://messenger-public-api.cogfy.com/conversation-sessions/enqueue",
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([
'waId' => '<string>',
'phoneNumberWaId' => '<string>',
'queueId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'observation' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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://messenger-public-api.cogfy.com/conversation-sessions/enqueue"
payload := strings.NewReader("{\n \"waId\": \"<string>\",\n \"phoneNumberWaId\": \"<string>\",\n \"queueId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"observation\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("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://messenger-public-api.cogfy.com/conversation-sessions/enqueue")
.header("api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"waId\": \"<string>\",\n \"phoneNumberWaId\": \"<string>\",\n \"queueId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"observation\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://messenger-public-api.cogfy.com/conversation-sessions/enqueue")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"waId\": \"<string>\",\n \"phoneNumberWaId\": \"<string>\",\n \"queueId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"observation\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"conversationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "<string>",
"currentQueueId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"enqueueDate": "2023-11-07T05:31:56Z",
"ticketId": 0,
"transferObservation": "<string>"
}Conversation sessions
Enqueue a conversation session
Enqueues the open conversation session for a contact into a queue and persists the observation as transfer_observation.
POST
/
conversation-sessions
/
enqueue
Enqueue a conversation session
curl --request POST \
--url https://messenger-public-api.cogfy.com/conversation-sessions/enqueue \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '
{
"waId": "<string>",
"phoneNumberWaId": "<string>",
"queueId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"observation": "<string>"
}
'import requests
url = "https://messenger-public-api.cogfy.com/conversation-sessions/enqueue"
payload = {
"waId": "<string>",
"phoneNumberWaId": "<string>",
"queueId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"observation": "<string>"
}
headers = {
"api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
waId: '<string>',
phoneNumberWaId: '<string>',
queueId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
observation: '<string>'
})
};
fetch('https://messenger-public-api.cogfy.com/conversation-sessions/enqueue', 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://messenger-public-api.cogfy.com/conversation-sessions/enqueue",
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([
'waId' => '<string>',
'phoneNumberWaId' => '<string>',
'queueId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'observation' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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://messenger-public-api.cogfy.com/conversation-sessions/enqueue"
payload := strings.NewReader("{\n \"waId\": \"<string>\",\n \"phoneNumberWaId\": \"<string>\",\n \"queueId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"observation\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("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://messenger-public-api.cogfy.com/conversation-sessions/enqueue")
.header("api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"waId\": \"<string>\",\n \"phoneNumberWaId\": \"<string>\",\n \"queueId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"observation\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://messenger-public-api.cogfy.com/conversation-sessions/enqueue")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"waId\": \"<string>\",\n \"phoneNumberWaId\": \"<string>\",\n \"queueId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"observation\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"conversationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "<string>",
"currentQueueId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"enqueueDate": "2023-11-07T05:31:56Z",
"ticketId": 0,
"transferObservation": "<string>"
}Authorizations
Body
application/json
Contact WhatsApp ID
Minimum string length:
1Business phone WhatsApp ID
Minimum string length:
1Queue id
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Observation persisted on the session as transfer_observation
Required string length:
1 - 400Response
Session enqueued successfully
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$Required range:
-9007199254740991 <= x <= 9007199254740991