DOCS

Sala de Conversa - Atualização

Evento

POST messenger/chat/room/patch

Como receber

Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload.

Payload

  • Content-Type: application/json
CampoTipoObrigatórioValores / ExemploDescrição
gueststringNão
usersstringNão
prefUserstringNão
ownerstringNão
prefUserPendAttrbooleanNão
histUsersstringNão
tagsstringNão
conversationDetailTagsstringNão
departmentstringNãoDepartamento atual da sala
contactstringNão
tlstringNão
lastTlstringNão
currFlowstringNão
currFlowDtLimitstring (date-time)Não
userstringNãoUsuário atual atribuído a sala
leadstringNão
infoobjectNão
lastEventstring (date-time)Não
createdAtstring (date-time)Não
lastFromUserbooleanNão
lastMsgstringNão
statusstringNão
currCasestringNão
triggersobjectNão
chSrcnumberNãoTipo de canal: 1 - WhatsApp, 2 - Facebook, 3 - Instagram, 4 - SMS
chInfoobjectNão
highlightVarsobjectNão
botFlagnumberNão
srcIdstringNão
chIdstringNãoIdentificador principal da sala no canal. No WhatsApp pode ser telefone ou BSUID quando chIdType = wa_user_id.
chIdTypestringNãoAceita: wa_user_idPreenchido apenas quando chId não é o identificador legado do canal. No WhatsApp, indica sala criada somente por BSUID.
chUserIdstringNãoBSUID do usuário WhatsApp quando informado pela Meta.
chPhonestringNãoTelefone WhatsApp confirmado quando informado pela Meta. Preserva vínculo em salas BSUID-only.
chUsernamestringNãoUsername WhatsApp quando informado pela Meta.
chIdPairstringNãoPar de identidade de canal ja conciliado automaticamente. No WhatsApp: BSUID|telefone.
mergeTostringNão
mergeAtstring (date-time)Não
utmobjectNão
utmClickobjectNão
chIsPendingbooleanNãoAtivado se o canal estiver pendente de resposta
dtIsArchivedstring (date-time)Não
dtTransferstring (date-time)Não
chIsArchivedbooleanNãoAtivado se o canal já foi concluído
isOutboundbooleanNãoDefine se é uma sala criada para envio ativo,
waCoexTakenbooleanNãoIndica que a sala foi assumida via Coexistência (WhatsApp app) antes de qualquer usuário entrar
isWaitingUserbooleanNão
leadUserPendAttrnumberNão
contactUserPendAttrnumberNão
companyUserPendAttrnumberNão
_integrationobjectNão
transmissionListstringNão
idleRulesDisabledbooleanNão
idleRulesobjectNão

Estruturas internas

info

{
  "name": "string",
  "phone": "string",
  "email": "string"
}

utm

{
  "provider": "string",
  "source": "string",
  "medium": "string",
  "clickId": "string",
  "campaignId": "string",
  "campaign": "string",
  "groupId": "string",
  "group": "string",
  "creativeId": "string",
  "creative": "string",
  "content": "string",
  "term": "string",
  "url": "string",
  "ref": "string"
}

utmClick

{
  "fbclid": "string",
  "ctwaClid": "string",
  "gclid": "string",
  "gbraid": "string",
  "wbraid": "string",
  "ttclid": "string"
}

idleRules

[
  {
    "rule": "string",
    "idleNextAt": "string (date-time)",
    "idleStep": "number"
  }
]

Exemplo básico recebido:

{
  "guest": "valor",
  "users": [
    "valor"
  ],
  "prefUser": "valor",
  "owner": "valor",
  "prefUserPendAttr": true,
  "histUsers": [
    "valor"
  ],
  "tags": [
    "valor"
  ],
  "conversationDetailTags": [
    "valor"
  ]
}

Respostas

StatusDescriçãoConteúdo
200Return a 200 status to indicate that the data was received successfully

Boas práticas

  • Trate reenvios como possibilidade real.
  • Valide o payload antes de executar regras de negócio.
  • Registre o identificador do evento ou do registro recebido para auditoria.