Controlar ligação em andamento

curl --request POST \
  --url https://api.notifique.dev/v1/voice/calls/{id}/actions/{action} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "text": "Pressione 1 para vendas.",
  "voice": "female-natural"
}
'

{
  "success": true,
  "data": {
    "callId": "clxx...",
    "action": "string"
  }
}

{
  "success": false,
  "error": "Bad Request",
  "code": "VALIDATION_ERROR",
  "message": "Campo inválido ou ausente."
}

{
  "success": false,
  "error": "Forbidden",
  "message": "Missing scope: voice:call",
  "code": "FORBIDDEN"
}

{
  "success": false,
  "error": "Bad Request",
  "code": "VALIDATION_ERROR",
  "message": "Campo inválido ou ausente."
}

{
  "success": false,
  "error": "string",
  "message": "string",
  "code": "string"
}

POST

voice

calls

{id}

actions

{action}

curl --request POST \
  --url https://api.notifique.dev/v1/voice/calls/{id}/actions/{action} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "text": "Pressione 1 para vendas.",
  "voice": "female-natural"
}
'

{
  "success": true,
  "data": {
    "callId": "clxx...",
    "action": "string"
  }
}

{
  "success": false,
  "error": "Bad Request",
  "code": "VALIDATION_ERROR",
  "message": "Campo inválido ou ausente."
}

{
  "success": false,
  "error": "Forbidden",
  "message": "Missing scope: voice:call",
  "code": "FORBIDDEN"
}

{
  "success": false,
  "error": "Bad Request",
  "code": "VALIDATION_ERROR",
  "message": "Campo inválido ou ausente."
}

{
  "success": false,
  "error": "string",
  "message": "string",
  "code": "string"
}

Autorizações

Authorization

string

header

obrigatório

API Key no formato Bearer (ex.: sk_live_...).

Parâmetros de caminho

string

obrigatório

action

enum<string>

obrigatório

Opções disponíveis:

speak,

play,

gather,

transfer,

record-start,

record-stop,

dtmf,

hangup

Corpo

application/json

Campos dependem da ação. speak: text, voice. play: audioUrl. gather: prompt, maxDigits, timeoutSecs, voice. transfer: to. dtmf: digits.

voice

string

Exemplo:

"female-natural"

prompt

string

Exemplo:

"Digite seu CPF"

maxDigits

integer

Exemplo:

11

timeoutSecs

integer

Exemplo:

10

string

Exemplo:

"5511999887766"

Resposta

Ação aceita.

success

boolean

Exemplo:

true

data

object

Show child attributes

Voz

Voice: Chamadas

Voice: Fluxos IVR

Números de telefone

Números de Telefone

Controlar ligação em andamento

Autorizações

Parâmetros de caminho

Corpo

Resposta