Contacts

Lista os contatos

get

Autorizações

basic

AuthorizationstringObrigatório

Parâmetros de consulta

internal_limitnumberOpcional

Quantidade de contatos internos por página

Default: 10Example: 10

internal_pagenumberOpcional

Número da página de contatos internos que deverá ser exibida

Default: 1Example: 1

internal_sortstring · enumOpcional

Indica como deve ser a ordenação dos contatos internos: asc ou desc

Default: ASCExample: ASCValores possíveis:

internal_sort_fieldstring · enumOpcional

Indica por qual campo deve ser a ordenação dos contatos internos: name ou number

Default: nameExample: nameValores possíveis:

internal_search_valuestringOpcional

Indica o valor do campo onde deve ser feita a busca dos contatos internos. Internamente o backend procura este valor nos campos name e extension

Example: John

internal_hide_numbersstringOpcional

Contato interno que não será exibido na lista de contatos

Example: 200,500

external_limitnumberOpcional

Quantidade de contatos externos por página

Default: 10Example: 10

external_pagenumberOpcional

Número da página de contatos externos que deverá ser exibida

Default: 1Example: 1

external_sortstring · enumOpcional

Indica como deve ser a ordenação dos contatos externos: asc ou desc

Default: ASCExample: ASCValores possíveis:

external_sort_fieldstring · enumOpcional

Indica por qual campo deve ser a ordenação dos contatos externos: name ou number

Default: nameExample: nameValores possíveis:

external_search_valuestringOpcional

Indica o valor do campo que deve onde ser feita a busca dos contatos externos. Internamente o backend procura este valor nos campos name e number

Example: Doe

external_hide_numbersstringOpcional

Contato externo que não será exibido na lista de contatos

Example: 200,500

Respostas

200Sucesso

Sem conteúdo

get

/pbx/contacts/paginated

HTTPcURLJavaScriptPython

GET /pbx/contacts/paginated HTTP/1.1
Authorization: Basic username:password
Accept: */*

200Sucesso

Sem conteúdo

Histórico de contato

get

Autorizações

basic

AuthorizationstringObrigatório

Parâmetros de consulta

idstringObrigatório

Respostas

default

application/json

get

/pbx/contacts/call_history_by_contact

HTTPcURLJavaScriptPython

GET /pbx/contacts/call_history_by_contact?id=text HTTP/1.1
Authorization: Basic username:password
Accept: */*

default

{
  "codename": "Alice",
  "date_time": "2025-03-07T17:57:11.200Z",
  "contact_id": "6421dc5c12b2cd388e01c4b3",
  "contact_name": "Bob",
  "contact_number": "11 99999-9999",
  "contact_photo": "/photos/contact/6421dc5c12b2cd388e011234",
  "agent_name": "Alice",
  "agent_photo": "/photos/agent/6723fab28608a57f79e5d9fc?sz=67cb57e59f6e8901f1e51234",
  "disposition": "answered",
  "call_type": "incoming",
  "recording_file": "https://example.com/voice/recording/file/6716a917a7a082a0c60918f2-bd7375a71fc3b768d42233ac29b1ba97",
  "recording_path": "6716a917a7a082a0c60918f2/20250307/20250307-175658-IN-1199999-9999-1003-2174137021751.wav",
  "recording_stream": "https://example.com/voice/recording/stream/6716a917a7a082a0c60918f2-bd7375a71fc3b768d42233ac29b1ba97",
  "transfer_type": "ATTENDEDTRANSFER",
  "transfer_source": "1003",
  "source": "11 99999-9999",
  "destination": "1002"
}