Itens de uma lista de ligação

Lista os itens em páginas com cursor: envie cursor com o meta.nextCursor da página anterior (meta.hasMore diz se há mais) e limit de 1 a 100 (padrão 50). Os pendentes (state=pending) vêm na ordem em que a fila os serve: primeiro os retornos já vencidos (callbackAt até o instante da primeira página), do mais antigo para o mais novo; depois a fila pela posição; por fim os retornos ainda por vir, pelo horário. O cursor guarda o instante em que a agenda dos pendentes foi cortada na primeira página, então as páginas seguintes seguem a mesma agenda; um cursor que não veio desta API responde 400 cursor_invalid, e um cursor de outra aba usado nos pendentes responde 400 call_list_items_cursor_invalid. A página seguinte nunca pula nem repete um item por causa de uma mudança no último item da página anterior. Os outros filtros seguem a posição na fila. Cada item traz o nome do lead (leadName, ausente quando o nome guardado é só o número dele), o bairro e a cidade do endereço principal dele (leadDistrict, leadCity), o número a chamar, o estado (pending, reserved, closed), quem o reservou e até quando, o resultado escolhido (disposition, um código do catálogo de resultados do workspace, _callback para ligar de novo em callbackAt ou _refused quando o lead deixou de poder receber ligações, com o motivo em refusal), a nota, a última ligação (lastCallId) e, tirados do histórico de chamadas, o resultado técnico dela (outcome) e quantas ligações feitas para o lead (só as de saída, de qualquer origem) existem desde que ele entrou na lista (attempts). closable diz se você pode registrar o resultado do item agora (veja POST /call-list-items/{itemId}/close): a última ligação registrada no item é sua, para o lead do item, o item não está fechado nem esperando um retorno sem nova ligação, ninguém mais o pegou, a lista aceita resultados e você pode trabalhar em listas (call_lists:read, sip_trunks:read, sip_trunks:call e call_session:use). Para quem foi escolhido para ligar na lista ou gerencia listas.

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

ID da lista

Query Params
string
enum

Filtra por estado

Allowed:
string

O meta.nextCursor da página anterior

integer

Itens por página, de 1 a 100 (padrão 50)

Headers
string

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

Responses

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