Call · AtendroZAP Docs

Call

Estrutura de dados do contrato OpenAPI.

Campos

Campo	Tipo	Presença	Descrição
`callId`	`string`	obrigatório	—
`direction`	`string`	obrigatório	Valores: `"inbound"`, `"outbound"`
`number`	`string`	obrigatório	Identidade telefônica canônica, quando conhecida.
`jid`	`string`	opcional	—
`status`	`string`	obrigatório	Valores: `"ringing"`, `"connecting"`, `"active"`, `"ended"`
`startedAt`	`string`	obrigatório	Formato: `date-time`
`answeredAt`	`string`	opcional	Formato: `date-time`
`endedAt`	`string`	opcional	Formato: `date-time`
`endReason`	`string`	opcional	hangup, rejected, ring_timeout, closed ou motivo do motor.
`endedBy`	`string`	opcional	Valores: `"local"`, `"remote"`

Definição OpenAPI

json

{
  "type": "object",
  "properties": {
    "callId": {
      "type": "string"
    },
    "direction": {
      "type": "string",
      "enum": [
        "inbound",
        "outbound"
      ]
    },
    "number": {
      "type": "string",
      "description": "Identidade telefônica canônica, quando conhecida."
    },
    "jid": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "enum": [
        "ringing",
        "connecting",
        "active",
        "ended"
      ]
    },
    "startedAt": {
      "type": "string",
      "format": "date-time"
    },
    "answeredAt": {
      "type": "string",
      "format": "date-time"
    },
    "endedAt": {
      "type": "string",
      "format": "date-time"
    },
    "endReason": {
      "type": "string",
      "description": "hangup, rejected, ring_timeout, closed ou motivo do motor."
    },
    "endedBy": {
      "type": "string",
      "enum": [
        "local",
        "remote"
      ]
    }
  },
  "required": [
    "callId",
    "direction",
    "number",
    "status",
    "startedAt"
  ]
}