Criar conversa com identificação flexível de usuários
curl --request POST \
--url https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/conversations \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"participants": {
"externals": [
{
"identifier": "john.doe@example.com",
"identifierType": "EMAIL",
"messageProviderType": "WHATSAPP",
"providerChannelId": "<string>",
"brandId": "<string>"
}
],
"internals": [
{
"identifier": "john.doe@example.com",
"identifierType": "EMAIL"
}
]
},
"name": "Bridge Support Team",
"status": "ACTIVE",
"teamId": "9fd1468d-e5ca-4ba3-98d1-13017e6f3808",
"onboardingTemplates": [
{
"templateId": "4061e74e-f6fe-4072-a760-3aec0b64f7a6",
"parameters": {
"delivery_date": "3 de octubre",
"order_number": "A-10492"
}
}
]
}
'import requests
url = "https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/conversations"
payload = {
"participants": {
"externals": [
{
"identifier": "john.doe@example.com",
"identifierType": "EMAIL",
"messageProviderType": "WHATSAPP",
"providerChannelId": "<string>",
"brandId": "<string>"
}
],
"internals": [
{
"identifier": "john.doe@example.com",
"identifierType": "EMAIL"
}
]
},
"name": "Bridge Support Team",
"status": "ACTIVE",
"teamId": "9fd1468d-e5ca-4ba3-98d1-13017e6f3808",
"onboardingTemplates": [
{
"templateId": "4061e74e-f6fe-4072-a760-3aec0b64f7a6",
"parameters": {
"delivery_date": "3 de octubre",
"order_number": "A-10492"
}
}
]
}
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({
participants: {
externals: [
{
identifier: 'john.doe@example.com',
identifierType: 'EMAIL',
messageProviderType: 'WHATSAPP',
providerChannelId: '<string>',
brandId: '<string>'
}
],
internals: [{identifier: 'john.doe@example.com', identifierType: 'EMAIL'}]
},
name: 'Bridge Support Team',
status: 'ACTIVE',
teamId: '9fd1468d-e5ca-4ba3-98d1-13017e6f3808',
onboardingTemplates: [
{
templateId: '4061e74e-f6fe-4072-a760-3aec0b64f7a6',
parameters: {delivery_date: '3 de octubre', order_number: 'A-10492'}
}
]
})
};
fetch('https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/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://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/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([
'participants' => [
'externals' => [
[
'identifier' => 'john.doe@example.com',
'identifierType' => 'EMAIL',
'messageProviderType' => 'WHATSAPP',
'providerChannelId' => '<string>',
'brandId' => '<string>'
]
],
'internals' => [
[
'identifier' => 'john.doe@example.com',
'identifierType' => 'EMAIL'
]
]
],
'name' => 'Bridge Support Team',
'status' => 'ACTIVE',
'teamId' => '9fd1468d-e5ca-4ba3-98d1-13017e6f3808',
'onboardingTemplates' => [
[
'templateId' => '4061e74e-f6fe-4072-a760-3aec0b64f7a6',
'parameters' => [
'delivery_date' => '3 de octubre',
'order_number' => 'A-10492'
]
]
]
]),
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://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/conversations"
payload := strings.NewReader("{\n \"participants\": {\n \"externals\": [\n {\n \"identifier\": \"john.doe@example.com\",\n \"identifierType\": \"EMAIL\",\n \"messageProviderType\": \"WHATSAPP\",\n \"providerChannelId\": \"<string>\",\n \"brandId\": \"<string>\"\n }\n ],\n \"internals\": [\n {\n \"identifier\": \"john.doe@example.com\",\n \"identifierType\": \"EMAIL\"\n }\n ]\n },\n \"name\": \"Bridge Support Team\",\n \"status\": \"ACTIVE\",\n \"teamId\": \"9fd1468d-e5ca-4ba3-98d1-13017e6f3808\",\n \"onboardingTemplates\": [\n {\n \"templateId\": \"4061e74e-f6fe-4072-a760-3aec0b64f7a6\",\n \"parameters\": {\n \"delivery_date\": \"3 de octubre\",\n \"order_number\": \"A-10492\"\n }\n }\n ]\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://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/conversations")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"participants\": {\n \"externals\": [\n {\n \"identifier\": \"john.doe@example.com\",\n \"identifierType\": \"EMAIL\",\n \"messageProviderType\": \"WHATSAPP\",\n \"providerChannelId\": \"<string>\",\n \"brandId\": \"<string>\"\n }\n ],\n \"internals\": [\n {\n \"identifier\": \"john.doe@example.com\",\n \"identifierType\": \"EMAIL\"\n }\n ]\n },\n \"name\": \"Bridge Support Team\",\n \"status\": \"ACTIVE\",\n \"teamId\": \"9fd1468d-e5ca-4ba3-98d1-13017e6f3808\",\n \"onboardingTemplates\": [\n {\n \"templateId\": \"4061e74e-f6fe-4072-a760-3aec0b64f7a6\",\n \"parameters\": {\n \"delivery_date\": \"3 de octubre\",\n \"order_number\": \"A-10492\"\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/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 \"participants\": {\n \"externals\": [\n {\n \"identifier\": \"john.doe@example.com\",\n \"identifierType\": \"EMAIL\",\n \"messageProviderType\": \"WHATSAPP\",\n \"providerChannelId\": \"<string>\",\n \"brandId\": \"<string>\"\n }\n ],\n \"internals\": [\n {\n \"identifier\": \"john.doe@example.com\",\n \"identifierType\": \"EMAIL\"\n }\n ]\n },\n \"name\": \"Bridge Support Team\",\n \"status\": \"ACTIVE\",\n \"teamId\": \"9fd1468d-e5ca-4ba3-98d1-13017e6f3808\",\n \"onboardingTemplates\": [\n {\n \"templateId\": \"4061e74e-f6fe-4072-a760-3aec0b64f7a6\",\n \"parameters\": {\n \"delivery_date\": \"3 de octubre\",\n \"order_number\": \"A-10492\"\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234",
"workspaceId": "b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234",
"participants": {
"externals": [
{
"identifier": "ef7ee722-5f95-415a-9a98-81eeae178b11",
"identifierType": "EMAIL",
"role": "EXTERNAL",
"joinedAt": "2004-04-10T09:00:00.000Z",
"lastSeenAt": null
}
],
"internals": [
{
"identifier": "ef7ee722-5f95-415a-9a98-81eeae178b11",
"identifierType": "EMAIL",
"role": "EXTERNAL",
"joinedAt": "2004-04-10T09:00:00.000Z",
"lastSeenAt": null
}
]
},
"createdAt": "2003-04-10T09:00:00.000Z",
"updatedAt": "2003-04-10T09:00:00.000Z",
"name": "Bridge Support Team",
"status": "ACTIVE"
}Criar conversa com identificação flexível de usuários
Cria uma conversa com identificação flexível de usuários.
Os usuários externos podem ser identificados por ID, e-mail ou telefone. Usuários internos só são atribuídos quando informados explicitamente; caso contrário, as conversas são distribuídas em rodízio por uma equipe ou ficam abertas para qualquer usuário interno disponível.
Quando não há uma linha livre e os Contacts têm uma conversa liberada com exatamente os participantes solicitados, essa conversa é recuperada e retornada, mantendo seu id e histórico. O name e o status da solicitação não são aplicados a ela.
POST
/
bridge
/
api
/
v1
/
workspaces
/
{workspaceId}
/
conversations
Criar conversa com identificação flexível de usuários
curl --request POST \
--url https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/conversations \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"participants": {
"externals": [
{
"identifier": "john.doe@example.com",
"identifierType": "EMAIL",
"messageProviderType": "WHATSAPP",
"providerChannelId": "<string>",
"brandId": "<string>"
}
],
"internals": [
{
"identifier": "john.doe@example.com",
"identifierType": "EMAIL"
}
]
},
"name": "Bridge Support Team",
"status": "ACTIVE",
"teamId": "9fd1468d-e5ca-4ba3-98d1-13017e6f3808",
"onboardingTemplates": [
{
"templateId": "4061e74e-f6fe-4072-a760-3aec0b64f7a6",
"parameters": {
"delivery_date": "3 de octubre",
"order_number": "A-10492"
}
}
]
}
'import requests
url = "https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/conversations"
payload = {
"participants": {
"externals": [
{
"identifier": "john.doe@example.com",
"identifierType": "EMAIL",
"messageProviderType": "WHATSAPP",
"providerChannelId": "<string>",
"brandId": "<string>"
}
],
"internals": [
{
"identifier": "john.doe@example.com",
"identifierType": "EMAIL"
}
]
},
"name": "Bridge Support Team",
"status": "ACTIVE",
"teamId": "9fd1468d-e5ca-4ba3-98d1-13017e6f3808",
"onboardingTemplates": [
{
"templateId": "4061e74e-f6fe-4072-a760-3aec0b64f7a6",
"parameters": {
"delivery_date": "3 de octubre",
"order_number": "A-10492"
}
}
]
}
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({
participants: {
externals: [
{
identifier: 'john.doe@example.com',
identifierType: 'EMAIL',
messageProviderType: 'WHATSAPP',
providerChannelId: '<string>',
brandId: '<string>'
}
],
internals: [{identifier: 'john.doe@example.com', identifierType: 'EMAIL'}]
},
name: 'Bridge Support Team',
status: 'ACTIVE',
teamId: '9fd1468d-e5ca-4ba3-98d1-13017e6f3808',
onboardingTemplates: [
{
templateId: '4061e74e-f6fe-4072-a760-3aec0b64f7a6',
parameters: {delivery_date: '3 de octubre', order_number: 'A-10492'}
}
]
})
};
fetch('https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/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://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/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([
'participants' => [
'externals' => [
[
'identifier' => 'john.doe@example.com',
'identifierType' => 'EMAIL',
'messageProviderType' => 'WHATSAPP',
'providerChannelId' => '<string>',
'brandId' => '<string>'
]
],
'internals' => [
[
'identifier' => 'john.doe@example.com',
'identifierType' => 'EMAIL'
]
]
],
'name' => 'Bridge Support Team',
'status' => 'ACTIVE',
'teamId' => '9fd1468d-e5ca-4ba3-98d1-13017e6f3808',
'onboardingTemplates' => [
[
'templateId' => '4061e74e-f6fe-4072-a760-3aec0b64f7a6',
'parameters' => [
'delivery_date' => '3 de octubre',
'order_number' => 'A-10492'
]
]
]
]),
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://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/conversations"
payload := strings.NewReader("{\n \"participants\": {\n \"externals\": [\n {\n \"identifier\": \"john.doe@example.com\",\n \"identifierType\": \"EMAIL\",\n \"messageProviderType\": \"WHATSAPP\",\n \"providerChannelId\": \"<string>\",\n \"brandId\": \"<string>\"\n }\n ],\n \"internals\": [\n {\n \"identifier\": \"john.doe@example.com\",\n \"identifierType\": \"EMAIL\"\n }\n ]\n },\n \"name\": \"Bridge Support Team\",\n \"status\": \"ACTIVE\",\n \"teamId\": \"9fd1468d-e5ca-4ba3-98d1-13017e6f3808\",\n \"onboardingTemplates\": [\n {\n \"templateId\": \"4061e74e-f6fe-4072-a760-3aec0b64f7a6\",\n \"parameters\": {\n \"delivery_date\": \"3 de octubre\",\n \"order_number\": \"A-10492\"\n }\n }\n ]\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://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/conversations")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"participants\": {\n \"externals\": [\n {\n \"identifier\": \"john.doe@example.com\",\n \"identifierType\": \"EMAIL\",\n \"messageProviderType\": \"WHATSAPP\",\n \"providerChannelId\": \"<string>\",\n \"brandId\": \"<string>\"\n }\n ],\n \"internals\": [\n {\n \"identifier\": \"john.doe@example.com\",\n \"identifierType\": \"EMAIL\"\n }\n ]\n },\n \"name\": \"Bridge Support Team\",\n \"status\": \"ACTIVE\",\n \"teamId\": \"9fd1468d-e5ca-4ba3-98d1-13017e6f3808\",\n \"onboardingTemplates\": [\n {\n \"templateId\": \"4061e74e-f6fe-4072-a760-3aec0b64f7a6\",\n \"parameters\": {\n \"delivery_date\": \"3 de octubre\",\n \"order_number\": \"A-10492\"\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/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 \"participants\": {\n \"externals\": [\n {\n \"identifier\": \"john.doe@example.com\",\n \"identifierType\": \"EMAIL\",\n \"messageProviderType\": \"WHATSAPP\",\n \"providerChannelId\": \"<string>\",\n \"brandId\": \"<string>\"\n }\n ],\n \"internals\": [\n {\n \"identifier\": \"john.doe@example.com\",\n \"identifierType\": \"EMAIL\"\n }\n ]\n },\n \"name\": \"Bridge Support Team\",\n \"status\": \"ACTIVE\",\n \"teamId\": \"9fd1468d-e5ca-4ba3-98d1-13017e6f3808\",\n \"onboardingTemplates\": [\n {\n \"templateId\": \"4061e74e-f6fe-4072-a760-3aec0b64f7a6\",\n \"parameters\": {\n \"delivery_date\": \"3 de octubre\",\n \"order_number\": \"A-10492\"\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234",
"workspaceId": "b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234",
"participants": {
"externals": [
{
"identifier": "ef7ee722-5f95-415a-9a98-81eeae178b11",
"identifierType": "EMAIL",
"role": "EXTERNAL",
"joinedAt": "2004-04-10T09:00:00.000Z",
"lastSeenAt": null
}
],
"internals": [
{
"identifier": "ef7ee722-5f95-415a-9a98-81eeae178b11",
"identifierType": "EMAIL",
"role": "EXTERNAL",
"joinedAt": "2004-04-10T09:00:00.000Z",
"lastSeenAt": null
}
]
},
"createdAt": "2003-04-10T09:00:00.000Z",
"updatedAt": "2003-04-10T09:00:00.000Z",
"name": "Bridge Support Team",
"status": "ACTIVE"
}Parâmetros de caminho
Corpo
application/json
Corpo da solicitação para criar uma conversa.
Templates ordenados para abrir a conversa. Eles substituem a sequência de abertura configurada no workspace para esta conversa, por inteiro ou apenas seu primeiro template, conforme a configuração do workspace; no segundo caso, o restante da sequência configurada ainda é enviado depois dos seus. A posição determina a ordem. Omita para manter o padrão do workspace. Cada template deve existir, pertencer ao seu workspace ou ao escopo da plataforma e, para templates de provedor do WhatsApp, estar aprovado pela Meta para a WhatsApp Business Account da linha pela qual cada participante é contatado; caso contrário, a solicitação é rejeitada e nenhuma conversa é criada. Um template cujas variáveis precisem de valores que só você pode fornecer os recebe em parameters da entrada. Se um dos templates configurados enviados depois dos seus precisar de valores que só quem chama pode fornecer, a solicitação é rejeitada com 422 BRIDGE_CONVERSATION_0608, com extra.templateId identificando esse template e extra.origin definido como WORKSPACE_CONFIGURATION. Alterar a solicitação não ajudará: peça a um administrador do workspace que altere a sequência de abertura.
Show child attributes
Show child attributes
Resposta
Resposta bem-sucedida
Corpo da resposta para os detalhes de uma conversa.
Esta página foi útil?