Saltar para o conteúdo principal
POST
/
webhooks
/
on-delivered
Webhook - Quando uma mensagem é entregue
curl --request POST \
  --url https://seudominio.com/webhooks/on-delivered \
  --header 'Content-Type: application/json' \
  --data '
{
  "country_code": "+57",
  "cellphone": "3176477608",
  "session_id": "d2fa98d29a2670dfa119335df1b0371720d674f1677302aba228876a",
  "conversation_id": 34820,
  "question": {
    "type": "open",
    "text": "Olá! Bom dia. Espero que esteja tudo bem. Gostaria de continuar nossa conversa para resolver todos os seus problemas e preocupações?"
  },
  "sent_at": "2021-06-22 15:19:06.473256",
  "sent_text": "Olá! Bom dia. Espero que esteja tudo bem. Gostaria de continuar nossa conversa para resolver todos os seus problemas e preocupações?",
  "user_session_keys": [],
  "delivered_at": "2021-06-22 15:19:08"
}
'
import requests

url = "https://seudominio.com/webhooks/on-delivered"

payload = {
    "country_code": "+57",
    "cellphone": "3176477608",
    "session_id": "d2fa98d29a2670dfa119335df1b0371720d674f1677302aba228876a",
    "conversation_id": 34820,
    "question": {
        "type": "open",
        "text": "Olá! Bom dia. Espero que esteja tudo bem. Gostaria de continuar nossa conversa para resolver todos os seus problemas e preocupações?"
    },
    "sent_at": "2021-06-22 15:19:06.473256",
    "sent_text": "Olá! Bom dia. Espero que esteja tudo bem. Gostaria de continuar nossa conversa para resolver todos os seus problemas e preocupações?",
    "user_session_keys": [],
    "delivered_at": "2021-06-22 15:19:08"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    country_code: '+57',
    cellphone: '3176477608',
    session_id: 'd2fa98d29a2670dfa119335df1b0371720d674f1677302aba228876a',
    conversation_id: 34820,
    question: {
      type: 'open',
      text: 'Olá! Bom dia. Espero que esteja tudo bem. Gostaria de continuar nossa conversa para resolver todos os seus problemas e preocupações?'
    },
    sent_at: '2021-06-22 15:19:06.473256',
    sent_text: 'Olá! Bom dia. Espero que esteja tudo bem. Gostaria de continuar nossa conversa para resolver todos os seus problemas e preocupações?',
    user_session_keys: [],
    delivered_at: '2021-06-22 15:19:08'
  })
};

fetch('https://seudominio.com/webhooks/on-delivered', 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://seudominio.com/webhooks/on-delivered",
  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([
    'country_code' => '+57',
    'cellphone' => '3176477608',
    'session_id' => 'd2fa98d29a2670dfa119335df1b0371720d674f1677302aba228876a',
    'conversation_id' => 34820,
    'question' => [
        'type' => 'open',
        'text' => 'Olá! Bom dia. Espero que esteja tudo bem. Gostaria de continuar nossa conversa para resolver todos os seus problemas e preocupações?'
    ],
    'sent_at' => '2021-06-22 15:19:06.473256',
    'sent_text' => 'Olá! Bom dia. Espero que esteja tudo bem. Gostaria de continuar nossa conversa para resolver todos os seus problemas e preocupações?',
    'user_session_keys' => [
        
    ],
    'delivered_at' => '2021-06-22 15:19:08'
  ]),
  CURLOPT_HTTPHEADER => [
    "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://seudominio.com/webhooks/on-delivered"

	payload := strings.NewReader("{\n  \"country_code\": \"+57\",\n  \"cellphone\": \"3176477608\",\n  \"session_id\": \"d2fa98d29a2670dfa119335df1b0371720d674f1677302aba228876a\",\n  \"conversation_id\": 34820,\n  \"question\": {\n    \"type\": \"open\",\n    \"text\": \"Olá! Bom dia. Espero que esteja tudo bem. Gostaria de continuar nossa conversa para resolver todos os seus problemas e preocupações?\"\n  },\n  \"sent_at\": \"2021-06-22 15:19:06.473256\",\n  \"sent_text\": \"Olá! Bom dia. Espero que esteja tudo bem. Gostaria de continuar nossa conversa para resolver todos os seus problemas e preocupações?\",\n  \"user_session_keys\": [],\n  \"delivered_at\": \"2021-06-22 15:19:08\"\n}")

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

	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://seudominio.com/webhooks/on-delivered")
  .header("Content-Type", "application/json")
  .body("{\n  \"country_code\": \"+57\",\n  \"cellphone\": \"3176477608\",\n  \"session_id\": \"d2fa98d29a2670dfa119335df1b0371720d674f1677302aba228876a\",\n  \"conversation_id\": 34820,\n  \"question\": {\n    \"type\": \"open\",\n    \"text\": \"Olá! Bom dia. Espero que esteja tudo bem. Gostaria de continuar nossa conversa para resolver todos os seus problemas e preocupações?\"\n  },\n  \"sent_at\": \"2021-06-22 15:19:06.473256\",\n  \"sent_text\": \"Olá! Bom dia. Espero que esteja tudo bem. Gostaria de continuar nossa conversa para resolver todos os seus problemas e preocupações?\",\n  \"user_session_keys\": [],\n  \"delivered_at\": \"2021-06-22 15:19:08\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://seudominio.com/webhooks/on-delivered")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"country_code\": \"+57\",\n  \"cellphone\": \"3176477608\",\n  \"session_id\": \"d2fa98d29a2670dfa119335df1b0371720d674f1677302aba228876a\",\n  \"conversation_id\": 34820,\n  \"question\": {\n    \"type\": \"open\",\n    \"text\": \"Olá! Bom dia. Espero que esteja tudo bem. Gostaria de continuar nossa conversa para resolver todos os seus problemas e preocupações?\"\n  },\n  \"sent_at\": \"2021-06-22 15:19:06.473256\",\n  \"sent_text\": \"Olá! Bom dia. Espero que esteja tudo bem. Gostaria de continuar nossa conversa para resolver todos os seus problemas e preocupações?\",\n  \"user_session_keys\": [],\n  \"delivered_at\": \"2021-06-22 15:19:08\"\n}"

response = http.request(request)
puts response.read_body
{}

Corpo

application/json

Informações do evento de entrega

Evento que é disparado quando uma mensagem é entregue ao usuário

country_code
string
obrigatório

Código do país do usuário

cellphone
string
obrigatório

Número de telefone do usuário sem o código do país

session_id
string
obrigatório

ID da sessão do usuário

conversation_id
integer
obrigatório

ID da conversa

question
object
obrigatório
sent_at
string<date-time>
obrigatório

Data e hora em que a mensagem foi enviada

sent_text
string
obrigatório

Texto da mensagem enviada

delivered_at
string<date-time>
obrigatório

Data e hora em que a mensagem foi entregue ao usuário

user_session_keys
object[]

Chaves de sessão do usuário coletadas durante a conversa ou fornecidas durante a implantação

Resposta

200 - application/json

Resposta para atualizar ou adicionar informações à sessão

Objeto JSON com as novas informações que serão substituídas ou adicionadas à sessão para uso futuro. O serviço deve responder em menos de 10 segundos.