Atribuir caixa de entrada

Endpoint · POST /conversation/actions

Move a conversa para uma caixa de entrada ou para uma categoria. Exatamente um de mailbox | category, nunca ambos. Campos

mailbox — objeto { name } da caixa de entrada.
category — objeto { name } da categoria.

{
  "type": "assign_mailbox",
  "mailbox": { "name": "Ventas" }
}
{
  "type": "assign_mailbox",
  "category": { "name": "Soporte" }
}

Em uma lista, este objeto vai no array actions de um POST /conversation/actions — veja Montar uma lista de ações.

Exemplo executável

Um assign_mailbox em uma conversa identificada por telefone e canal. Exatamente um de mailbox ou category, nunca ambos — e cada modo se comporta de forma diferente:

mailbox — atribui a conversa à caixa de entrada exata que você indica.
category — você não escolhe uma caixa: o sistema distribui a carga e atribui a conversa à caixa de entrada com menos chats pendentes dentro dessa categoria (útil para distribuir automaticamente entre uma equipe). A categoria deve ter pelo menos uma caixa de entrada configurada.

Cada canal tem sua categoria Predeterminada, com a caixa de entrada padrão do canal dentro. Com vários canais, category: { name: "Predeterminada" } coincide com várias categorias e retorna 409 AMBIGUOUS_CATEGORY. Para mover a conversa para a caixa de entrada padrão, passe-a em mailbox com o nome que a consulta de Caixas de entrada devolve: ele é único no business.

Request

curl -X POST "https://app.1to1ai.com/api/v1/public/{slug}/conversation/actions" \
  -H "Authorization: Bearer sk_1to1_sua_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "conversation": {
      "phone": "+525512345678",
      "channel": "ch_7A9K2M4Q"
    },
    "actions": [
      {
        "type": "assign_mailbox",
        "mailbox": { "name": "Ventas" }
      }
    ]
  }'

curl -X POST "https://app.1to1ai.com/api/v1/public/{slug}/conversation/actions" \
  -H "Authorization: Bearer sk_1to1_sua_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "conversation": {
      "phone": "+525512345678",
      "channel": "ch_7A9K2M4Q"
    },
    "actions": [
      {
        "type": "assign_mailbox",
        "category": { "name": "Soporte" }
      }
    ]
  }'

Resposta

202 Accepted — o grupo foi aceito e roda em background. O resultado por ação não viaja na resposta (consulte-o depois — veja Como é executado).

{
  "status": "processing",
  "actions_accepted": 1
}

string

Sempre processing: confirma que o grupo foi aceito e está em execução.

integer

Quantas ações do array foram admitidas para execução — não quantas tiveram sucesso.

Introdução

Conceitos

Guias

Ações

Exemplo executável

Request

Resposta