Próximo contato da lista

Reserva para você o próximo item da lista e o devolve com o que é preciso para ligar. A fila serve primeiro os retornos que já venceram (_callback com callbackAt no passado), depois os itens cuja reserva expirou e depois os pendentes pela posição. Cada membro segura um item por vez: pedir de novo devolve o mesmo item e renova a reserva (15 minutos, renovada também quando a ligação começa); uma reserva sua que já expirou volta para a fila antes. Se você segura um item de outra lista, responde 409 call_list_reservation_held.

Antes de entregar, a regra de ligação é conferida de novo. Um lead que foi bloqueado, pediu para não ser chamado, perdeu o número ou tem um número inválido tem o item fechado com _refused e o motivo em refusal. O próximo é servido, e refused conta quantos foram pulados. A cada pedido são pulados no máximo 25: quando o limite é atingido sem item, more vem true e é preciso pedir de novo.

A resposta traz item, lead (só nome, bairro, cidade e quantidade de familiares), lastInteraction (a conversa mais recente do lead, só quando você pode abri-la) e as linhas que podem fazer a ligação (trunks, ou trunkRefusal: unauthorized ou no_dialable_trunk). Para ligar, use start_call no WebSocket de chamadas com lead_id, phone_number igual ao phone do item e call_list_item_id. O item traz closable: depois de recarregar a página com a ligação já feita, true diz que o resultado pode ser registrado sem ligar de novo. Sem item e com more false, a fila acabou por agora (item não vem). Exige ser um dos membros que ligam na lista e call_lists:read, sip_trunks:read, sip_trunks:call e call_session:use; a lista precisa estar active.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

ID da lista

Headers
string

Workspace da requisição. Sem ele vale o workspace padrão da pessoa; um workspace do qual ela não participa responde 403 workspace_not_member.

string

Departamento que limita os dados. Quem não participa do departamento recebe 403; donos e administradores escolhem qualquer um.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json