Crear conversación con identificación flexible de usuarios
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"
}Crear conversación con identificación flexible de usuarios
Crea una conversación con identificación flexible de usuarios.
Los usuarios externos pueden identificarse por ID, correo electrónico o teléfono. Los usuarios internos solo se asignan cuando se indican explícitamente; de lo contrario, las conversaciones se asignan por turnos mediante un equipo o quedan abiertas para cualquier usuario interno disponible.
Cuando no hay una línea libre y los Contacts tienen una conversación liberada con exactamente los participantes solicitados, se recupera y devuelve esa conversación, conservando su id e historial. No se le aplican el name ni el status de la solicitud.
POST
/
bridge
/
api
/
v1
/
workspaces
/
{workspaceId}
/
conversations
Crear conversación con identificación flexible de usuarios
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 ruta
Cuerpo
application/json
Cuerpo de la solicitud para crear una conversación.
Plantillas ordenadas con las que abrir la conversación. Reemplazan la secuencia de inicio configurada en el workspace para esta conversación, en su totalidad o solo su primera plantilla, según la configuración del workspace; en el segundo caso, el resto de la secuencia configurada se envía después de las tuyas. La posición determina el orden. Omite este campo para conservar el valor predeterminado del workspace. Cada plantilla debe existir, pertenecer a tu workspace o al ámbito de la plataforma y, para plantillas de proveedor de WhatsApp, estar aprobada por Meta para la WhatsApp Business Account de la línea por la que se contacta a cada participante; de lo contrario, se rechaza la solicitud y no se crea ninguna conversación. Una plantilla cuyas variables necesiten valores que solo tú puedas proporcionar los recibe en los parameters de la entrada. Si una de las plantillas configuradas que se envían después de las tuyas necesita valores que solo pueda proporcionar quien llama, la solicitud se rechaza con 422 BRIDGE_CONVERSATION_0608, con extra.templateId identificando esa plantilla y extra.origin establecido en WORKSPACE_CONFIGURATION. Cambiar la solicitud no ayudará: pide a un administrador del workspace que cambie la secuencia de inicio.
Show child attributes
Show child attributes
Respuesta
Respuesta satisfactoria
Cuerpo de respuesta para los detalles de una conversación.
¿Esta página le ayudó?