Skip to main content
POST
/
v1
/
channels
/
{id}
/
conversation
Iniciar conversa no canal
curl --request POST \
  --url https://api.timelyai.com.br/v1/channels/{id}/conversation \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customer_name": "João Silva",
  "customer_phone": "+5547999999999",
  "customer_email": "joao@empresa.com",
  "initial_message": "Olá, gostaria de mais informações."
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "customer_name": "<string>",
    "channel": "<string>",
    "status": "<string>",
    "last_message_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
x-api-key
string
header
required

Chave de API para autenticação. Obtenha sua chave em https://app.timelyai.com.br/developers

Path Parameters

​
id
string<uuid>
required

ID único do recurso (UUID)

Body

application/json
​
contact_id
string<uuid>

ID do contato existente (opcional)

​
customer_name
string

Nome do cliente

Maximum string length: 255
Example:

"João Silva"

​
customer_phone
string

Telefone do cliente

Maximum string length: 50
Example:

"+5547999999999"

​
customer_email
string<email>

Email do cliente

Maximum string length: 255
Example:

"joao@empresa.com"

​
initial_message
string

Mensagem inicial da conversa

Example:

"Olá, gostaria de mais informações."

Response

Conversa iniciada

​
data
object