Ir para a navegação

Listar campanhas de chamadas ativas

Liste as campanhas ativas do espaço de trabalho, da mais recente para a mais antiga.

Cabeçalhos

xi-api-keystringOpcional

Parâmetros de consulta

page_sizeintegerOpcional1-500Padrão é 100

Número máximo de itens a retornar.

statuslist of enums or nullOpcional
Somente campanhas em um destes status.
agent_idstring or nullOpcional
Somente campanhas executadas por este agente.
channelenum or nullOpcional
Somente campanhas neste canal.
Valores permitidos:
modeenum or nullOpcional
Somente campanhas de voz ou somente campanhas de mensagens.
Valores permitidos:
searchstring or nullOpcional<=256 characters

Somente campanhas cujo nome contém este texto.

cursorstring or nullOpcional

Usado para buscar a próxima página. O cursor é retornado na resposta.

Resposta

Resposta bem-sucedida

campaignslist of objects
next_cursorstring or null
has_moreboolean

Erros

422
Unprocessable Entity Error